This repository has been archived on 2023-02-01. You can view files and clone it, but cannot push or open issues or pull requests.
gitea/routers/api/v1
zeripath 06f968d662
Fix hard-coded timeout and error panic in API archive download endpoint (#20925) (#21051)
Backport #20925

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>

Signed-off-by: Peter Gardfjäll <peter.gardfjall.work@gmail.com>
Signed-off-by: Andrew Thornton <art27@cantab.net>
Co-authored-by: Peter Gardfjäll <peter.gardfjall.work@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-09-06 07:54:47 +01:00
..
admin Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
misc Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
notify Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
org Fix owners cannot create organization repos bug (#20841) (#20854) 2022-08-18 14:54:48 -04:00
packages Hide private repositories in packages (#19584) 2022-05-07 18:21:15 +02:00
repo Fix hard-coded timeout and error panic in API archive download endpoint (#20925) (#21051) 2022-09-06 07:54:47 +01:00
settings Make mirror feature more configurable (#16957) 2021-09-07 17:49:36 +02:00
swagger Add API to query collaborators permission for a repository (#18761) 2022-04-29 14:24:38 +02:00
user Pad GPG Key ID with preceding zeroes (#20878) (#20885) 2022-08-22 19:35:18 +01:00
utils Use middleware to open gitRepo (#19559) 2022-04-30 16:32:01 +02:00
api.go Add write check for creating Commit status (#20332) (#20333) 2022-07-12 14:51:35 +02: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