0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-23 07:43:18 -05:00
forgejo/services/repository
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
..
archiver fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
files Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
adopt.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
adopt_test.go
avatar.go Add migrate repo archiver and packages storage support on command line (#20757) 2022-08-16 12:05:15 +08:00
avatar_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
branch.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
cache.go Slightly simplify LastCommitCache (#20444) 2022-07-25 16:39:42 +01:00
check.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
fork.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
fork_test.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
hooks.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
main_test.go
push.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
repository.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
repository_test.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
review.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
review_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
template.go Remove manual rollback for failed generated repositories (#20639) 2022-08-09 17:41:52 +08:00
transfer.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
transfer_test.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00