forgejo/routers/api/v1
Gergely Nagy 67fa52dedb
feat(quota): Quota enforcement
The previous commit laid out the foundation of the quota engine, this
one builds on top of it, and implements the actual enforcement.

Enforcement happens at the route decoration level, whenever possible. In
case of the API, when over quota, a 413 error is returned, with an
appropriate JSON payload. In case of web routes, a 413 HTML page is
rendered with similar information.

This implementation is for a **soft quota**: quota usage is checked
before an operation is to be performed, and the operation is *only*
denied if the user is already over quota. This makes it possible to go
over quota, but has the significant advantage of being practically
implementable within the current Forgejo architecture.

The goal of enforcement is to deny actions that can make the user go
over quota, and allow the rest. As such, deleting things should - in
almost all cases - be possible. A prime exemption is deleting files via
the web ui: that creates a new commit, which in turn increases repo
size, thus, is denied if the user is over quota.

Limitations
-----------

Because we generally work at a route decorator level, and rarely
look *into* the operation itself, `size:repos:public` and
`size:repos:private` are not enforced at this level, the engine enforces
against `size:repos:all`. This will be improved in the future.

AGit does not play very well with this system, because AGit PRs count
toward the repo they're opened against, while in the GitHub-style fork +
pull model, it counts against the fork. This too, can be improved in the
future.

There's very little done on the UI side to guard against going over
quota. What this patch implements, is enforcement, not prevention. The
UI will still let you *try* operations that *will* result in a denial.

Signed-off-by: Gergely Nagy <forgejo@gergo.csillger.hu>
2024-08-02 11:10:34 +02:00
..
activitypub add more integration testcases 2024-05-21 18:49:31 +02:00
admin feat(quota): Humble beginnings of a quota engine 2024-08-02 11:10:34 +02:00
misc
notify drop log.Error in ReadRepoNotifications 2024-03-24 07:12:31 +01:00
org feat(quota): Humble beginnings of a quota engine 2024-08-02 11:10:34 +02:00
packages
repo feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
settings
shared feat(quota): Humble beginnings of a quota engine 2024-08-02 11:10:34 +02:00
swagger feat(quota): Humble beginnings of a quota engine 2024-08-02 11:10:34 +02:00
user feat(quota): Humble beginnings of a quota engine 2024-08-02 11:10:34 +02:00
utils
api.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00