Display dependencies and pack extensions after add

Author: code-asher

README.md

@@ -63,10 +63,9 @@ directory does not need to be created beforehand.
 ./code-marketplace add https://domain.tld/extension.vsix --extensions-dir ./extensions
 ```
 
-Extensions listed as dependencies must also be added.
-
-If the extension is part of an extension pack the other extensions in the pack
-can also be added but doing so is optional.
+If the extension has dependencies or is in an extension pack those details will
+be printed. Extensions listed as dependencies must also be added but extensions
+in a pack are optional.
 
 If an extension is open source you can get it from one of three locations:
 

api/api.go

@@ -208,7 +208,7 @@ func (api *API) extensionQuery(rw http.ResponseWriter, r *http.Request) {
 func (api *API) assetRedirect(rw http.ResponseWriter, r *http.Request) {
 // TODO: Asset URIs can contain a targetPlatform query variable.
 baseURL := httpapi.RequestBaseURL(r, "/")
-assetType := chi.URLParam(r, "type")
+assetType := storage.AssetType(chi.URLParam(r, "type"))
 if assetType == "vspackage" {
 assetType = storage.VSIXAssetType
 }

api/api_test.go

@@ -26,8 +26,8 @@ import (
 
 type fakeStorage struct{}
 
-func (s *fakeStorage) AddExtension(ctx context.Context, source string) (string, error) {
-return "", errors.New("not implemented")
+func (s *fakeStorage) AddExtension(ctx context.Context, source string) (*storage.Extension, error) {
+return nil, errors.New("not implemented")
 }
 
 func (s *fakeStorage) FileServer() http.Handler {

cli/add.go

@@ -4,13 +4,15 @@ import (
 "context"
 "fmt"
 "path/filepath"
+"strings"
 
 "github.com/spf13/cobra"
 
 "cdr.dev/slog"
 "cdr.dev/slog/sloggers/sloghuman"
 
 "github.com/coder/code-marketplace/storage"
+"github.com/coder/code-marketplace/util"
 )
 
 func add() *cobra.Command {
@@ -46,13 +48,35 @@ func add() *cobra.Command {
 Logger: logger,
 }
 
-dest, err := store.AddExtension(ctx, args[0])
+ext, err := store.AddExtension(ctx, args[0])
 if err != nil {
 return err
 }
 
-_, _ = fmt.Fprintf(cmd.OutOrStdout(), "Extension unpacked to %s\n", dest)
-return nil
+depCount := len(ext.Dependencies)
+summary := []string{
+fmt.Sprintf("Unpacked %s to %s", ext.ID, ext.Location),
+fmt.Sprintf("%s has %s", ext.ID, util.Plural(depCount, "dependency", "dependencies")),
+}
+
+if depCount > 0 {
+for _, id := range ext.Dependencies {
+summary = append(summary, fmt.Sprintf(" - %s", id))
+}
+}
+
+packCount := len(ext.Pack)
+if packCount > 0 {
+summary = append(summary, fmt.Sprintf("%s is in a pack with %s", ext.ID, util.Plural(packCount, "other extension", "")))
+for _, id := range ext.Pack {
+summary = append(summary, fmt.Sprintf(" - %s", id))
+}
+} else {
+summary = append(summary, fmt.Sprintf("%s is not in a pack", ext.ID))
+}
+
+_, err = fmt.Fprintln(cmd.OutOrStdout(), strings.Join(summary, "\n"))
+return err
 },
 }
 

database/database.go

@@ -4,6 +4,8 @@ import (
 "context"
 "net/url"
 "time"
+
+"github.com/coder/code-marketplace/storage"
 )
 
 // API references:
@@ -133,15 +135,15 @@ type ExtVersion struct {
 // ExtFile implements IRawGalleryExtensionFile.
 // https://github.com/microsoft/vscode/blob/29234f0219bdbf649d6107b18651a1038d6357ac/src/vs/platform/extensionManagement/common/extensionGalleryService.ts#L32-L35
 type ExtFile struct {
-Type string `json:"assetType"`
-Source string `json:"source"`
+Type storage.AssetType `json:"assetType"`
+Source string  `json:"source"`
 }
 
 // ExtProperty implements IRawGalleryExtensionProperty.
 // https://github.com/microsoft/vscode/blob/29234f0219bdbf649d6107b18651a1038d6357ac/src/vs/platform/extensionManagement/common/extensionGalleryService.ts#L37-L40
 type ExtProperty struct {
-Key string `json:"key"`
-Value string `json:"value"`
+Key storage.PropertyType `json:"key"`
+Value string  `json:"value"`
 }
 
 // ExtStat implements IRawGalleryExtensionStatistics.
@@ -154,7 +156,7 @@ type ExtStat struct {
 type Asset struct {
 Extension string
 Publisher string
-Type string
+Type storage.AssetType
 Version string
 }
 

database/database_test.go

@@ -20,8 +20,8 @@ import (
 
 type memoryStorage struct{}
 
-func (s *memoryStorage) AddExtension(ctx context.Context, source string) (string, error) {
-return "", errors.New("not implemented")
+func (s *memoryStorage) AddExtension(ctx context.Context, source string) (*storage.Extension, error) {
+return nil, errors.New("not implemented")
 }
 
 func (s *memoryStorage) FileServer() http.Handler {
@@ -505,7 +505,7 @@ func TestGetExtensions(t *testing.T) {
 require.Len(t, ext.Versions, 5, "versions")
 for _, version := range ext.Versions {
 require.Empty(t, version.Files, "files")
-require.Len(t, version.Properties, 1, "properties")
+require.Len(t, version.Properties, 2, "properties")
 }
 },
 },
@@ -546,7 +546,7 @@ func TestGetExtensions(t *testing.T) {
 for _, version := range ext.Versions {
 require.Len(t, version.Files, 1, "files")
 require.Equal(t, fmt.Sprintf("%s/files/foo/zany/%s/icon.png", base, version.Version), version.Files[0].Source)
-require.Len(t, version.Properties, 1, "properties")
+require.Len(t, version.Properties, 2, "properties")
 require.Equal(t, version.AssetURI, version.FallbackAssetURI)
 }
 },

storage/local.go

@@ -9,6 +9,7 @@ import (
 "os"
 "path/filepath"
 "sort"
+"strings"
 
 "golang.org/x/mod/semver"
 
@@ -21,26 +22,26 @@ type Local struct {
 Logger slog.Logger
 }
 
-func (s *Local) AddExtension(ctx context.Context, source string) (string, error) {
+func (s *Local) AddExtension(ctx context.Context, source string) (*Extension, error) {
 vsixBytes, err := readVSIX(ctx, source)
 if err != nil {
-return "", err
+return nil, err
 }
 
 mr, err := GetZipFileReader(vsixBytes, "extension.vsixmanifest")
 if err != nil {
-return "", err
+return nil, err
 }
 defer mr.Close()
 
 manifest, err := parseVSIXManifest(mr)
 if err != nil {
-return "", err
+return nil, err
 }
 
 err = validateManifest(manifest)
 if err != nil {
-return "", err
+return nil, err
 }
 
 // Extract the zip to the correct path.
@@ -55,21 +56,35 @@ func (s *Local) AddExtension(ctx context.Context, source string) (string, error)
 return os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
 })
 if err != nil {
-return "", err
+return nil, err
 }
 
 // Copy the VSIX itself as well.
-vsixName := fmt.Sprintf("%s.%s-%s.vsix", identity.Publisher, identity.ID, identity.Version)
+name := fmt.Sprintf("%s.%s-%s", identity.Publisher, identity.ID, identity.Version)
+vsixName := fmt.Sprintf("%s.vsix", name)
 dst, err := os.OpenFile(filepath.Join(dir, vsixName), os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
 if err != nil {
-return "", err
+return nil, err
 }
 _, err = io.Copy(dst, bytes.NewReader(vsixBytes))
 if err != nil {
-return "", err
+return nil, err
+}
+
+ext := &Extension{ID: name, Location: dir}
+for _, prop := range manifest.Metadata.Properties.Property {
+if prop.Value == "" {
+continue
+}
+switch prop.ID {
+case DependencyPropertyType:
+ext.Dependencies = append(ext.Dependencies, strings.Split(prop.Value, ",")...)
+case PackPropertyType:
+ext.Pack = append(ext.Pack, strings.Split(prop.Value, ",")...)
+}
 }
 
-return dir, nil
+return ext, nil
 }
 
 func (s *Local) FileServer() http.Handler {

storage/storage.go

@@ -12,8 +12,6 @@ import (
 "golang.org/x/xerrors"
 )
 
-const VSIXAssetType = "Microsoft.VisualStudio.Services.VSIXPackage"
-
 // VSIXManifest implement XMLManifest.PackageManifest.
 // https://github.com/microsoft/vscode-vsce/blob/main/src/xml.ts#L9-L26
 type VSIXManifest struct {
@@ -57,11 +55,18 @@ type VSIXProperties struct {
 Property []VSIXProperty
 }
 
+type PropertyType string
+
+const (
+DependencyPropertyType PropertyType = "Microsoft.VisualStudio.Code.ExtensionDependencies"
+PackPropertyType PropertyType = "Microsoft.VisualStudio.Code.ExtensionPack"
+)
+
 // VSIXProperty implements XMLManifest.PackageManifest.Metadata.Properties.Property.
 // https://github.com/microsoft/vscode-vsce/blob/main/src/xml.ts#L19
 type VSIXProperty struct {
-ID string `xml:"Id,attr"`
-Value string `xml:",attr"`
+ID PropertyType `xml:"Id,attr"`
+Value string  `xml:",attr"`
 }
 
 // VSIXAssets implements XMLManifest.PackageManifest.Assets.
@@ -70,20 +75,33 @@ type VSIXAssets struct {
 Asset []VSIXAsset
 }
 
+type AssetType string
+
+const (
+VSIXAssetType AssetType = "Microsoft.VisualStudio.Services.VSIXPackage"
+)
+
 // VSIXAsset implements XMLManifest.PackageManifest.Assets.Asset.
 // https://github.com/microsoft/vscode-vsce/blob/main/src/xml.ts#L25
 type VSIXAsset struct {
-Type string `xml:",attr"`
-Path string `xml:",attr"`
-Addressable string `xml:",attr"`
+Type AssetType `xml:",attr"`
+Path string `xml:",attr"`
+Addressable string `xml:",attr"`
+}
+
+type Extension struct {
+ID string
+Location string
+Dependencies []string
+Pack []string
 }
 
 // TODO: Add Artifactory implementation of Storage.
 type Storage interface {
 // AddExtension adds the extension found at the specified source by copying it
-// into the extension storage directory and returns the location of the new
+// into the extension storage directory and returns details about the added
 // extension. The source may be an URI or a local file path.
-AddExtension(ctx context.Context, source string) (string, error)
+AddExtension(ctx context.Context, source string) (*Extension, error)
 // FileServer provides a handler for fetching extension repository files from
 // a client.
 FileServer() http.Handler