DocumentaçãoCommerceManual de implementação

[Contribuição de Anton Evers, arquiteto técnico sênior, Adobe]{class="badge informative" title="Contribuição de Anton Evers"}

Práticas recomendadas para distribuição de patches do Adobe Commerce em escala

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

Criado para:

  • Experiente
  • Desenvolvedor

Se você gerencia várias instalações do Adobe Commerce, o patch pode ser um processo complexo. A aplicação centralizada de patches é uma parte essencial da arquitetura de referência global e uma prática recomendada para empresas. Ele ajuda a aplicar os patches corretos em todas as instalações do Adobe Commerce. Este tópico explica como obter a distribuição centralizada de patches para todos os tipos de patches do Adobe Commerce.

NOTE
O conteúdo a seguir foi publicado originalmente na publicação Distributing Adobe Commerce Patches at Scale no Blog da Adobe Tech. Ela foi modificada para se concentrar nas etapas e amostras de código para implementar uma estratégia de patch centralizada. Consulte a publicação original para obter mais detalhes sobre os diferentes tipos de correções descritos aqui.

Produtos e versões afetados

Todas as versõescom suporte de:

  • Adobe Commerce na infraestrutura em nuvem
  • Adobe Commerce no local

Estratégia

Como há vários tipos diferentes de patches e muitas maneiras de aplicá-los, como você sabe qual patch é aplicado primeiro? Quanto mais patches você tiver, maior a chance de eles serem aplicados no mesmo arquivo ou na mesma linha de código. Os patches são aplicados na seguinte ordem:

  1. Patches de segurança fazem parte da base de código estático de uma versão do Adobe Commerce.

  2. Patches do compositor por meio de composer install e composer update plug-ins, como cweagans/composer-patches.

  3. Todos os patches necessários incluídos no pacote Patches da Nuvem para o Commerce.

  4. patches de qualidade selecionados incluídos em [Quality Patches Tool].

  5. Patches personalizados e patches do Suporte da Adobe Commerce no diretório /m2-hotfixes em ordem alfabética por nome de patch.

    note important
    IMPORTANT
    Quanto mais patches você aplicar, mais complexo será o código. Códigos complexos podem dificultar a atualização para uma nova versão do Adobe Commerce e aumentar seu custo total de propriedade.

Se você for responsável por manter várias instalações do Adobe Commerce, garantir que todas as instâncias tenham o mesmo conjunto de patches instalados pode ser desafiador. Cada instalação tem seu próprio repositório Git, diretório /m2-hotfixes e arquivo composer.json. A única garantia que você tem é que os patches de segurança e os patches necessários para usuários da nuvem estejam todos instalados como parte da sua versão principal do Adobe Commerce.

Atualmente, não há uma solução única centralizada para esse problema, mas o Composer oferece uma maneira de preencher a lacuna. O pacote cweagans/composer-patches permite aplicar patches de dependências. Você pode criar um pacote do Composer que instale todos os seus patches e, em seguida, exigir esse pacote em todos os seus projetos.

Isso abrange patches de segurança, patches necessários e patches de compositor, mas e os patches de qualidade e o conteúdo do diretório /m2-hotfixes?

Aplicar patches e hotfixes de qualidade

Você pode instalar patches de qualidade na infraestrutura de nuvem e em instalações locais usando o comando vendor/bin/magento-patches apply. Você deve garantir que o comando vendor/bin/magento-patches apply seja executado após composer install operações.

NOTE
Na infraestrutura em nuvem, você também pode instalar patches de qualidade listando-os no arquivo .magento.env.yaml do seu projeto. O exemplo descrito aqui requer o uso do comando vendor/bin/magento-patches apply.

Você pode especificar os patches a serem aplicados no arquivo composer.json de um pacote de componente Composer personalizado e, em seguida, criar um pacote de plug-in que execute o comando após composer install operações.

Em resumo, este exemplo de patch centralizado requer a criação de dois pacotes personalizados do Composer:

  • Pacote de componentes: centralized-patcher

    • Define a lista de patches de qualidade e o m2-hotfixes a ser instalado
    • Requer o pacote centralized-patcher-composer-plugin, que executa o comando vendor/bin/magento-patches apply após composer install operações

  • Pacote de plug-ins: centralized-patcher-composer-plugin

    • Define uma classe PHP CentralizedPatcher que lê a lista de patches de qualidade do pacote centralized-patcher
    • Executa o comando vendor/bin/magento-patches apply para instalar a lista de patches de qualidade após composer install operações

centralized-patcher

Você pode criar um pacote de componentes do Composer (centralized-patcher) para gerenciar centralmente todos os patches de qualidade e o /m2-hotfixes em todas as instalações do Adobe Commerce.

O pacote de componentes deve:

  • Copie o conteúdo do diretório /m2-hotfixes em todas as suas instalações durante a implantação.
  • Defina a lista de patches de qualidade a serem instalados.
  • Execute o comando vendor/bin/magento-patches para instalar a mesma lista de patches de qualidade em todas as instalações (usando o pacote de plug-in centralized-patcher-composer-plugin como uma dependência).

