1
0
Fork 0
forgejo/cmd
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
..
admin.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
admin_auth_ldap.go Allow enable LDAP source and disable user sync via CLI (#20206) 2022-07-04 11:21:14 +02:00
admin_auth_ldap_test.go Allow enable LDAP source and disable user sync via CLI (#20206) 2022-07-04 11:21:14 +02:00
cert.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
cmd.go fix: some typos (#19956) 2022-06-13 15:34:46 +08:00
convert.go Improve install code to avoid low-level mistakes. (#17779) 2021-12-01 15:50:01 +08:00
docs.go
doctor.go Disable doctor logging on panic (#20847) 2022-08-18 21:27:27 -04:00
dump.go Add Tar ZSTD support (#20493) 2022-07-27 07:16:28 +01:00
dump_repo.go Make sure repo_dir is an empty directory or doesn't exist before 'dump-repo' (#20205) 2022-07-14 21:52:18 +08:00
embedded.go Share HTML template renderers and create a watcher framework (#20218) 2022-08-28 10:43:25 +01:00
embedded_stub.go Remove legacy +build: constraint (#19582) 2022-05-02 23:22:45 +08:00
generate.go
hook.go Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
hook_test.go
keys.go
mailer.go Improve install code to avoid low-level mistakes. (#17779) 2021-12-01 15:50:01 +08:00
main_test.go Add migrate repo archiver and packages storage support on command line (#20757) 2022-08-16 12:05:15 +08:00
manager.go Fix various typos (#20338) 2022-07-12 23:32:37 +02:00
manager_logging.go Allow manager logging to set SQL (#20064) 2022-06-24 12:49:47 +02:00
migrate.go Improve install code to avoid low-level mistakes. (#17779) 2021-12-01 15:50:01 +08:00
migrate_storage.go fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
migrate_storage_test.go Add migrate repo archiver and packages storage support on command line (#20757) 2022-08-16 12:05:15 +08:00
restore_repo.go Fix cli command restore-repo: "units" should be splitted to string slice, to match the old behavior and match the dump-repo's behavior (#20183) 2022-07-01 15:47:44 +08:00
serv.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
web.go Share HTML template renderers and create a watcher framework (#20218) 2022-08-28 10:43:25 +01:00
web_acme.go Support Proxy protocol (#12527) 2022-08-21 19:20:43 +01:00
web_graceful.go Support Proxy protocol (#12527) 2022-08-21 19:20:43 +01:00
web_https.go Support Proxy protocol (#12527) 2022-08-21 19:20:43 +01:00