Drupal & Composer - Appliquer un patch dans le fichier composer.json

Si vous utilisez composer pour gérer votre instance de Drupal, vous avez parfois besoin d'appliquer un patch (de votre conception ou depuis drupal.org) que ce soit pour un module tiers ou pour le core.

Si on est "à l'ancienne" on a le core et les module sous gestionnaire de version (git par exemple), cela reste simple, vous appliquez le patch et commitez le tout.

En utilisant composer, nous avons uniquement le "cutom" qui est versionné, avec les fichiers composer.json et composer.lock qui contiennent la liste des modules utilisés et leurs version spécifique. Donc pas possible d'appliquer un patch comme plus haut.

Par contre on peut à l'aide d'un dépendance spécifier les patchs que l'on veut utiliser directement dans le fichier composer.json, regardez si ça ce trouve le module est déjà installé; il s'agit de cweagans/composer-patches.

s'il n'est pas présent : 

composer require cweagans/composer-patches

ensuite pour appliquer un patch, on doit ajouter les éléments suivants dans la partie "extra" du fichier composer.json :

En théorie

"patches": {
  "package": {
    "description libre": "Url du patch"
  }
}

Un patch simple

exemple pour un patch pour mimemail :

"patches": {
  "drupal/mimemail": {
    "Fix mimemail error on admin form": "https://www.drupal.org/files/issues/mime-mail-error-message-on-admin-form-with-webprorfiler-2719981-3.patch"
  }
}

Plusieurs patchs pour un même module

Si vous avez plusieurs patchs pour un même module, séparez-les par une virgule :

"patches": {
  "drupal/mimemail": {
    "Fix mimemail error on admin form": "https://www.drupal.org/files/issues/mime-mail-error-message-on-admin-form-with-webprorfiler-2719981-3.patch",
    "patch 2": "https://www.drupal.org/files/issues/mime-mail-error-message-on-admin-form-with-webprorfiler-2719981-3qdqsdqsd.patch"
  }
}

Plusieurs patchs pour plusieurs modules

Si vous avez plusieurs modules à patcher, même principe :

"patches": {
  "drupal/mimemail": {
    "Fix mimemail error on admin form": "https://www.drupal.org/files/issues/mime-mail-error-message-on-admin-form-with-webprorfiler-2719981-3.patch",
    "patch 2": "https://www.drupal.org/files/issues/mime-mail-error-message-on-admin-form-with-webprorfiler-2719981-3qdqsdqsd.patch"
  },
  "drupal/monautremodule": {
    "ma description du patch": "https://www.drupal.org/files/issues/mimhfhmin-form-with-webprorfiler-2719981-3.patch",
  }
}

Patcher le core, ou un de ses modules

Pour patcher le core ou un module du core (views par exemple), comme précisé par Mika dans les commentaires, il faut utiliser la clé : 'drupal/core'

"patches": {
  "drupal/core": {
    "patch 1": "https://www.drupal.org/Url-du-patch1.patch",
    "patch 2": "https://www.drupal.org/Url-du-patch2.patch"
  }
}

Patch « local »

Voyons maintenant le cas d'un patch local, car parfois on créé nos propres patchs sans forcement les proposer sur drupal.org.

Ici, on suppose que le patch est stocké dans un dossier "patchs", au même niveau que le fichier composer.json :

"patches": {
  "drupal/monmodule": {
    "Patch custom stocké localement": "patchs/patch-custom-stocke-localement.patch"
  }
}

Installation et application des patchs

Enfin update et install pour que le(s) modules patchés soient supprimés, re-téléchargés et enfin patchés.

composer update
composer install

«Patching is disabled. Skipping.»

Si vous obtenez ce message, c'est peut-être car vous n'avez pas ajouté la section "patches" dans la section "extra" du fichier composer.json.