scheduler: Replace the input parameter of AddScheduler with types.CheckerSchedulerType. #8416

okJiang · 2024-07-18T03:55:31Z

What problem does this PR solve?

Issue Number: Ref #8379

What is changed and how does it work?

1. Replace the input parameter of AddScheduler with types.CheckerSchedulerType.
2. Simplified the logic of AddScheduler by using a temporary map.
3. Remove scope's redundant definition and use types.CheckerSchedulerType.

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: okJiang <[email protected]>

codecov · 2024-07-18T09:50:12Z

Codecov Report

Attention: Patch coverage is 88.23529% with 4 lines in your changes missing coverage. Please review.

Project coverage is 77.32%. Comparing base (1f14057) to head (e2935c7).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8416      +/-   ##
==========================================
- Coverage   77.35%   77.32%   -0.04%     
==========================================
  Files         472      472              
  Lines       61903    61807      -96     
==========================================
- Hits        47885    47790      -95     
- Misses      10428    10448      +20     
+ Partials     3590     3569      -21

Flag	Coverage Δ
unittests	`77.32% <88.23%> (-0.04%)`	⬇️

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

rleungx · 2024-07-19T08:06:56Z

pkg/schedule/type/type.go

@@ -70,3 +70,46 @@ const (
 	// LabelScheduler is label scheduler name.
 	LabelScheduler CheckerSchedulerType = "label-scheduler"
 )
+
+// SchedulerTypeCompatibleMap temporarily exists for compatibility.


I suggest adding more explanation about when we need to consider the compatibility.

I don't think there is a need to explain in the code now. Its current role is only to do a layer of conversion when the user adds a scheduler. If it is used in more places in the future, or permanently exists in the code, I will add a more accurate description to it. How about this?

ping @rleungx

I am just wondering when we need to consider the compatibility.

This is an intermediate pr, it may be deleted in the subsequent pr, if it stays, I will add more comments

okJiang · 2024-07-23T08:13:50Z

server/handler.go

@@ -186,7 +185,8 @@ func (h *Handler) GetAllRequestHistoryHotRegion(request *HistoryHotRegionsReques
 }

 // AddScheduler adds a scheduler.
-func (h *Handler) AddScheduler(name string, args ...string) error {
+func (h *Handler) AddScheduler(tp types.CheckerSchedulerType, args ...string) error {
+	name := types.SchedulerTypeCompatibleMap[tp]


This line may be removed in the subsequent pr.

okJiang · 2024-07-23T08:14:24Z

Could you take a look? @HuSharp @JmPotato

HuSharp

rest LGTM

server/api/scheduler.go

Signed-off-by: okJiang <[email protected]>

ti-chi-bot · 2024-07-25T03:00:42Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [HuSharp,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 · 2024-07-25T03:00:43Z

[LGTM Timeline notifier]

Timeline:

2024-07-23 08:08:23.956983867 +0000 UTC m=+946125.947925338: ☑️ agreed by rleungx.
2024-07-25 03:00:43.13113123 +0000 UTC m=+1100465.122072701: ☑️ agreed by HuSharp.

ti-chi-bot · 2024-07-25T03:01:51Z

@okJiang: Your PR was out of date, I have automatically updated it for you.

If the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

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 ti-community-infra/tichi repository.

okJiang added 2 commits July 18, 2024 11:49

update handler.CreateScheduler

f8f0d93

Signed-off-by: okJiang <[email protected]>

remove redundant definition

2c80eef

Signed-off-by: okJiang <[email protected]>

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. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 18, 2024

okJiang mentioned this pull request Jul 18, 2024

Standardize the use of scheduler name/type and checker name/type #8379

Closed

trigger ci

5ecb0a6

Signed-off-by: okJiang <[email protected]>

okJiang marked this pull request as draft July 18, 2024 07:18

ti-chi-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 18, 2024

okJiang added 2 commits July 18, 2024 17:06

fix ci

11db5aa

Signed-off-by: okJiang <[email protected]>

fix ci

53eb110

Signed-off-by: okJiang <[email protected]>

okJiang marked this pull request as ready for review July 18, 2024 10:02

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 Jul 18, 2024

rleungx reviewed Jul 19, 2024

View reviewed changes

rleungx approved these changes Jul 23, 2024

View reviewed changes

ti-chi-bot bot added needs-1-more-lgtm Indicates a PR needs 1 more LGTM. approved labels Jul 23, 2024

okJiang commented Jul 23, 2024

View reviewed changes

HuSharp reviewed Jul 24, 2024

View reviewed changes

server/api/scheduler.go Outdated Show resolved Hide resolved

fix comment

b192be8

Signed-off-by: okJiang <[email protected]>

HuSharp approved these changes Jul 25, 2024

View reviewed changes

ti-chi-bot bot added the lgtm label Jul 25, 2024

ti-chi-bot bot removed the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 25, 2024

Merge branch 'master' into name3-1

e2935c7

ti-chi-bot bot merged commit e8c05e0 into tikv:master Jul 25, 2024
25 checks passed

okJiang deleted the name3-1 branch July 25, 2024 03:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

scheduler: Replace the input parameter of AddScheduler with types.CheckerSchedulerType. #8416

scheduler: Replace the input parameter of AddScheduler with types.CheckerSchedulerType. #8416

okJiang commented Jul 18, 2024 •

edited

Loading

codecov bot commented Jul 18, 2024 •

edited

Loading

rleungx Jul 19, 2024

okJiang Jul 19, 2024 •

edited

Loading

okJiang Jul 22, 2024

rleungx Jul 23, 2024 •

edited

Loading

okJiang Jul 23, 2024

okJiang Jul 23, 2024

okJiang commented Jul 23, 2024

HuSharp left a comment

ti-chi-bot bot commented Jul 25, 2024

ti-chi-bot bot commented Jul 25, 2024

ti-chi-bot bot commented Jul 25, 2024

scheduler: Replace the input parameter of AddScheduler with types.CheckerSchedulerType. #8416

scheduler: Replace the input parameter of AddScheduler with types.CheckerSchedulerType. #8416

Conversation

okJiang commented Jul 18, 2024 • edited Loading

What problem does this PR solve?

What is changed and how does it work?

Check List

Release note

codecov bot commented Jul 18, 2024 • edited Loading

Codecov Report

rleungx Jul 19, 2024

Choose a reason for hiding this comment

okJiang Jul 19, 2024 • edited Loading

Choose a reason for hiding this comment

okJiang Jul 22, 2024

Choose a reason for hiding this comment

rleungx Jul 23, 2024 • edited Loading

Choose a reason for hiding this comment

okJiang Jul 23, 2024

Choose a reason for hiding this comment

okJiang Jul 23, 2024

Choose a reason for hiding this comment

okJiang commented Jul 23, 2024

HuSharp left a comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Jul 25, 2024

ti-chi-bot bot commented Jul 25, 2024

[LGTM Timeline notifier]

ti-chi-bot bot commented Jul 25, 2024

okJiang commented Jul 18, 2024 •

edited

Loading

codecov bot commented Jul 18, 2024 •

edited

Loading

okJiang Jul 19, 2024 •

edited

Loading

rleungx Jul 23, 2024 •

edited

Loading