forgejo/routers/api/packages
wxiaoguang b9a97ccd0e
Refactor web route (#24080)
The old code is unnecessarily complex, and has many misuses.

Old code "wraps" a lot, wrap wrap wrap, it's difficult to understand
which kind of handler is used.

The new code uses a general approach, we do not need to write all kinds
of handlers into the "wrapper", do not need to wrap them again and
again.

New code, there are only 2 concepts:

1. HandlerProvider: `func (h any) (handlerProvider func (next)
http.Handler)`, it can be used as middleware
2. Use HandlerProvider to get the final HandlerFunc, and use it for
`r.Get()`


And we can decouple the route package from context package (see the
TODO).

# FAQ

## Is `reflect` safe?

Yes, all handlers are checked during startup, see the `preCheckHandler`
comment. If any handler is wrong, developers could know it in the first
time.

## Does `reflect` affect performance?

No. https://github.com/go-gitea/gitea/pull/24080#discussion_r1164825901

1. This reflect code only runs for each web handler call, handler is far
more slower: 10ms-50ms
2. The reflect is pretty fast (comparing to other code): 0.000265ms
3. XORM has more reflect operations already
2023-04-20 14:49:06 -04:00
..
cargo Add Cargo package registry (#21888) 2023-02-05 18:12:31 +08:00
chef Use minio/sha256-simd for accelerated SHA256 (#23052) 2023-02-22 14:21:46 -05:00
composer Use ErrInvalidArgument in packages (#22268) 2022-12-31 12:49:37 +01:00
conan refactor auth interface to return error when verify failure (#22119) 2022-12-28 13:53:28 +08:00
conda Add Conda package registry (#22262) 2023-02-01 12:30:39 -06:00
container Add actions support to package auth verification (#23729) 2023-04-10 15:21:03 +08:00
generic Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
helm Use ErrInvalidArgument in packages (#22268) 2022-12-31 12:49:37 +01:00
helper Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
maven Use minio/sha256-simd for accelerated SHA256 (#23052) 2023-02-22 14:21:46 -05:00
npm Set repository link based on the url in package.json for npm packages (#20379) 2023-03-28 13:55:03 -04:00
nuget Add /$count endpoints for NuGet v2 (#22855) 2023-02-11 19:30:44 +08:00
pub Use ErrInvalidArgument in packages (#22268) 2022-12-31 12:49:37 +01:00
pypi Sort Python package descriptors by version to mimic PyPI format (#23550) 2023-03-19 15:19:37 +01:00
rubygems Use ErrInvalidArgument in packages (#22268) 2022-12-31 12:49:37 +01:00
swift Add Swift package registry (#22404) 2023-03-13 15:28:39 -05:00
vagrant Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
api.go Refactor web route (#24080) 2023-04-20 14:49:06 -04:00
README.md Add package registry architecture overview (#23445) 2023-03-13 18:15:09 -04:00

Gitea Package Registry

This document gives a brief overview how the package registry is organized in code.

Structure

The package registry code is divided into multiple modules to split the functionality and make code reuse possible.

Module Description
models/packages Common methods and models used by all registry types
models/packages/<type> Methods used by specific registry type. There should be no need to use type specific models.
modules/packages Common methods and types used by multiple registry types
modules/packages/<type> Registry type specific methods and types (e.g. metadata extraction of package files)
routers/api/packages Route definitions for all registry types
routers/api/packages/<type> Route implementation for a specific registry type
services/packages Helper methods used by registry types to handle common tasks like package creation and deletion in routers
services/packages/<type> Registry type specific methods used by routers and services

Models

Every package registry implementation uses the same underlaying models:

Model Description
Package The root of a package providing values fixed for every version (e.g. the package name)
PackageVersion A version of a package containing metadata (e.g. the package description)
PackageFile A file of a package describing its content (e.g. file name)
PackageBlob The content of a file (may be shared by multiple files)
PackageProperty Additional properties attached to Package, PackageVersion or PackageFile (e.g. used if metadata is needed for routing)

The following diagram shows the relationship between the models:

Package <1---*> PackageVersion <1---*> PackageFile <*---1> PackageBlob

Adding a new package registry type

Before adding a new package registry type have a look at the existing implementation to get an impression of how it could work. Most registry types offer endpoints to retrieve the metadata, upload and download package files. The upload endpoint is often the heavy part because it must validate the uploaded blob, extract metadata and create the models. The methods to validate and extract the metadata should be added in the modules/packages/<type> package. If the upload is valid the methods in services/packages allow to store the upload and create the corresponding models. It depends if the registry type allows multiple files per package version which method should be called:

  • CreatePackageAndAddFile: error if package version already exists
  • CreatePackageOrAddFileToExisting: error if file already exists
  • AddFileToExistingPackage: error if package version does not exist or file already exists

services/packages also contains helper methods to download a file or to remove a package version. There are no helper methods for metadata endpoints because they are very type specific.