diff --git a/README.md b/README.md index 4f0a78c..c2984e1 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Each type's paths, Terraform examples and local/virtual behaviour are in `docs/< - `generic`: [remote](docs/generic/remote.md) - `goproxy`: [remote](docs/goproxy/remote.md) - `helm`: [remote](docs/helm/remote.md), [local](docs/helm/local.md), [virtual](docs/helm/virtual.md) -- `npm`: [remote](docs/npm/remote.md) +- `npm`: [remote](docs/npm/remote.md), [local](docs/npm/local.md) - `nuget`: [remote](docs/nuget/remote.md) - `puppet`: [remote](docs/puppet/remote.md), [local](docs/puppet/local.md) - `pypi`: [remote](docs/pypi/remote.md) @@ -129,6 +129,7 @@ No patterns + no blocklist = open proxy. Provider handles mutability classificat ``` GET /api/v1/remote/{name}/{path} Proxy/cache artifact GET /api/v1/virtual/{name}/{path} Virtual repo (merged index) +PUT /api/v1/local/{name}/{package} npm publish (local npm repos) GET /v2/{name}/{path} Docker Registry v2 ``` diff --git a/docs/npm/local.md b/docs/npm/local.md new file mode 100644 index 0000000..798a48b --- /dev/null +++ b/docs/npm/local.md @@ -0,0 +1,14 @@ +# Local npm registry + +A local `npm` repo is a real npm registry: `npm publish` (scoped and unscoped) +and `npm install` work against `/api/v1/local//`. npm requires an +`_authToken` for the registry before it will publish; any value works. + +```ini +# .npmrc +registry=https://artifactapi.example.com/api/v1/local// +//artifactapi.example.com/api/v1/local//:_authToken=unused +``` + +Versions are immutable: republishing an existing version is rejected. The +dist-tags sent with a publish (`latest`, or `--tag`) move to that version. diff --git a/e2e-docker/README.md b/e2e-docker/README.md index 70825fc..85364c2 100644 --- a/e2e-docker/README.md +++ b/e2e-docker/README.md @@ -27,7 +27,9 @@ already-running stack. verified against the origin fixture. - **Local uploads** — puppet (Forge v3 API via real `r10k` and `puppet module install`), generic (upload/download), pypi (wheel + generated `simple/` - index), rpm (real package + **automatic repodata** generation). + index), rpm (real package + **automatic repodata** generation), npm (stock + `node:22` client: `npm publish` unscoped + scoped, `npm install` + `require()`, + second version, republish rejected). - **Virtual repositories** — pypi simple-index merge and helm `index.yaml` merge across two members. - **Mirrorlist** — an rpm remote with a `mirrorlist` of extra upstream mirrors diff --git a/e2e-docker/npm_local_test.go b/e2e-docker/npm_local_test.go new file mode 100644 index 0000000..9455611 --- /dev/null +++ b/e2e-docker/npm_local_test.go @@ -0,0 +1,62 @@ +//go:build dockere2e + +package e2edocker + +import ( + "fmt" + "os" + "os/exec" + "strings" + "testing" + "time" +) + +// TestLocalNPMPublishInstall drives a stock npm client against a local npm +// repo: publish unscoped and scoped packages, install and require() them in a +// fresh project, publish a second version, and reject a republish. +func TestLocalNPMPublishInstall(t *testing.T) { + network := os.Getenv("COMPOSE_NETWORK") + internal := os.Getenv("ARTIFACTAPI_INTERNAL") + if network == "" || internal == "" { + t.Skip("COMPOSE_NETWORK/ARTIFACTAPI_INTERNAL not set; run via scripts/docker-e2e.sh") + } + if _, err := exec.LookPath("docker"); err != nil { + t.Skip("docker not available on the test host") + } + + name := fmt.Sprintf("e2e-npm-local-%d", time.Now().UnixNano()) + createRepo(t, fmt.Sprintf(`{"name":%q,"package_type":"npm","repo_type":"local"}`, name)) + defer deleteRepo(t, name) + + reg := strings.TrimRight(internal, "/") + "/api/v1/local/" + name + "/" + script := `set -euo pipefail +printf 'registry=%s\n%s:_authToken=unused\n' "$REG" "${REG#http:}" > ~/.npmrc +mk() { d="/w/src/$1-$2"; mkdir -p "$d"; cd "$d" + printf '{"name":"%s","version":"%s","main":"index.js"}' "$1" "$2" > package.json + echo "module.exports = '$1@$2';" > index.js; } +mk e2e-npm-plain 1.0.0 && npm publish +mk @e2e/npm-scoped 1.0.0 && npm publish +mk e2e-npm-plain 1.0.0 +if npm publish 2>/dev/null; then echo "republish accepted"; exit 1; fi +mkdir -p /w/app && cd /w/app && npm init -y >/dev/null +npm install --no-audit --cache /tmp/fresh-cache e2e-npm-plain @e2e/npm-scoped +node -e "console.log('REQ', require('e2e-npm-plain'), require('@e2e/npm-scoped'))" +mk e2e-npm-plain 1.1.0 && npm publish +echo "VERSIONS $(npm view e2e-npm-plain versions --json | tr -d ' \n')" +echo "LATEST $(npm view e2e-npm-plain dist-tags.latest)"` + + out, err := exec.Command("docker", "run", "--rm", "--network", network, + "-e", "REG="+reg, "node:22", "bash", "-c", script).CombinedOutput() + if err != nil { + t.Fatalf("npm client run failed: %v\n%s", err, out) + } + for _, want := range []string{ + "REQ e2e-npm-plain@1.0.0 @e2e/npm-scoped@1.0.0", + `VERSIONS ["1.0.0","1.1.0"]`, + "LATEST 1.1.0", + } { + if !strings.Contains(string(out), want) { + t.Fatalf("missing %q in npm output:\n%s", want, out) + } + } +} diff --git a/internal/api/v1/npm.go b/internal/api/v1/npm.go new file mode 100644 index 0000000..18604cf --- /dev/null +++ b/internal/api/v1/npm.go @@ -0,0 +1,322 @@ +package v1 + +import ( + "bytes" + "context" + "crypto/sha1" + "crypto/sha512" + "encoding/base64" + "encoding/hex" + "encoding/json" + "errors" + "fmt" + "io" + "log/slog" + "net/http" + "net/url" + "regexp" + "strings" + + "github.com/go-chi/chi/v5" + + "git.unkin.net/unkin/artifactapi/internal/database" + "git.unkin.net/unkin/artifactapi/internal/storage" + "git.unkin.net/unkin/artifactapi/pkg/models" +) + +// Local npm repos speak the npm registry publish/read protocol. Per package: +// /-/-.tgz tarball (immutable) +// /-/-.json version manifest (immutable) +// /-/dist-tags/ version string (mutable) + +var ( + npmNameRe = regexp.MustCompile(`^(@[a-z0-9][a-z0-9._~-]*/)?[a-z0-9][a-z0-9._~-]*$`) + npmRefRe = regexp.MustCompile(`^[0-9A-Za-z][0-9A-Za-z.+_-]*$`) + npmSemverRe = regexp.MustCompile(`^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`) + + npmMaxPublishBytes int64 = 256 << 20 +) + +func (h *ProxyHandler) localNPMRemote(r *http.Request, name string) (*models.Remote, bool) { + remote, err := h.db.GetRemote(r.Context(), name) + if err != nil { + return nil, false + } + return remote, remote.RepoType == models.RepoTypeLocal && remote.PackageType == models.PackageNPM +} + +// npmPackageName returns the package a packument/publish path addresses, or "" +// when the path is something else (e.g. a tarball under /-/). +func npmPackageName(raw string) string { + p, err := url.PathUnescape(raw) + if err != nil { + return "" + } + p = strings.TrimSuffix(p, "/") + if !npmNameRe.MatchString(p) { + return "" + } + return p +} + +type npmRelease struct { + version string + manifest []byte + tarball []byte + tags []string +} + +func parseNPMPublish(body io.Reader, pkg string) (*npmRelease, error) { + var doc struct { + Name string `json:"name"` + DistTags map[string]string `json:"dist-tags"` + Versions map[string]json.RawMessage `json:"versions"` + Attachments map[string]struct { + Data string `json:"data"` + } `json:"_attachments"` + } + if err := json.NewDecoder(body).Decode(&doc); err != nil { + return nil, fmt.Errorf("invalid publish body: %w", err) + } + if doc.Name != pkg { + return nil, fmt.Errorf("body name %q does not match %q", doc.Name, pkg) + } + if len(doc.Versions) != 1 || len(doc.Attachments) != 1 { + return nil, errors.New("publish must carry exactly one version and one tarball") + } + + rel := &npmRelease{} + for v, m := range doc.Versions { + rel.version, rel.manifest = v, m + } + if !npmSemverRe.MatchString(rel.version) { + return nil, fmt.Errorf("invalid version %q", rel.version) + } + var meta struct { + Name string `json:"name"` + Version string `json:"version"` + Dist struct { + Integrity string `json:"integrity"` + Shasum string `json:"shasum"` + } `json:"dist"` + } + if err := json.Unmarshal(rel.manifest, &meta); err != nil { + return nil, fmt.Errorf("invalid version manifest: %w", err) + } + if meta.Name != pkg || meta.Version != rel.version { + return nil, errors.New("version manifest name/version mismatch") + } + + for _, a := range doc.Attachments { + tgz, err := base64.StdEncoding.DecodeString(a.Data) + if err != nil { + return nil, fmt.Errorf("invalid tarball encoding: %w", err) + } + rel.tarball = tgz + } + if err := verifyNPMDist(rel.tarball, meta.Dist.Integrity, meta.Dist.Shasum); err != nil { + return nil, err + } + + for tag, v := range doc.DistTags { + if !npmRefRe.MatchString(tag) || v != rel.version { + return nil, fmt.Errorf("dist-tag %q must point at the published version", tag) + } + rel.tags = append(rel.tags, tag) + } + return rel, nil +} + +func verifyNPMDist(tgz []byte, integrity, shasum string) error { + if b64, ok := strings.CutPrefix(integrity, "sha512-"); ok { + sum := sha512.Sum512(tgz) + if base64.StdEncoding.EncodeToString(sum[:]) != b64 { + return errors.New("tarball does not match dist.integrity") + } + return nil + } + if shasum != "" { + sum := sha1.Sum(tgz) + if hex.EncodeToString(sum[:]) != shasum { + return errors.New("tarball does not match dist.shasum") + } + return nil + } + return errors.New("version manifest carries no sha512 integrity or shasum") +} + +func npmError(w http.ResponseWriter, status int, msg string) { + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(status) + _ = json.NewEncoder(w).Encode(map[string]string{"error": msg}) +} + +func (h *ProxyHandler) handleLocalPut(w http.ResponseWriter, r *http.Request) { + remote, ok := h.localNPMRemote(r, chi.URLParam(r, "localName")) + if !ok { + npmError(w, http.StatusMethodNotAllowed, "publish is only supported on local npm repositories") + return + } + pkg := npmPackageName(chi.URLParam(r, "*")) + if pkg == "" { + npmError(w, http.StatusBadRequest, "invalid package name") + return + } + rel, err := parseNPMPublish(http.MaxBytesReader(w, r.Body, npmMaxPublishBytes), pkg) + if err != nil { + var tooLarge *http.MaxBytesError + if errors.As(err, &tooLarge) { + npmError(w, http.StatusRequestEntityTooLarge, fmt.Sprintf("publish body exceeds %d bytes", npmMaxPublishBytes)) + return + } + npmError(w, http.StatusBadRequest, err.Error()) + return + } + + base := pkg[strings.LastIndex(pkg, "/")+1:] + stem := pkg + "/-/" + base + "-" + rel.version + // The manifest gates visibility and tags may only name visible versions, so + // the order is tarball, manifest, tags. A tarball left by a failed publish is + // accepted again only with identical bytes; an existing manifest always conflicts. + conflict := func() { + npmError(w, http.StatusConflict, fmt.Sprintf("%s@%s already exists; overwrites are not allowed", pkg, rel.version)) + } + ok, err = h.npmStoreImmutable(r.Context(), remote.Name, stem+".tgz", rel.tarball, "application/octet-stream") + if err != nil { + npmError(w, http.StatusInternalServerError, err.Error()) + return + } + if !ok { + conflict() + return + } + if _, err := h.npmStore(r.Context(), remote.Name, stem+".json", rel.manifest, "application/json", false); err != nil { + if errors.Is(err, database.ErrAlreadyExists) { + conflict() + return + } + npmError(w, http.StatusInternalServerError, err.Error()) + return + } + for _, tag := range rel.tags { + if _, err := h.npmStore(r.Context(), remote.Name, pkg+"/-/dist-tags/"+tag, []byte(rel.version), "text/plain", true); err != nil { + npmError(w, http.StatusInternalServerError, err.Error()) + return + } + } + + slog.Info("local npm package published", "repo", remote.Name, "package", pkg, "version", rel.version) + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(http.StatusCreated) + _ = json.NewEncoder(w).Encode(map[string]any{"ok": true, "id": pkg}) +} + +// npmStoreImmutable reports false when path already holds different bytes. +func (h *ProxyHandler) npmStoreImmutable(ctx context.Context, repo, path string, data []byte, contentType string) (bool, error) { + hash, err := h.npmStore(ctx, repo, path, data, contentType, false) + if !errors.Is(err, database.ErrAlreadyExists) { + return err == nil, err + } + existing, err := h.db.GetLocalFile(ctx, repo, path) + if err != nil || existing == nil { + return false, fmt.Errorf("read existing %s: %v", path, err) + } + return existing.ContentHash == hash, nil +} + +func (h *ProxyHandler) npmStore(ctx context.Context, repo, path string, data []byte, contentType string, mutable bool) (string, error) { + result, err := h.cas.Store(ctx, bytes.NewReader(data), contentType) + if err != nil { + return "", err + } + if err := h.db.UpsertBlob(ctx, result.ContentHash, result.S3Key, result.SizeBytes, contentType); err != nil { + return "", err + } + if mutable { + return result.ContentHash, h.db.UpsertLocalFile(ctx, repo, path, result.ContentHash) + } + return result.ContentHash, h.db.CreateLocalFile(ctx, repo, path, result.ContentHash) +} + +func (h *ProxyHandler) readLocalBlob(ctx context.Context, contentHash string) ([]byte, error) { + reader, _, err := h.store.Download(ctx, storage.BlobKey(strings.TrimPrefix(contentHash, "sha256:"))) + if err != nil { + return nil, err + } + defer reader.Close() + return io.ReadAll(reader) +} + +func (h *ProxyHandler) serveNPMPackument(w http.ResponseWriter, r *http.Request, remote *models.Remote, pkg string) { + files, err := h.db.ListLocalFilesByPrefix(r.Context(), remote.Name, pkg+"/-/") + if err != nil { + npmError(w, http.StatusInternalServerError, err.Error()) + return + } + read := func(hash string) ([]byte, error) { return h.readLocalBlob(r.Context(), hash) } + tarballBase := fmt.Sprintf("%s://%s/api/v1/local/%s/", scheme(r), r.Host, remote.Name) + doc, err := buildNPMPackument(pkg, files, read, tarballBase) + if err != nil { + npmError(w, http.StatusInternalServerError, err.Error()) + return + } + if doc == nil { + npmError(w, http.StatusNotFound, "not found") + return + } + w.Header().Set("Content-Type", "application/json") + w.Header().Set("X-Artifact-Source", "local") + w.WriteHeader(http.StatusOK) + _ = json.NewEncoder(w).Encode(doc) +} + +// buildNPMPackument returns nil when pkg has no published versions. +func buildNPMPackument(pkg string, files []database.LocalFile, read func(hash string) ([]byte, error), tarballBase string) (map[string]any, error) { + prefix := pkg + "/-/" + versions := map[string]any{} + tags := map[string]string{} + for _, f := range files { + // LIKE treats '_' as a wildcard, so the prefix match can over-select. + rest, ok := strings.CutPrefix(f.FilePath, prefix) + if !ok { + continue + } + if tag, isTag := strings.CutPrefix(rest, "dist-tags/"); isTag { + v, err := read(f.ContentHash) + if err != nil { + return nil, err + } + tags[tag] = string(v) + continue + } + stem, isManifest := strings.CutSuffix(rest, ".json") + if !isManifest { + continue + } + raw, err := read(f.ContentHash) + if err != nil { + return nil, err + } + var m map[string]any + if err := json.Unmarshal(raw, &m); err != nil { + return nil, fmt.Errorf("manifest %s: %w", f.FilePath, err) + } + dist, _ := m["dist"].(map[string]any) + if dist == nil { + dist = map[string]any{} + m["dist"] = dist + } + dist["tarball"] = tarballBase + prefix + stem + ".tgz" + v, _ := m["version"].(string) + versions[v] = m + } + if len(versions) == 0 { + return nil, nil + } + for tag, v := range tags { + if _, ok := versions[v]; !ok { + delete(tags, tag) + } + } + return map[string]any{"_id": pkg, "name": pkg, "dist-tags": tags, "versions": versions}, nil +} diff --git a/internal/api/v1/npm_handler_test.go b/internal/api/v1/npm_handler_test.go new file mode 100644 index 0000000..8b21c09 --- /dev/null +++ b/internal/api/v1/npm_handler_test.go @@ -0,0 +1,293 @@ +package v1 + +import ( + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "net/http/httptest" + "os" + "strings" + "sync" + "testing" + "time" + + "github.com/go-chi/chi/v5" + + "git.unkin.net/unkin/artifactapi/internal/database" + "git.unkin.net/unkin/artifactapi/internal/storage" + "git.unkin.net/unkin/artifactapi/internal/testsupport" + "git.unkin.net/unkin/artifactapi/pkg/models" +) + +var ( + testDSN string + testMinio testsupport.MinioConn +) + +func TestMain(m *testing.M) { + ctx := context.Background() + dsn, termPG, err := testsupport.StartPostgres(ctx) + if err != nil { + os.Exit(m.Run()) + } + conn, termMinio, err := testsupport.StartMinio(ctx) + if err != nil { + termPG() + os.Exit(m.Run()) + } + testDSN, testMinio = dsn, conn + code := m.Run() + termMinio() + termPG() + os.Exit(code) +} + +func npmTestServer(t *testing.T) (*ProxyHandler, *httptest.Server) { + t.Helper() + if testDSN == "" { + t.Skip("Docker unavailable") + } + db, err := database.New(testDSN) + if err != nil { + t.Fatal(err) + } + t.Cleanup(db.Close) + var store *storage.S3 + for i := 0; i < 20; i++ { + if store, err = storage.NewS3(testMinio.Endpoint, testMinio.AccessKey, testMinio.SecretKey, "npm", false, ""); err == nil { + break + } + time.Sleep(500 * time.Millisecond) + } + if err != nil { + t.Fatal(err) + } + h := NewProxyHandler(nil, nil, db, store, nil) + r := chi.NewRouter() + r.Mount("/api/v1", h.Routes()) + srv := httptest.NewServer(r) + t.Cleanup(srv.Close) + return h, srv +} + +func npmRepo(t *testing.T, h *ProxyHandler, pt models.PackageType) string { + t.Helper() + name := fmt.Sprintf("npm-%s-%d", pt, time.Now().UnixNano()) + if err := h.db.CreateRemote(context.Background(), &models.Remote{Name: name, PackageType: pt, RepoType: models.RepoTypeLocal}); err != nil { + t.Fatal(err) + } + return name +} + +func npmDo(t *testing.T, method, url, body string) (int, string) { + t.Helper() + req, _ := http.NewRequest(method, url, strings.NewReader(body)) + resp, err := http.DefaultClient.Do(req) + if err != nil { + t.Fatal(err) + } + defer func() { _ = resp.Body.Close() }() + b, _ := io.ReadAll(resp.Body) + return resp.StatusCode, string(b) +} + +func packumentVersions(t *testing.T, url string) map[string]any { + t.Helper() + code, body := npmDo(t, http.MethodGet, url, "") + if code != http.StatusOK { + t.Fatalf("GET %s = %d: %s", url, code, body) + } + var doc struct { + Versions map[string]any `json:"versions"` + } + if err := json.Unmarshal([]byte(body), &doc); err != nil { + t.Fatal(err) + } + return doc.Versions +} + +func packumentTags(t *testing.T, url string) map[string]string { + t.Helper() + _, body := npmDo(t, http.MethodGet, url, "") + var doc struct { + Tags map[string]string `json:"dist-tags"` + } + if err := json.Unmarshal([]byte(body), &doc); err != nil { + t.Fatal(err) + } + return doc.Tags +} + +func concurrentPuts(t *testing.T, url string, bodies ...string) []int { + t.Helper() + var wg sync.WaitGroup + codes := make([]int, len(bodies)) + for i, b := range bodies { + wg.Add(1) + go func() { + defer wg.Done() + codes[i], _ = npmDo(t, http.MethodPut, url, b) + }() + } + wg.Wait() + return codes +} + +func TestNPMPublishHandler(t *testing.T) { + h, srv := npmTestServer(t) + repo := npmRepo(t, h, models.PackageNPM) + base := srv.URL + "/api/v1/local/" + repo + "/" + + t.Run("scoped name via %2f", func(t *testing.T) { + body := publishBody(t, "@acme/widget", []byte("scoped tgz"), publishOpts{}) + if code, b := npmDo(t, http.MethodPut, base+"@acme%2fwidget", body); code != http.StatusCreated { + t.Fatalf("publish = %d: %s", code, b) + } + v := packumentVersions(t, base+"@acme%2fwidget") + dist := v["1.0.0"].(map[string]any)["dist"].(map[string]any) + tarball := dist["tarball"].(string) + if !strings.HasPrefix(tarball, base+"@acme/widget/-/widget-1.0.0.tgz") { + t.Fatalf("tarball = %s", tarball) + } + if code, b := npmDo(t, http.MethodGet, tarball, ""); code != http.StatusOK || b != "scoped tgz" { + t.Fatalf("tarball fetch = %d %q", code, b) + } + }) + + t.Run("republish", func(t *testing.T) { + if code, b := npmDo(t, http.MethodPut, base+"repub", publishBody(t, "repub", []byte("v1"), publishOpts{})); code != http.StatusCreated { + t.Fatalf("first publish = %d: %s", code, b) + } + if code, _ := npmDo(t, http.MethodPut, base+"repub", publishBody(t, "repub", []byte("different"), publishOpts{})); code != http.StatusConflict { + t.Errorf("different bytes = %d, want 409", code) + } + if code, b := npmDo(t, http.MethodPut, base+"repub", publishBody(t, "repub", []byte("v2"), publishOpts{version: "1.1.0"})); code != http.StatusCreated { + t.Fatalf("publish 1.1.0 = %d: %s", code, b) + } + if code, _ := npmDo(t, http.MethodPut, base+"repub", publishBody(t, "repub", []byte("v1"), publishOpts{})); code != http.StatusConflict { + t.Errorf("identical republish = %d, want 409", code) + } + if tags := packumentTags(t, base+"repub"); tags["latest"] != "1.1.0" { + t.Errorf("latest = %q, want 1.1.0", tags["latest"]) + } + }) + + t.Run("rejected republish leaves tags", func(t *testing.T) { + for _, v := range []string{"1.0.0", "1.1.0"} { + if code, b := npmDo(t, http.MethodPut, base+"rej", publishBody(t, "rej", []byte("tgz "+v), publishOpts{version: v})); code != http.StatusCreated { + t.Fatalf("publish %s = %d: %s", v, code, b) + } + } + if code, _ := npmDo(t, http.MethodPut, base+"rej", publishBody(t, "rej", []byte("tgz 1.0.0"), publishOpts{shasum: "x"})); code != http.StatusConflict { + t.Fatalf("re-PUT 1.0.0 = %d, want 409", code) + } + if tags := packumentTags(t, base+"rej"); tags["latest"] != "1.1.0" { + t.Errorf("latest = %q, want 1.1.0", tags["latest"]) + } + }) + + t.Run("mid-publish window", func(t *testing.T) { + if code, b := npmDo(t, http.MethodPut, base+"mid", publishBody(t, "mid", []byte("v1"), publishOpts{})); code != http.StatusCreated { + t.Fatalf("publish = %d: %s", code, b) + } + ctx := context.Background() + if _, err := h.npmStore(ctx, repo, "mid/-/mid-1.0.1.tgz", []byte("v2"), "application/octet-stream", false); err != nil { + t.Fatal(err) + } + if tags := packumentTags(t, base+"mid"); tags["latest"] != "1.0.0" { + t.Errorf("tarball-only 1.0.1: latest = %q", tags["latest"]) + } + if _, err := h.npmStore(ctx, repo, "mid/-/dist-tags/latest", []byte("1.0.1"), "text/plain", true); err != nil { + t.Fatal(err) + } + if tags := packumentTags(t, base+"mid"); tags["latest"] == "1.0.1" { + t.Error("latest points at invisible 1.0.1") + } + }) + + t.Run("concurrent identical", func(t *testing.T) { + body := publishBody(t, "same", []byte("same tgz"), publishOpts{}) + codes := concurrentPuts(t, base+"same", body, body) + if codes[0]+codes[1] != http.StatusCreated+http.StatusConflict || codes[0] == codes[1] { + t.Fatalf("codes = %v, want one 201 and one 409", codes) + } + if tags := packumentTags(t, base+"same"); len(tags) != 1 || tags["latest"] != "1.0.0" { + t.Errorf("tags = %v", tags) + } + }) + + t.Run("concurrent different manifests", func(t *testing.T) { + tgz := []byte("race tgz") + codes := concurrentPuts(t, base+"race", + publishBody(t, "race", tgz, publishOpts{shasum: "a", tags: map[string]string{"a": "1.0.0"}}), + publishBody(t, "race", tgz, publishOpts{shasum: "b", tags: map[string]string{"b": "1.0.0"}})) + won := map[int]string{} + for i, c := range codes { + won[c] = []string{"a", "b"}[i] + } + if len(won) != 2 || won[http.StatusCreated] == "" || won[http.StatusConflict] == "" { + t.Fatalf("codes = %v, want one 201 and one 409", codes) + } + v := packumentVersions(t, base+"race")["1.0.0"].(map[string]any) + if got := v["dist"].(map[string]any)["shasum"]; got != won[http.StatusCreated] { + t.Errorf("manifest shasum = %v, winner %s", got, won[http.StatusCreated]) + } + tags := packumentTags(t, base+"race") + if len(tags) != 1 || tags[won[http.StatusCreated]] != "1.0.0" { + t.Errorf("tags = %v, winner %s", tags, won[http.StatusCreated]) + } + }) + + t.Run("retry after tarball-only write", func(t *testing.T) { + tgz := []byte("half published") + if _, err := h.npmStore(context.Background(), repo, "retry/-/retry-1.0.0.tgz", tgz, "application/octet-stream", false); err != nil { + t.Fatal(err) + } + if code, _ := npmDo(t, http.MethodGet, base+"retry", ""); code != http.StatusNotFound { + t.Fatalf("tarball-only version visible: %d", code) + } + if code, _ := npmDo(t, http.MethodPut, base+"retry", publishBody(t, "retry", []byte("other bytes"), publishOpts{})); code != http.StatusConflict { + t.Errorf("retry with different bytes = %d, want 409", code) + } + if code, b := npmDo(t, http.MethodPut, base+"retry", publishBody(t, "retry", tgz, publishOpts{})); code != http.StatusCreated { + t.Fatalf("retry with identical bytes = %d: %s", code, b) + } + if _, ok := packumentVersions(t, base+"retry")["1.0.0"]; !ok { + t.Error("retried version missing from packument") + } + }) + + t.Run("concurrent versions", func(t *testing.T) { + codes := concurrentPuts(t, base+"conc", + publishBody(t, "conc", []byte("tgz 1.0.0"), publishOpts{version: "1.0.0"}), + publishBody(t, "conc", []byte("tgz 2.0.0"), publishOpts{version: "2.0.0"})) + if codes[0] != http.StatusCreated || codes[1] != http.StatusCreated { + t.Fatalf("codes = %v", codes) + } + v := packumentVersions(t, base+"conc") + if _, ok := v["1.0.0"]; !ok { + t.Error("1.0.0 missing") + } + if _, ok := v["2.0.0"]; !ok { + t.Error("2.0.0 missing") + } + }) + + t.Run("body too large", func(t *testing.T) { + old := npmMaxPublishBytes + npmMaxPublishBytes = 64 + defer func() { npmMaxPublishBytes = old }() + if code, _ := npmDo(t, http.MethodPut, base+"big", publishBody(t, "big", []byte("x"), publishOpts{})); code != http.StatusRequestEntityTooLarge { + t.Errorf("oversized body = %d, want 413", code) + } + }) + + t.Run("non-npm local", func(t *testing.T) { + generic := npmRepo(t, h, models.PackageGeneric) + if code, _ := npmDo(t, http.MethodPut, srv.URL+"/api/v1/local/"+generic+"/pkg", publishBody(t, "pkg", []byte("x"), publishOpts{})); code != http.StatusMethodNotAllowed { + t.Errorf("publish to generic local = %d, want 405", code) + } + }) +} diff --git a/internal/api/v1/npm_test.go b/internal/api/v1/npm_test.go new file mode 100644 index 0000000..82cf676 --- /dev/null +++ b/internal/api/v1/npm_test.go @@ -0,0 +1,166 @@ +package v1 + +import ( + "crypto/sha1" + "crypto/sha512" + "encoding/base64" + "encoding/hex" + "encoding/json" + "errors" + "strings" + "testing" + + "git.unkin.net/unkin/artifactapi/internal/database" +) + +func TestNPMPackageName(t *testing.T) { + tests := map[string]string{ + "left-pad": "left-pad", + "left-pad/": "left-pad", + "@acme%2fwidget": "@acme/widget", + "@acme%2Fwidget": "@acme/widget", + "@acme/widget": "@acme/widget", + "left-pad/-/left-pad.tgz": "", + "@acme/widget/-/w-1.tgz": "", + "a/b": "", + "../etc": "", + "Upper": "", + "": "", + } + for in, want := range tests { + if got := npmPackageName(in); got != want { + t.Errorf("npmPackageName(%q) = %q, want %q", in, got, want) + } + } +} + +type publishOpts struct { + bodyName, manifestName, version, integrity, shasum string + tags map[string]string + extraVersion bool +} + +func publishBody(t *testing.T, pkg string, tgz []byte, o publishOpts) string { + t.Helper() + sha := sha512.Sum512(tgz) + sh1 := sha1.Sum(tgz) + if o.bodyName == "" { + o.bodyName = pkg + } + if o.manifestName == "" { + o.manifestName = pkg + } + if o.version == "" { + o.version = "1.0.0" + } + if o.integrity == "" { + o.integrity = "sha512-" + base64.StdEncoding.EncodeToString(sha[:]) + } + if o.shasum == "" { + o.shasum = hex.EncodeToString(sh1[:]) + } + if o.tags == nil { + o.tags = map[string]string{"latest": o.version} + } + versions := map[string]any{o.version: map[string]any{ + "name": o.manifestName, "version": o.version, "main": "index.js", + "dist": map[string]any{"integrity": o.integrity, "shasum": o.shasum, "tarball": "http://elsewhere/x.tgz"}, + }} + if o.extraVersion { + versions["2.0.0"] = map[string]any{"name": pkg, "version": "2.0.0"} + } + b, _ := json.Marshal(map[string]any{ + "_id": pkg, "name": o.bodyName, "dist-tags": o.tags, "versions": versions, + "_attachments": map[string]any{pkg + "-" + o.version + ".tgz": map[string]any{ + "content_type": "application/octet-stream", "data": base64.StdEncoding.EncodeToString(tgz), "length": len(tgz), + }}, + }) + return string(b) +} + +func TestParseNPMPublish(t *testing.T) { + tgz := []byte("fake tarball bytes") + + rel, err := parseNPMPublish(strings.NewReader(publishBody(t, "@acme/widget", tgz, publishOpts{tags: map[string]string{"latest": "1.0.0", "beta": "1.0.0"}})), "@acme/widget") + if err != nil { + t.Fatalf("valid scoped publish rejected: %v", err) + } + if rel.version != "1.0.0" || string(rel.tarball) != string(tgz) || len(rel.tags) != 2 { + t.Fatalf("unexpected release: %+v", rel) + } + + if _, err := parseNPMPublish(strings.NewReader(publishBody(t, "left-pad", tgz, publishOpts{integrity: "none", shasum: hex.EncodeToString(make([]byte, 20))})), "left-pad"); err == nil { + t.Fatal("shasum fallback should reject a mismatched tarball") + } + if _, err := parseNPMPublish(strings.NewReader(publishBody(t, "left-pad", tgz, publishOpts{integrity: "none"})), "left-pad"); err != nil { + t.Fatalf("matching shasum fallback rejected: %v", err) + } + + bad := map[string]publishOpts{ + "body name mismatch": {bodyName: "other"}, + "manifest name mismatch": {manifestName: "other"}, + "integrity mismatch": {integrity: "sha512-AAAA"}, + "path-like version": {version: "../1.0.0"}, + "non-semver version": {version: "1..2"}, + "leading-zero version": {version: "01.0.0"}, + "tag at another version": {tags: map[string]string{"latest": "9.9.9"}}, + "path-like tag": {tags: map[string]string{"../x": "1.0.0"}}, + "multiple versions at once": {extraVersion: true}, + } + for name, o := range bad { + if _, err := parseNPMPublish(strings.NewReader(publishBody(t, "left-pad", tgz, o)), "left-pad"); err == nil { + t.Errorf("%s: expected rejection", name) + } + } + if _, err := parseNPMPublish(strings.NewReader(`{"name":"left-pad","versions":{}}`), "left-pad"); err == nil { + t.Error("deprecate-style body without attachments should be rejected") + } +} + +func TestBuildNPMPackument(t *testing.T) { + blobs := map[string]string{ + "h1": `{"name":"my_pkg","version":"1.0.0","dist":{"shasum":"aa","tarball":"http://elsewhere/x.tgz"}}`, + "h2": `{"name":"my_pkg","version":"1.1.0"}`, + "h3": "1.1.0", + "h4": "2.0.0", + "hx": `{"name":"myXpkg","version":"6.6.6"}`, + } + read := func(h string) ([]byte, error) { + b, ok := blobs[h] + if !ok { + return nil, errors.New("missing blob") + } + return []byte(b), nil + } + files := []database.LocalFile{ + {FilePath: "my_pkg/-/dist-tags/latest", ContentHash: "h3"}, + {FilePath: "my_pkg/-/dist-tags/next", ContentHash: "h4"}, + {FilePath: "my_pkg/-/my_pkg-1.0.0.json", ContentHash: "h1"}, + {FilePath: "my_pkg/-/my_pkg-1.0.0.tgz", ContentHash: "nope"}, + {FilePath: "my_pkg/-/my_pkg-1.1.0.json", ContentHash: "h2"}, + {FilePath: "myXpkg/-/myXpkg-6.6.6.json", ContentHash: "hx"}, + } + + doc, err := buildNPMPackument("my_pkg", files, read, "http://reg/api/v1/local/npm/") + if err != nil { + t.Fatal(err) + } + if tags := doc["dist-tags"].(map[string]string); tags["latest"] != "1.1.0" || len(tags) != 1 { + t.Errorf("dist-tags = %v", tags) + } + versions := doc["versions"].(map[string]any) + if len(versions) != 2 { + t.Fatalf("versions = %v (LIKE over-match must be dropped)", versions) + } + v1 := versions["1.0.0"].(map[string]any)["dist"].(map[string]any) + if v1["tarball"] != "http://reg/api/v1/local/npm/my_pkg/-/my_pkg-1.0.0.tgz" || v1["shasum"] != "aa" { + t.Errorf("1.0.0 dist = %v", v1) + } + if versions["1.1.0"].(map[string]any)["dist"].(map[string]any)["tarball"] != "http://reg/api/v1/local/npm/my_pkg/-/my_pkg-1.1.0.tgz" { + t.Error("1.1.0 missing rewritten tarball") + } + + if doc, err := buildNPMPackument("absent", files, read, "x/"); err != nil || doc != nil { + t.Errorf("absent package: doc=%v err=%v", doc, err) + } +} diff --git a/internal/api/v1/proxy.go b/internal/api/v1/proxy.go index 7429007..27395d0 100644 --- a/internal/api/v1/proxy.go +++ b/internal/api/v1/proxy.go @@ -16,6 +16,7 @@ import ( "git.unkin.net/unkin/artifactapi/internal/proxy" "git.unkin.net/unkin/artifactapi/internal/storage" "git.unkin.net/unkin/artifactapi/internal/virtual" + "git.unkin.net/unkin/artifactapi/pkg/models" ) type ProxyHandler struct { @@ -42,6 +43,7 @@ func (h *ProxyHandler) Routes() chi.Router { r := chi.NewRouter() r.Get("/remote/{remoteName}/*", h.handleProxy) r.Get("/local/{localName}/*", h.handleLocal) + r.Put("/local/{localName}/*", h.handleLocalPut) r.Get("/virtual/{virtualName}/*", h.handleVirtual) return r } @@ -211,6 +213,13 @@ func (h *ProxyHandler) handleLocal(w http.ResponseWriter, r *http.Request) { return } + if remote.PackageType == models.PackageNPM { + if pkg := npmPackageName(path); pkg != "" { + h.serveNPMPackument(w, r, remote, pkg) + return + } + } + prov, _ := provider.Get(remote.PackageType) if indexer, ok := prov.(provider.LocalIndexer); ok { if indexer.ServeLocalIndex(w, r, h.db, remote.Name, path) { diff --git a/ui/src/packagetypes/defs/npm.ts b/ui/src/packagetypes/defs/npm.ts index 441c99f..a10af90 100644 --- a/ui/src/packagetypes/defs/npm.ts +++ b/ui/src/packagetypes/defs/npm.ts @@ -2,7 +2,28 @@ import type { PackageTypeUI } from '../types'; const def: PackageTypeUI = { color: 'red', - snippets: ({ proxy }) => { + snippets: ({ name, url, host, proxy, isLocal }) => { + if (isLocal) { + const reg = `${url}/api/v1/local/${name}/`; + return [ + { + title: 'Configure .npmrc (registry + publish token)', + language: 'bash', + code: `cat >> .npmrc <<'EOF' +registry=${reg} +//${host}/api/v1/local/${name}/:_authToken=unused +EOF`, + note: 'npm refuses to publish without an _authToken for the registry; any value works. For a scope only, use @:registry=… instead of registry=.', + }, + { + title: 'Publish and install', + language: 'bash', + code: `npm publish +npm install `, + note: 'Versions are immutable: republishing an existing version is rejected. The dist-tags sent with the publish (latest, or --tag) move to the new version.', + }, + ]; + } return [ { title: 'Point npm at this registry',