forgejo/models/repo
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
..
archiver.go Fix hard-coded timeout and error panic in API archive download endpoint (#20925) (#21051) 2022-09-06 07:54:47 +01:00
attachment.go Add migrate repo archiver and packages storage support on command line (#20757) (#20806) 2022-08-18 09:27:56 +08:00
attachment_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
avatar.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
collaboration.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
collaboration_test.go Move tests as seperate sub packages to reduce duplicated file names (#19951) 2022-06-15 09:02:00 +02:00
fork.go Feature: Find files in repo (#15028) 2022-06-09 14:15:08 +03:00
fork_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
git.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
issue.go Prevent deadlock in create issue (#17970) 2021-12-13 17:59:39 -05:00
language_stats.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
main_test.go Feature: Find files in repo (#15028) 2022-06-09 14:15:08 +03:00
mirror.go In PushMirrorsIterate and MirrorsIterate if limit is negative do not set it (#20837) (#20899) 2022-08-23 12:38:52 -04:00
pushmirror.go In PushMirrorsIterate and MirrorsIterate if limit is negative do not set it (#20837) (#20899) 2022-08-23 12:38:52 -04:00
pushmirror_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
redirect.go Some repository refactors (#17950) 2021-12-12 23:48:20 +08:00
redirect_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
repo.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
repo_indexer.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
repo_list.go Add migrate repo archiver and packages storage support on command line (#20757) (#20806) 2022-08-18 09:27:56 +08:00
repo_list_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
repo_test.go Move tests as seperate sub packages to reduce duplicated file names (#19951) 2022-06-15 09:02:00 +02:00
repo_unit.go Custom regexp external issues (#17624) 2022-06-10 13:39:53 +08:00
star.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
star_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
topic.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
topic_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
update.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
user_repo.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
user_repo_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
watch.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
watch_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
wiki.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
wiki_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00