[由Adobe高級技術架構師Anton Evers提供]{class="badge informative" title="安東·埃弗斯撰寫"}

大規模散佈Adobe Commerce修補程式的最佳作法

如果您管理多個Adobe Commerce安裝,修補可能會是一個複雜的程式。 集中修補 ​是企業的最佳作法。 它可協助您在所有Adobe Commerce安裝上套用正確的修補程式。 本主題說明如何針對所有型別的Adobe Commerce 修補程式達成集中式修補程式散佈。

NOTE
下列內容最初發佈在Adobe技術部落格上的按比例分發Adobe Commerce修補程式文章中。 它已修改為專注於實作集中式修補策略的步驟和程式碼範例。 請參閱原始文章,以取得此處說明的不同修補程式型別的詳細資訊。

受影響的產品和版本

所有支援的版本

  • 雲端基礎結構上的Adobe Commerce
  • Adobe Commerce內部部署

策略

由於有許多不同型別的修補程式和套用修補程式的方法,您如何知道哪個修補程式會先套用? 您擁有的修補程式越多,這些修補程式套用至相同檔案或相同程式碼行的機會就越大。 修補程式會依下列順序套用:

  1. 安全性修補程式 ​是Adobe Commerce發行版本的靜態程式碼基底的一部分。

  2. Composer修補程式 ​透過composer installcomposer update外掛程式,例如cweagans/composer-patches

  3. 所有​ 必要的修補程式 ​包含在Commerce🔗封裝的雲端修補程式。

  4. 已選取包含在[Quality Patches Tool]中的​ 品質修補程式

  5. 自訂修補程式 ​以及/m2-hotfixes目錄中的Adobe Commerce支援修補程式,依修補程式名稱的字母順序排列。

    note important
    IMPORTANT
    您套用的修補程式越多,程式碼就越複雜。 複雜的程式碼會讓升級至新版Adobe commerce更加困難,並增加您的總擁有成本。

如果您負責維護Adobe Commerce的多個安裝,確保所有執行個體都安裝了相同的修補程式集,可能會相當困難。 每個安裝都有自己的Git存放庫、/m2-hotfixes目錄和composer.json檔案。 您唯一能保證的是,雲端使用者的​ 安全性修補程式 ​和​ 必要的修補程式 ​都作為主要Adobe Commerce版本的一部分安裝。

目前,此問題沒有單一集中式的解決方案,但Composer提供填補空白的方法。 cweagans/composer-patches封裝可讓您從相依性套用修補程式。 您可以建立可安裝所有修補程式的Composer套件,然後在所有專案中需要該套件。

涵蓋​ 安全性修補程式必要的修補程式 ​及​ Composer修補程式,但品質修補程式及/m2-hotfixes目錄的內容呢?

套用高品質的修補程式和Hotfix

您可以使用vendor/bin/magento-patches apply命令,在雲端基礎結構和內部部署安裝上安裝高品質的修補程式。 您必須確定vendor/bin/magento-patches apply命令會在composer install作業之後執行。

NOTE
在雲端基礎結構上,您也可以將品質修補程式列在您的專案的.magento.env.yaml檔案中,以安裝品質修補程式。 此處說明的範例需要使用vendor/bin/magento-patches apply命令。

您可以指定要在自訂Composer元件封裝的composer.json檔案中套用的修補程式,然後建立在composer install作業之後執行命令的外掛程式封裝。

總而言之,此集中式修補範例需要您建立兩個自訂撰寫器套裝程式:

  • 元件封裝: centralized-patcher

    • 定義品質修補程式清單及要安裝的m2-hotfixes
    • 需要centralized-patcher-composer-plugin套件,該套件會在composer install作業之後執行vendor/bin/magento-patches apply命令
  • 外掛程式套件: centralized-patcher-composer-plugin

    • 定義從centralized-patcher封裝讀取品質修補程式清單的CentralizedPatcher PHP類別
    • 執行vendor/bin/magento-patches apply命令以在composer install作業之後安裝品質修補程式清單

centralized-patcher

您可以建立Composer元件套件(centralized-patcher),以集中管理所有Adobe Commerce安裝中的所有品質修補程式和/m2-hotfixes

元件套件必須:

  • 在部署期間將/m2-hotfixes目錄的內容複製到所有安裝中。
  • 定義要安裝的品質修補程式清單。
  • 執行vendor/bin/magento-patches命令,在所有安裝中安裝相同的品質修補程式清單(使用centralized-patcher-composer-plugin外掛程式套件做為相依性)。

