Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ddl/dxf: refine internal docs and some log refactor #58881

Merged
merged 5 commits into from
Jan 14, 2025

Conversation

D3Hunter
Copy link
Contributor

What problem does this PR solve?

Issue Number: ref #57497

Problem Summary:

What changed and how does it work?

  • previously they are scatter around in different files, it's harder for starters to understand how DXF works
  • add docs for service scope and resource abstraction
  • refactor some logs and comments

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No need to test
    • I checked and no code files have been changed.

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

@ti-chi-bot ti-chi-bot bot added release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 13, 2025
@tiprow tiprow bot added the needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. label Jan 13, 2025
Copy link

tiprow bot commented Jan 13, 2025

Hi @D3Hunter. Thanks for your PR.

I'm waiting for a pingcap 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.

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.

@hawkingrei hawkingrei removed the needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. label Jan 13, 2025
@D3Hunter D3Hunter requested a review from lance6716 January 13, 2025 08:20
Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.8345%. Comparing base (c44672e) to head (6bbc0e1).
Report is 11 commits behind head on master.

Additional details and impacted files
@@               Coverage Diff                @@
##             master     #58881        +/-   ##
================================================
+ Coverage   73.1281%   74.8345%   +1.7064%     
================================================
  Files          1678       1723        +45     
  Lines        464006     473145      +9139     
================================================
+ Hits         339319     354076     +14757     
+ Misses       103827      96735      -7092     
- Partials      20860      22334      +1474     
Flag Coverage Δ
integration 48.9908% <20.0000%> (?)
unit 72.2930% <100.0000%> (-0.0357%) ⬇️

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

Components Coverage Δ
dumpling 52.6910% <ø> (ø)
parser ∅ <ø> (∅)
br 61.5029% <ø> (+15.7579%) ⬆️

@D3Hunter D3Hunter changed the title dxf: refine internal docs and some log refactor ddl/dxf: refine internal docs and some log refactor Jan 13, 2025
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 14, 2025
Copy link
Contributor

@GMHDBJD GMHDBJD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ti-chi-bot ti-chi-bot bot added approved lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jan 14, 2025
Copy link

ti-chi-bot bot commented Jan 14, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-01-14 02:20:04.979882205 +0000 UTC m=+838548.268713910: ☑️ agreed by CbcWestwolf.
  • 2025-01-14 02:23:43.705631544 +0000 UTC m=+838766.994463229: ☑️ agreed by GMHDBJD.

Copy link
Contributor

@lance6716 lance6716 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/hold

reviewing, please check if there are typos

@ti-chi-bot ti-chi-bot bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 14, 2025
Copy link

ti-chi-bot bot commented Jan 14, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CbcWestwolf, GMHDBJD, lance6716

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:

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

@D3Hunter
Copy link
Contributor Author

/hold

reviewing, please check if there are typos

didn't find others, will unhold

@D3Hunter
Copy link
Contributor Author

/unhold

@ti-chi-bot ti-chi-bot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 14, 2025
@lance6716
Copy link
Contributor

/retest

1 similar comment
@D3Hunter
Copy link
Contributor Author

/retest

Copy link

tiprow bot commented Jan 14, 2025

@lance6716: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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.

Copy link

tiprow bot commented Jan 14, 2025

@D3Hunter: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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 ti-chi-bot bot merged commit 87867eb into pingcap:master Jan 14, 2025
23 of 25 checks passed
@D3Hunter D3Hunter deleted the refine-docs branch January 14, 2025 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants