forgejo/models/repo
Peter Gardfjäll 4562d40fce
fix hard-coded timeout and error panic in API archive download endpoint ()
* 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.go fix hard-coded timeout and error panic in API archive download endpoint () 2022-08-29 11:45:20 +02:00
attachment.go Add migrate repo archiver and packages storage support on command line () 2022-08-16 12:05:15 +08:00
attachment_test.go Move some repository related code into sub package () 2022-06-06 16:01:49 +08:00
avatar.go Move almost all functions' parameter db.Engine to context.Context () 2022-05-20 22:08:52 +08:00
collaboration.go Move some code into models/git () 2022-06-12 23:51:54 +08:00
collaboration_test.go Refactor AssertExistsAndLoadBean to use generics () 2022-08-16 10:22:25 +08:00
fork.go Feature: Find files in repo () 2022-06-09 14:15:08 +03:00
fork_test.go Move some repository related code into sub package () 2022-06-06 16:01:49 +08:00
git.go Move repository model into models/repo () 2021-12-10 09:27:50 +08:00
issue.go Prevent deadlock in create issue () 2021-12-13 17:59:39 -05:00
language_stats.go Move almost all functions' parameter db.Engine to context.Context () 2022-05-20 22:08:52 +08:00
main_test.go Feature: Find files in repo () 2022-06-09 14:15:08 +03:00
mirror.go In PushMirrorsIterate and MirrorsIterate if limit is negative do not set it () 2022-08-18 22:12:00 -04:00
pushmirror.go In PushMirrorsIterate and MirrorsIterate if limit is negative do not set it () 2022-08-18 22:12:00 -04:00
pushmirror_test.go Add new API endpoints for push mirrors management () 2022-07-30 18:45:59 +02:00
redirect.go Some repository refactors () 2021-12-12 23:48:20 +08:00
redirect_test.go Refactor AssertExistsAndLoadBean to use generics () 2022-08-16 10:22:25 +08:00
release.go Move some files into models' sub packages () 2022-08-25 10:31:57 +08:00
repo.go Move some files into models' sub packages () 2022-08-25 10:31:57 +08:00
repo_indexer.go Move almost all functions' parameter db.Engine to context.Context () 2022-05-20 22:08:52 +08:00
repo_list.go Only show relevant repositories on explore page () 2022-08-25 20:38:41 +02:00
repo_list_test.go Move some repository related code into sub package () 2022-06-06 16:01:49 +08:00
repo_test.go Refactor AssertExistsAndLoadBean to use generics () 2022-08-16 10:22:25 +08:00
repo_unit.go Custom regexp external issues () 2022-06-10 13:39:53 +08:00
star.go Move almost all functions' parameter db.Engine to context.Context () 2022-05-20 22:08:52 +08:00
star_test.go Refactor AssertExistsAndLoadBean to use generics () 2022-08-16 10:22:25 +08:00
topic.go Move almost all functions' parameter db.Engine to context.Context () 2022-05-20 22:08:52 +08:00
topic_test.go Move some repository related code into sub package () 2022-06-06 16:01:49 +08:00
update.go Move some repository related code into sub package () 2022-06-06 16:01:49 +08:00
upload.go Move some files into models' sub packages () 2022-08-25 10:31:57 +08:00
user_repo.go Add issue filter for Author () 2022-08-08 22:03:58 +02:00
user_repo_test.go Refactor AssertExistsAndLoadBean to use generics () 2022-08-16 10:22:25 +08:00
watch.go Move almost all functions' parameter db.Engine to context.Context () 2022-05-20 22:08:52 +08:00
watch_test.go Refactor AssertExistsAndLoadBean to use generics () 2022-08-16 10:22:25 +08:00
wiki.go Move some files into models' sub packages () 2022-08-25 10:31:57 +08:00
wiki_test.go Refactor AssertExistsAndLoadBean to use generics () 2022-08-16 10:22:25 +08:00