Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

api: use suitable status code and make TestResetTS stable #7368

Merged
merged 8 commits into from
Nov 22, 2023
Merged

api: use suitable status code and make TestResetTS stable #7368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1a1e0b7
tests: make TestResetTS stable
lhy1024 Nov 14, 2023
7a56c16
add status code
lhy1024 Nov 16, 2023
871a8d9
fix status code
lhy1024 Nov 16, 2023
50e0365
add comments
lhy1024 Nov 16, 2023
23fa5f0
add comments
lhy1024 Nov 16, 2023
8730e26
Merge branch 'master' into fix-test15
lhy1024 Nov 16, 2023
d4c9778
Merge branch 'master' into fix-test15
ti-chi-bot[bot] Nov 22, 2023
3db09f6
Merge branch 'master' into fix-test15
ti-chi-bot[bot] Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions pkg/mcs/tso/server/apis/v1/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package apis

import (
"fmt"
"net/http"
"strconv"
"sync"
Expand Down Expand Up @@ -150,6 +151,7 @@ type ResetTSParams struct {
// @Failure 400 {string} string "The input is invalid."
// @Failure 403 {string} string "Reset ts is forbidden."
// @Failure 500 {string} string "TSO server failed to proceed the request."
// @Failure 503 {string} string "It's a temporary failure, please retry."
// @Router /admin/reset-ts [post]
// if force-use-larger=true:
//
Expand Down Expand Up @@ -185,6 +187,12 @@ func ResetTS(c *gin.Context) {
if err = svr.ResetTS(ts, ignoreSmaller, skipUpperBoundCheck, 0); err != nil {
if err == errs.ErrServerNotStarted {
c.String(http.StatusInternalServerError, err.Error())
} else if err == errs.ErrEtcdTxnConflict {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not only for test? Because it will effect the resp to users.
I want to know whether this PR needs to cherry-pick.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, not only for test. But I am not sure whether it is a bug to need cherry-pick.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's only for TSO services, IMO we don't need to.

Copy link
Contributor Author

@lhy1024 lhy1024 Nov 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PD mode also returns 403 when meeting ErrEtcdTxnConflict before this PR

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BR is using it https://github.com/pingcap/tidb/blob/1f7c1e02bcd402cfbc1a0b0a26acfbd0d0fe4d8c/br/pkg/pdutil/pd.go#L892

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussion with @niubell, we will only fix it on master branch.

// If the error is ErrEtcdTxnConflict, it means there is a temporary failure.
// Return 503 to let the client retry.
// Ref: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.4
c.String(http.StatusServiceUnavailable,
fmt.Sprintf("It's a temporary failure with error %s, please retry.", err.Error()))
} else {
c.String(http.StatusForbidden, err.Error())
}
Expand Down
8 changes: 8 additions & 0 deletions pkg/tso/admin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package tso

import (
"fmt"
"net/http"
"strconv"

Expand Down Expand Up @@ -53,6 +54,7 @@ func NewAdminHandler(handler Handler, rd *render.Render) *AdminHandler {
// @Failure 400 {string} string "The input is invalid."
// @Failure 403 {string} string "Reset ts is forbidden."
// @Failure 500 {string} string "TSO server failed to proceed the request."
// @Failure 503 {string} string "It's a temporary failure, please retry."
// @Router /admin/reset-ts [post]
// if force-use-larger=true:
//
Expand Down Expand Up @@ -96,6 +98,12 @@ func (h *AdminHandler) ResetTS(w http.ResponseWriter, r *http.Request) {
if err = handler.ResetTS(ts, ignoreSmaller, skipUpperBoundCheck, 0); err != nil {
if err == errs.ErrServerNotStarted {
h.rd.JSON(w, http.StatusInternalServerError, err.Error())
} else if err == errs.ErrEtcdTxnConflict {
// If the error is ErrEtcdTxnConflict, it means there is a temporary failure.
// Return 503 to let the client retry.
// Ref: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.4
h.rd.JSON(w, http.StatusServiceUnavailable,
fmt.Sprintf("It's a temporary failure with error %s, please retry.", err.Error()))
} else {
h.rd.JSON(w, http.StatusForbidden, err.Error())
}
Expand Down
23 changes: 20 additions & 3 deletions server/api/admin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"testing"
"time"
Expand All @@ -27,6 +28,7 @@ import (
"github.com/stretchr/testify/suite"
"github.com/tikv/pd/pkg/core"
"github.com/tikv/pd/pkg/replication"
"github.com/tikv/pd/pkg/utils/apiutil"
tu "github.com/tikv/pd/pkg/utils/testutil"
"github.com/tikv/pd/server"
)
Expand Down Expand Up @@ -188,9 +190,24 @@ func (suite *adminTestSuite) TestResetTS() {
values, err := json.Marshal(args)
suite.NoError(err)
re := suite.Require()
err = tu.CheckPostJSON(testDialClient, url, values,
tu.StatusOK(re),
tu.StringEqual(re, "\"Reset ts successfully.\"\n"))
tu.Eventually(re, func() bool {
resp, err := apiutil.PostJSON(testDialClient, url, values)
re.NoError(err)
defer resp.Body.Close()
b, err := io.ReadAll(resp.Body)
re.NoError(err)
switch resp.StatusCode {
case http.StatusOK:
re.Contains(string(b), "Reset ts successfully.")
return true
case http.StatusServiceUnavailable:
re.Contains(string(b), "[PD:etcd:ErrEtcdTxnConflict]etcd transaction failed, conflicted and rolled back")
return false
default:
re.FailNow("unexpected status code %d", resp.StatusCode)
return false
}
})
suite.NoError(err)
t2 := makeTS(32 * time.Hour)
args["tso"] = fmt.Sprintf("%d", t2)
Expand Down
Loading