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

Minor enhancement about listener #4931

Merged
merged 4 commits into from
Nov 28, 2022
Merged

Conversation

critical27
Copy link
Contributor

@critical27 critical27 commented Nov 24, 2022

What type of PR is this?

  • bug
  • feature
  • enhancement

What problem(s) does this PR solve?

Issue(s) number:

Description:

Also a prepare work:

  1. Only pass necessary parameter to Listener's constructor, other's could be passed to their inherited classes.
  2. Modify the comment about Listener to keep up with latest changes.

How do you solve it?

Special notes for your reviewer, ex. impact of this fix, design document, etc:

Checklist:

Tests:

  • Unit test(positive and negative cases)
  • Function test
  • Performance test
  • N/A

Affects:

  • Documentation affected (Please add the label if documentation needs to be modified.)
  • Incompatibility (If it breaks the compatibility, please describe it and add the label.)
  • If it's needed to cherry-pick (If cherry-pick to some branches is required, please label the destination version(s).)
  • Performance impacted: Consumes more CPU/Memory

Release notes:

Please confirm whether to be reflected in release notes and how to describe:

ex. Fixed the bug .....

liwenhui-soul
liwenhui-soul previously approved these changes Nov 24, 2022
Copy link
Contributor

@panda-sheep panda-sheep left a comment

Choose a reason for hiding this comment

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

Good job

* // Main interface to process logs, listener need to apply the committed log entry to their
* // state machine. Once apply succeeded, user should call persist() to make their progress
* // persisted.
* virtual void processLogs() = 0;
Copy link
Contributor

@panda-sheep panda-sheep Nov 25, 2022

Choose a reason for hiding this comment

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

I have a small question:
Why does the function comment here exist? Can it be removed?
Only leave functions, such as the above function, only need to leave
virtual void processLogs() = 0;

Otherwise, there are two copies of these comments, which feels a bit redundant?

@critical27 critical27 merged commit 645afb4 into vesoft-inc:master Nov 28, 2022
@critical27 critical27 deleted the fix branch November 30, 2022 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for review ready-for-testing PR: ready for the CI test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants