forgejo/models
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 Use a struct as test options (#19393) 2022-04-14 21:58:21 +08:00
appstate
asymkey Pad GPG Key ID with preceding zeroes (#20878) (#20885) 2022-08-22 19:35:18 +01:00
auth Fix panic when an invalid oauth2 name is passed (#20820) (#20900) 2022-08-21 23:23:48 -04:00
avatars
db Add migrate repo archiver and packages storage support on command line (#20757) (#20806) 2022-08-18 09:27:56 +08:00
fixtures Fix SQL Query for SearchTeam (#20844) (#20872) 2022-08-21 19:31:51 +01:00
foreignreference
git Add migrate repo archiver and packages storage support on command line (#20757) (#20806) 2022-08-18 09:27:56 +08:00
issues Fix missed sort bug (#21006) 2022-08-31 23:40:29 +08:00
migrations Add another index for Action table on postgres (#21033) (#21054) 2022-09-04 16:11:02 +01:00
organization Fix SQL Query for SearchTeam (#20844) (#20872) 2022-08-21 19:31:51 +01:00
packages Fix delete user missed some comments (#21067) (#21068) 2022-09-06 06:48:57 +08:00
perm Store read access in access for team repo's (#20275) (#20276) 2022-07-09 20:01:44 +02:00
project Use correct count for NumOpenIssues (#19980) 2022-06-16 10:51:34 +08:00
pull Delete related PullAutoMerge and ReviewState on User/Repo Deletion (#19649) 2022-05-08 15:46:34 +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
unit Fix incorrect translation key (#19744) 2022-05-19 09:59:28 +08:00
unittest Use git.HOME_PATH for Git HOME directory (#20114) (#20293) 2022-07-08 21:44:36 +08:00
user Add migrate repo archiver and packages storage support on command line (#20757) (#20806) 2022-08-18 09:27:56 +08:00
webhook Check webhooks slice length before calling xorm (#20642) (#20768) 2022-08-12 11:36:45 +03:00
action.go Add another index for Action table on postgres (#21033) (#21054) 2022-09-04 16:11:02 +01:00
action_list.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
action_test.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
consistency.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
error.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
fixture_generation.go Move access and repo permission to models/perm/access (#19350) 2022-05-11 12:09:36 +02:00
fixture_test.go
main_test.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
migrate.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
migrate_test.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
notification.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
notification_test.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
org.go In code search, get code unit accessible repos in one (main) query (#19764) 2022-06-16 02:24:10 +03:00
org_team.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
org_team_test.go Move access and repo permission to models/perm/access (#19350) 2022-05-11 12:09:36 +02:00
org_test.go Move tests as seperate sub packages to reduce duplicated file names (#19951) 2022-06-15 09:02:00 +02:00
release.go improvement some release related code (#19867) 2022-06-03 02:13:58 -04:00
repo.go Fix hard-coded timeout and error panic in API archive download endpoint (#20925) (#21051) 2022-09-06 07:54:47 +01:00
repo_activity.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
repo_collaboration.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
repo_collaboration_test.go Move tests as seperate sub packages to reduce duplicated file names (#19951) 2022-06-15 09:02:00 +02: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_transfer.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
repo_transfer_test.go
statistic.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
task.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2022-05-20 22:08:52 +08:00
token.go
token_test.go
upload.go
user.go Fix delete user missed some comments (#21067) (#21068) 2022-09-06 06:48:57 +08:00
user_heatmap.go
user_heatmap_test.go