forgejo/modules
wxiaoguang f4538791f5
Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687)
# Why this PR comes

At first, I'd like to help users like #23636 (there are a lot)

The unclear "Internal Server Error" is quite anonying, scare users,
frustrate contributors, nobody knows what happens.

So, it's always good to provide meaningful messages to end users (of
course, do not leak sensitive information).

When I started working on the "response message to end users", I found
that the related code has a lot of technical debt. A lot of copy&paste
code, unclear fields and usages.

So I think it's good to make everything clear.

# Tech Backgrounds

Gitea has many sub-commands, some are used by admins, some are used by
SSH servers or Git Hooks. Many sub-commands use "internal API" to
communicate with Gitea web server.

Before, Gitea server always use `StatusCode + Json "err" field` to
return messages.

* The CLI sub-commands: they expect to show all error related messages
to site admin
* The Serv/Hook sub-commands (for git clients): they could only show
safe messages to end users, the error log could only be recorded by
"SSHLog" to Gitea web server.

In the old design, it assumes that:

* If the StatusCode is 500 (in some functions), then the "err" field is
error log, shouldn't be exposed to git client.
* If the StatusCode is 40x, then the "err" field could be exposed. And
some functions always read the "err" no matter what the StatusCode is.

The old code is not strict, and it's difficult to distinguish the
messages clearly and then output them correctly.

# This PR

To help to remove duplicate code and make everything clear, this PR
introduces `ResponseExtra` and `requestJSONResp`.

* `ResponseExtra` is a struct which contains "extra" information of a
internal API response, including StatusCode, UserMsg, Error
* `requestJSONResp` is a generic function which can be used for all
cases to help to simplify the calls.
* Remove all `map["err"]`, always use `private.Response{Err}` to
construct error messages.
* User messages and error messages are separated clearly, the `fail` and
`handleCliResponseExtra` will output correct messages.
* Replace all `Internal Server Error` messages with meaningful (still
safe) messages.

This PR saves more than 300 lines, while makes the git client messages
more clear.

Many gitea-serv/git-hook related essential functions are covered by
tests.

---------

Co-authored-by: delvh <dev.lh@web.de>
2023-03-29 14:32:26 +08:00
..
actions Use GitHub Actions compatible globbing for branches, tag, path filter (#22804) 2023-03-27 16:27:40 +08:00
activitypub
analyze
auth Fix various bugs for "install" page (#23194) 2023-03-04 10:12:02 +08:00
avatar Use minio/sha256-simd for accelerated SHA256 (#23052) 2023-02-22 14:21:46 -05:00
base Use minio/sha256-simd for accelerated SHA256 (#23052) 2023-02-22 14:21:46 -05:00
cache Improve cache context (#23330) 2023-03-08 11:57:05 -06:00
charset Use data-tooltip-content for tippy tooltip (#23649) 2023-03-24 18:35:38 +08:00
container
context Implement Issue Config (#20956) 2023-03-28 14:22:07 -04:00
csv Add context when rendering labels or emojis (#23281) 2023-03-05 22:59:05 +01:00
doctor Check LFS/Packages settings in dump and doctor command (#23631) 2023-03-23 20:30:28 +08:00
emoji
eventsource
generate
git Add git dashes separator to some "log" and "diff" commands (#23606) 2023-03-26 19:31:21 +01:00
gitgraph Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
graceful
hcaptcha
highlight test_env: hardcode major go version in use (#23464) 2023-03-14 16:09:01 -04:00
hostmatcher
html
httpcache Set X-Gitea-Debug header once (#23361) 2023-03-08 15:40:04 -05:00
httplib Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 2023-03-29 14:32:26 +08:00
indexer Add meilisearch support (#23136) 2023-03-28 22:23:23 -04:00
issue/template
json
label Reduce duplicate and useless code in options (#23369) 2023-03-08 17:31:27 +08:00
lfs Make minio package support legacy MD5 checksum (#23768) 2023-03-28 11:10:24 -04:00
log
markup Editor preview support for external renderers (#23333) 2023-03-24 14:12:23 +08:00
mcaptcha
metrics
migration Scoped labels (#22585) 2023-02-18 21:17:39 +02:00
mirror
nosql
notification
options Introduce path Clean/Join helper functions (#23495) 2023-03-21 16:02:49 -04:00
packages Return repository in npm package metadata endpoint (#23539) 2023-03-17 14:39:19 -04:00
paginator
pprof
private Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 2023-03-29 14:32:26 +08:00
process
proxy
proxyprotocol
public Introduce path Clean/Join helper functions (#23495) 2023-03-21 16:02:49 -04:00
queue Properly flush unique queues on startup (#23154) 2023-02-28 17:55:43 -05:00
recaptcha
references
regexplru
repository Fix pull request update showing too many commits with multiple branches (#22856) 2023-03-09 12:14:22 -06:00
secret Use minio/sha256-simd for accelerated SHA256 (#23052) 2023-02-22 14:21:46 -05:00
session
setting Add meilisearch support (#23136) 2023-03-28 22:23:23 -04:00
sitemap
ssh
storage Make minio package support legacy MD5 checksum (#23768) 2023-03-28 11:10:24 -04:00
structs Implement Issue Config (#20956) 2023-03-28 14:22:07 -04:00
svg Keep (add if not existing) xmlns attribute for generated SVG images (#23410) 2023-03-21 13:39:27 +08:00
sync
system
templates Improve template error reporting (#23396) 2023-03-20 15:56:48 -05:00
test Rename repo.GetOwner to repo.LoadOwner (#22967) 2023-02-18 20:11:03 +08:00
timeutil Use data-tooltip-content for tippy tooltip (#23649) 2023-03-24 18:35:38 +08:00
translation
turnstile
typesniffer Do not recognize text files as audio (#23355) 2023-03-07 22:40:41 -05:00
updatechecker
upload
uri
user
util Introduce path Clean/Join helper functions (#23495) 2023-03-21 16:02:49 -04:00
validation
watcher
web
webhook