bring back list

Author: andreasjansson

README.md

@@ -40,7 +40,7 @@ model: "model.py:JazzSoloComposerModel"
 3. Build and push the model:
 
 ```
-$ cog repo set http://10.1.2.3:8000
+$ cog repo set http://10.1.2.3:8000/andreas/my-model
 $ cog build
 ...
 --> Built and pushed b6a2f8a2d2ff
@@ -86,6 +86,10 @@ You can see more details about the package:
 
     cog show b31f9f72d8f14f0eacc5452e85b05c957b9a8ed9
 
+You can also list the packages for this repo:
+
+    cog list
+
 In this output is the Docker image. You can run this anywhere a Docker image runs to deploy your model.
 
 
@@ -116,7 +120,7 @@ This does the following:
 * Tests that the model works by running the Docker image locally and performing an inference
 * Inserts model metadata into database (local files)
 
-### GET `/v1/packages/<user>/<name>`
+### GET `/v1/packages/<user>/<name>/<id>`
 
 Fetch package metadata.
 
@@ -149,6 +153,24 @@ $ curl localhost:8080/v1/packages/andreas/my-model/c43b98b37776656e6b3dac3ea3270
 }
 ```
 
+### GET `/v1/packages/<user>/<name>`
+
+List all packages' metadata.
+
+Example:
+
+```
+$ curl localhost:8080/v1/packages/andreas/my-model/ | jq .
+[
+  {
+    "ID": "c43b98b37776656e6b3dac3ea3270660ffc21ca7",
+    "Artifacts": [
+      {
+        "Target": "docker-cpu",
+  [...]
+]
+```
+
 ### GET `/v1/packages/<user>/<name>/<id>.zip`
 
 Download the package.

end-to-end-test/end_to_end_test/test_server.py

@@ -115,6 +115,10 @@ def run(self, text, path):
     assert lines[0] == f"ID:       {package_id}"
     assert lines[1] == f"Repo:     {user}/{repo_name}"
 
+    out, _ = subprocess.Popen(["cog", "-r", repo, "ls"], stdout=subprocess.PIPE).communicate()
+    lines = out.decode().splitlines()
+    assert lines[1].startswith(f"{package_id}  ")
+
     download_dir = tmpdir_factory.mktemp("download") / "my-dir"
     subprocess.Popen(
         ["cog", "-r", repo, "download", "--output-dir", download_dir, package_id],

pkg/cli/list.go

@@ -0,0 +1,47 @@
+package cli
+
+import (
+	"fmt"
+	"os"
+	"text/tabwriter"
+
+	"github.com/spf13/cobra"
+	"github.com/xeonx/timeago"
+
+	"github.com/replicate/cog/pkg/client"
+)
+
+func newListCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "list",
+		Short:   "List Cog packages",
+		RunE:    listPackages,
+		Args:    cobra.NoArgs,
+		Aliases: []string{"ls"},
+	}
+	addRepoFlag(cmd)
+
+	return cmd
+}
+
+func listPackages(cmd *cobra.Command, args []string) error {
+	repo, err := getRepo()
+	if err != nil {
+		return err
+	}
+
+	cli := client.NewClient()
+	models, err := cli.ListPackages(repo)
+	if err != nil {
+		return err
+	}
+
+	w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+	fmt.Fprintln(w, "ID\tCREATED")
+	for _, mod := range models {
+		fmt.Fprintf(w, "%s\t%s\n", mod.ID, timeago.English.Format(mod.Created))
+	}
+	w.Flush()
+
+	return nil
+}

pkg/cli/root.go

@@ -35,6 +35,7 @@ func NewRootCommand() (*cobra.Command, error) {
 		newShowCommand(),
 		newRepoCommand(),
 		newDownloadCommand(),
+		newListCommand(),
 	)
 
 	log.SetLevel(log.DebugLevel)

pkg/client/list.go

@@ -0,0 +1,28 @@
+package client
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/replicate/cog/pkg/model"
+)
+
+func (c *Client) ListPackages(repo *model.Repo) ([]*model.Model, error) {
+	url := fmt.Sprintf("http://%s/v1/repos/%s/%s/packages/", repo.Host, repo.User, repo.Name)
+	resp, err := http.Get(url)
+	if err != nil {
+		return nil, err
+	}
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, fmt.Errorf("List endpoint returned status %d", resp.StatusCode)
+	}
+
+	models := []*model.Model{}
+	if err := json.NewDecoder(resp.Body).Decode(&models); err != nil {
+		return nil, fmt.Errorf("Failed to decode response: %w", err)
+	}
+
+	return models, nil
+}

