add failed_regions_id for scatter regions response (#9167)

GMHDBJD · ti-chi-bot[bot] · web-flow · commit 29ead019cd09 · 2025-06-11T12:26:55.000Z
close #9088 Signed-off-by: gmhdbjd <gmhdbjd@gmail.com> Co-authored-by: ti-chi-bot[bot] <108142056+ti-chi-bot[bot]@users.noreply.github.com>
diff --git a/go.mod b/go.mod
@@ -35,7 +35,7 @@ require (
 	github.com/pingcap/errcode v0.3.0
 	github.com/pingcap/errors v0.11.5-0.20211224045212-9687c2b0f87c
 	github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86
-	github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1
+	github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38
 	github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3
 	github.com/pingcap/sysutil v1.0.1-0.20230407040306-fb007c5aff21
 	github.com/pingcap/tidb-dashboard v0.0.0-20250219061340-d62018124ae2
diff --git a/go.sum b/go.sum
@@ -392,8 +392,8 @@ github.com/pingcap/errors v0.11.5-0.20211224045212-9687c2b0f87c/go.mod h1:X2r9ue
 github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86 h1:tdMsjOqUR7YXHoBitzdebTvOjs/swniBTOLy5XiMtuE=
 github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86/go.mod h1:exzhVYca3WRtd6gclGNErRWb1qEgff3LYta0LvRmON4=
 github.com/pingcap/kvproto v0.0.0-20191211054548-3c6b38ea5107/go.mod h1:WWLmULLO7l8IOcQG+t+ItJ3fEcrL5FxF0Wu+HrMy26w=
-github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1 h1:peVY7sHw2RCDH8lEHEVMYe4M7GXyeXRKR8QDc5f5dM4=
-github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1/go.mod h1:rXxWk2UnwfUhLXha1jxRWPADw9eMZGWEWCg92Tgmb/8=
+github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38 h1:V088U5aznaPX6SK5Oyznb7LhrBicuaYsdI9bb4Fzjq4=
+github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38/go.mod h1:rXxWk2UnwfUhLXha1jxRWPADw9eMZGWEWCg92Tgmb/8=
 github.com/pingcap/log v0.0.0-20210625125904-98ed8e2eb1c7/go.mod h1:8AanEdAHATuRurdGxZXBz0At+9avep+ub7U1AGYLIMM=
 github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3 h1:HR/ylkkLmGdSSDaD8IDP+SZrdhV1Kibl9KrHxJ9eciw=
 github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3/go.mod h1:DWQW5jICDR7UJh4HtxXSM20Churx4CQL0fwL/SoOSA4=
diff --git a/pkg/mcs/scheduling/server/grpc_service.go b/pkg/mcs/scheduling/server/grpc_service.go
@@ -216,6 +216,7 @@ func (s *Service) ScatterRegions(_ context.Context, request *schedulingpb.Scatte
 		return &schedulingpb.ScatterRegionsResponse{Header: header}, nil
 	}
 	percentage := 100
+	failedRegionIDs := make([]uint64, 0, len(failures))
 	if len(failures) > 0 {
 		percentage = 100 - 100*len(failures)/(opsCount+len(failures))
 		log.Debug("scatter regions", zap.Errors("failures", func() []error {
@@ -225,10 +226,14 @@ func (s *Service) ScatterRegions(_ context.Context, request *schedulingpb.Scatte
 			}
 			return r
 		}()))
+		for regionID := range failures {
+			failedRegionIDs = append(failedRegionIDs, regionID)
+		}
 	}
 	return &schedulingpb.ScatterRegionsResponse{
 		Header:             wrapHeader(),
 		FinishedPercentage: uint64(percentage),
+		FailedRegionsId:    failedRegionIDs,
 	}, nil
 }
 
diff --git a/server/grpc_service.go b/server/grpc_service.go
@@ -32,6 +32,8 @@ import (
 	"go.uber.org/multierr"
 	"go.uber.org/zap"
 	"google.golang.org/grpc"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 
 	"github.com/pingcap/errors"
 	"github.com/pingcap/failpoint"
@@ -2111,13 +2113,14 @@ func (s *GrpcServer) ScatterRegion(ctx context.Context, request *pdpb.ScatterReg
 	}
 
 	if len(request.GetRegionsId()) > 0 {
-		percentage, err := scatterRegions(rc, request.GetRegionsId(), request.GetGroup(), int(request.GetRetryLimit()), request.GetSkipStoreLimit())
+		percentage, failedRegionsID, err := scatterRegions(rc, request.GetRegionsId(), request.GetGroup(), int(request.GetRetryLimit()), request.GetSkipStoreLimit())
 		if err != nil {
 			return nil, err
 		}
 		return &pdpb.ScatterRegionResponse{
 			Header:             wrapHeader(),
 			FinishedPercentage: uint64(percentage),
+			FailedRegionsId:    failedRegionsID,
 		}, nil
 	}
 	// TODO: Deprecate it use `request.GetRegionsID`.
@@ -2486,6 +2489,7 @@ func convertScatterResponse(resp *schedulingpb.ScatterRegionsResponse) *pdpb.Sca
 	return &pdpb.ScatterRegionResponse{
 		Header:             convertHeader(resp.GetHeader()),
 		FinishedPercentage: resp.GetFinishedPercentage(),
+		FailedRegionsId:    resp.GetFailedRegionsId(),
 	}
 }
 
@@ -2598,7 +2602,7 @@ func (s *GrpcServer) SplitAndScatterRegions(ctx context.Context, request *pdpb.S
 		return &pdpb.SplitAndScatterRegionsResponse{Header: notBootstrappedHeader()}, nil
 	}
 	splitFinishedPercentage, newRegionIDs := rc.GetRegionSplitter().SplitRegions(ctx, request.GetSplitKeys(), int(request.GetRetryLimit()))
-	scatterFinishedPercentage, err := scatterRegions(rc, newRegionIDs, request.GetGroup(), int(request.GetRetryLimit()), false)
+	scatterFinishedPercentage, _, err := scatterRegions(rc, newRegionIDs, request.GetGroup(), int(request.GetRetryLimit()), false)
 	if err != nil {
 		return nil, err
 	}
@@ -2610,13 +2614,15 @@ func (s *GrpcServer) SplitAndScatterRegions(ctx context.Context, request *pdpb.S
 	}, nil
 }
 
