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/web
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 Redirect if user does not exist on admin pages (#20981) (#21059) 2022-09-04 12:17:35 -04:00
auth WebAuthn CredentialID field needs to be increased in size (#20530) (#20555) 2022-07-30 20:16:25 +02:00
dev Move user related model into models/user (#17781) 2021-11-24 17:49:20 +08:00
events Improve Stopwatch behavior (#18930) 2022-04-25 22:45:22 +02:00
explore In code search, get code unit accessible repos in one (main) query (#19764) 2022-06-16 02:24:10 +03:00
feed Add ContextUser to http request context (#18798) 2022-03-26 17:04:22 +08:00
healthcheck Update go-chi/cache to utilize Ping() (#19719) 2022-05-15 20:43:27 +02:00
misc Fix panic in team repos API (#19431) 2022-04-20 18:43:26 +08:00
org Fix SQL Query for SearchTeam (#20844) (#20872) 2022-08-21 19:31:51 +01:00
repo Fix hard-coded timeout and error panic in API archive download endpoint (#20925) (#21051) 2022-09-06 07:54:47 +01:00
user Remove calls to load Mirrors in user.Dashboard (#20855) (#20897) 2022-08-22 09:46:56 +08: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
base.go Add Cache-Control header to html and api responses, add no-transform (#20432) (#20459) 2022-07-23 11:58:58 +01:00
goget.go Refactor legacy unknwon/com package, improve golangci lint (#19284) 2022-04-01 16:47:50 +08:00
home.go Renamed ctx.User to ctx.Doer. (#19161) 2022-03-22 15:03:22 +08:00
metrics.go Update HTTP status codes to modern codes (#18063) 2022-03-23 12:54:07 +08:00
nodeinfo.go Add nodeinfo endpoint for federation purposes (#16953) 2021-09-28 01:38:06 +02:00
swagger_json.go Refactor routers directory (#15800) 2021-06-09 01:33:54 +02:00
web.go Add disable download source configuration (#20548) (#20579) 2022-08-12 23:53:10 +08:00
webfinger.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00