forgejo/routers/api/v1/repo
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
..
action.go [API] Add error messages to dispatch API 2024-07-31 21:09:17 +02:00
avatar.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
blob.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
branch.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
collaborators.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
commits.go [BUG] Use correct SHA in GetCommitPullRequest 2024-07-06 22:04:31 +02:00
compare.go Enable unparam linter (#31277) 2024-06-16 13:42:58 +02:00
file.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
flags.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
fork.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
git_hook.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
git_ref.go Add codespell support and fix a good number of typos with its help (#3270) 2024-05-09 13:49:37 +00:00
hook.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
hook_test.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue.go fix(api): issue state change is not idempotent 2024-07-25 15:16:44 +02:00
issue_attachment.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
issue_comment.go Load attachments for /issues/comments/{id} 2024-07-16 11:09:54 +02:00
issue_comment_attachment.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
issue_dependency.go Fix missed doer (#30231) 2024-04-15 20:01:35 +02:00
issue_label.go Support using label names when changing issue labels (#30943) 2024-05-19 13:12:35 +02:00
issue_pin.go Fix missed doer (#30231) 2024-04-15 20:01:35 +02:00
issue_reaction.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue_stopwatch.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
issue_subscription.go Add codespell support and fix a good number of typos with its help (#3270) 2024-05-09 13:49:37 +00:00
issue_tracked_time.go Fix missed doer (#30231) 2024-04-15 20:01:35 +02:00
key.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
label.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
language.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
main_test.go make writing main test easier (#27270) 2023-09-28 01:38:53 +00:00
migrate.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
milestone.go remove util.OptionalBool and related functions (#29513) 2024-03-06 12:10:46 +08:00
mirror.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
notes.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
patch.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
pull.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
pull_review.go Prevent allow/reject reviews on merged/closed PRs (#30686) 2024-04-28 15:39:01 +02:00
release.go Implement external assets 2024-07-29 20:35:55 +02:00
release_attachment.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
release_tags.go Protected tag is no internal server error (#30962) 2024-05-19 13:12:35 +02:00
repo.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
repo_test.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
star.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
status.go Cache repository default branch commit status to reduce query on commit status table (#29444) 2024-03-11 23:36:58 +07:00
subscriber.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
tag.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
teams.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
topic.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
transfer.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00
tree.go Move context from modules to services (#29440) 2024-03-06 12:10:43 +08:00
wiki.go feat(quota): Quota enforcement 2024-08-02 11:10:34 +02:00