[Contributed by Tony Evers, シニア・テクニカル・アーキテクト,Adobe]{class="badge informative" title="アーティスト:Tony Evers"}

Adobe Commerce パッチを大規模に配布するためのベストプラクティス

複数のAdobe Commerce インストールを管理する場合、​ パッチ適用は複雑なプロセスになる可能性があります。 一元的なパッチ適用​は、企業にとってベストプラクティスです。 Adobe Commerceのすべてのインストールに適切なパッチを適用するのに役立ちます。 このトピックでは、すべての種類のAdobe Commerce ​ パッチ ​に対して一元的にパッチを配布する方法について説明します。

NOTE
以下の内容は、当初Adobe Tech ブログのAdobe Commerce パッチの大規模な配布記事に掲載されました。 一元化されたパッチ戦略を実装するための手順とコードサンプルに焦点を当てるように変更されました。 ここで説明する様々な種類のパッチについて詳しくは、元の投稿を参照してください。

影響を受ける製品とバージョン

​ サポートされているすべてのバージョン ​ /:

  • Adobe Commerce on cloud infrastructure
  • Adobe Commerce オンプレミス

戦略

パッチには様々な種類があり、適用する方法も多いので、最初に適用するパッチを知るにはどうすればよいでしょうか? パッチが多ければ多いほど、同じファイルや同じコード行に適用される可能性が高くなります。 パッチは次の順序で適用されます。

  1. セキュリティパッチ​は、Adobe Commerce リリースの静的コードベースの一部です。

  2. コンポーザーのパッチcomposer installおよびcweagans/composer-patchesなどのcomposer update個のプラグイン。

  3. すべての​ 必要なパッチ ​は、Cloud Patches for Commerce パッケージに含まれています。

  4. [Quality Patches Tool]に含まれる高品質のパッチ を選択しました。

  5. カスタムパッチ​とAdobe Commerceは、パッチ名でアルファベット順に/m2-hotfixes ディレクトリのパッチをサポートします。

    note important
    IMPORTANT
    パッチを適用すればするほど、コードが複雑になります。 複雑なコードを使用すると、新しいバージョンのAdobe commerceへのアップグレードがより困難になり、総所有コストが増加する可能性があります。

Adobe Commerceの複数のインストールを管理する責任がある場合、すべてのインスタンスに同じパッチセットがインストールされていることを確認することは困難です。 各インストールには、独自のGit リポジトリ、/m2-hotfixes ディレクトリ、およびcomposer.json ファイルがあります。 お客様が持っている唯一の保証は、クラウドユーザーに必要な​ セキュリティパッチ ​と​ パッチ ​がすべて、メインのAdobe Commerce版の一部としてインストールされていることです。

現在、この問題に対する一元的な解決策はありませんが、Composerはギャップを埋める方法を提供します。 cweagans/composer-patches パッケージでは、依存関係🔗から パッチを適用できます。 すべてのパッチをインストールするComposer パッケージを作成し、そのパッケージをすべてのプロジェクトに必要とすることができます。

セキュリティパッチ必要なパッチコンポーザーのパッチ​について説明しますが、品質パッチと/m2-hotfixes ディレクトリの内容については何でしょうか?

高品質のパッチとホットフィックスの適用

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操作の後にコマンドを実行するプラグインパッケージを作成できます。

要約すると、この一元化されたパッチ適用の例では、2つのカスタムコンポーザーパッケージを作成する必要があります。

  • コンポーネントパッケージ: 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
    次の例の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
    centralized-patcher パッケージは、/m2-hotfixes ディレクトリの内容をcomposer installのターゲット プロジェクトのm2-hotfixes ディレクトリにコピーします。 クラウド展開スクリプトはcomposer installの後にm2-hotfixを適用するので、すべてのホットフィックスは展開メカニズムによってインストールされます。
  3. quality-patches属性にインストールする品質パッチを定義します。

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

前述のコードサンプルのquality-patches属性には、例として​ フルパッチリスト ​の2つのパッチが含まれています。 これらの品質のパッチは、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

この例では、オンプレミス メソッドを使用して品質のパッチをインストールするため、composer install操作の後にvendor/bin/magento-patches apply コマンドが実行されていることを確認する必要があります。 このプラグインは、vendor/bin/magento-patches apply コマンドを実行するcomposer install操作の後にトリガーされます。

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
この例で説明されている2つのパッケージの実際については、code-examplesを参照してください。

プロジェクト固有のパッチの処理方法

すべてのプロジェクトで必要なパッチの95%のみが適用され、一部のパッチは特定のインスタンスにのみ適用されるシナリオがある場合があります。 パッチを適用する通常の方法は引き続き機能します。 プロジェクト固有のパッチは/m2-hotfixes ディレクトリに保存し、プロジェクトごとに品質のパッチをインストールできます。

このアプローチを使用する場合、centralized-patcher コンポーネントパッケージによってプロジェクトにコピーされた/m2-hotfixes ディレクトリのパッチを コミットしません。 /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 on cloud infrastructureと同様に、この記事では、デプロイメントプロセスでcomposer updateまたはgit pullではなくcomposer install コマンドを使用して新しいコードをサーバーにデプロイすることを前提としています。 一元化されたパッチのインストールのフローは次のようになります。

  1. Composer インストール

    • -p1または – p2のセキュリティおよび機能パッチを含むAdobe Commerceをインストールします
    • 一元化された/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
commerce-operations-help-implementation-playbook