Add /api/vscode/{publisher}/{extension}/latest endpoint

Author: code-asher

api/api.go

@@ -128,6 +128,9 @@ func New(options *Options) *API {
 	r.Get("/publishers/{publisher}/vsextensions/{extension}/{version}/{type}", api.assetRedirect)
 	r.Get("/api/publishers/{publisher}/vsextensions/{extension}/{version}/{type}", api.assetRedirect)
 
+	// Return the specified extension with only the latest version included.
+	r.Get("/api/vscode/{publisher}/{extension}/latest", api.latestExtension)
+
 	// This is the URL you get taken to when you click the extension's names,
 	// ratings, etc from the extension details page.
 	r.Get("/item", func(rw http.ResponseWriter, r *http.Request) {
@@ -256,3 +259,48 @@ func (api *API) assetRedirect(rw http.ResponseWriter, r *http.Request) {
 
 	http.Redirect(rw, r, url, http.StatusMovedPermanently)
 }
+
+func (api *API) latestExtension(rw http.ResponseWriter, r *http.Request) {
+	baseURL := httpapi.RequestBaseURL(r, "/")
+	filter := database.Filter{
+		Criteria: []database.Criteria{
+			{
+				Type:  database.Target,
+				Value: "Microsoft.VisualStudio.Code",
+			},
+			{
+				// ExtensionName is the fully qualified name `publisher.extension`.
+				Type:  database.ExtensionName,
+				Value: storage.ExtensionIDWithoutVersion(chi.URLParam(r, "publisher"), chi.URLParam(r, "extension")),
+			},
+		},
+		PageNumber: 1,
+		PageSize:   1,
+	}
+	flags := database.IncludeVersions |
+		database.IncludeFiles |
+		database.IncludeCategoryAndTags |
+		database.IncludeVersionProperties |
+		database.IncludeAssetURI |
+		database.IncludeStatistics |
+		database.IncludeLatestVersionOnly
+	extensions, _, err := api.Database.GetExtensions(r.Context(), filter, flags, baseURL)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.ErrorResponse{
+			Message:   "Unable to read extension",
+			Detail:    "Contact an administrator with the request ID",
+			RequestID: httpmw.RequestID(r),
+		})
+		return
+	}
+	if len(extensions) == 0 {
+		httpapi.Write(rw, http.StatusNotFound, httpapi.ErrorResponse{
+			Message:   "Extension does not exist",
+			Detail:    "Please check the publisher and extension name",
+			RequestID: httpmw.RequestID(r),
+		})
+		return
+	}
+
+	httpapi.Write(rw, http.StatusOK, extensions[0])
+}

api/api_test.go

@@ -24,7 +24,7 @@ func TestAPI(t *testing.T) {
 	t.Parallel()
 
 	exts := []*database.Extension{}
-	for i := 0; i < 10; i++ {
+	for i := range 10 {
 		exts = append(exts, &database.Extension{
 			ID: fmt.Sprintf("extension-%d", i),
 		})
@@ -266,6 +266,23 @@ func TestAPI(t *testing.T) {
 			Path:   "/api/publishers/vscodevim/extensions/vim/1.23.1/stats?statType=1",
 			Status: http.StatusOK,
 		},
+		{
+			Name:   "LatestExtensionNotExist",
+			Path:   "/api/vscode/notexist/nope/latest",
+			Method: http.MethodGet,
+			Status: http.StatusNotFound,
+			Response: &httpapi.ErrorResponse{
+				Message: "Extension does not exist",
+				Detail:  "Please check the publisher and extension name",
+			},
+		},
+		{
+			Name:     "LatestExtensionExists",
+			Path:     "/api/vscode/vscodevim/vim/latest",
+			Method:   http.MethodGet,
+			Status:   http.StatusOK,
+			Response: exts[0],
+		},
 	}
 
 	for _, c := range cases {
@@ -324,11 +341,11 @@ func TestAPI(t *testing.T) {
 			require.Equal(t, c.Status, resp.StatusCode)
 
 			if c.Response != nil {
-				// Copy the request ID so the objects can match.
 				if a, aok := c.Response.(*httpapi.ErrorResponse); aok {
 					var body httpapi.ErrorResponse
 					err := json.NewDecoder(resp.Body).Decode(&body)
 					require.NoError(t, err)
+					// Copy the request ID so the objects can match.
 					a.RequestID = body.RequestID
 					require.Equal(t, c.Response, &body)
 				} else if c.Status == http.StatusMovedPermanently {
@@ -337,6 +354,11 @@ func TestAPI(t *testing.T) {
 					b, err := io.ReadAll(resp.Body)
 					require.NoError(t, err)
 					require.Equal(t, a, string(b))
+				} else if _, aok := c.Response.(*database.Extension); aok {
+					var body database.Extension
+					err := json.NewDecoder(resp.Body).Decode(&body)
+					require.NoError(t, err)
+					require.Equal(t, c.Response, &body)
 				} else {
 					var body api.QueryResponse
 					err := json.NewDecoder(resp.Body).Decode(&body)

cli/add_test.go

@@ -165,7 +165,7 @@ func TestAdd(t *testing.T) {
 					_, err := os.Stat(dest)
 					require.NoError(t, err)
 					// Should tell you where it went.
-					id := storage.ExtensionID(ext.Publisher, ext.Name, ext.LatestVersion)
+					id := storage.ExtensionIDWithVersion(ext.Publisher, ext.Name, ext.LatestVersion)
 					require.Contains(t, output, fmt.Sprintf("Unpacked %s to %s", id, dest))
 					// Should mention the dependencies and pack.
 					require.Contains(t, output, fmt.Sprintf("%s has %d dep", id, len(ext.Dependencies)))

database/nodb.go

@@ -58,6 +58,7 @@ func (db *NoDB) GetExtensions(ctx context.Context, filter Filter, flags Flag, ba
 	start := time.Now()
 	err := db.Storage.WalkExtensions(ctx, func(manifest *storage.VSIXManifest, versions []storage.Version) error {
 		vscodeExt := convertManifestToExtension(manifest)
+		// TODO: Could return early if ExtensionID or ExtensionName match.
 		if matched, distances := getMatches(vscodeExt, filter); matched {
 			vscodeExt.versions = versions
 			vscodeExt.distances = distances
@@ -134,7 +135,8 @@ func getMatches(extension *noDBExtension, filter Filter) (bool, []int) {
 			match(containsFold(extension.Categories, c.Value))
 		case ExtensionName:
 			// The value here is the fully qualified name `publisher.extension`.
-			match(strings.EqualFold(extension.Publisher.PublisherName+"."+extension.Name, c.Value))
+			name := storage.ExtensionIDWithoutVersion(extension.Publisher.PublisherName, extension.Name)
+			match(strings.EqualFold(name, c.Value))
 		case Target:
 			// Unlike the other criteria the target is an AND so if it does not match
 			// we can abort early.

storage/artifactory.go

@@ -102,7 +102,7 @@ func NewArtifactoryStorage(ctx context.Context, options *ArtifactoryOptions) (*A
 				if err != nil && !errors.Is(err, context.Canceled) {
 					return err
 				} else if err != nil {
-					id := ExtensionID(identity.Publisher, identity.ID, ver.Version)
+					id := ExtensionIDWithVersion(identity.Publisher, identity.ID, ver.Version)
 					s.logger.Error(ctx, "Unable to read extension manifest", slog.Error(err),
 						slog.F("id", id),
 						slog.F("targetPlatform", ver.TargetPlatform))
@@ -400,7 +400,7 @@ func (s *Artifactory) WalkExtensions(ctx context.Context, fn func(manifest *VSIX
 			if err != nil && errors.Is(err, context.Canceled) {
 				return err
 			} else if err != nil {
-				id := ExtensionID(ext.publisher, ext.name, ext.versions[0].Version)
+				id := ExtensionIDWithVersion(ext.publisher, ext.name, ext.versions[0].Version)
 				s.logger.Error(ctx, "Unable to read extension manifest; extension will be ignored", slog.Error(err),
 					slog.F("id", id),
 					slog.F("targetPlatform", ext.versions[0].TargetPlatform))

storage/storage.go

@@ -385,18 +385,24 @@ func ReadVSIX(ctx context.Context, source string) ([]byte, error) {
 // ExtensionIDFromManifest returns the full ID of an extension without the the
 // platform, for example [email protected].
 func ExtensionIDFromManifest(manifest *VSIXManifest) string {
-	return ExtensionID(
+	return ExtensionIDWithVersion(
 		manifest.Metadata.Identity.Publisher,
 		manifest.Metadata.Identity.ID,
 		manifest.Metadata.Identity.Version)
 }
 
-// ExtensionID returns the full ID of an extension without the platform, for
+// ExtensionIDWithVersion returns the full ID of an extension without the platform, for
 // example [email protected].
-func ExtensionID(publisher, name, version string) string {
+func ExtensionIDWithVersion(publisher, name, version string) string {
 	return fmt.Sprintf("%s.%s@%s", publisher, name, version)
 }
 
+// ExtensionID returns the full ID of an extension without the platform or
+// version, for example publisher.name.
+func ExtensionIDWithoutVersion(publisher, name string) string {
+	return fmt.Sprintf("%s.%s", publisher, name)
+}
+
 // ExtensionVSIXNameFromManifest returns the full ID of an extension including
 // the platform if not universal, for example publisher.name-0.0.1 or
 // publisher.name-0.0.1@linux-x64.

storage/storage_test.go

@@ -1070,7 +1070,7 @@ func testVersions(t *testing.T, factory storageFactory) {
 	}
 }
 
-func TestExtensionID(t *testing.T) {
+func TestExtensionIDFromManifest(t *testing.T) {
 	t.Parallel()
 
 	tests := []struct {
@@ -1105,6 +1105,69 @@ func TestExtensionID(t *testing.T) {
 	}
 }
 
+func TestExtensionIDWithVersion(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		// expected is the expected id.
+		expected string
+		// publisher is the publisher of the extension.
+		publisher string
+		// extension is name of the extension.
+		extension string
+		// version is version of the extension.
+		version string
+		// name is the name of the test.
+		name string
+	}{
+		{
+			name:      "OK",
+			expected:  "foo.bar@baz",
+			publisher: "foo",
+			version:   "baz",
+			extension: "bar",
+		},
+	}
+
+	for _, test := range tests {
+		test := test
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+			require.Equal(t, test.expected, storage.ExtensionIDWithVersion(test.publisher, test.extension, test.version))
+		})
+	}
+}
+
+func TestExtensionIDWithoutVersion(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		// expected is the expected id.
+		expected string
+		// publisher is the publisher of the extension.
+		publisher string
+		// extension is name of the extension.
+		extension string
+		// name is the name of the test.
+		name string
+	}{
+		{
+			name:      "OK",
+			expected:  "foo.bar",
+			publisher: "foo",
+			extension: "bar",
+		},
+	}
+
+	for _, test := range tests {
+		test := test
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+			require.Equal(t, test.expected, storage.ExtensionIDWithoutVersion(test.publisher, test.extension))
+		})
+	}
+}
+
 func TestExtensionVSIXNameWithPlatform(t *testing.T) {
 	t.Parallel()
 

testutil/mockdb.go

@@ -41,5 +41,11 @@ func (db *MockDB) GetExtensions(ctx context.Context, filter database.Filter, fla
 	if len(filter.Criteria) == 0 {
 		return nil, 0, nil
 	}
+	if len(filter.Criteria) > 1 && filter.Criteria[1].Type == database.ExtensionName {
+		if strings.HasPrefix(filter.Criteria[1].Value, "notexist") {
+			return nil, 0, nil
+		}
+		return db.exts[:1], 1, nil
+	}
 	return db.exts, len(db.exts), nil
 }