You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
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>
2 years ago
..
archiver fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2 years ago
files Move some files into models' sub packages (#20262) 2 years ago
adopt.go Move some files into models' sub packages (#20262) 2 years ago
adopt_test.go format with gofumpt (#18184) 2 years ago
avatar.go Add migrate repo archiver and packages storage support on command line (#20757) 2 years ago
avatar_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2 years ago
branch.go Move some code into models/git (#19879) 2 years ago
cache.go Slightly simplify LastCommitCache (#20444) 2 years ago
check.go Move some repository related code into sub package (#19711) 2 years ago
fork.go Move some files into models' sub packages (#20262) 2 years ago
fork_test.go Move some files into models' sub packages (#20262) 2 years ago
hooks.go Move some repository related code into sub package (#19711) 2 years ago
main_test.go Use a struct as test options (#19393) 2 years ago
push.go Move some files into models' sub packages (#20262) 2 years ago
repository.go Move some files into models' sub packages (#20262) 2 years ago
repository_test.go Move some repository related code into sub package (#19711) 2 years ago
review.go Move some repository related code into sub package (#19711) 2 years ago
review_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2 years ago
template.go Remove manual rollback for failed generated repositories (#20639) 2 years ago
transfer.go Move some files into models' sub packages (#20262) 2 years ago
transfer_test.go Move some files into models' sub packages (#20262) 2 years ago