*: expose SetGlobalGCBarrier/DeleteGlobalGCBarrier API for pd client #9361

tiancaiamao · 2025-05-27T11:49:55Z

What problem does this PR solve?

Issue Number: ref #8978

What is changed and how does it work?

Based on #9340, so please review that PR before this one.
All the global GC barrier related API in the server side are implemented there.

This commit update the pd client part.
And also update GetAllKeyspacesGCStates to return global GC barriers.

Check List

Tests

Unit test
Integration test
Manual test (add detailed scripts or steps below)
No code

Code changes

Has the configuration change
Has HTTP API interfaces changed (Don't forget to add the declarative for the new API)
Has persistent data change

Side effects

Possible performance regression
Increased code complexity
Breaking backward compatibility

Related changes

PR to update pingcap/docs/pingcap/docs-cn:
PR to update pingcap/tiup:
Need to cherry-pick to the release branch

Release note

None.

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

ti-chi-bot · 2025-05-27T11:50:05Z

Hi @tiancaiamao. Thanks for your PR.

I'm waiting for a tikv member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

purelind · 2025-05-28T06:29:30Z

/retest

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

codecov · 2025-08-08T08:39:01Z

Codecov Report

❌ Patch coverage is 72.66187% with 38 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.86%. Comparing base (1ac8d8c) to head (11701da).
⚠️ Report is 19 commits behind head on master.

❌ Your patch status has failed because the patch coverage (72.66%) is below the target coverage (74.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #9361      +/-   ##
==========================================
+ Coverage   76.80%   76.86%   +0.05%     
==========================================
  Files         486      486              
  Lines       77396    77525     +129     
==========================================
+ Hits        59444    59589     +145     
+ Misses      14321    14299      -22     
- Partials     3631     3637       +6

Flag	Coverage Δ
unittests	`76.86% <72.66%> (+0.05%)`	⬆️

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: tiancaiamao <tiancaiamao@gmail.com>

client/clients/gc/client.go

MyonKeminta · 2025-08-13T04:32:42Z

client/clients/gc/client.go

+	// DeleteGlobalGCBarrier deletes a global GC barrier.
+	DeleteGlobalGCBarrier(ctx context.Context, barrierID string) (*GlobalGCBarrierInfo, error)
+	// Get the GC states from all keyspaces.
+	GetAllKeyspacesGCStates(ctx context.Context) (GCStates, error)


If you want to include it in this PR, consider adding it to the PR title. Also it might be a good idea to split it into another PR.
Actually I didn't expect this API to be needed in the golang PD client...

There is no GetGlobalGCBarriers API, so without this, how can you write tests?

client/clients/gc/client.go

client/gc_client.go

MyonKeminta · 2025-08-13T05:24:53Z

tests/integrations/client/client_test.go

The GetAllKeyspacesGCStates needs test coverage.

https://github.com/tikv/pd/pull/9361/files#diff-06dd564d14b6ddcba3265a1d8d868e76617cb078f4e8711d0ec6239cd30f7bd8R2641

tests/integrations/client/client_test.go

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

client/clients/gc/client.go

MyonKeminta · 2025-09-09T10:19:46Z

client/clients/gc/client.go

+	// DeleteGlobalGCBarrier deletes a global GC barrier.
+	DeleteGlobalGCBarrier(ctx context.Context, barrierID string) (*GlobalGCBarrierInfo, error)
+	// Get the GC states from all keyspaces.


Consider also expand these comments.

OK, I'm trying my best already

client/clients/gc/client.go

client/gc_client.go

client/metrics/metrics.go

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

ti-chi-bot · 2025-10-09T03:34:31Z

@MyonKeminta: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

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.

ti-chi-bot · 2025-10-13T02:41:55Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JmPotato, MyonKeminta, 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~~ [JmPotato,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-10-13T02:41:56Z

[LGTM Timeline notifier]

Timeline:

2025-10-09 08:04:48.981342658 +0000 UTC m=+341078.012441976: ☑️ agreed by JmPotato.
2025-10-13 02:41:55.226879987 +0000 UTC m=+62021.304132547: ☑️ agreed by rleungx.

rleungx · 2025-10-13T02:42:02Z

/ok-to-test

rleungx · 2025-10-13T02:42:40Z

/ok-to-test

ti-chi-bot · 2025-10-13T02:47:34Z

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

Test name	Commit	Details	Required	Rerun command
idc-jenkins-ci/build	`09c6e98`	link	true	`/test build`
non-block/pull-unit-test-next-gen	`11701da`	link	false	`/test pull-unit-test-next-gen`

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.

…ikv#9361) ref tikv#8978 Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

tiancaiamao added 13 commits May 21, 2025 12:18

add SetGlobalGCBarrier API and update AdvanceTxnSafePoint

5c82fdb

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

Merge branch 'master' into global-gc-barrier

1cf3791

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

add the grpc api

c4df2aa

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

add unit test

4e674cd

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

make fmt

b6caf12

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

add integration test

2ffe7a4

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

make fmt

0007cde

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

address comment

5a90975

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

update go.mod for latest kvproto

c8c26e5

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

fix tests

efd6f3d

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

Merge branch 'master' into global-gc-barrier

4a52539

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

update pd client to provide global gc barriers API

c3a1b95

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

update GetAllKeyspacesGCStates and add test

09c6e98

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

ti-chi-bot bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has signed the dco. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels May 27, 2025

ti-chi-bot bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 27, 2025

tiancaiamao mentioned this pull request Jun 4, 2025

gc: global GC barriers support #9340

Merged

2 tasks

tiancaiamao added 2 commits August 5, 2025 15:35

Merge branch 'master' into update-pdclient

085e37b

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

end

880cdbd

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

ti-chi-bot bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 5, 2025

tiancaiamao added 2 commits August 8, 2025 16:14

Merge branch 'master' into update-pdclient

588e7b2

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

checkout go.mod

53b0cd7

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

tiancaiamao added 3 commits August 8, 2025 16:51

lint?

3041687

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

make check

5febb98

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

Merge branch 'master' into update-pdclient

574545b

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

tiancaiamao added 2 commits August 12, 2025 11:56

address comment

cff1b51

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

address comment

5684113

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

MyonKeminta reviewed Aug 13, 2025

View reviewed changes

tests/integrations/client/client_test.go Outdated Show resolved Hide resolved

tests/integrations/client/client_test.go Outdated Show resolved Hide resolved

tests/integrations/client/client_test.go Outdated Show resolved Hide resolved

MyonKeminta reviewed Aug 13, 2025

View reviewed changes

tests/integrations/client/client_test.go Outdated Show resolved Hide resolved

tiancaiamao added 3 commits August 19, 2025 15:31

address comment

b93c24f

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

Merge branch 'master' into update-pdclient

10fd788

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

imporve test coverage a bit

faf6d9b

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

MyonKeminta reviewed Sep 9, 2025

View reviewed changes

tiancaiamao added 3 commits September 24, 2025 21:07

address comment

a06ad66

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

make lint happy

0ed0fa1

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

Merge branch 'master' into update-pdclient

11701da

Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

MyonKeminta mentioned this pull request Oct 9, 2025

Refactor GC related PD APIs #8978

Closed

24 tasks

MyonKeminta approved these changes Oct 9, 2025

View reviewed changes

JmPotato approved these changes Oct 9, 2025

View reviewed changes

ti-chi-bot bot added needs-1-more-lgtm Indicates a PR needs 1 more LGTM. approved labels Oct 9, 2025

rleungx approved these changes Oct 13, 2025

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Oct 13, 2025

ti-chi-bot bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Oct 13, 2025

ti-chi-bot bot merged commit 8e7aea4 into tikv:master Oct 13, 2025
26 of 29 checks passed

JmPotato pushed a commit to JmPotato/pd that referenced this pull request Dec 3, 2025

*: expose SetGlobalGCBarrier/DeleteGlobalGCBarrier API for pd client (t…

320e52c

…ikv#9361) ref tikv#8978 Signed-off-by: tiancaiamao <tiancaiamao@gmail.com>

*: expose SetGlobalGCBarrier/DeleteGlobalGCBarrier API for pd client #9361

*: expose SetGlobalGCBarrier/DeleteGlobalGCBarrier API for pd client #9361

Uh oh!

Conversation

tiancaiamao commented May 27, 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 May 27, 2025

Uh oh!

purelind commented May 28, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

MyonKeminta Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

tiancaiamao Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MyonKeminta Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

tiancaiamao Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MyonKeminta Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

tiancaiamao Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot bot commented Oct 9, 2025

Uh oh!

ti-chi-bot bot commented Oct 13, 2025

Uh oh!

ti-chi-bot bot commented Oct 13, 2025

[LGTM Timeline notifier]

Uh oh!

rleungx commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rleungx commented Oct 13, 2025

Uh oh!

ti-chi-bot bot commented Oct 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Aug 8, 2025 •

edited

Loading

rleungx commented Oct 13, 2025 •

edited

Loading