Para criar o pacote do componente centralized-patcher:

  1. Criar um arquivo composer.json com o seguinte conteúdo:

    note note
    NOTE
    O atributo require no exemplo a seguir mostra uma dependência require no pacote de plug-in que você deve criar posteriormente neste exemplo.
    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. Crie um diretório /m2-hotfixes dentro do pacote e adicione-o ao atributo map em seu arquivo composer.json. O atributo map contém arquivos a serem copiados deste pacote na raiz do projeto de destino do qual você deseja aplicar patch.

    code language-json 
    {
 ...
 "extra": {
     "map": [
         [
             "/m2-hotfixes",
             "/m2-hotfixes"
         ]
     ],
}
    note note
    NOTE
    O pacote centralized-patcher copia o conteúdo do diretório /m2-hotfixes para o diretório m2-hotfixes do projeto de destino em composer install. Como os scripts de implantação em nuvem aplicam hotfixes m2 após composer install, todos os hotfixes são instalados pelo mecanismo de implantação.

  3. Defina os patches de qualidade a serem instalados no atributo quality-patches.

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

O atributo quality-patches na amostra de código anterior contém dois patches da lista completa de patches, por exemplo. Esses patches de qualidade são instalados em todos os projetos que exigem o pacote centralized-patcher usando o comando vendor/bin/magento-patches apply.

Para fins de teste, você pode criar um exemplo de patch (/m2-hotfixes/EXAMPLE-PATCH_2.4.6.patch).

NOTE
Você deve colocar seus próprios patches no diretório m2-hotfixes, juntamente com os patches recebidos diretamente do Suporte da Adobe Commerce.

Um exemplo de arquivo de patch (/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

Como este exemplo usa o método local para instalar patches de qualidade, você deve garantir que o comando vendor/bin/magento-patches apply seja executado após composer install operações. Este plug-in é acionado após composer install operações, que executam o comando vendor/bin/magento-patches apply.

Para criar o pacote do componente centralized-patcher-compose-plugin:

  1. Criar um arquivo composer.json com o seguinte conteúdo:

    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. Crie um arquivo PHP e defina uma classe CentralizedPatcher para ler a lista de patches de qualidade do pacote de componentes centralized-patcher e instale-os imediatamente após cada operação 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
Consulte os exemplos de código para ver os dois pacotes descritos neste exemplo em ação.

O que fazer com patches específicos de projetos

Você pode ter um cenário em que apenas 95% dos patches são necessários em todos os projetos, enquanto alguns patches se aplicam apenas a uma instância específica. A forma regular de aplicar patches ainda funciona. Você pode manter patches específicos do projeto no diretório /m2-hotfixes e instalar patches de qualidade por projeto.

Se você usar esta abordagem, não confirme patches no diretório /m2-hotfixes que foram copiados para o seu projeto pelo pacote de componentes centralized-patcher. Você pode evitar confirmações acidentais adicionando /m2-hotfixes ao arquivo .gitignore. Depois de atualizar o arquivo .gitignore, lembre-se de que qualquer /m2-hotfixes específico do projeto deve ser adicionado usando o comando git add –force.

Execução de diferentes versões do Adobe Commerce

Defina a dependência correta no pacote de componentes centralized-patcher. Por exemplo, talvez você precise do Adobe Commerce 2.4.5-p2 para uma versão específica do seu pacote, que só fornece patches compatíveis com o Adobe Commerce 2.4.5-p2. Você pode ter outra versão deste pacote compatível com o Adobe Commerce 2.4.4.

Compreender o resultado

Assim como com o Adobe Commerce na infraestrutura em nuvem, este artigo presume que o processo de implantação usa o comando composer install e não o composer update ou o git pull para implantar o novo código em seus servidores. O fluxo da instalação de patch centralizada terá a seguinte aparência:

  1. Instalação do Composer

    • Instala o Adobe Commerce, incluindo segurança -p1 ou -p2 e patches funcionais
    • Combina /m2-hotfixes centralizado e patches de suporte com /m2-hotfixes específicos do projeto e patches de suporte
    • Aplica todas as correções instaladas com o pacote do Composer cweagans/composer-patches

  2. Depois de composer install

    • O plug-in do Composer instala correções de qualidade centralizadas

  3. Implantação

    • Os patches necessários e os patches de qualidade específicos do projeto são instalados com base no arquivo .magento.env.yaml (Adobe Commerce somente em projetos de infraestrutura em nuvem).
    • Os patches personalizados e os patches de suporte do diretório /m2-hotfixes são instalados em ordem alfabética pelo nome do patch.

Dessa forma, você pode gerenciar centralmente todos os patches de todas as suas instalações e pode garantir melhor a segurança e a estabilidade das lojas Adobe Commerce. Use os seguintes métodos para verificar o status do patch:

Exemplos de código

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