Synchronisieren eines NPM-Pakets zwischen mehreren Registrierungen

Foto von Nicolas Radzimski auf Unsplash

Das Problem

Unser Team verlässt sich bei der Verwaltung von Paketen auf eine interne GitLab NPM-Registrierung. Dies funktioniert perfekt für die interne Verteilung, es gibt jedoch Fälle, in denen ein Paket mit externen Mitarbeitern geteilt werden muss. Das Synchronisieren des Pakets von der internen Registrierung mit einer externen wurde zu einer neuen Herausforderung.

Ich machte mich auf die Suche nach einer Lösung und stieß wie üblich auf eine Reihe von Hürden, die daraus ein weiteres Kapitel meiner Entwicklerprobleme machten.

Versuch 1: Verwenden von HTTP-Anfragen zur Nachahmung der NPM-CLI

Anfangs dachte ich, ich könnte dies mit rohen HTTP-Anfragen bewältigen und im Wesentlichen nachahmen, was die NPM-CLI unter der Haube tut. Die Idee war einfach: Fragen Sie die Quellregistrierung nach Paketmetadaten ab, rufen Sie den Tarball ab und laden Sie ihn in die Zielregistrierung hoch.

Warum es fehlgeschlagen ist:

• Der Prozess war zu komplex und fragil.
• Es war eine manuelle Erstellung des gesamten package.json-Manifests für jede Version erforderlich.
• Jeder kleine Fehltritt führte zu kaputten Paketen.

Versuch 2: Nutzung von npm-registry-sync

Als nächstes entdeckte ich npm-registry-sync, eine Bibliothek zum Synchronisieren von NPM-Registrierungen. Dieses Tool hat das Problem fast gelöst; Es könnte Änderungen überwachen und sie registrierungsübergreifend replizieren.

Warum es bei mir nicht funktioniert hat:

• Es arbeitet im „Daemon-Modus“ und fragt kontinuierlich nach Updates.
• In einer GitLab CI-Pipeline benötigte ich eine einmalige Ausführung, die vollständig von der Pipeline gesteuert wurde – es waren keine Hintergrundprozesse zulässig.

Die erfolgreiche Lösung: Die NPM-CLI

Irgendwann wurde mir klar, dass ich bei der bewährten NPM-CLI bleiben konnte. Die Schritte waren unkompliziert:

1. Installieren Sie das Paket lokal aus Registry A.
   1. Konfigurieren Sie NPM neu, um auf Registrierung B zu verweisen.
   2. Veröffentlichen Sie das Paket in Registry B.

Obwohl dies wunderbar funktionierte, waren ein paar zusätzliche Schritte erforderlich, um es CI-freundlich zu machen.

Konfigurieren von NPM für mehrere Registrierungen

Das dynamische Verwalten von Registrierungskonfigurationen in einer CI-Pipeline war etwas schwierig.

So habe ich es gelöst:

Allgemeine Konfiguration

Mit der npm-CLI können Sie Parameter für jede Registrierung festlegen:

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

Wichtiges Problem:
Die URL in der Konfiguration muss das Protokoll (https:) ausschließen.

Paket-zu-Registrierungs-Vereinigung

So verknüpfen Sie einen bestimmten Namespace oder ein bestimmtes Paket mit einer Registrierung:

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

Umgang mit der Authentifizierung in CI-Pipelines

Einige Registrierungsstellen erforderten eine Kombination aus Benutzername und Passwort, während andere Token verwendeten. Folgendes habe ich gelernt:

Token

Token sind unkompliziert, aber stellen Sie sicher, dass Sie das Protokoll entfernen, wenn Sie die Authentifizierungs-URL konfigurieren:

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

Grundlegende Auth

Das Generieren eines grundlegenden Authentifizierungs-Hashs (Benutzername:Passwort) erforderte Liebe zum Detail. In einigen Distributionen weist der base64-Befehl Besonderheiten auf, die sich von anderen unterscheiden.

Auf macOS:

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

Wird Ihnen (wie erwartet) geben:

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

Mit Docker-Linuxkit:

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

Was ist hier los? Es gibt einen Zeilenumbruch!

Bei einigen Distributionen ist der Wrap-Parameter standardmäßig auf 76 Zeichen eingestellt, um private Schlüssel usw. zu formatieren.

Es funktioniert so:

d2hhdCBhcmUgeW91IGRvaW5nIGhlcmU/IGdvdCB5YSEgc29tZSBtb3JlIHRleHQgdG8gbWFrZSB0aGlzIHJlYWxseSByZWFsbHkgbG9uZw==

Das echo -n ist sehr wichtig. Wenn es weggelassen wird, fügt echo einen Zeilenumbruch am Ende der Zeichenfolge hinzu und dadurch wird Ihr Hash manipuliert.

Das fertige Drehbuch

Alles in allem könnte das Skript so aussehen:

d2hhdCBhcmUgeW91IGRvaW5nIGhlcmU/IGdvdCB5YSEgc29tZSBtb3JlIHRleHQgdG8gbWFrZSB0
aGlzIHJlYWxseSByZWFsbHkgbG9uZw==

Sie könnten es also so verwenden:

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

Wichtige Erkenntnisse

1. Halten Sie sich an einfache Tools:
   Die npm-CLI ist für diese Aufgabe vielleicht nicht besonders schick, aber sie ist zuverlässig und erledigt ihre Aufgabe.

2. Achten Sie auf die Details:
   Die Konfiguration der Authentifizierung, insbesondere mit Base64, kann subtile plattformspezifische Besonderheiten aufweisen.

3. Halten Sie es CI-freundlich:
   Vermeiden Sie Lösungen wie Daemons oder Hintergrundaufgaben, wenn Sie in CI/CD-Pipelines arbeiten. Halten Sie den Prozess unter Kontrolle der Pipeline.

Das Synchronisieren von NPM-Paketen zwischen Registrierungen war eine frustrierende, aber lohnende Lernerfahrung. Wenn Sie vor einer ähnlichen Herausforderung stehen, hoffe ich, dass diese Lektionen Ihnen dabei helfen, den Kampf etwas leichter zu meistern!

Das obige ist der detaillierte Inhalt vonSynchronisieren eines NPM-Pakets zwischen mehreren Registrierungen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!