From 4130feb1240dae180fc84f6f0c73ef2f7174fbf5 Mon Sep 17 00:00:00 2001 From: imgurbot12 Date: Wed, 29 Oct 2025 00:26:57 -0700 Subject: [PATCH 1/7] feat: new generic package version/file enumeration api endpoint --- routers/api/packages/api.go | 1 + routers/api/packages/generic/generic.go | 60 +++++++++++++++++++++++++ 2 files changed, 61 insertions(+) diff --git a/routers/api/packages/api.go b/routers/api/packages/api.go index f6ee5958b5bb9..bea5c385e1e31 100644 --- a/routers/api/packages/api.go +++ b/routers/api/packages/api.go @@ -336,6 +336,7 @@ func CommonRoutes() *web.Router { }) }, reqPackageAccess(perm.AccessModeRead)) r.Group("/generic", func() { + r.Get("/{packagename}/list", generic.EnumeratePackageVersions) r.Group("/{packagename}/{packageversion}", func() { r.Delete("", reqPackageAccess(perm.AccessModeWrite), generic.DeletePackage) r.Group("/{filename}", func() { diff --git a/routers/api/packages/generic/generic.go b/routers/api/packages/generic/generic.go index 5eb189e6d9c7b..1252c6868d5e8 100644 --- a/routers/api/packages/generic/generic.go +++ b/routers/api/packages/generic/generic.go @@ -12,6 +12,7 @@ import ( packages_model "code.gitea.io/gitea/models/packages" packages_module "code.gitea.io/gitea/modules/packages" + "code.gitea.io/gitea/modules/timeutil" "code.gitea.io/gitea/routers/api/packages/helper" "code.gitea.io/gitea/services/context" packages_service "code.gitea.io/gitea/services/packages" @@ -22,11 +23,70 @@ var ( filenameRegex = regexp.MustCompile(`\A[-_+=:;.()\[\]{}~!@#$%^& \w]+\z`) ) +// GenericPackageFileInfo represents information about an existing package file +// swagger:model +type GenericPackageFileInfo struct { + // Name of package file + Name string `json:"name"` + // swagger:strfmt date-time + // Date when package file was created/uploaded + CreatedUnix timeutil.TimeStamp `json:"created"` +} + +// GenericPackageInfo represents information about an existing package file +// swagger:model +type GenericPackageInfo struct { + /// Version linked to package information + Version string `json:"version"` + /// Download count for files within version + DownloadCount int64 `json:"downloads"` + /// Files uploaded for package version + Files []GenericPackageFileInfo `json:"files"` +} + func apiError(ctx *context.Context, status int, obj any) { message := helper.ProcessErrorForUser(ctx, status, obj) ctx.PlainText(status, message) } +// EnumeratePackageVersions lists upload versions and their associated files +func EnumeratePackageVersions(ctx *context.Context) { + pvs, err := packages_model.GetVersionsByPackageName(ctx, ctx.Package.Owner.ID, packages_model.TypeGeneric, ctx.PathParam("packagename")) + if err != nil { + apiError(ctx, http.StatusInternalServerError, err) + return + } + if len(pvs) == 0 { + apiError(ctx, http.StatusNotFound, err) + return + } + + var info []GenericPackageInfo + for _, pv := range pvs { + packageFiles, err := packages_model.GetFilesByVersionID(ctx, pv.ID) + if err != nil { + apiError(ctx, http.StatusInternalServerError, err) + return + } + + var files []GenericPackageFileInfo + for _, file := range packageFiles { + files = append(files, GenericPackageFileInfo{ + Name: file.Name, + CreatedUnix: file.CreatedUnix, + }) + } + + info = append(info, GenericPackageInfo{ + Version: pv.Version, + DownloadCount: pv.DownloadCount, + Files: files, + }) + } + + ctx.JSON(http.StatusOK, info) +} + // DownloadPackageFile serves the specific generic package. func DownloadPackageFile(ctx *context.Context) { s, u, pf, err := packages_service.OpenFileForDownloadByPackageNameAndVersion( From b4efc0e726e2ab52e7f518ccba5036bf69740fce Mon Sep 17 00:00:00 2001 From: imgurbot12 Date: Wed, 29 Oct 2025 00:49:23 -0700 Subject: [PATCH 2/7] fix: i forgor to run lint again after changing the struct names. unchanged the names --- routers/api/packages/generic/generic.go | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/routers/api/packages/generic/generic.go b/routers/api/packages/generic/generic.go index 1252c6868d5e8..a410dfda51132 100644 --- a/routers/api/packages/generic/generic.go +++ b/routers/api/packages/generic/generic.go @@ -23,9 +23,9 @@ var ( filenameRegex = regexp.MustCompile(`\A[-_+=:;.()\[\]{}~!@#$%^& \w]+\z`) ) -// GenericPackageFileInfo represents information about an existing package file +// PackageFileInfo represents information about an existing package file // swagger:model -type GenericPackageFileInfo struct { +type PackageFileInfo struct { // Name of package file Name string `json:"name"` // swagger:strfmt date-time @@ -33,15 +33,15 @@ type GenericPackageFileInfo struct { CreatedUnix timeutil.TimeStamp `json:"created"` } -// GenericPackageInfo represents information about an existing package file +// PackageInfo represents information about an existing package file // swagger:model -type GenericPackageInfo struct { +type PackageInfo struct { /// Version linked to package information Version string `json:"version"` /// Download count for files within version DownloadCount int64 `json:"downloads"` /// Files uploaded for package version - Files []GenericPackageFileInfo `json:"files"` + Files []PackageFileInfo `json:"files"` } func apiError(ctx *context.Context, status int, obj any) { @@ -61,7 +61,7 @@ func EnumeratePackageVersions(ctx *context.Context) { return } - var info []GenericPackageInfo + var info []PackageInfo for _, pv := range pvs { packageFiles, err := packages_model.GetFilesByVersionID(ctx, pv.ID) if err != nil { @@ -69,15 +69,15 @@ func EnumeratePackageVersions(ctx *context.Context) { return } - var files []GenericPackageFileInfo + var files []PackageFileInfo for _, file := range packageFiles { - files = append(files, GenericPackageFileInfo{ + files = append(files, PackageFileInfo{ Name: file.Name, CreatedUnix: file.CreatedUnix, }) } - info = append(info, GenericPackageInfo{ + info = append(info, PackageInfo{ Version: pv.Version, DownloadCount: pv.DownloadCount, Files: files, From 119a984223c655c05a62c42e66b27ce5d6b44c05 Mon Sep 17 00:00:00 2001 From: imgurbot12 Date: Wed, 5 Nov 2025 19:12:25 -0700 Subject: [PATCH 3/7] chore: renamed endpoint, and added unit-tests --- routers/api/packages/api.go | 2 +- routers/api/packages/generic/generic.go | 4 +-- .../integration/api_packages_generic_test.go | 31 +++++++++++++++++++ tests/integration/api_packages_test.go | 12 ++++++- 4 files changed, 45 insertions(+), 4 deletions(-) diff --git a/routers/api/packages/api.go b/routers/api/packages/api.go index bea5c385e1e31..2b9ccb295d832 100644 --- a/routers/api/packages/api.go +++ b/routers/api/packages/api.go @@ -336,7 +336,7 @@ func CommonRoutes() *web.Router { }) }, reqPackageAccess(perm.AccessModeRead)) r.Group("/generic", func() { - r.Get("/{packagename}/list", generic.EnumeratePackageVersions) + r.Get("/{packagename}/list", generic.ListPackageVersions) r.Group("/{packagename}/{packageversion}", func() { r.Delete("", reqPackageAccess(perm.AccessModeWrite), generic.DeletePackage) r.Group("/{filename}", func() { diff --git a/routers/api/packages/generic/generic.go b/routers/api/packages/generic/generic.go index a410dfda51132..6655e3beac96c 100644 --- a/routers/api/packages/generic/generic.go +++ b/routers/api/packages/generic/generic.go @@ -49,8 +49,8 @@ func apiError(ctx *context.Context, status int, obj any) { ctx.PlainText(status, message) } -// EnumeratePackageVersions lists upload versions and their associated files -func EnumeratePackageVersions(ctx *context.Context) { +// ListPackageVersions lists upload versions and their associated files +func ListPackageVersions(ctx *context.Context) { pvs, err := packages_model.GetVersionsByPackageName(ctx, ctx.Package.Owner.ID, packages_model.TypeGeneric, ctx.PathParam("packagename")) if err != nil { apiError(ctx, http.StatusInternalServerError, err) diff --git a/tests/integration/api_packages_generic_test.go b/tests/integration/api_packages_generic_test.go index ae0506d48bab2..fb3dbb2aea6a0 100644 --- a/tests/integration/api_packages_generic_test.go +++ b/tests/integration/api_packages_generic_test.go @@ -5,6 +5,7 @@ package integration import ( "bytes" + "encoding/json" "fmt" "io" "net/http" @@ -15,6 +16,8 @@ import ( user_model "code.gitea.io/gitea/models/user" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/test" + "code.gitea.io/gitea/modules/timeutil" + "code.gitea.io/gitea/routers/api/packages/generic" "code.gitea.io/gitea/tests" "github.com/stretchr/testify/assert" @@ -30,7 +33,9 @@ func TestPackageGeneric(t *testing.T) { filename := "fi-le_na.me" content := []byte{1, 2, 3} + timestamp := timeutil.TimeStampNow().AsTime().Unix() url := fmt.Sprintf("/api/packages/%s/generic/%s/%s", user.Name, packageName, packageVersion) + listUrl := fmt.Sprintf("/api/packages/%s/generic/%s/list", user.Name, packageName) t.Run("Upload", func(t *testing.T) { defer tests.PrintCurrentTest(t)() @@ -98,6 +103,32 @@ func TestPackageGeneric(t *testing.T) { }) }) + t.Run("List", func(t *testing.T) { + defer tests.PrintCurrentTest(t)() + + req := NewRequest(t, "GET", listUrl) + resp := MakeRequest(t, req, http.StatusOK) + + var expected []generic.PackageInfo + err := json.Unmarshal(resp.Body.Bytes(), &expected) + assert.NoError(t, err) + + assert.Equal(t, len(expected), 1) + assert.Equal(t, len(expected[0].Files), 2) + + resPkg := expected[0] + assert.Equal(t, resPkg.Version, packageVersion) + assert.Equal(t, resPkg.DownloadCount, int64(0)) + + resFile1 := expected[0].Files[0] + assert.Equal(t, resFile1.Name, filename) + assert.GreaterOrEqual(t, resFile1.CreatedUnix, timestamp) + + resFile2 := expected[0].Files[1] + assert.Equal(t, resFile2.Name, "dummy.bin") + assert.GreaterOrEqual(t, resFile2.CreatedUnix, timestamp) + }) + t.Run("Download", func(t *testing.T) { defer tests.PrintCurrentTest(t)() diff --git a/tests/integration/api_packages_test.go b/tests/integration/api_packages_test.go index 4fbb31b11ff60..0f40865522b3f 100644 --- a/tests/integration/api_packages_test.go +++ b/tests/integration/api_packages_test.go @@ -249,6 +249,15 @@ func TestPackageAccess(t *testing.T) { MakeRequest(t, req, expectedStatus) } + listPackage := func(doer, owner *user_model.User, expectedStatus int) { + url := fmt.Sprintf("/api/packages/%s/generic/test-package/list", owner.Name) + req := NewRequest(t, "GET", url) + if doer != nil { + req.AddBasicAuth(doer.Name) + } + MakeRequest(t, req, expectedStatus) + } + type Target struct { Owner *user_model.User ExpectedStatus int @@ -339,7 +348,7 @@ func TestPackageAccess(t *testing.T) { } }) - t.Run("Download", func(t *testing.T) { + t.Run("List/Download", func(t *testing.T) { defer tests.PrintCurrentTest(t)() cases := []struct { @@ -416,6 +425,7 @@ func TestPackageAccess(t *testing.T) { for _, c := range cases { for _, target := range c.Targets { downloadPackage(c.Doer, target.Owner, target.ExpectedStatus) + listPackage(c.Doer, target.Owner, target.ExpectedStatus) } } }) From 4f878a1cdda18d9f9a24c01c52d7aac2da686808 Mon Sep 17 00:00:00 2001 From: imgurbot12 Date: Wed, 5 Nov 2025 19:21:14 -0700 Subject: [PATCH 4/7] fix: linter fixes --- .../integration/api_packages_generic_test.go | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/tests/integration/api_packages_generic_test.go b/tests/integration/api_packages_generic_test.go index fb3dbb2aea6a0..aa9d8acd11247 100644 --- a/tests/integration/api_packages_generic_test.go +++ b/tests/integration/api_packages_generic_test.go @@ -5,7 +5,6 @@ package integration import ( "bytes" - "encoding/json" "fmt" "io" "net/http" @@ -14,6 +13,7 @@ import ( "code.gitea.io/gitea/models/packages" "code.gitea.io/gitea/models/unittest" user_model "code.gitea.io/gitea/models/user" + "code.gitea.io/gitea/modules/json" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/test" "code.gitea.io/gitea/modules/timeutil" @@ -35,7 +35,7 @@ func TestPackageGeneric(t *testing.T) { timestamp := timeutil.TimeStampNow().AsTime().Unix() url := fmt.Sprintf("/api/packages/%s/generic/%s/%s", user.Name, packageName, packageVersion) - listUrl := fmt.Sprintf("/api/packages/%s/generic/%s/list", user.Name, packageName) + listURL := fmt.Sprintf("/api/packages/%s/generic/%s/list", user.Name, packageName) t.Run("Upload", func(t *testing.T) { defer tests.PrintCurrentTest(t)() @@ -106,27 +106,27 @@ func TestPackageGeneric(t *testing.T) { t.Run("List", func(t *testing.T) { defer tests.PrintCurrentTest(t)() - req := NewRequest(t, "GET", listUrl) + req := NewRequest(t, "GET", listURL) resp := MakeRequest(t, req, http.StatusOK) var expected []generic.PackageInfo err := json.Unmarshal(resp.Body.Bytes(), &expected) assert.NoError(t, err) - assert.Equal(t, len(expected), 1) - assert.Equal(t, len(expected[0].Files), 2) + assert.Len(t, expected, 1) + assert.Len(t, expected[0].Files, 2) resPkg := expected[0] - assert.Equal(t, resPkg.Version, packageVersion) - assert.Equal(t, resPkg.DownloadCount, int64(0)) + assert.Equal(t, packageVersion, resPkg.Version) + assert.Equal(t, int64(0), resPkg.DownloadCount) resFile1 := expected[0].Files[0] - assert.Equal(t, resFile1.Name, filename) - assert.GreaterOrEqual(t, resFile1.CreatedUnix, timestamp) + assert.Equal(t, filename, resFile1.Name) + assert.LessOrEqual(t, timestamp, resFile1.CreatedUnix) resFile2 := expected[0].Files[1] - assert.Equal(t, resFile2.Name, "dummy.bin") - assert.GreaterOrEqual(t, resFile2.CreatedUnix, timestamp) + assert.Equal(t, "dummy.bin", resFile2.Name) + assert.LessOrEqual(t, timestamp, resFile2.CreatedUnix) }) t.Run("Download", func(t *testing.T) { From 451a64e98f60d2383e9d73e662723267329a4d80 Mon Sep 17 00:00:00 2001 From: imgurbot12 Date: Wed, 5 Nov 2025 20:04:53 -0700 Subject: [PATCH 5/7] fix: json results are ordered differently in different db engines for some reason --- tests/integration/api_packages_generic_test.go | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/tests/integration/api_packages_generic_test.go b/tests/integration/api_packages_generic_test.go index aa9d8acd11247..fcc5c6294c856 100644 --- a/tests/integration/api_packages_generic_test.go +++ b/tests/integration/api_packages_generic_test.go @@ -8,6 +8,7 @@ import ( "fmt" "io" "net/http" + "sort" "testing" "code.gitea.io/gitea/models/packages" @@ -120,12 +121,17 @@ func TestPackageGeneric(t *testing.T) { assert.Equal(t, packageVersion, resPkg.Version) assert.Equal(t, int64(0), resPkg.DownloadCount) - resFile1 := expected[0].Files[0] - assert.Equal(t, filename, resFile1.Name) + // json results are ordered differently in different db engines for some reason + sort.Slice(resPkg.Files, func(i, j int) bool { + return resPkg.Files[i].Name < resPkg.Files[j].Name + }) + + resFile1 := resPkg.Files[0] + assert.Equal(t, "dummy.bin", resFile1.Name) assert.LessOrEqual(t, timestamp, resFile1.CreatedUnix) - resFile2 := expected[0].Files[1] - assert.Equal(t, "dummy.bin", resFile2.Name) + resFile2 := resPkg.Files[1] + assert.Equal(t, filename, resFile2.Name) assert.LessOrEqual(t, timestamp, resFile2.CreatedUnix) }) From 885cd085253d80628fe77f4865c83e9985f91d3c Mon Sep 17 00:00:00 2001 From: imgurbot12 Date: Thu, 6 Nov 2025 01:26:28 -0700 Subject: [PATCH 6/7] chore: move sorting to db execution with OrderBy --- models/packages/package_file.go | 2 +- tests/integration/api_packages_generic_test.go | 10 ++-------- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/models/packages/package_file.go b/models/packages/package_file.go index bf877485d62a6..4a2674c97c53e 100644 --- a/models/packages/package_file.go +++ b/models/packages/package_file.go @@ -68,7 +68,7 @@ func TryInsertFile(ctx context.Context, pf *PackageFile) (*PackageFile, error) { // GetFilesByVersionID gets all files of a version func GetFilesByVersionID(ctx context.Context, versionID int64) ([]*PackageFile, error) { pfs := make([]*PackageFile, 0, 10) - return pfs, db.GetEngine(ctx).Where("version_id = ?", versionID).Find(&pfs) + return pfs, db.GetEngine(ctx).OrderBy("id").Where("version_id = ?", versionID).Find(&pfs) } // GetFileForVersionByID gets a file of a version by id diff --git a/tests/integration/api_packages_generic_test.go b/tests/integration/api_packages_generic_test.go index fcc5c6294c856..7573351a8d530 100644 --- a/tests/integration/api_packages_generic_test.go +++ b/tests/integration/api_packages_generic_test.go @@ -8,7 +8,6 @@ import ( "fmt" "io" "net/http" - "sort" "testing" "code.gitea.io/gitea/models/packages" @@ -121,17 +120,12 @@ func TestPackageGeneric(t *testing.T) { assert.Equal(t, packageVersion, resPkg.Version) assert.Equal(t, int64(0), resPkg.DownloadCount) - // json results are ordered differently in different db engines for some reason - sort.Slice(resPkg.Files, func(i, j int) bool { - return resPkg.Files[i].Name < resPkg.Files[j].Name - }) - resFile1 := resPkg.Files[0] - assert.Equal(t, "dummy.bin", resFile1.Name) + assert.Equal(t, filename, resFile1.Name) assert.LessOrEqual(t, timestamp, resFile1.CreatedUnix) resFile2 := resPkg.Files[1] - assert.Equal(t, filename, resFile2.Name) + assert.Equal(t, "dummy.bin", resFile2.Name) assert.LessOrEqual(t, timestamp, resFile2.CreatedUnix) }) From a9b81b00fe8808d990e0f42091c37fecdb4a9d6b Mon Sep 17 00:00:00 2001 From: imgurbot12 Date: Thu, 6 Nov 2025 11:28:09 -0700 Subject: [PATCH 7/7] fix: explicit sort id ascending --- models/packages/package_file.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/models/packages/package_file.go b/models/packages/package_file.go index 4a2674c97c53e..4d114832c3a96 100644 --- a/models/packages/package_file.go +++ b/models/packages/package_file.go @@ -68,7 +68,7 @@ func TryInsertFile(ctx context.Context, pf *PackageFile) (*PackageFile, error) { // GetFilesByVersionID gets all files of a version func GetFilesByVersionID(ctx context.Context, versionID int64) ([]*PackageFile, error) { pfs := make([]*PackageFile, 0, 10) - return pfs, db.GetEngine(ctx).OrderBy("id").Where("version_id = ?", versionID).Find(&pfs) + return pfs, db.GetEngine(ctx).OrderBy("id ASC").Where("version_id = ?", versionID).Find(&pfs) } // GetFileForVersionByID gets a file of a version by id