api: add affinity groups api and client support #10041

lhy1024 · 2025-12-10T10:47:59Z

What problem does this PR solve?

Issue Number: Ref #9764

What is changed and how does it work?

Check List

Tests

Unit test

Release note

None.

ti-chi-bot · 2025-12-10T10:48:02Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

codecov · 2025-12-10T11:29:19Z

Codecov Report

❌ Patch coverage is 79.08847% with 78 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.49%. Comparing base (27c2705) to head (6653ab5).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #10041      +/-   ##
==========================================
+ Coverage   78.40%   78.49%   +0.09%     
==========================================
  Files         511      513       +2     
  Lines       68415    68893     +478     
==========================================
+ Hits        53644    54081     +437     
- Misses      10876    10899      +23     
- Partials     3895     3913      +18

Flag	Coverage Δ
unittests	`78.49% <79.08%> (+0.09%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 · 2025-12-11T10:31:15Z

/retest

lhy1024 · 2025-12-12T03:27:15Z

/retest

rleungx · 2025-12-12T04:03:45Z

client/http/types.go

+
+// IsStable indicates that the Group has completed the required scheduling and is currently in a stable state.
+func (s *AffinityGroupState) IsStable() bool {
+	return s.Phase == "stable"


The phase name is strange, but we can rename it later.

It is public. Can we rename it in the future?

I means "Can" we update it?

server/apiv2/middlewares/affinity_enabled_checker.go

rleungx · 2025-12-12T04:18:47Z

server/apiv2/handlers/affinity.go

+	router.PATCH("", BatchModifyAffinityGroups)
+	router.PUT("/:group_id", UpdateAffinityGroupPeers)
+	router.DELETE("/:group_id", DeleteAffinityGroup)
+	router.POST("/batch-delete", BatchDeleteAffinityGroups)


not meet the RESTful requirement

The primary reason is that we want to perform batch deletions within a single transaction, but the DELETE does not support carrying a body.

And I found that there is also "/config/rules/batch" and "/regions/accelerate-schedule/batch", so I chose a similar path.

I just find an example https://linter.aip.dev/235/http-method

After discussion, use POST /?delete to batch delete https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-multiple-objects.html

Signed-off-by: lhy1024 <admin@liudos.us>

okJiang · 2025-12-12T08:51:58Z

client/http/types.go

+
+// IsStable indicates that the Group has completed the required scheduling and is currently in a stable state.
+func (s *AffinityGroupState) IsStable() bool {
+	return s.Phase == "stable"


I means "Can" we update it?

client/http/types.go

Copilot

Pull request overview

This PR adds comprehensive API and client support for affinity groups, which allow managing key ranges with specific peer placement requirements for region scheduling. The feature enables users to group key ranges together and control their leader and voter store placement through a RESTful API.

Key Changes

Adds complete REST API endpoints for affinity group management (create, get, update, delete, batch operations)
Implements HTTP client methods for all affinity group operations
Adds middleware to check if affinity scheduling is enabled before processing requests
Includes comprehensive test coverage for API handlers and client integration

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
server/apiv2/router.go	Registers affinity group API handlers with the v2 router
server/apiv2/middlewares/affinity_enabled_checker.go	New middleware to block requests when affinity scheduling is disabled
server/apiv2/handlers/affinity.go	Complete handler implementation for all affinity group API endpoints including create, get, update, delete, and batch modify operations
client/http/types.go	Defines client-side types for affinity group operations and responses
client/http/interface.go	Adds affinity group methods to the HTTP client interface and implements all operations
client/http/api.go	Adds API endpoint path constants for affinity groups
pkg/utils/apiutil/apiutil.go	Adds PutJSON utility function for PUT requests
pkg/utils/testutil/api_check.go	Adds CheckPutJSON helper for testing PUT endpoints
tests/server/apiv2/handlers/affinity_test.go	Comprehensive test suite covering all affinity group operations, error cases, and edge cases
tests/integrations/client/http_client_test.go	Integration tests for the HTTP client affinity group methods

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/server/apiv2/handlers/affinity_test.go

client/http/types.go

server/apiv2/handlers/affinity.go

Signed-off-by: lhy1024 <admin@liudos.us>

server/apiv2/handlers/affinity.go

okJiang · 2025-12-12T09:51:45Z

server/apiv2/handlers/affinity.go

+
+	// Convert internal manager output to API output.
+	resp := AffinityGroupsResponse{
+		AffinityGroups: make(map[string]*affinity.GroupState, len(req.AffinityGroups)),


Just a question. Is it necessary to return complete Group information?

Will we use it?

In the future, we will be able to include the correct StoreIDs in the return value of Create, which will help tidb update the cache faster.

Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 · 2025-12-12T10:20:00Z

@okJiang @rleungx PTAL

ti-chi-bot · 2025-12-12T11:39:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: okJiang, rleungx

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [rleungx]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ti-chi-bot · 2025-12-12T11:39:27Z

[LGTM Timeline notifier]

Timeline:

2025-12-12 11:33:11.489830316 +0000 UTC m=+1213536.303607889: ☑️ agreed by okJiang.
2025-12-12 11:39:26.396730655 +0000 UTC m=+1213911.210508217: ☑️ agreed by rleungx.

ref tikv#9764 Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>

ti-chi-bot · 2025-12-12T11:44:35Z

In response to a cherrypick label: new pull request created to branch release-8.5: #10058.
But this PR has conflicts, please resolve them!

ti-chi-bot · 2025-12-12T11:53:26Z

@lhy1024: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-unit-test-next-gen-2	`6653ab5`	link	unknown	`/test pull-unit-test-next-gen-2`

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

ref tikv#9764 Signed-off-by: lhy1024 <admin@liudos.us>

ti-chi-bot bot added release-note-none Denotes a PR that doesn't merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Dec 10, 2025

ti-chi-bot bot added dco-signoff: yes Indicates the PR's author has signed the dco. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 10, 2025

lhy1024 mentioned this pull request Dec 10, 2025

Support data affinity schedule for performance optimization #9764

Open

28 tasks

lhy1024 force-pushed the affinity-pr5 branch from 068e513 to fd696e6 Compare December 10, 2025 11:03

lhy1024 force-pushed the affinity-pr5 branch from fd696e6 to 31db939 Compare December 10, 2025 13:35

api: add affinity groups api and client support

137d358

Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 force-pushed the affinity-pr5 branch from 31db939 to 137d358 Compare December 11, 2025 10:05

lhy1024 marked this pull request as ready for review December 11, 2025 10:05

ti-chi-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 11, 2025

fix ci

23def0b

Signed-off-by: lhy1024 <admin@liudos.us>

rleungx reviewed Dec 12, 2025

View reviewed changes

lhy1024 requested a review from rleungx December 12, 2025 06:05

remove batch-delete

d10ecc9

Signed-off-by: lhy1024 <admin@liudos.us>

rleungx requested a review from Copilot December 12, 2025 08:56

Copilot started reviewing on behalf of rleungx December 12, 2025 08:57 View session

okJiang reviewed Dec 12, 2025

View reviewed changes

Copilot AI reviewed Dec 12, 2025

View reviewed changes

lhy1024 added 2 commits December 12, 2025 17:33

address comments

940acdc

Signed-off-by: lhy1024 <admin@liudos.us>

remove api check

1c9e44b

Signed-off-by: lhy1024 <admin@liudos.us>

okJiang reviewed Dec 12, 2025

View reviewed changes

address comments

6653ab5

Signed-off-by: lhy1024 <admin@liudos.us>

okJiang approved these changes Dec 12, 2025

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Dec 12, 2025

rleungx approved these changes Dec 12, 2025

View reviewed changes

ti-chi-bot bot added the lgtm label Dec 12, 2025

ti-chi-bot bot added approved and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Dec 12, 2025

ti-chi-bot bot merged commit 09f1b5d into tikv:master Dec 12, 2025
31 checks passed

ti-chi-bot pushed a commit to ti-chi-bot/pd that referenced this pull request Dec 12, 2025

This is an automated cherry-pick of tikv#10041

1a85036

ref tikv#9764 Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>

ti-chi-bot mentioned this pull request Dec 12, 2025

api: add affinity groups api and client support (#10041) #10058

Closed

lhy1024 added a commit to lhy1024/pd that referenced this pull request Dec 13, 2025

api: add affinity groups api and client support (tikv#10041)

8de3ba8

ref tikv#9764 Signed-off-by: lhy1024 <admin@liudos.us>

HunDunDM pushed a commit to HunDunDM/pd that referenced this pull request Dec 13, 2025

api: add affinity groups api and client support (tikv#10041)

ca1dbf3

ref tikv#9764 Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 added a commit to lhy1024/pd that referenced this pull request Dec 14, 2025

api: add affinity groups api and client support (tikv#10041)

9216a5a

ref tikv#9764 Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 added a commit to lhy1024/pd that referenced this pull request Dec 14, 2025

api: add affinity groups api and client support (tikv#10041)

1c6f8a3

ref tikv#9764 Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 added a commit to lhy1024/pd that referenced this pull request Dec 16, 2025

api: add affinity groups api and client support (tikv#10041)

2a02272

ref tikv#9764 Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 added a commit to lhy1024/pd that referenced this pull request Dec 16, 2025

api: add affinity groups api and client support (tikv#10041)

5830565

ref tikv#9764 Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 added a commit to lhy1024/pd that referenced this pull request Dec 16, 2025

api: add affinity groups api and client support (tikv#10041)

07d2140

ref tikv#9764 Signed-off-by: lhy1024 <admin@liudos.us>

lhy1024 mentioned this pull request Dec 17, 2025

cherrypick data affinity feature to release-8.5 #10061

Merged

api: add affinity groups api and client support #10041

api: add affinity groups api and client support #10041

Uh oh!

Conversation

lhy1024 commented Dec 10, 2025

What problem does this PR solve?

What is changed and how does it work?

Check List

Release note

Uh oh!

ti-chi-bot bot commented Dec 10, 2025

Uh oh!

codecov bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

lhy1024 commented Dec 11, 2025

Uh oh!

lhy1024 commented Dec 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhy1024 Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhy1024 commented Dec 12, 2025

Uh oh!

ti-chi-bot bot commented Dec 12, 2025

Uh oh!

ti-chi-bot bot commented Dec 12, 2025

[LGTM Timeline notifier]

Uh oh!

Uh oh!

ti-chi-bot commented Dec 12, 2025

Uh oh!

ti-chi-bot bot commented Dec 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

codecov bot commented Dec 10, 2025 •

edited

Loading

lhy1024 Dec 12, 2025 •

edited

Loading