Synchronisation d'un package NPM entre plusieurs registres

Photo de Nicolas Radzimski sur Unsplash

Le problème

Notre équipe s'appuie sur un registre interne GitLab NPM pour la gestion des packages. Cela fonctionne parfaitement pour la distribution interne, mais il existe des cas où un package doit être partagé avec des collaborateurs externes. Synchroniser le package du registre interne vers un registre externe est devenu un nouveau défi.

J'ai cherché une solution et, comme d'habitude, j'ai rencontré une série d'obstacles qui en ont fait un autre chapitre de mes difficultés de développeur.

Tentative 1 : Utilisation de requêtes HTTP pour imiter la CLI NPM

Au départ, je pensais pouvoir gérer cela avec des requêtes HTTP brutes, imitant essentiellement ce que fait la CLI NPM sous le capot. L'idée était simple : interrogez le registre source pour les métadonnées du package, récupérez l'archive tar et téléchargez-la dans le registre cible.

Pourquoi cela a échoué :

• Le processus était trop complexe et fragile.
• Cela nécessitait de construire manuellement l'intégralité du manifeste package.json pour chaque version.
• Chaque petit faux pas entraînait des colis cassés.

Tentative 2 : tirer parti de npm-registry-sync

Ensuite, j'ai découvert npm-registry-sync, une bibliothèque conçue pour synchroniser les registres NPM. Cet outil a presque résolu le problème ; il pourrait surveiller les changements et les reproduire dans les registres.

Pourquoi ça n'a pas fonctionné pour moi :

• Il fonctionne en « mode démon », interrogeant continuellement les mises à jour.
• Dans un pipeline GitLab CI, j'avais besoin d'une exécution unique, entièrement contrôlée par le pipeline — aucun processus en arrière-plan n'est autorisé.

La solution gagnante : la CLI NPM

Finalement, j'ai réalisé que je pouvais m'en tenir à la CLI NPM éprouvée. Les étapes étaient simples :

1. Installez le package localement à partir du registre A.
   1. Reconfigurez NPM pour pointer vers le registre B.
   2. Publiez le package dans le registre B.

Bien que cela ait fonctionné à merveille, quelques étapes supplémentaires ont été nécessaires pour le rendre compatible avec CI.

---

Configuration de NPM pour plusieurs registres

La gestion dynamique des configurations de registre dans un pipeline CI était un peu délicate.

Voici comment je l'ai résolu :

Configuration générale

À l'aide de la CLI npm, vous pouvez définir des paramètres pour chaque registre :

npm config set "//my.awesome.registry.com:<parameter name>=<parameter value>"

Je vous ai trouvé important :
L'URL dans la configuration doit exclure le protocole (https:).

Association package-registre

Pour associer un espace de noms ou un package spécifique à un registre :

npm config set "<your namespace>:registry" "<your registry url with https:>"

Gestion de l'authentification dans les pipelines CI

Certains registres nécessitaient une combinaison nom d'utilisateur/mot de passe, tandis que d'autres utilisaient des jetons. Voici ce que j'ai appris :

Jetons

Les jetons sont simples, mais assurez-vous de supprimer le protocole lors de la configuration de l'URL d'authentification :

npm config set "//my.awesome.registry.com:<parameter name>=<parameter value>"

Authentification de base

La génération d'un hachage d'authentification de base (nom d'utilisateur : mot de passe) nécessitait une attention particulière aux détails. Dans certaines distributions, la commande base64 présente des bizarreries qui diffèrent des autres.

Sur macOS :

npm config set "<your namespace>:registry" "<your registry url with https:>"

Vous donnera (comme prévu) :

npm config set "//my.registry.com:_authToken=<token>"

Avec docker Linuxkit :

echo -n "<my username & password hash>" | base64

Que se passe-t-il ici ? Il y a un saut de ligne !

Sur certaines distributions, le paramètre wrap a une valeur par défaut de 76 caractères pour le formatage des clés privées, etc.

Ça fonctionne comme ceci :

d2hhdCBhcmUgeW91IGRvaW5nIGhlcmU/IGdvdCB5YSEgc29tZSBtb3JlIHRleHQgdG8gbWFrZSB0aGlzIHJlYWxseSByZWFsbHkgbG9uZw==

Le echo -n est très important. En cas d'omission, echo ajoutera un saut de ligne à la fin de la chaîne et cela manipulera votre hachage.

Le scénario terminé

En mettant tout cela ensemble, le script pourrait ressembler à ceci :

d2hhdCBhcmUgeW91IGRvaW5nIGhlcmU/IGdvdCB5YSEgc29tZSBtb3JlIHRleHQgdG8gbWFrZSB0
aGlzIHJlYWxseSByZWFsbHkgbG9uZw==

Vous pouvez donc l'utiliser comme ceci :

echo -n "<my username & password hash>" | base64 --wrap 0

---

Principales leçons apprises

1. S'en tenir à des outils simples :
   La CLI npm n'est peut-être pas sophistiquée pour cette tâche, mais elle est fiable et fait le travail.

2. Attention aux détails :
   La configuration de l'authentification, en particulier avec base64, peut présenter de subtiles bizarreries spécifiques à la plate-forme.

3. Gardez-le compatible avec CI :
   Évitez les solutions telles que les démons ou les tâches en arrière-plan lorsque vous travaillez dans des pipelines CI/CD. Gardez le processus sous contrôle du pipeline.

La synchronisation des packages npm entre les registres a été une expérience d'apprentissage frustrante mais enrichissante. Si vous êtes confronté à un défi similaire, j’espère que ces leçons vous aideront à naviguer dans la lutte avec un peu plus de facilité !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!