若要建立centralized-patcher元件封裝:

  1. 建立包含下列內容的composer.json檔案:

    note note
    NOTE
    下列範例中的require屬性顯示您稍後必須建立的外掛程式套件上的require相依性。
    code language-json
    {
     "name": "magento-services/centralized-patcher",
     "version": "0.0.1",
     "description": "Centralized patcher for patching multiple web stores from a central place",
     "type": "magento2-component",
     "license": [
         "OSL-3.0",
         "AFL-3.0"
     ],
     "require": {
         "magento-services/centralized-patcher-composer-plugin": "~0.0.1"
     },
     "require-dev": {
         "composer/composer": "^2.0"
     },
     "extra": {
         "map": [
         ],
    }
    
  2. 在您的套件中建立/m2-hotfixes目錄,並將其新增至composer.json檔案中的map屬性。 map屬性包含要從此套件複製到要修補之目標專案根目錄的檔案。

    code language-json
    {
     ...
     "extra": {
         "map": [
             [
                 "/m2-hotfixes",
                 "/m2-hotfixes"
             ]
         ],
    }
    
    note note
    NOTE
    centralized-patcher封裝將/m2-hotfixes目錄的內容複製到composer install上目標專案的m2-hotfix目錄中。 由於雲端部署指令碼會在composer install之後套用m2-hotfix,因此所有hotfix都是由部署機制安裝。
  3. 定義要安裝在quality-patches屬性中的品質修補程式。

    code language-json
    {
    ...
     "extra": {
         "map": [
             [
                 "/m2-hotfixes",
                 "/m2-hotfixes"
             ]
         ],
         "quality-patches": [
             "MDVA-30106",
             "MDVA-12304"
         ]
    }
    

上述程式碼範例中的quality-patches屬性包含完整修補程式清單中的兩個修補程式,以為例。 這些品質修補程式會使用vendor/bin/magento-patches apply命令安裝在需要centralized-patcher套件的每個專案上。

您可以建立範例修補程式(/m2-hotfixes/EXAMPLE-PATCH_2.4.6.patch)以進行測試。

NOTE
您應該將自己的修補程式連同您直接從Adobe Commerce支援收到的修補程式一起放在m2-hotfixes目錄中。

範例修補程式檔案(/m2-hotfixes/EXAMPLE-PATCH_2.4.6.patch):

diff --git a/vendor/magento/framework/Mview/View/Subscription.php b/vendor/magento/framework/Mview/View/Subscription.php
index 03a3bf9..681e0b0 100644
--- a/vendor/magento/framework/Mview/View/Subscription.php
+++ b/vendor/magento/framework/Mview/View/Subscription.php
@@ -16,6 +16,7 @@ use Magento\Framework\Mview\ViewInterface;

 /**
  * Mview subscription.
+ * Test Patch File
  */
 class Subscription implements SubscriptionInterface
 {

centralized-patcher-composer-plugin

由於此範例使用內部部署方法來安裝品質修補程式,因此您必須確定vendor/bin/magento-patches apply命令會在composer install作業之後執行。 此外掛程式會在composer install作業之後觸發,該作業會執行vendor/bin/magento-patches apply命令。

若要建立centralized-patcher-compose-plugin元件封裝:

  1. 建立包含下列內容的composer.json檔案:

    code language-json
    {
     "name": "magento-services/centralized-patcher-composer-plugin",
     "version": "0.0.1",
     "description": "Centralized patcher composer plugin to apply quality patches from the centralized patcher",
     "type": "composer-plugin",
     "license": [
         "OSL-3.0",
         "AFL-3.0"
     ],
     "require": {
         "symfony/process": "^4.1 || ^5.1",
         "magento/magento-cloud-patches": "~1.0.20",
         "magento/framework": "~103.0.5-p1",
         "composer-plugin-api": "^2.0"
     },
     "require-dev": {
         "composer/composer": "^2.0"
     },
     "suggest": {
         "magento-services/centralized-patcher": "~0.0.1"
     },
     "autoload": {
         "psr-4": {
             "MagentoServices\\CentralizedPatcherComposerPlugin\\": ""
         }
     },
     "extra": {
         "class": "MagentoServices\\CentralizedPatcherComposerPlugin\\Patcher"
     }
    }
    
  2. 建立PHP檔案並定義CentralizedPatcher類別以從centralized-patcher元件封裝讀取品質修補程式清單,並在每次composer install作業後立即安裝。

    code language-php
    <?php
    declare(strict_types=1);
    
    namespace MagentoServices\CentralizedPatcherComposerPlugin;
    
    use Composer\Composer;
    use Composer\EventDispatcher\EventSubscriberInterface;
    use Composer\IO\IOInterface;
    use Composer\Plugin\PluginInterface;
    use Composer\Script\ScriptEvents;
    use Symfony\Component\Process\Exception\ProcessFailedException;
    use Symfony\Component\Process\Process;
    
    class Patcher implements PluginInterface, EventSubscriberInterface
    {
     /**
      * @var Composer $composer
      */
     protected $composer;
    
     /**
      * @var IOInterface $io
      */
     protected $io;
    
     /**
      * @param Composer $composer
      * @param IOInterface $io
      * @return void
      */
     public function activate(Composer $composer, IOInterface $io)
     {
         $this->composer = $composer;
         $this->io = $io;
     }
    
     /**
      * @param Composer $composer
      * @param IOInterface $io
      * @return void
      */
     public function deactivate(Composer $composer, IOInterface $io)
     {
         // Method must exist
     }
    
     /**
      * @param Composer $composer
      * @param IOInterface $io
      * @return void
      */
     public function uninstall(Composer $composer, IOInterface $io)
     {
         // Method must exist
     }
    
     /**
      * @return string[]
      */
     public static function getSubscribedEvents()
     {
         return [
             ScriptEvents::POST_UPDATE_CMD => 'installPatches',
             ScriptEvents::POST_INSTALL_CMD => 'installPatches',
         ];
     }
    
     /**
      * Apply patches from magento-services/centralized-patcher
      *
      * @param \Composer\Script\Event $event
      * @return void
      */
     public function installPatches(\Composer\Script\Event $event)
     {
         $patches = [];
         $this->io->write('Applying centralized quality patches');
         $packages = $this->composer->getLocker()->getLockData()['packages'];
         foreach ($packages as $package) {
             if ($package['name'] !== 'magento-services/centralized-patcher') {
                 continue;
             }
             $patches = $package['extra']['quality-patches'] ?? [];
         }
         if (empty($patches)) {
             $this->io->error("No centralized quality patches to install");
             exit(0);
         }
         $command = array_merge(
             ['php','./vendor/bin/magento-patches','apply','--no-interaction'],
              $patches
         );
         $process = new Process($command);
         try {
             $this->io->debug($process->getCommandLine());
             $process->mustRun();
             $this->io->write(
                 str_replace("\n\n", "\n", trim($process->getErrorOutput() ?: $process->getOutput(), "\n"))
             );
         } catch (ProcessFailedException $e) {
             $process = $e->getProcess();
             $error = sprintf(
                 'The command "%s" failed. %s',
                 $process->getCommandLine(),
                 trim($process->getErrorOutput() ?: $process->getOutput(), "\n")
             );
             throw new \RuntimeException($error, $process->getExitCode());
         }
     }
    }
    
TIP
請參考code-examples,檢視此範例中說明的兩個封裝的實際運作情況。

如何處理專案專屬修補程式

您可能會遇到在所有專案中僅需要95%的修補程式,而少數修補程式僅套用至特定執行個體的情況。 套用修補的常規方法仍然有效。 您可以在/m2-hotfixes目錄中保留專案特定的修補程式,並為每個專案安裝品質修補程式。

如果您使用此方法,不會 ​認可/m2-hotfixes目錄中任何已由centralized-patcher元件封裝複製到專案中的修補程式。 您可以將/m2-hotfixes新增至您的.gitignore檔案,以防止意外認可。 更新.gitignore檔案後,請記住,必須使用git add –force命令新增任何專案特定的/m2-hotfixes

執行不同的Adobe Commerce版本

請確定您在centralized-patcher元件封裝中設定正確的相依性。 例如,您的特定套件版本可能需要Adobe Commerce 2.4.5-p2,此套件僅提供與Adobe Commerce 2.4.5-p2相容的修補程式。 您可以有此套件的其他版本與Adobe Commerce 2.4.4相容。

瞭解結果

就像在雲端基礎結構上使用Adobe Commerce一樣,本文假設您的部署程式使用composer install命令(而非composer updategit pull)將新程式碼部署到您的伺服器。 集中安裝修補程式的流程如下所示:

  1. Composer安裝

    • 安裝Adobe Commerce,包括 — p1或 — p2安全性與功能修補程式
    • 結合集中式/m2-hotfixes,並透過專案特定的/m2-hotfixes支援修補程式以及支援修補程式
    • 套用隨cweagans/composer-patches Composer套件安裝的任何修補程式
  2. composer install之後

    • Composer外掛程式會安裝集中式品質修補程式
  3. 部署

    • 已根據.magento.env.yaml檔案安裝必要的修補程式和專案特定的品質修補程式(僅限雲端基礎結構專案上的Adobe Commerce)。
    • 自訂修補程式和/m2-hotfixes目錄中的支援修補程式會依修補程式名稱的字母順序安裝。

如此一來,您可以集中管理所有安裝的所有修補程式,更能保證Adobe Commerce存放區的安全性和穩定性。 請使用下列方法檢查修正程式狀態:

程式碼範例

recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60