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

add logging.file.path to get config from user app config #894

Merged
merged 7 commits into from
Mar 30, 2024
Merged

Conversation

lvjing2
Copy link
Collaborator

@lvjing2 lvjing2 commented Mar 30, 2024

Summary by CodeRabbit

  • Documentation
    • Updated documentation linting configuration for better flexibility and maintenance.
  • New Features
    • Enhanced log configuration filtering to support additional key checks.
  • Refactor
    • Modified the BizModel class to improve accessibility and flexibility of various fields.
    • Updated data structures for better performance and compatibility across the application.
  • Tests
    • Adjusted test implementations to align with the latest code refactorings.

Copy link
Contributor

coderabbitai bot commented Mar 30, 2024

Walkthrough

The recent updates focus on enhancing documentation linting configurations, refining log configuration filtering, and improving the flexibility of the BizModel class by adjusting access modifiers and changing the collection type for state records. These modifications aim at better code maintainability and operational adaptability, signifying a move towards more flexible and dynamic software development practices.

Changes

File Path Change Summary
pom.xml Replaced <skip>true</skip> with <doclint>none</doclint> for documentation linting configuration.
.../container/ArkContainer.java Updated log configuration filtering to include "logging.file.path".
.../container/model/BizModel.java, .../container/model/BizModelTest.java, .../spi/model/BizInfo.java Changed bizStateRecords from CopyOnWriteArrayList<BizStateRecord> to List<BizStateRecord>; adjusted access modifiers from private to protected in BizModel; updated related imports and usage.

🐇✨
Changes afoot, in code we trust,
Linting, logging, adjustments a must.
From private to protected, we freely adjust,
Lists over arrays, in flexibility we trust.
Through fields and methods, our code does hop,
With every commit, improvements non-stop.
🚀🐾

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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@sofastack-cla sofastack-cla bot added size/XS and removed size/M labels Mar 30, 2024
Copy link

codecov bot commented Mar 30, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 78.85%. Comparing base (6602b96) to head (50e23fd).

Files Patch % Lines
...va/com/alipay/sofa/ark/container/ArkContainer.java 0.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master     #894      +/-   ##
============================================
+ Coverage     78.72%   78.85%   +0.13%     
  Complexity      836      836              
============================================
  Files           164      164              
  Lines          6796     6796              
  Branches       1009     1009              
============================================
+ Hits           5350     5359       +9     
+ Misses          923      912      -11     
- Partials        523      525       +2     

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

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

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6602b96 and 89469b3.
Files selected for processing (5)
  • pom.xml (1 hunks)
  • sofa-ark-parent/core-impl/container/src/main/java/com/alipay/sofa/ark/container/ArkContainer.java (1 hunks)
  • sofa-ark-parent/core-impl/container/src/main/java/com/alipay/sofa/ark/container/model/BizModel.java (3 hunks)
  • sofa-ark-parent/core-impl/container/src/test/java/com/alipay/sofa/ark/container/model/BizModelTest.java (2 hunks)
  • sofa-ark-parent/core/spi/src/main/java/com/alipay/sofa/ark/spi/model/BizInfo.java (2 hunks)
Additional Context Used
Additional comments not posted (5)
sofa-ark-parent/core-impl/container/src/test/java/com/alipay/sofa/ark/container/model/BizModelTest.java (1)

59-59: The change from CopyOnWriteArrayList to List for changeLogs increases flexibility in choosing the list implementation. Ensure that if concurrent modifications to changeLogs are expected, an appropriate thread-safe implementation of List is used to maintain thread safety.

sofa-ark-parent/core/spi/src/main/java/com/alipay/sofa/ark/spi/model/BizInfo.java (1)

130-130: Changing the return type of getBizStateRecords to List<BizStateRecord> increases flexibility but removes the implicit thread-safety guarantee provided by CopyOnWriteArrayList. Consider documenting the thread safety expectations of the returned List to guide consumers of this method.

sofa-ark-parent/core-impl/container/src/main/java/com/alipay/sofa/ark/container/ArkContainer.java (1)

253-253: The addition of the "logging.file.path" condition in the filterAllLogConfig method aligns with the objective to enhance logging configuration capabilities. Ensure that this new configuration key is well-documented and its usage is consistent with the rest of the logging configuration system.

pom.xml (1)

177-177: Replacing <skip>true</skip> with <doclint>none</doclint> in the maven-javadoc-plugin configuration makes documentation linting more lenient by disabling doclint checks. Consider the trade-offs of this approach, especially in terms of the potential impact on the quality and consistency of Javadoc comments.

sofa-ark-parent/core-impl/container/src/main/java/com/alipay/sofa/ark/container/model/BizModel.java (1)

64-106: Changing various fields' access levels from private to protected and the type of bizStateRecords from CopyOnWriteArrayList<BizStateRecord> to List<BizStateRecord> enhances flexibility and maintainability. However, ensure that the increased access level does not lead to unintended modifications and that thread safety is considered for bizStateRecords if accessed concurrently.

@lvjing2 lvjing2 merged commit 38405da into master Mar 30, 2024
6 of 7 checks passed
@lvjing2 lvjing2 deleted the youji-dev branch March 30, 2024 13:39
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.

None yet

1 participant