-// scatterRegions add operators to scatter regions and return the processed percentage and error
-func scatterRegions(cluster *cluster.RaftCluster, regionsID []uint64, group string, retryLimit int, skipStoreLimit bool) (int, error) {
+// scatterRegions add operators to scatter regions
+// returns the percentage of successfully scattered regions and the IDs of failed regions
+func scatterRegions(cluster *cluster.RaftCluster, regionsID []uint64, group string, retryLimit int, skipStoreLimit bool) (int, []uint64, error) {
 	opsCount, failures, err := cluster.GetRegionScatterer().ScatterRegionsByID(regionsID, group, retryLimit, skipStoreLimit)
 	if err != nil {
-		return 0, err
+		return 0, nil, err
 	}
 	percentage := 100
+	var failedRegionIDs []uint64
 	if len(failures) > 0 {
 		percentage = 100 - 100*len(failures)/(opsCount+len(failures))
 		log.Debug("scatter regions", zap.Errors("failures", func() []error {
@@ -2626,8 +2632,11 @@ func scatterRegions(cluster *cluster.RaftCluster, regionsID []uint64, group stri
 			}
 			return r
 		}()))
+		for regionID := range failures {
+			failedRegionIDs = append(failedRegionIDs, regionID)
+		}
 	}
-	return percentage, nil
+	return percentage, failedRegionIDs, nil
 }
 
 // GetDCLocationInfo implements gRPC PDServer.
@@ -2944,3 +2953,13 @@ func (s *GrpcServer) rateLimitCheck() (done ratelimit.DoneFunc, err error) {
 	}
 	return
 }
