DocumentationCommerceManuel d’implémentation

[Contribution d'Anton Evers, ingénieur en architecture technique, Adobe]{class="badge informative" title="Contribution d’Anton Evers"}

Bonnes pratiques pour la distribution de correctifs Adobe Commerce à grande échelle

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Expérimenté
  • Développeur

Si vous gérez plusieurs installations Adobe Commerce, correction peut être un processus complexe. La correction centralisée est une partie essentielle de l’ architecture de référence globale et une bonne pratique pour les entreprises. Il vous aide à appliquer les correctifs appropriés sur toutes vos installations Adobe Commerce. Cette rubrique explique comment obtenir une distribution de correctifs centralisée pour tous les types de correctifs Adobe Commerce.

NOTE
Le contenu suivant a été publié à l’origine dans l’article Distribution de correctifs Adobe Commerce à l’échelle sur le blog Adobe Tech. Il a été modifié afin de se concentrer sur les étapes et les exemples de code pour mettre en oeuvre une stratégie de correctif centralisé. Pour plus d’informations sur les différents types de correctifs décrits ici, consultez la publication d’origine .

Produits et versions concernés

Toutes les versions prises en charge de :

  • Adobe Commerce sur l’infrastructure cloud
  • Adobe Commerce sur site

Stratégie

Comme il existe de nombreux types de correctifs différents et de nombreuses façons de les appliquer, comment savoir quel correctif est appliqué en premier ? Plus vous avez de correctifs, plus les chances qu’ils s’appliquent au même fichier ou à la même ligne de code sont grandes. Les correctifs sont appliqués dans l’ordre suivant :

  1. Les correctifs de sécurité font partie de la base de code statique d’une version d’Adobe Commerce.

  2. Correctifs du compositeur à composer install et composer update plug-ins tels que cweagans/compositeur-patches.

  3. Tous les correctifs requis inclus dans le package Cloud Patches for Commerce.

  4. Correctifs de qualité sélectionnés inclus dans [Quality Patches Tool].

  5. Correctifs personnalisés et correctifs de prise en charge d’Adobe Commerce dans le répertoire /m2-hotfixes dans l’ordre alphabétique par nom de correctif.

    note important
    IMPORTANT
    Plus vous appliquez de correctifs, plus votre code devient complexe. Un code complexe peut rendre la mise à niveau vers une nouvelle version du commerce Adobe plus difficile et augmenter le coût total de possession.

Si vous êtes responsable de la maintenance de plusieurs installations d’Adobe Commerce, il peut s’avérer difficile de s’assurer que toutes les instances ont le même ensemble de correctifs installés. Chaque installation possède son propre référentiel git, son répertoire /m2-hotfixes et son fichier composer.json. La seule garantie que vous avez est que les correctifs de sécurité et les correctifs requis pour les utilisateurs de cloud sont tous installés dans le cadre de votre version principale d’Adobe Commerce.

Actuellement, il n’existe pas de solution centralisée unique pour ce problème, mais le compositeur d’expérience offre un moyen de combler le fossé. Le package cweagans/composer-patches vous permet d’appliquer des correctifs à partir de dépendances. Vous pouvez créer un module Compositeur qui installe tous vos correctifs, puis en avoir besoin dans tous vos projets.

Cela concerne les correctifs de sécurité, les correctifs requis et les ​, mais qu’en est-il des correctifs de qualité et du contenu du répertoire /m2-hotfixes ?

Application de correctifs de qualité et de correctifs logiciels

Vous pouvez installer des correctifs de qualité sur l’infrastructure cloud et les installations sur site à l’aide de la commande vendor/bin/magento-patches apply. Vous devez vous assurer que la commande vendor/bin/magento-patches apply s’exécute après les opérations composer install.

NOTE
Sur l’infrastructure cloud, vous pouvez également installer des correctifs de qualité en les répertoriant dans le fichier .magento.env.yaml de votre projet. L’exemple décrit ici nécessite l’utilisation de la commande vendor/bin/magento-patches apply.

Vous pouvez spécifier les correctifs à appliquer dans le fichier composer.json d’un module de composant Composer personnalisé, puis créer un module externe qui exécute la commande après les opérations composer install.

Pour résumer, cet exemple de correctif centralisé nécessite la création de deux packages compositeur personnalisés :

  • Package de composant : centralized-patcher

    • Définit la liste des correctifs de qualité et m2-hotfixes à installer
    • Nécessite le package centralized-patcher-composer-plugin qui exécute la commande vendor/bin/magento-patches apply après les opérations composer install

  • Package de module externe : centralized-patcher-composer-plugin

    • Définit une classe PHP CentralizedPatcher qui lit la liste des correctifs de qualité du package centralized-patcher.
    • Exécute la commande vendor/bin/magento-patches apply pour installer la liste des correctifs de qualité après les opérations composer install.

centralized-patcher

Vous pouvez créer un module de composant Compositeur (centralized-patcher) pour gérer de manière centralisée tous les correctifs de qualité et /m2-hotfixes sur toutes vos installations Adobe Commerce.

Le module de composant doit :

  • Copiez le contenu du répertoire /m2-hotfixes dans toutes vos installations pendant le déploiement.
  • Définissez la liste des correctifs de qualité à installer.
  • Exécutez la commande vendor/bin/magento-patches pour installer la même liste de correctifs de qualité sur toutes les installations (en utilisant le module externe centralized-patcher-composer-plugin comme dépendance).

Pour créer le package de composant centralized-patcher :

  1. Créez un fichier composer.json avec les contenus suivants :

    note note
    NOTE
    L’attribut require de l’exemple suivant montre une dépendance require sur le module externeque vous devez créer plus tard dans cet exemple.
    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. Créez un répertoire /m2-hotfixes dans votre package et ajoutez-le à l’attribut map de votre fichier composer.json. L’attribut map contient des fichiers à copier de ce package dans la racine du projet cible que vous souhaitez corriger.

    code language-json 
    {
 ...
 "extra": {
     "map": [
         [
             "/m2-hotfixes",
             "/m2-hotfixes"
         ]
     ],
}
    note note
    NOTE
    Le package centralized-patcher copie le contenu du répertoire /m2-hotfixes dans le répertoire m2-hotfixes du projet cible sur composer install. Puisque les scripts de déploiement cloud appliquent des correctifs m2 après composer install, tous les correctifs sont installés par le mécanisme de déploiement.

  3. Définissez les correctifs de qualité à installer dans l’attribut quality-patches.

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

L’attribut quality-patches de l’exemple de code précédent contient deux correctifs de la liste complète de correctifs comme exemple. Ces correctifs de qualité sont installés sur chaque projet qui nécessite le package centralized-patcher à l’aide de la commande vendor/bin/magento-patches apply.

À des fins de test, vous pouvez créer un exemple de correctif (/m2-hotfixes/EXAMPLE-PATCH_2.4.6.patch).

NOTE
Vous devez placer vos propres correctifs dans le répertoire m2-hotfixes avec les correctifs que vous recevez directement du support Adobe Commerce.

Exemple de fichier de correctif (/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

Puisque cet exemple utilise la méthode sur site pour installer des correctifs de qualité, vous devez vous assurer que la commande vendor/bin/magento-patches apply s’exécute après les opérations composer install. Ce module externe est déclenché après les opérations composer install qui exécutent la commande vendor/bin/magento-patches apply.

Pour créer le package de composant centralized-patcher-compose-plugin :

  1. Créez un fichier composer.json avec les contenus suivants :

    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. Créez un fichier PHP et définissez une classe CentralizedPatcher pour lire la liste des correctifs de qualité à partir du package de composant centralized-patcher et les installer immédiatement après chaque opération 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
Reportez-vous aux exemples-code pour voir les deux packages décrits dans cet exemple en action.

Que faire des correctifs spécifiques à un projet

Il peut y avoir un scénario où seulement 95 % des correctifs sont requis dans tous les projets, tandis que quelques correctifs s’appliquent uniquement à une instance spécifique. La méthode régulière d’application de correction fonctionne toujours. Vous pouvez conserver des correctifs spécifiques au projet dans le répertoire /m2-hotfixes et installer des correctifs de qualité par projet.

Si vous utilisez cette approche, ne validez pas les correctifs du répertoire /m2-hotfixes qui ont été copiés dans votre projet par le package de composant centralized-patcher. Vous pouvez empêcher les validations accidentelles en ajoutant /m2-hotfixes à votre fichier .gitignore. Après la mise à jour du fichier .gitignore, n’oubliez pas que tout /m2-hotfixes spécifique au projet doit être ajouté à l’aide de la commande git add –force.

Exécution de différentes versions d’Adobe Commerce

Assurez-vous de définir la dépendance appropriée dans le package de composants centralized-patcher. Par exemple, vous pouvez avoir besoin d’Adobe Commerce 2.4.5-p2 pour une version spécifique de votre package, qui ne fournit que les correctifs compatibles avec Adobe Commerce 2.4.5-p2. Vous pouvez avoir une autre version de ce module compatible avec Adobe Commerce 2.4.4.

Comprendre le résultat

Comme avec Adobe Commerce sur l’infrastructure cloud, cet article suppose que votre processus de déploiement utilise la commande composer install et non composer update ou git pull pour déployer le nouveau code sur vos serveurs. Le flux d'installation de correctifs centralisés se présente alors comme suit :

  1. Installation du compositeur

    • Installe Adobe Commerce, y compris les correctifs de sécurité -p1 ou -p2 et fonctionnels.
    • Combine les /m2-hotfixes centralisés et les correctifs de prise en charge avec les /m2-hotfixes spécifiques au projet et les correctifs de prise en charge
    • Applique tous les correctifs installés avec le package du compositeur cweagans/composer-patches.

  2. Après composer install

    • Le module externe du compositeur installe des correctifs de qualité centralisés.

  3. Déploiement

    • Les correctifs requis et les correctifs de qualité spécifiques au projet sont installés sur la base du fichier .magento.env.yaml (Adobe Commerce sur les projets d’infrastructure cloud uniquement).
    • Les correctifs personnalisés et les correctifs de prise en charge du répertoire /m2-hotfixes sont installés par ordre alphabétique par nom de correctif.

Ainsi, vous pouvez gérer de manière centralisée tous vos correctifs pour toutes vos installations et vous pouvez mieux garantir la sécurité et la stabilité de vos magasins Adobe Commerce. Utilisez les méthodes suivantes pour vérifier l’état du correctif :

Exemples de code

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