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

table: make AddRecordOpt/UpdateRecordOpt/CreateIdxOpt immutable #55325

Merged
merged 1 commit into from
Aug 9, 2024

Conversation

lcwangchao
Copy link
Collaborator

@lcwangchao lcwangchao commented Aug 9, 2024

What problem does this PR solve?

Issue Number: ref #54397

Problem Summary:

We should to make XXXOpt in table immutable to avoid some potential bugs introduced by modifying its inner state and then shared with other operations. See issue: #55313

What changed and how does it work?

  • Make the fields in the opt objects private to avoid modification directly in other package.
  • Make the method in the interfaces AddRecordOption / UpdateRecordOption / CreateIdxOption private to forbid outside package to use them.

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/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 9, 2024
Copy link

tiprow bot commented Aug 9, 2024

Hi @lcwangchao. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

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.

@lcwangchao
Copy link
Collaborator Author

/retest

Copy link

tiprow bot commented Aug 9, 2024

@lcwangchao: 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

codecov bot commented Aug 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.8394%. Comparing base (2a731e6) to head (d703a45).
Report is 2 commits behind head on master.

Additional details and impacted files
@@               Coverage Diff                @@
##             master     #55325        +/-   ##
================================================
+ Coverage   72.8378%   74.8394%   +2.0016%     
================================================
  Files          1570       1570                
  Lines        439564     440563       +999     
================================================
+ Hits         320169     329715      +9546     
+ Misses        99701      90647      -9054     
- Partials      19694      20201       +507     
Flag Coverage Δ
integration 49.0766% <94.3396%> (?)
unit 71.9630% <100.0000%> (+0.0905%) ⬆️

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

Components Coverage Δ
dumpling 52.9567% <ø> (ø)
parser ∅ <ø> (∅)
br 52.5154% <ø> (+6.6399%) ⬆️

// CreateIdxOptFunc is defined for the Create() method of Index interface.
// Here is a blog post about how to use this pattern:
// https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis
type CreateIdxOptFunc func(*CreateIdxOpt)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Also delete CreateIdxOptFunc to avoid some operations like WithIgnoreAssertion(createIdxOpt) to modify the internal state of CreateIdxOpt.

Copy link
Contributor

@cfzjywxk cfzjywxk 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 needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Aug 9, 2024
Copy link

ti-chi-bot bot commented Aug 9, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cfzjywxk, wjhuang2016

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

@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Aug 9, 2024
Copy link

ti-chi-bot bot commented Aug 9, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-08-09 07:13:30.134014288 +0000 UTC m=+595340.001113376: ☑️ agreed by cfzjywxk.
  • 2024-08-09 07:20:29.235238255 +0000 UTC m=+595759.102337343: ☑️ agreed by wjhuang2016.

@ti-chi-bot ti-chi-bot bot merged commit bf7c8b1 into pingcap:master Aug 9, 2024
23 checks passed
@lcwangchao lcwangchao deleted the immitableopt branch August 9, 2024 13:25
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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants