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 sofaruntime manager destroy whitout shutdown #1324

Merged
merged 1 commit into from
May 23, 2024

Conversation

CrazyHZM
Copy link
Contributor

@CrazyHZM CrazyHZM commented May 23, 2024

see #1321

Summary by CodeRabbit

  • Bug Fixes
    • Improved shutdown handling for SofaRuntimeManager to ensure it is properly shut down before removal.
    • Enhanced business artifact uninstallation process to prevent errors by checking if sofaRuntimeManager is not null before shutting it down.

@sofastack-cla sofastack-cla bot added bug Something isn't working cla:yes size/S labels May 23, 2024
Copy link

coderabbitai bot commented May 23, 2024

Walkthrough

The recent changes enhance the shutdown process of SofaRuntimeManager in SofaRuntimeContainer and SofaBizUninstallEventHandler. SofaRuntimeContainer now ensures proper shutdown of SofaRuntimeManager before removal, while SofaBizUninstallEventHandler includes a null check before external shutdown.

Changes

File Path Change Summary
.../SofaRuntimeContainer.java Enhanced destroy method to safely shut down SofaRuntimeManager before removal from the map.
.../SofaBizUninstallEventHandler.java Modified doUninstallBiz method to include a null check before shutting down SofaRuntimeManager.
.../SofaRuntimeContainerTests.java, .../SofaBizUninstallEventHandlerTests.java Test methods and assertions related to SofaRuntimeManager handling were updated or removed.

In the realm of code, where logic flows,
A rabbit hops and swiftly knows,
To shut down right, avoid the plight,
Ensuring managers sleep tight.
With checks in place, no errors trace,
The system's grace, a smoother pace.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between b78f29d and 0e6d92b.
Files selected for processing (2)
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/SofaRuntimeContainer.java (1 hunks)
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/handler/SofaBizUninstallEventHandler.java (1 hunks)
Additional comments not posted (1)
sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/handler/SofaBizUninstallEventHandler.java (1)

48-49: LGTM! The addition of the null check before shutting down the SofaRuntimeManager enhances robustness.

Verification successful

The verification script successfully identified instances where SofaRuntimeManager is checked for null before usage. The results show that the null check is present in the following files:

  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/SofaRuntimeContainer.java
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/handler/SofaBizUninstallEventHandler.java

This confirms that the null check is consistently applied in the relevant parts of the codebase.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify integration with other components interacting with `SofaRuntimeManager`.

# Test: Search for other usages of `SofaRuntimeManager` to ensure they handle null cases.
rg --type java $'SofaRuntimeManager' --exec cat {} | grep 'if (sofaRuntimeManager != null)'

Length of output: 501



Script:

#!/bin/bash
# Description: Verify integration with other components interacting with `SofaRuntimeManager`.

# Test: Search for other usages of `SofaRuntimeManager` to ensure they handle null cases.
rg 'SofaRuntimeManager' --type java | xargs grep 'if (sofaRuntimeManager != null)'

Length of output: 38490



Script:

#!/bin/bash
# Description: Verify integration with other components interacting with `SofaRuntimeManager`.

# Test: Search for other usages of `SofaRuntimeManager` to ensure they handle null cases.
rg 'SofaRuntimeManager' --type java --files-with-matches | xargs grep -H 'if (sofaRuntimeManager != null)'

Length of output: 430

Comment on lines +110 to +112
SofaRuntimeManager sofaRuntimeManager = SOFA_RUNTIME_MANAGER_MAP.remove(contextClassLoader);
if (sofaRuntimeManager != null) {
sofaRuntimeManager.shutDownExternally();
}
Copy link

Choose a reason for hiding this comment

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

LGTM! Properly shutting down SofaRuntimeManager before removal is a good practice for clean resource management.

Consider adding logging before and after the shutdown process to enhance traceability and debugging.

+ logger.info("Shutting down SofaRuntimeManager for class loader: " + contextClassLoader);
  sofaRuntimeManager.shutDownExternally();
+ logger.info("Shutdown complete for SofaRuntimeManager.");

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
SofaRuntimeManager sofaRuntimeManager = SOFA_RUNTIME_MANAGER_MAP.remove(contextClassLoader);
if (sofaRuntimeManager != null) {
sofaRuntimeManager.shutDownExternally();
}
SofaRuntimeManager sofaRuntimeManager = SOFA_RUNTIME_MANAGER_MAP.remove(contextClassLoader);
if (sofaRuntimeManager != null) {
logger.info("Shutting down SofaRuntimeManager for class loader: " + contextClassLoader);
sofaRuntimeManager.shutDownExternally();
logger.info("Shutdown complete for SofaRuntimeManager.");
}

Signed-off-by: JermaineHua <crazyhzm@apache.org>
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 0e6d92b and 355fedc.
Files selected for processing (4)
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/SofaRuntimeContainer.java (3 hunks)
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/handler/SofaBizUninstallEventHandler.java (1 hunks)
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/test/java/com/alipay/sofa/boot/ark/SofaRuntimeContainerTests.java (1 hunks)
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/test/java/com/alipay/sofa/boot/ark/handler/SofaBizUninstallEventHandlerTests.java (2 hunks)
Files skipped from review due to trivial changes (1)
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/test/java/com/alipay/sofa/boot/ark/handler/SofaBizUninstallEventHandlerTests.java
Files skipped from review as they are similar to previous changes (2)
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/SofaRuntimeContainer.java
  • sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/main/java/com/alipay/sofa/boot/ark/handler/SofaBizUninstallEventHandler.java
Additional comments not posted (1)
sofa-boot-project/sofa-boot-core/ark-sofa-boot/src/test/java/com/alipay/sofa/boot/ark/SofaRuntimeContainerTests.java (1)

96-96: The updated destroy method now correctly accepts a ClassLoader parameter, enhancing the test's specificity and accuracy.

Copy link

codecov bot commented May 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.12%. Comparing base (b78f29d) to head (355fedc).
Report is 1 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #1324      +/-   ##
============================================
+ Coverage     83.08%   83.12%   +0.03%     
+ Complexity     2964     2960       -4     
============================================
  Files           337      337              
  Lines          9718     9711       -7     
  Branches       1173     1174       +1     
============================================
- Hits           8074     8072       -2     
+ Misses         1133     1128       -5     
  Partials        511      511              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@HzjNeverStop HzjNeverStop left a comment

Choose a reason for hiding this comment

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

LGTM

@HzjNeverStop HzjNeverStop merged commit 9bfbb73 into sofastack:master May 23, 2024
7 checks passed
@CrazyHZM CrazyHZM deleted the fix/lifecycle branch May 23, 2024 09:57
@NoTimeKeeper
Copy link

LGTM

@HzjNeverStop 你好,合并后可以构建下并部署到mvnrepository仓库吗,似乎现在的还是之前的

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working cla:yes size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants