gitea/routers/web/repo
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
..
activity.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
attachment.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
blame.go Switch Unicode Escaping to a VSCode-like system (#19990) 2022-08-13 19:32:34 +01:00
branch.go Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
cherry_pick.go Remove RequireHighlightJS field, update plantuml example. (#19615) 2022-05-05 10:53:38 +03:00
commit.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
compare.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
download.go Slightly simplify LastCommitCache (#20444) 2022-07-25 16:39:42 +01:00
editor_test.go Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
editor.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
find.go Feature: Find files in repo (#15028) 2022-06-09 14:15:08 +03:00
http_test.go Fix http path bug (#16117) 2021-06-09 14:53:12 +02:00
http.go Use request timeout for git service rpc (#20689) 2022-08-06 16:13:11 +03:00
issue_content_history.go Make better use of i18n (#20096) 2022-06-26 22:19:22 +08:00
issue_dependency.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_label_test.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_label.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_lock.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_stopwatch.go Stop spurious APIFormat stopwatches logs (#20008) 2022-06-17 22:47:15 +01:00
issue_test.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_timetrack.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_watch.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
lfs.go Switch Unicode Escaping to a VSCode-like system (#19990) 2022-08-13 19:32:34 +01:00
main_test.go Use a struct as test options (#19393) 2022-04-14 21:58:21 +08:00
middlewares.go Renamed ctx.User to ctx.Doer. (#19161) 2022-03-22 15:03:22 +08:00
migrate.go Unify repo settings & show better error (#19828) 2022-06-12 13:43:27 +08:00
milestone.go Move milestone to models/issues/ (#19278) 2022-04-08 17:11:15 +08:00
packages.go Show hint to link package to repo when viewing empty repo package list (#20504) 2022-07-27 19:58:21 +08:00
patch.go Remove RequireHighlightJS field, update plantuml example. (#19615) 2022-05-05 10:53:38 +03:00
projects_test.go Decouple unit test code from business code (#17623) 2021-11-12 22:36:47 +08:00
projects.go Check if project has the same repository id with issue when assign project to issue (#20133) 2022-06-30 23:55:08 +08:00
pull_review.go Dismiss prior pull reviews if done via web in review dismiss (#20197) 2022-07-19 15:20:28 +02:00
pull.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
release_test.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
release.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
render.go Allow render HTML with css/js external links (#19017) 2022-06-16 11:33:23 +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
search.go Remove RequireHighlightJS field, update plantuml example. (#19615) 2022-05-05 10:53:38 +03:00
setting_protected_branch.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
setting.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
settings_test.go Move access and repo permission to models/perm/access (#19350) 2022-05-11 12:09:36 +02:00
tag.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
topic.go Renamed ctx.User to ctx.Doer. (#19161) 2022-03-22 15:03:22 +08:00
treelist.go Feature: Find files in repo (#15028) 2022-06-09 14:15:08 +03:00
view_test.go Support localized README (#20508) 2022-08-01 01:36:58 +03:00
view.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
webhook.go refactor webhook *EditPost (#20780) 2022-08-23 02:52:35 -04:00
wiki_test.go Make git.OpenRepository accept Context (#19260) 2022-03-30 03:13:41 +08:00
wiki.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00