forgejo/routers/api/v1
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
..
activitypub Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
admin Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
misc Share HTML template renderers and create a watcher framework (#20218) 2022-08-28 10:43:25 +01:00
notify Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
org Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
packages Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
repo fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
settings Make mirror feature more configurable (#16957) 2021-09-07 17:49:36 +02:00
swagger Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
user Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
utils refactor webhook *NewPost (#20729) 2022-08-11 17:48:23 +02:00
api.go Share HTML template renderers and create a watcher framework (#20218) 2022-08-28 10:43:25 +01:00
auth.go Remove legacy +build: constraint (#19582) 2022-05-02 23:22:45 +08:00
auth_windows.go Let web and API routes have different auth methods group (#19168) 2022-03-28 12:46:28 +08:00