From 8514eebca6ca7b3213e879faa2a83c7e9ea6e181 Mon Sep 17 00:00:00 2001 From: Ethan Lee Date: Wed, 11 Mar 2026 21:20:21 +0000 Subject: internal/api: implement package imported-by endpoint - Implement ServePackageImportedBy handler and GetImportedBy and GetImportedByCount datasource methods. Change-Id: I8c4cc65fbff7172eaf48e5426e4f3f41c82bd38e Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/754865 Reviewed-by: Jonathan Amsterdam kokoro-CI: kokoro LUCI-TryBot-Result: Go LUCI Auto-Submit: Ethan Lee --- internal/api/api.go | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) (limited to 'internal/api/api.go') diff --git a/internal/api/api.go b/internal/api/api.go index b2be2327..8cfe2151 100644 --- a/internal/api/api.go +++ b/internal/api/api.go @@ -399,6 +399,67 @@ func ServePackageSymbols(w http.ResponseWriter, r *http.Request, ds internal.Dat return serveJSON(w, http.StatusOK, resp) } +// ServePackageImportedBy handles requests for the v1 package imported-by endpoint. +func ServePackageImportedBy(w http.ResponseWriter, r *http.Request, ds internal.DataSource) (err error) { + defer derrors.Wrap(&err, "ServePackageImportedBy") + + pkgPath := strings.TrimPrefix(r.URL.Path, "/v1/imported-by/") + if pkgPath == "" { + return serveErrorJSON(w, http.StatusBadRequest, "missing package path", nil) + } + + var params ImportedByParams + 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 + } + + um, candidates, err := resolveModulePath(r, ds, pkgPath, params.Module, requestedVersion) + if err != nil { + if errors.Is(err, derrors.NotFound) { + return serveErrorJSON(w, http.StatusNotFound, err.Error(), nil) + } + return err + } + if len(candidates) > 0 { + return serveErrorJSON(w, http.StatusBadRequest, "ambiguous package path", candidates) + } + modulePath := um.ModulePath + + limit := params.Limit + if limit <= 0 { + limit = 100 + } + + importedBy, err := ds.GetImportedBy(r.Context(), pkgPath, modulePath, limit) + if err != nil { + if errors.Is(err, derrors.NotFound) { + return serveErrorJSON(w, http.StatusNotFound, err.Error(), nil) + } + return err + } + + count, err := ds.GetImportedByCount(r.Context(), pkgPath, modulePath) + if err != nil { + return err + } + + resp := PackageImportedBy{ + ModulePath: modulePath, + Version: requestedVersion, + ImportedBy: PaginatedResponse[string]{ + Items: importedBy, + Total: count, + }, + } + + return serveJSON(w, http.StatusOK, resp) +} + // resolveModulePath determines the correct module path for a given package path and version. // If the module path is not provided, it searches through potential candidate module paths // derived from the package path. If multiple valid modules contain the package, it returns -- cgit v1.3