gitea/routers/api/v1/repo
Peter Gardfjäll 4562d40fce
fix hard-coded timeout and error panic in API archive download endpoint (#20925)
* fix hard-coded timeout and error panic in API archive download endpoint

This commit updates the `GET /api/v1/repos/{owner}/{repo}/archive/{archive}`
endpoint which prior to this PR had a couple of issues.

1. The endpoint had a hard-coded 20s timeout for the archiver to complete after
   which a 500 (Internal Server Error) was returned to client. For a scripted
   API client there was no clear way of telling that the operation timed out and
   that it should retry.

2. Whenever the timeout _did occur_, the code used to panic. This was caused by
   the API endpoint "delegating" to the same call path as the web, which uses a
   slightly different way of reporting errors (HTML rather than JSON for
   example).

   More specifically, `api/v1/repo/file.go#GetArchive` just called through to
   `web/repo/repo.go#Download`, which expects the `Context` to have a `Render`
   field set, but which is `nil` for API calls. Hence, a `nil` pointer error.

The code addresses (1) by dropping the hard-coded timeout. Instead, any
timeout/cancelation on the incoming `Context` is used.

The code addresses (2) by updating the API endpoint to use a separate call path
for the API-triggered archive download. This avoids producing HTML-errors on
errors (it now produces JSON errors).

Signed-off-by: Peter Gardfjäll <peter.gardfjall.work@gmail.com>
2022-08-29 11:45:20 +02:00
..
blob.go RepoAssignment ensure to close before overwrite (#19449) 2022-04-21 17:17:57 +02:00
branch.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
collaborators.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
commits.go Pass gitRepo down to GetRawDiff, since its used for main repo and wiki (#19461) 2022-04-25 20:45:18 +02:00
file.go fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
fork.go Move access and repo permission to models/perm/access (#19350) 2022-05-11 12:09:36 +02:00
git_hook.go Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
git_ref.go Multiple Escaping Improvements (#17551) 2021-11-16 18:18:25 +00:00
hook.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
hook_test.go Decouple unit test, remove intermediate `unittestbridge` package (#17662) 2021-11-16 16:53:21 +08:00
issue.go Use correct page size for link header pagination (#20546) 2022-08-02 22:59:44 +08:00
issue_comment.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_label.go Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
issue_reaction.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_stopwatch.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_subscription.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_tracked_time.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
key.go Use `ctx` instead of `db.DefaultContext` in some packages(routers/services/modules) (#19163) 2022-03-22 16:22:54 +01:00
label.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
language.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
main_test.go Use queue instead of memory queue in webhook send service (#19390) 2022-04-25 20:03:01 +02:00
migrate.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
milestone.go fix: some typos (#19956) 2022-06-13 15:34:46 +08:00
mirror.go Add new API endpoints for push mirrors management (#19841) 2022-07-30 18:45:59 +02:00
notes.go RepoAssignment ensure to close before overwrite (#19449) 2022-04-21 17:17:57 +02:00
patch.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
pull.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
pull_review.go Dismiss prior pull reviews if done via web in review dismiss (#20197) 2022-07-19 15:20:28 +02:00
release.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
release_attachment.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
release_tags.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
repo.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
repo_test.go Renamed ctx.User to ctx.Doer. (#19161) 2022-03-22 15:03:22 +08:00
star.go Renamed ctx.User to ctx.Doer. (#19161) 2022-03-22 15:03:22 +08:00
status.go Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
subscriber.go Renamed ctx.User to ctx.Doer. (#19161) 2022-03-22 15:03:22 +08:00
tag.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
teams.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
topic.go Add missing return for when topic isn't found (#20351) 2022-07-13 18:39:19 +01:00
transfer.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
tree.go Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
wiki.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00