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.
gitea/routers/api/v1/repo
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>
3 years ago
..
blob.go RepoAssignment ensure to close before overwrite (#19449) 3 years ago
branch.go Move some code into models/git (#19879) 3 years ago
collaborators.go Move some repository related code into sub package (#19711) 3 years ago
commits.go Add more checks in migration code (#21011) (#21050) 3 years ago
file.go Fix hard-coded timeout and error panic in API archive download endpoint (#20925) (#21051) 3 years ago
fork.go Move access and repo permission to models/perm/access (#19350) 3 years ago
git_hook.go Move macaron to chi (#14293) 4 years ago
git_ref.go Multiple Escaping Improvements (#17551) 3 years ago
hook.go Fill the specified ref in webhook test payload (#20961) (#21055) 3 years ago
hook_test.go Decouple unit test, remove intermediate `unittestbridge` package (#17662) 3 years ago
issue.go Move issues related files into models/issues (#19931) 3 years ago
issue_comment.go Move issues related files into models/issues (#19931) 3 years ago
issue_label.go Move issues related files into models/issues (#19931) 3 years ago
issue_reaction.go Move issues related files into models/issues (#19931) 3 years ago
issue_stopwatch.go Move issues related files into models/issues (#19931) 3 years ago
issue_subscription.go Move issues related files into models/issues (#19931) 3 years ago
issue_tracked_time.go Move issues related files into models/issues (#19931) 3 years ago
key.go Use `ctx` instead of `db.DefaultContext` in some packages(routers/services/modules) (#19163) 3 years ago
label.go Move issues related files into models/issues (#19931) 3 years ago
language.go Move almost all functions' parameter db.Engine to context.Context (#19748) 3 years ago
main_test.go Use queue instead of memory queue in webhook send service (#19390) 3 years ago
migrate.go Move almost all functions' parameter db.Engine to context.Context (#19748) 3 years ago
milestone.go fix: some typos (#19956) 3 years ago
mirror.go Move almost all functions' parameter db.Engine to context.Context (#19748) 3 years ago
notes.go Add more checks in migration code (#21011) (#21050) 3 years ago
patch.go Move issues related files into models/issues (#19931) 3 years ago
pull.go Move issues related files into models/issues (#19931) 3 years ago
pull_review.go Dismiss prior pull reviews if done via web in review dismiss (#20197) (#20407) 3 years ago
release.go Set target on create release with existing tag (#20381) (#20382) 3 years ago
release_attachment.go Return 404 NotFound if requested attachment does not exist (#20886) (#20941) 3 years ago
release_tags.go fix permission check for delete tag (#19985) 3 years ago
repo.go Move some repository related code into sub package (#19711) 3 years ago
repo_test.go Renamed ctx.User to ctx.Doer. (#19161) 3 years ago
star.go Renamed ctx.User to ctx.Doer. (#19161) 3 years ago
status.go Move some code into models/git (#19879) 3 years ago
subscriber.go Renamed ctx.User to ctx.Doer. (#19161) 3 years ago
tag.go fix permission check for delete tag (#19985) 3 years ago
teams.go Move almost all functions' parameter db.Engine to context.Context (#19748) 3 years ago
topic.go Add missing return for when topic isn't found (#20351) (#20395) 3 years ago
transfer.go Move almost all functions' parameter db.Engine to context.Context (#19748) 3 years ago
tree.go Propagate context and ensure git commands run in request context (#17868) 3 years ago
wiki.go Make git.OpenRepository accept Context (#19260) 3 years ago