mirror of
1
Fork 0
forgejo/services
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
..
agit move agit dependcy (#19998) 2022-06-17 20:17:12 +02:00
asymkey Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
attachment Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
auth EscapeFilter the group dn membership (#20200) (#20254) 2022-07-06 20:51:40 +01:00
automerge Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08: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 code into models/git (#19879) 2022-06-12 23:51:54 +08:00
externalaccount Refactor auth package (#17962) 2022-01-02 21:12:35 +08:00
forms Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
gitdiff Remove legacy git code (ver < 2.0), fine tune markup tests (#19930) 2022-06-16 23:47:44 +08:00
issue Check if project has the same repository id with issue when assign project to issue (#20133) (#20188) 2022-07-01 15:00:05 +02:00
lfs Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
mailer Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
migrations Add more checks in migration code (#21011) (#21050) 2022-09-04 08:41:21 -05:00
mirror Always try to fetch repo for mirrors (#19975) 2022-06-15 23:58:44 +08:00
org Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
packages Use correct context to get package content (#20673) (#20676) 2022-08-05 14:55:16 -04:00
pull Prevent 500 is head repo does not have PullRequest unit in IsUserAllowedToUpdate (#20839) (#20848) 2022-08-18 14:55:34 -04:00
release Add more checks in migration code (#21011) (#21050) 2022-09-04 08:41:21 -05:00
repository Fix hard-coded timeout and error panic in API archive download endpoint (#20925) (#21051) 2022-09-06 07:54:47 +01:00
task Use a more general (and faster) method to sanitize URLs with credentials (#19239) 2022-03-31 10:25:40 +08:00
user Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
webhook fix(telegram): fix link bot to release tag (#19830) 2022-05-28 16:44:51 -04:00
wiki Move some helper files out of models (#19355) 2022-05-08 18:46:32 +02:00