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

fix: fix ZkHelixPropertyStore memeory leak issue #2626

Closed

Conversation

MarkGaox
Copy link
Contributor

@MarkGaox MarkGaox commented Sep 20, 2023

Issues

  • My PR addresses the following Helix issues and references them in the PR description:
    A potential memory leak may arise when the user calls getHelixPropertyStore(). This is because upon calling HelixManager.disconnect(), _helixPropertyStore is just set to null while a stop() method is needed to clean up the memory. Double checked other class variables. And it seems like _helixPropertyStore is the only class variable that isn't properly cleaned up after manager disconnects.

(#200 - Link your issue number here: You can write "Fixes #XXX". Please use the proper keyword so that the issue gets closed automatically. See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
Any of the following keywords can be used: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved)

Description

  • Here are some details about my PR, including screenshots of any UI changes:
    Stop ZkHelixPropertyStore when the ZkHelixManager closes out.
    (Write a concise description including what, why, how)

Tests

  • The following tests are written for this issue:
    mvn test -Dtest=TestZkClusterManager
    (List the names of added unit/integration tests)

  • The following is the result of the "mvn test" command on the appropriate module:

[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 12.668 s - in org.apache.helix.manager.zk.TestZkClusterManager
[INFO] 
[INFO] Results:
[INFO] 
[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] 
[INFO] --- jacoco:0.8.6:report (generate-code-coverage-report) @ helix-core ---
[INFO] Loading execution data file /Users/xiaxgao/IdeaProjects/helix_ps/helix-core/target/jacoco.exec
[INFO] Analyzed bundle 'Apache Helix :: Core' with 946 classes
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  16.712 s
[INFO] Finished at: 2023-09-20T15:57:01-07:00
[INFO] ------------------------------------------------------------------------

(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)

Changes that Break Backward Compatibility (Optional)

  • My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:

(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)

Documentation (Optional)

  • In case of new functionality, my PR adds documentation in the following wiki page:

(Link the GitHub wiki you added)

Commits

  • My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Code Quality

  • My diff has been formatted using helix-style.xml
    (helix-style-intellij.xml if IntelliJ IDE is used)

Copy link
Contributor

@himanshukandwal himanshukandwal left a comment

Choose a reason for hiding this comment

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

Thanks @MarkGaox for the fix!

Copy link
Contributor

@xyuanlu xyuanlu left a comment

Choose a reason for hiding this comment

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

Thanks for the PR.
Please include more accurate info in commit summary.

@MarkGaox
Copy link
Contributor Author

This change is approved by @himanshukandwal @xyuanlu
Commit message "Stop helixPropertyStore immediately after ZkHelixManager is disconnected"

@junkaixue
Copy link
Contributor

Just mark it here. This may cause problem if property store closes the zkclient without synchronized on HelixManager object as HelixManager owns the zkclient.

@MarkGaox MarkGaox closed this Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants