api: add role_name and is_learner to the returned peer info

[HunDunDM]

Signed-off-by: HunDunDM hundundm@gmail.com

What problem does this PR solve?

close #3372 tidb#24293

What is changed and how it works?

• api: add role_name and is_learner to the returned peer info

Check List

Tests

• Unit test
• Manual test (add detailed scripts or steps below)

Before

region 83693
{
  "id": 83693,
  "peers": [
    {
      "id": 83694,
      "store_id": 1
    },
    {
      "id": 83695,
      "store_id": 51
    },
    {
      "id": 83696,
      "store_id": 76
    },
    {
      "id": 104792,
      "store_id": 101,
      "role": 1
    }
  ],
  "leader": {
    "id": 83694,
    "store_id": 1
  },
  ...
}

SELECT * FROM INFORMATION_SCHEMA.TIKV_REGION_PEERS WHERE REGION_ID=83693;
+-----------+---------+----------+------------+-----------+--------+--------------+
| REGION_ID | PEER_ID | STORE_ID | IS_LEARNER | IS_LEADER | STATUS | DOWN_SECONDS |
+-----------+---------+----------+------------+-----------+--------+--------------+
|     83693 |   83694 |        1 |          0 |         1 | NORMAL |         NULL |
|     83693 |   83695 |       51 |          0 |         0 | NORMAL |         NULL |
|     83693 |   83696 |       76 |          0 |         0 | NORMAL |         NULL |
|     83693 |  104792 |      101 |          0 |         0 | NORMAL |         NULL |
+-----------+---------+----------+------------+-----------+--------+--------------+

After

region 83693                                                                                                                                   
{
  "id": 83693,
  "peers": [
    {
      "id": 83694,
      "store_id": 1,
      "role_name": "Voter"
    },
    {
      "id": 83695,
      "store_id": 51,
      "role_name": "Voter"
    },
    {
      "id": 83696,
      "store_id": 76,
      "role_name": "Voter"
    },
    {
      "id": 104792,
      "store_id": 101,
      "role": 1,
      "role_name": "Learner",
      "is_learner": true
    }
  ],
  "leader": {
    "id": 83696,
    "store_id": 76,
    "role_name": "Voter"
  },
  ...
}

SELECT * FROM INFORMATION_SCHEMA.TIKV_REGION_PEERS WHERE REGION_ID=83693;
+-----------+---------+----------+------------+-----------+--------+--------------+
| REGION_ID | PEER_ID | STORE_ID | IS_LEARNER | IS_LEADER | STATUS | DOWN_SECONDS |
+-----------+---------+----------+------------+-----------+--------+--------------+
|     83693 |   83694 |        1 |          0 |         0 | NORMAL |         NULL |
|     83693 |   83695 |       51 |          0 |         0 | NORMAL |         NULL |
|     83693 |   83696 |       76 |          0 |         1 | NORMAL |         NULL |
|     83693 |  104792 |      101 |          1 |         0 | NORMAL |         NULL |
+-----------+---------+----------+------------+-----------+--------+--------------+

Side effects

• Possible performance regression
  • When /regions returns a large number of regions

Before

goos: darwin
goarch: amd64
pkg: github.com/tikv/pd/server/api
cpu: Intel(R) Core(TM) i5-7360U CPU @ 2.30GHz
BenchmarkConvertToAPIRegions-4               571           1918032 ns/op
BenchmarkConvertToAPIRegions-4               584           1892309 ns/op
BenchmarkConvertToAPIRegions-4               570           1918750 ns/op
BenchmarkConvertToAPIRegions-4               592           2220998 ns/op
BenchmarkConvertToAPIRegions-4               598           1936396 ns/op

After

goos: darwin
goarch: amd64
pkg: github.com/tikv/pd/server/api
cpu: Intel(R) Core(TM) i5-7360U CPU @ 2.30GHz
BenchmarkConvertToAPIRegions-4               368           3293800 ns/op
BenchmarkConvertToAPIRegions-4               375           3128312 ns/op
BenchmarkConvertToAPIRegions-4               368           3121975 ns/op
BenchmarkConvertToAPIRegions-4               374           3114500 ns/op
BenchmarkConvertToAPIRegions-4               373           3083650 ns/op

Related changes

• Need to cherry-pick to the release branch

Release note

• Fix the bug that the is_learner field of the Region Peer in TiDB is incorrect.

[sonarcloud]

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
4.9% Duplication

[codecov]

Codecov Report

Merging #3643 (8562081) into master (c6ce285) will decrease coverage by 0.29%.
The diff coverage is 96.66%.

❗ Current head 8562081 differs from pull request most recent head 76bc290. Consider uploading reports for the commit 76bc290 to get more accurate results

@@            Coverage Diff             @@
##           master    #3643      +/-   ##
==========================================
- Coverage   74.97%   74.67%   -0.30%     
==========================================
  Files         244      245       +1     
  Lines       24403    24162     -241     
==========================================
- Hits        18296    18044     -252     
- Misses       4489     4504      +15     
+ Partials     1618     1614       -4     

Flag	Coverage Δ
unittests	74.67% <96.66%> (-0.30%)	⬇️

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

Impacted Files	Coverage Δ
server/api/region.go	65.84% <96.15%> (+1.66%)	⬆️
tests/pdctl/helper.go	100.00% <100.00%> (ø)
pkg/tempurl/tempurl.go	45.00% <0.00%> (-15.00%)	⬇️
server/tso/allocator_manager.go	74.05% <0.00%> (-9.09%)	⬇️
server/statistics/hot_cache.go	92.85% <0.00%> (-3.89%)	⬇️
server/schedule/region_splitter.go	65.71% <0.00%> (-3.81%)	⬇️
server/schedulers/random_merge.go	60.00% <0.00%> (-3.34%)	⬇️
server/core/region_tree.go	91.34% <0.00%> (-3.23%)	⬇️
server/tso/tso.go	68.71% <0.00%> (-3.20%)	⬇️
server/statistics/hot_peer_cache.go	93.18% <0.00%> (-2.67%)	⬇️
... and 48 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 57932d6...76bc290. Read the comment docs.

[ti-chi-bot]

[REVIEW NOTIFICATION]

This pull request has been approved by:

• JmPotato
• disksing

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

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

Reviewer can indicate their review by writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

[HunDunDM]

/merge

[ti-chi-bot]

@HunDunDM: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

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.

[ti-chi-bot]

This pull request has been accepted and is ready to merge.

Commit hash: ffa896c

[ti-chi-bot]

In response to a cherrypick label: new pull request created: #3743.