mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-23 08:47:42 -05:00
f4538791f5
# 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>
63 lines
1.9 KiB
Go
63 lines
1.9 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package private
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/url"
|
|
|
|
asymkey_model "code.gitea.io/gitea/models/asymkey"
|
|
"code.gitea.io/gitea/models/perm"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
)
|
|
|
|
// KeyAndOwner is the response from ServNoCommand
|
|
type KeyAndOwner struct {
|
|
Key *asymkey_model.PublicKey `json:"key"`
|
|
Owner *user_model.User `json:"user"`
|
|
}
|
|
|
|
// ServNoCommand returns information about the provided key
|
|
func ServNoCommand(ctx context.Context, keyID int64) (*asymkey_model.PublicKey, *user_model.User, error) {
|
|
reqURL := setting.LocalURL + fmt.Sprintf("api/internal/serv/none/%d", keyID)
|
|
req := newInternalRequest(ctx, reqURL, "GET")
|
|
keyAndOwner, extra := requestJSONResp(req, &KeyAndOwner{})
|
|
if extra.HasError() {
|
|
return nil, nil, extra.Error
|
|
}
|
|
return keyAndOwner.Key, keyAndOwner.Owner, nil
|
|
}
|
|
|
|
// ServCommandResults are the results of a call to the private route serv
|
|
type ServCommandResults struct {
|
|
IsWiki bool
|
|
DeployKeyID int64
|
|
KeyID int64 // public key
|
|
KeyName string // this field is ambiguous, it can be the name of DeployKey, or the name of the PublicKey
|
|
UserName string
|
|
UserEmail string
|
|
UserID int64
|
|
OwnerName string
|
|
RepoName string
|
|
RepoID int64
|
|
}
|
|
|
|
// ServCommand preps for a serv call
|
|
func ServCommand(ctx context.Context, keyID int64, ownerName, repoName string, mode perm.AccessMode, verbs ...string) (*ServCommandResults, ResponseExtra) {
|
|
reqURL := setting.LocalURL + fmt.Sprintf("api/internal/serv/command/%d/%s/%s?mode=%d",
|
|
keyID,
|
|
url.PathEscape(ownerName),
|
|
url.PathEscape(repoName),
|
|
mode,
|
|
)
|
|
for _, verb := range verbs {
|
|
if verb != "" {
|
|
reqURL += fmt.Sprintf("&verb=%s", url.QueryEscape(verb))
|
|
}
|
|
}
|
|
req := newInternalRequest(ctx, reqURL, "GET")
|
|
return requestJSONResp(req, &ServCommandResults{})
|
|
}
|