diff options
| -rw-r--r-- | internal/api/api.go | 54 | ||||
| -rw-r--r-- | internal/api/api_test.go | 81 | ||||
| -rw-r--r-- | internal/frontend/server.go | 1 | ||||
| -rw-r--r-- | internal/testing/fakedatasource/fakedatasource.go | 12 |
4 files changed, 146 insertions, 2 deletions
diff --git a/internal/api/api.go b/internal/api/api.go index d27e49b0..97c3b5a1 100644 --- a/internal/api/api.go +++ b/internal/api/api.go @@ -158,6 +158,60 @@ func ServePackage(w http.ResponseWriter, r *http.Request, ds internal.DataSource return serveJSON(w, http.StatusOK, resp) } +// ServeModule handles requests for the v1 module metadata endpoint. +func ServeModule(w http.ResponseWriter, r *http.Request, ds internal.DataSource) (err error) { + defer derrors.Wrap(&err, "ServeModule") + + modulePath := strings.TrimPrefix(r.URL.Path, "/v1/module/") + if modulePath == "" { + return serveErrorJSON(w, http.StatusBadRequest, "missing module path", nil) + } + + var params ModuleParams + if err := ParseParams(r.URL.Query(), ¶ms); err != nil { + return serveErrorJSON(w, http.StatusBadRequest, err.Error(), nil) + } + + requestedVersion := params.Version + if requestedVersion == "" { + requestedVersion = version.Latest + } + + // For modules, we can use GetUnitMeta on the module path. + um, err := ds.GetUnitMeta(r.Context(), modulePath, modulePath, requestedVersion) + if err != nil { + if errors.Is(err, derrors.NotFound) { + return serveErrorJSON(w, http.StatusNotFound, err.Error(), nil) + } + return err + } + + resp := Module{ + Path: um.ModulePath, + Version: um.Version, + IsStandardLibrary: stdlib.Contains(um.ModulePath), + IsRedistributable: um.IsRedistributable, + } + // RepoURL needs to be extracted from source info if available + if um.SourceInfo != nil { + resp.RepoURL = um.SourceInfo.RepoURL() + } + + if params.Readme { + readme, err := ds.GetModuleReadme(r.Context(), um.ModulePath, um.Version) + if err == nil && readme != nil { + resp.Readme = &Readme{ + Filepath: readme.Filepath, + Contents: readme.Contents, + } + } + } + + // Future: handle licenses param. + + return serveJSON(w, http.StatusOK, resp) +} + // needsResolution reports whether the version string is a sentinel like "latest" or "master". func needsResolution(v string) bool { return v == version.Latest || v == version.Master || v == version.Main diff --git a/internal/api/api_test.go b/internal/api/api_test.go index e087b13e..f61c8581 100644 --- a/internal/api/api_test.go +++ b/internal/api/api_test.go @@ -166,3 +166,84 @@ func TestServePackage(t *testing.T) { }) } } + +func TestServeModule(t *testing.T) { + ctx := context.Background() + ds := fakedatasource.New() + + const ( + modulePath = "example.com" + version = "v1.2.3" + ) + + ds.MustInsertModule(ctx, &internal.Module{ + ModuleInfo: internal.ModuleInfo{ + ModulePath: modulePath, + Version: version, + }, + Units: []*internal.Unit{{ + UnitMeta: internal.UnitMeta{ + Path: modulePath, + ModuleInfo: internal.ModuleInfo{ + ModulePath: modulePath, + Version: version, + }, + }, + Readme: &internal.Readme{Filepath: "README.md", Contents: "Hello world"}, + }}, + }) + + for _, test := range []struct { + name string + url string + wantStatus int + want *Module + }{ + { + name: "basic module metadata", + url: "/v1/module/example.com?version=v1.2.3", + wantStatus: http.StatusOK, + want: &Module{ + Path: modulePath, + Version: version, + }, + }, + { + name: "module with readme", + url: "/v1/module/example.com?version=v1.2.3&readme=true", + wantStatus: http.StatusOK, + want: &Module{ + Path: modulePath, + Version: version, + Readme: &Readme{ + Filepath: "README.md", + Contents: "Hello world", + }, + }, + }, + } { + t.Run(test.name, func(t *testing.T) { + r := httptest.NewRequest("GET", test.url, nil) + w := httptest.NewRecorder() + + err := ServeModule(w, r, ds) + if err != nil { + t.Fatalf("ServeModule returned error: %v", err) + } + + if w.Code != test.wantStatus { + t.Errorf("status = %d, want %d", w.Code, test.wantStatus) + } + + if test.want != nil { + var got Module + if err := json.Unmarshal(w.Body.Bytes(), &got); err != nil { + t.Fatalf("json.Unmarshal: %v", err) + } + if diff := cmp.Diff(test.want, &got); diff != "" { + t.Errorf("mismatch (-want +got):\n%s", diff) + } + } + }) + } +} diff --git a/internal/frontend/server.go b/internal/frontend/server.go index 49ecd39e..00dc7ad6 100644 --- a/internal/frontend/server.go +++ b/internal/frontend/server.go @@ -237,6 +237,7 @@ func (s *Server) Install(handle func(string, http.Handler), cacher Cacher, authV handle("GET /files/", http.StripPrefix("/files", s.fileMux)) handle("GET /vuln/", vulnHandler) handle("GET /v1/package/", s.errorHandler(api.ServePackage)) + handle("GET /v1/module/", s.errorHandler(api.ServeModule)) handle("/opensearch.xml", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { serveFileFS(w, r, s.staticFS, "shared/opensearch.xml") })) diff --git a/internal/testing/fakedatasource/fakedatasource.go b/internal/testing/fakedatasource/fakedatasource.go index 1f695196..754a00cb 100644 --- a/internal/testing/fakedatasource/fakedatasource.go +++ b/internal/testing/fakedatasource/fakedatasource.go @@ -234,9 +234,17 @@ func findUnit(m *internal.Module, path string) *internal.Unit { return nil } -// GetModuleReadme is not implemented. +// GetModuleReadme gets the readme for the module. func (ds *FakeDataSource) GetModuleReadme(ctx context.Context, modulePath, resolvedVersion string) (*internal.Readme, error) { - return nil, nil + m := ds.getModule(modulePath, resolvedVersion) + if m == nil { + return nil, derrors.NotFound + } + u := findUnit(m, modulePath) + if u == nil { + return nil, nil + } + return u.Readme, nil } // GetLatestInfo gets information about the latest versions of a unit and module. |