pkg/database/database.go

@@ -7,5 +7,6 @@ import (
 type Database interface {
 	InsertModel(user string, name string, id string, mod *model.Model) error
 	GetModel(user string, name string, id string) (*model.Model, error)
+	ListModels(user string, name string) ([]*model.Model, error)
 	DeleteModel(user string, name string, id string) error
 }

pkg/database/local.go

@@ -6,6 +6,8 @@ import (
 	"os"
 	"path/filepath"
 
+	"strings"
+
 	"github.com/replicate/cog/pkg/files"
 	"github.com/replicate/cog/pkg/model"
 )
@@ -82,6 +84,27 @@ func (db *LocalFileDatabase) DeleteModel(user string, name string, id string) er
 	return nil
 }
 
+func (db *LocalFileDatabase) ListModels(user string, name string) ([]*model.Model, error) {
+	repoDir := db.repoDir(user, name)
+	entries, err := os.ReadDir(repoDir)
+	if err != nil {
+		return nil, fmt.Errorf("Failed to scan %s: %w", db.rootDir, err)
+	}
+	models := []*model.Model{}
+	for _, entry := range entries {
+		filename := entry.Name()
+		if strings.HasSuffix(filename, ".json") {
+			path := filepath.Join(repoDir, filename)
+			mod, err := db.readModel(path)
+			if err != nil {
+				return nil, err
+			}
+			models = append(models, mod)
+		}
+	}
+	return models, nil
+}
+
 func (db *LocalFileDatabase) readModel(path string) (*model.Model, error) {
 	contents, err := os.ReadFile(path)
 	if err != nil {
@@ -95,5 +118,9 @@ func (db *LocalFileDatabase) readModel(path string) (*model.Model, error) {
 }
 
 func (db *LocalFileDatabase) packagePath(user string, name string, id string) string {
-	return filepath.Join(db.rootDir, user, name, id+".json")
+	return filepath.Join(db.repoDir(user, name), id+".json")
+}
+
+func (db *LocalFileDatabase) repoDir(user string, name string) string {
+	return filepath.Join(db.rootDir, user, name)
 }

pkg/server/server.go

@@ -51,22 +51,25 @@ func NewServer(port int, db database.Database, dockerImageBuilder docker.ImageBu
 func (s *Server) Start() error {
 	router := mux.NewRouter()
 	router.Path("/ping").
-		Methods("GET").
+		Methods(http.MethodGet).
 		HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			log.Info("Received ping request")
 			w.Write([]byte("pong"))
 		})
 	router.Path("/v1/repos/{user}/{name}/packages/{id}.zip").
-		Methods("GET").
+		Methods(http.MethodGet).
 		HandlerFunc(s.SendModelPackage)
 	router.Path("/v1/repos/{user}/{name}/packages/").
-		Methods("PUT").
+		Methods(http.MethodPut).
 		HandlerFunc(s.ReceiveFile)
+	router.Path("/v1/repos/{user}/{name}/packages/").
+		Methods(http.MethodGet).
+		HandlerFunc(s.ListPackages)
 	router.Path("/v1/repos/{user}/{name}/packages/{id}").
-		Methods("GET").
+		Methods(http.MethodGet).
 		HandlerFunc(s.SendModelMetadata)
 	router.Path("/v1/repos/{user}/{name}/packages/{id}").
-		Methods("DELETE").
+		Methods(http.MethodDelete).
 		HandlerFunc(s.DeletePackage)
 	fmt.Println("Starting")
 	return http.ListenAndServe(fmt.Sprintf(":%d", s.port), router)
@@ -136,6 +139,26 @@ func (s *Server) SendModelMetadata(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+func (s *Server) ListPackages(w http.ResponseWriter, r *http.Request) {
+	user, name, _ := getRepoVars(r)
+	log.Infof("Received list request for %s%s", user, name)
+
+	models, err := s.db.ListModels(user, name)
+	if err != nil {
+		log.Error(err)
+		w.WriteHeader(http.StatusInternalServerError)
+		return
+	}
+	w.WriteHeader(http.StatusOK)
+	w.Header().Set("Content-Type", "application/json")
+
+	if err := json.NewEncoder(w).Encode(models); err != nil {
+		log.Error(err)
+		w.WriteHeader(http.StatusInternalServerError)
+		return
+	}
+}
+
 func (s *Server) DeletePackage(w http.ResponseWriter, r *http.Request) {
 	user, name, id := getRepoVars(r)
 	log.Infof("Received delete request for %s/%s/%s", user, name, id)