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

修复静态合并部署时,springcloud依赖兼容性问题导致模块先于基座被加载的问题(#1032) #1033

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

YanZhipeng-UESTC
Copy link

@YanZhipeng-UESTC YanZhipeng-UESTC commented Nov 22, 2024

issue: #1032

Summary by CodeRabbit

  • Bug Fixes
    • Improved the deployment logic for static business processes to ensure they only occur under specific conditions, enhancing application stability.

Copy link

sofastack-cla bot commented Nov 22, 2024

Hi @YanZhipeng-UESTC, welcome to SOFAStack community, Please sign Contributor License Agreement!

After you signed CLA, we will automatically sync the status of this pull request in 3 minutes.

Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

Walkthrough

The changes involve a modification to the onApplicationEvent method in the ArkDeployStaticBizListener class. The enhancement introduces an additional condition to the existing check for event instances, ensuring that static business logic is deployed only when the event's application context is a ConfigurableWebServerApplicationContext. This adjustment refines the control flow to prevent unintended deployments in inappropriate contexts.

Changes

File Change Summary
sofa-ark-parent/support/ark-springboot-integration/ark-springboot-starter/src/main/java/com/alipay/sofa/ark/springboot/listener/ArkDeployStaticBizListener.java Modified onApplicationEvent method to include a check for ConfigurableWebServerApplicationContext. Added import for the new class.

Poem

In the land of code, where logic flows,
A listener waits, as the event grows.
With checks in place, deployments align,
No more mishaps, everything's fine!
Hopping through changes, we celebrate here,
A refined flow brings us all cheer! 🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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
Contributor

@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

🧹 Outside diff range and nitpick comments (2)
sofa-ark-parent/support/ark-springboot-integration/ark-springboot-starter/src/main/java/com/alipay/sofa/ark/springboot/listener/ArkDeployStaticBizListener.java (2)

21-21: Consider documenting web server requirement

The addition of ConfigurableWebServerApplicationContext check makes this component specific to web applications. This architectural constraint should be documented to prevent misuse in non-web contexts.

Consider adding a class-level JavaDoc comment explaining this requirement:

/**
 * Listener for deploying static biz modules after master biz startup.
 * Note: This listener requires a web application context and won't deploy modules in non-web environments.
 */

37-41: Consider adding debug logging

For better troubleshooting of deployment timing issues, consider adding debug logging to explain why deployment was skipped or executed.

Add logging statements:

 if (event instanceof ContextRefreshedEvent
     && event.getApplicationContext() instanceof ConfigurableWebServerApplicationContext) {
+    logger.debug("Deploying static biz after master biz started in web context");
     EmbedSofaArkBootstrap.deployStaticBizAfterEmbedMasterBizStarted();
+ } else {
+    logger.debug("Skipping static biz deployment: refreshEvent={}, webContext={}",
+        event instanceof ContextRefreshedEvent,
+        event.getApplicationContext() instanceof ConfigurableWebServerApplicationContext);
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7ab39b4 and 0e4604e.

📒 Files selected for processing (1)
  • sofa-ark-parent/support/ark-springboot-integration/ark-springboot-starter/src/main/java/com/alipay/sofa/ark/springboot/listener/ArkDeployStaticBizListener.java (2 hunks)
🔇 Additional comments (1)
sofa-ark-parent/support/ark-springboot-integration/ark-springboot-starter/src/main/java/com/alipay/sofa/ark/springboot/listener/ArkDeployStaticBizListener.java (1)

37-38: Verify compatibility with existing use cases

The additional check for ConfigurableWebServerApplicationContext fixes the Spring Cloud initialization issue, but we should verify this doesn't affect other valid use cases.

Let's check for any non-web context usage patterns in tests or examples:

✅ Verification successful

The ConfigurableWebServerApplicationContext check appears safe to implement

The verification shows that:

  1. The listener is registered via spring.factories as a general ApplicationListener
  2. No explicit non-web usage patterns were found in the codebase
  3. No specific configuration properties or documentation indicate non-web use cases
  4. The static deployment feature appears to be inherently tied to web applications

The change to check for ConfigurableWebServerApplicationContext is a targeted fix for Spring Cloud initialization issues and doesn't appear to break any existing use cases, as static biz deployment seems to be a web-specific feature.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for test cases or examples that might be affected
rg -l "ArkDeployStaticBizListener" | while read -r file; do
  if [[ $file =~ .*Test.* ]] || [[ $file =~ .*Example.* ]]; then
    echo "=== $file ==="
    rg -A 10 "ArkDeployStaticBizListener" "$file"
  fi
done

Length of output: 723


Script:

#!/bin/bash
# Let's check how this listener is registered and used
echo "=== Checking spring.factories configuration ==="
cat sofa-ark-parent/support/ark-springboot-integration/ark-springboot-starter/src/main/resources/META-INF/spring.factories

echo -e "\n=== Checking for non-web application usage patterns ==="
rg -B 3 -A 3 "ArkDeployStaticBizListener|StaticBizDeployment" --type java

echo -e "\n=== Checking for any documentation or comments about usage ==="
fd README.md | xargs rg -i "static.*biz|deploy.*static"

Length of output: 2586


Script:

#!/bin/bash
# Let's check for any configuration properties or deployment logic related to static biz deployment
echo "=== Checking for static deployment configuration ==="
rg -B 2 -A 2 "static.*deployment|deploy.*static" --type java

echo -e "\n=== Checking for any Spring Boot configuration properties ==="
fd "application.properties|application.yml|bootstrap.properties|bootstrap.yml" | xargs rg -i "static.*biz|deploy.*static"

echo -e "\n=== Checking for any web-specific configuration or usage ==="
ast-grep --pattern 'class $_ implements ApplicationListener<$_> {
  $$$
  onApplicationEvent($_) {
    $$$
  }
}'

Length of output: 693

@gaosaroma gaosaroma self-requested a review November 25, 2024 05:52
Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.34%. Comparing base (7ab39b4) to head (0e4604e).
Report is 8 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #1033      +/-   ##
============================================
+ Coverage     78.20%   78.34%   +0.14%     
  Complexity      874      874              
============================================
  Files           171      171              
  Lines          7056     7056              
  Branches       1037     1037              
============================================
+ Hits           5518     5528      +10     
+ Misses         1006      995      -11     
- Partials        532      533       +1     

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

Copy link
Collaborator

@gaosaroma gaosaroma left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -33,7 +34,8 @@ public void onApplicationEvent(ApplicationContextEvent event) {
return;
}
if (ArkConfigs.isEmbedEnable() && ArkConfigs.isEmbedStaticBizEnable()) {
if (event instanceof ContextRefreshedEvent) {
if (event instanceof ContextRefreshedEvent
&& event.getApplicationContext() instanceof ConfigurableWebServerApplicationContext) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

如果master biz 非web应用,也无法走进这个if

Copy link

This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

@github-actions github-actions bot added the stale label Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants