gitea/services
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
..
agit Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
asymkey Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
attachment Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
auth Share HTML template renderers and create a watcher framework (#20218) 2022-08-28 10:43:25 +01:00
automerge Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
comments Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
context Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
cron Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
externalaccount Refactor auth package (#17962) 2022-01-02 21:12:35 +08:00
forms refactor webhook *NewPost (#20729) 2022-08-11 17:48:23 +02:00
gitdiff Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
issue Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
lfs Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
mailer Share HTML template renderers and create a watcher framework (#20218) 2022-08-28 10:43:25 +01:00
migrations Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
mirror Add new API endpoints for push mirrors management (#19841) 2022-07-30 18:45:59 +02:00
org Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
packages Replace `ServeStream` with `ServeContent` (#20903) 2022-08-25 12:05:21 -04:00
pull Prevent 500 is head repo does not have PullRequest unit in IsUserAllowedToUpdate (#20839) 2022-08-18 13:31:15 +03:00
release Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
repository fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
task Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
user Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
webhook Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
wiki Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00