forgejo/models
Peter Gardfjäll 4562d40fce
fix hard-coded timeout and error panic in API archive download endpoint (#20925)
* fix hard-coded timeout and error panic in API archive download endpoint

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>
2022-08-29 11:45:20 +02:00
..
activities Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
admin Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
appstate Sync gitea app path for git hooks and authorized keys when starting (#17335) 2021-10-21 17:22:43 +08:00
asymkey Increase Content field size of gpg_key and public_key to MEDIUMTEXT (#20896) 2022-08-22 14:32:28 +01:00
auth Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
avatars format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
db Add migrate repo archiver and packages storage support on command line (#20757) 2022-08-16 12:05:15 +08:00
fixtures Fix SQL Query for SearchTeam (#20844) 2022-08-21 17:24:05 +01:00
foreignreference Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
git Add migrate repo archiver and packages storage support on command line (#20757) 2022-08-16 12:05:15 +08:00
issues Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
migrations Increase Content field size of gpg_key and public_key to MEDIUMTEXT (#20896) 2022-08-22 14:32:28 +01:00
organization Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
packages Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
perm Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
project Add option to purge users (#18064) 2022-07-14 08:22:09 +01: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) 2022-08-29 11:45:20 +02:00
unit Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
unittest Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
user Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
webhook Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
error.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +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 Decouple unit test code from business code (#17623) 2021-11-12 22:36:47 +08:00
main_test.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
migrate.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
migrate_test.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
org.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
org_team.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
org_team_test.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
org_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
repo.go fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
repo_collaboration.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
repo_collaboration_test.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +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_transfer.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
repo_transfer_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
user.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00