+
+// SetGlobalGCBarrier implements gRPC PDServer.
+func (*GrpcServer) SetGlobalGCBarrier(context.Context, *pdpb.SetGlobalGCBarrierRequest) (*pdpb.SetGlobalGCBarrierResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "SetGlobalGCBarrier is not implemented yet, waiting for https://github.com/tikv/pd/pull/9361")
+}
+
+// DeleteGlobalGCBarrier implements gRPC PDServer.
+func (*GrpcServer) DeleteGlobalGCBarrier(context.Context, *pdpb.DeleteGlobalGCBarrierRequest) (*pdpb.DeleteGlobalGCBarrierResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "DeleteGlobalGCBarrier is not implemented yet, waiting for https://github.com/tikv/pd/pull/9361")
+}
diff --git a/tests/integrations/client/client_test.go b/tests/integrations/client/client_test.go
@@ -1303,8 +1303,10 @@ func (suite *clientStatelessTestSuite) TestScatterRegion() {
 			return false
 		}
 		if scatterResp.FinishedPercentage != uint64(100) {
+			re.Contains(scatterResp.FailedRegionsId, regionID)
 			return false
 		}
+		re.Empty(scatterResp.FailedRegionsId)
 		resp, err := suite.client.GetOperator(context.Background(), regionID)
 		if err != nil {
 			return false
diff --git a/tests/integrations/go.mod b/tests/integrations/go.mod
@@ -14,7 +14,7 @@ require (
 	github.com/go-sql-driver/mysql v1.7.0
 	github.com/pingcap/errors v0.11.5-0.20211224045212-9687c2b0f87c
 	github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86
-	github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1
+	github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38
 	github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3
 	github.com/prometheus/client_golang v1.20.5
 	github.com/prometheus/client_model v0.6.1
diff --git a/tests/integrations/go.sum b/tests/integrations/go.sum
@@ -385,8 +385,8 @@ github.com/pingcap/errors v0.11.5-0.20211224045212-9687c2b0f87c/go.mod h1:X2r9ue
 github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86 h1:tdMsjOqUR7YXHoBitzdebTvOjs/swniBTOLy5XiMtuE=
 github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86/go.mod h1:exzhVYca3WRtd6gclGNErRWb1qEgff3LYta0LvRmON4=
 github.com/pingcap/kvproto v0.0.0-20191211054548-3c6b38ea5107/go.mod h1:WWLmULLO7l8IOcQG+t+ItJ3fEcrL5FxF0Wu+HrMy26w=
-github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1 h1:peVY7sHw2RCDH8lEHEVMYe4M7GXyeXRKR8QDc5f5dM4=
-github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1/go.mod h1:rXxWk2UnwfUhLXha1jxRWPADw9eMZGWEWCg92Tgmb/8=
+github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38 h1:V088U5aznaPX6SK5Oyznb7LhrBicuaYsdI9bb4Fzjq4=
+github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38/go.mod h1:rXxWk2UnwfUhLXha1jxRWPADw9eMZGWEWCg92Tgmb/8=
 github.com/pingcap/log v0.0.0-20210625125904-98ed8e2eb1c7/go.mod h1:8AanEdAHATuRurdGxZXBz0At+9avep+ub7U1AGYLIMM=
 github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3 h1:HR/ylkkLmGdSSDaD8IDP+SZrdhV1Kibl9KrHxJ9eciw=
 github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3/go.mod h1:DWQW5jICDR7UJh4HtxXSM20Churx4CQL0fwL/SoOSA4=
diff --git a/tools/go.mod b/tools/go.mod
@@ -22,7 +22,7 @@ require (
 	github.com/mattn/go-shellwords v1.0.12
 	github.com/pingcap/errors v0.11.5-0.20211224045212-9687c2b0f87c
 	github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86
-	github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1
+	github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38
 	github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3
 	github.com/pmezard/go-difflib v1.0.0
 	github.com/prometheus/client_golang v1.20.5
diff --git a/tools/go.sum b/tools/go.sum
@@ -390,8 +390,8 @@ github.com/pingcap/errors v0.11.5-0.20211224045212-9687c2b0f87c/go.mod h1:X2r9ue
 github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86 h1:tdMsjOqUR7YXHoBitzdebTvOjs/swniBTOLy5XiMtuE=
 github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86/go.mod h1:exzhVYca3WRtd6gclGNErRWb1qEgff3LYta0LvRmON4=
 github.com/pingcap/kvproto v0.0.0-20191211054548-3c6b38ea5107/go.mod h1:WWLmULLO7l8IOcQG+t+ItJ3fEcrL5FxF0Wu+HrMy26w=
-github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1 h1:peVY7sHw2RCDH8lEHEVMYe4M7GXyeXRKR8QDc5f5dM4=
-github.com/pingcap/kvproto v0.0.0-20250521074834-db74bf0e3ac1/go.mod h1:rXxWk2UnwfUhLXha1jxRWPADw9eMZGWEWCg92Tgmb/8=
+github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38 h1:V088U5aznaPX6SK5Oyznb7LhrBicuaYsdI9bb4Fzjq4=
+github.com/pingcap/kvproto v0.0.0-20250604104108-d780eebb4f38/go.mod h1:rXxWk2UnwfUhLXha1jxRWPADw9eMZGWEWCg92Tgmb/8=
 github.com/pingcap/log v0.0.0-20210625125904-98ed8e2eb1c7/go.mod h1:8AanEdAHATuRurdGxZXBz0At+9avep+ub7U1AGYLIMM=
 github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3 h1:HR/ylkkLmGdSSDaD8IDP+SZrdhV1Kibl9KrHxJ9eciw=
 github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3/go.mod h1:DWQW5jICDR7UJh4HtxXSM20Churx4CQL0fwL/SoOSA4=

Original file line number	Diff line number	Diff line change
`@@ -216,6 +216,7 @@ func (s Service) ScatterRegions(_ context.Context, request schedulingpb.Scatte`
`216`	`216`	`return &schedulingpb.ScatterRegionsResponse{Header: header}, nil`
`217`	`217`	`}`
`218`	`218`	`percentage := 100`
	`219`	`+ failedRegionIDs := make([]uint64, 0, len(failures))`
`219`	`220`	`if len(failures) > 0 {`
`220`	`221`	`percentage = 100 - 100*len(failures)/(opsCount+len(failures))`
`221`	`222`	`log.Debug("scatter regions", zap.Errors("failures", func() []error {`
`@@ -225,10 +226,14 @@ func (s Service) ScatterRegions(_ context.Context, request schedulingpb.Scatte`
`225`	`226`	`}`
`226`	`227`	`return r`
`227`	`228`	`}()))`
	`229`	`+ for regionID := range failures {`
	`230`	`+ failedRegionIDs = append(failedRegionIDs, regionID)`
	`231`	`+ }`
`228`	`232`	`}`
`229`	`233`	`return &schedulingpb.ScatterRegionsResponse{`
`230`	`234`	`Header: wrapHeader(),`
`231`	`235`	`FinishedPercentage: uint64(percentage),`
	`236`	`+ FailedRegionsId: failedRegionIDs,`
`232`	`237`	`}, nil`
`233`	`238`	`}`
`234`	`239`
Original file line number	Diff line number	Diff line change
`@@ -1303,8 +1303,10 @@ func (suite *clientStatelessTestSuite) TestScatterRegion() {`
`1303`	`1303`	`return false`
`1304`	`1304`	`}`
`1305`	`1305`	`if scatterResp.FinishedPercentage != uint64(100) {`
	`1306`	`+ re.Contains(scatterResp.FailedRegionsId, regionID)`
`1306`	`1307`	`return false`
`1307`	`1308`	`}`
	`1309`	`+ re.Empty(scatterResp.FailedRegionsId)`
`1308`	`1310`	`resp, err := suite.client.GetOperator(context.Background(), regionID)`
`1309`	`1311`	`if err != nil {`
`1310`	`1312`	`return false`