]> source.dussan.org Git - gitea.git/commit
Fix hard-coded timeout and error panic in API archive download endpoint (#20925)...
authorzeripath <art27@cantab.net>
Tue, 6 Sep 2022 06:54:47 +0000 (07:54 +0100)
committerGitHub <noreply@github.com>
Tue, 6 Sep 2022 06:54:47 +0000 (07:54 +0100)
commit06f968d662e3f49daeb9182cf1b6e4abc247df4e
tree935c4f0b0ded0d094930cbe16992c606dbd26325
parent084797b4dc56b6f9186bb20f6b09ae902a20a26a
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>
cmd/migrate_storage.go
models/repo.go
models/repo/archiver.go
modules/timeutil/timestamp.go
routers/api/v1/repo/file.go
routers/web/repo/repo.go
services/repository/archiver/archiver.go