Fixed span clone concurrency issues #518

ZijieSong · 2024-05-27T02:43:08Z

Motivation:

When using com.alipay.common.tracer.core.span.SofaTracerSpan#cloneInstance, it may lead to concurrency safety issues.

Modification:

Change the class that causes concurrency issues: linkedhashmap, to concurrenthashmap. Note that there may be a loss of order here, but there is no need for insertion order in the code, so this modification can be made.

Summary by CodeRabbit

Updates
- Updated version from 3.1.3 to 3.1.4-SNAPSHOT across various components for consistency and future enhancements.
Improvements
- Enhanced thread safety by replacing LinkedHashMap with ConcurrentHashMap for tag storage in SofaTracerSpan.
Tests
- Added file handling logic in SofaTracerTest to improve test robustness.
- Included error message printing in TestUtil for better debugging during test failures.

sofastack-cla · 2024-05-27T02:43:12Z

Hi @ZijieSong, 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.

coderabbitai · 2024-05-27T02:43:22Z

Walkthrough

The changes primarily consist of updating the version from 3.1.3 to 3.1.4-SNAPSHOT across various pom.xml files in multiple modules, ensuring consistency. Additionally, thread safety improvements were made in SofaTracerSpan.java by replacing LinkedHashMap with ConcurrentHashMap. Minor updates to test files include adding file handling logic and error messaging.

Changes

Files/Modules	Change Summary
`pom.xml`, `sofa-tracer-plugins/.../pom.xml`, `tracer-all/pom.xml`, `tracer-core/pom.xml`, ...	Updated version from `3.1.3` to `3.1.4-SNAPSHOT` in parent artifact configuration.
`tracer-core/src/main/java/com/alipay/common/tracer/core/span/SofaTracerSpan.java`	Replaced `LinkedHashMap` with `ConcurrentHashMap` for thread-safe tag storage.
`tracer-core/src/test/java/com/alipay/common/tracer/core/tracertest/SofaTracerTest.java`	Added file handling logic and imports for file operations.
`tracer-core/src/test/java/com/alipay/common/tracer/core/TestUtil.java`	Added a `System.out.println` statement to print an error message along with the assertion during a catch block.

Poem

In the world of code, where versions bloom,
We updated numbers, and cleared some room.
From 3.1.3 to 3.1.4, we leap,
With ConcurrentHashMap, thread safety we keep.
Tests now handle files with care,
For a smoother run, everywhere.
🐇✨ CodeRabbit cheers, changes are here!

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.
- @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 as 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.

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.

coderabbitai

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 76e0574 and f85dab0.

Files selected for processing (27)

pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-datasource-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-dubbo-2.6.x-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-dubbo-common-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-dubbo-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-flexible-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-httpclient-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-kafkamq-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-mongodb-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-okhttp-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-rabbitmq-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-redis-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-resttmplate-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-rocketmq-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-spring-cloud-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-springmessage-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-springmvc-plugin/pom.xml (1 hunks)
sofa-tracer-plugins/sofa-tracer-zipkin-plugin/pom.xml (1 hunks)
tracer-all/pom.xml (1 hunks)
tracer-core/pom.xml (1 hunks)
tracer-core/src/main/java/com/alipay/common/tracer/core/span/SofaTracerSpan.java (2 hunks)
tracer-extensions/pom.xml (1 hunks)
tracer-sofa-boot-starter/pom.xml (1 hunks)
tracer-test/core-test/pom.xml (1 hunks)
tracer-test/log4j-test/pom.xml (1 hunks)
tracer-test/log4j2-test/pom.xml (1 hunks)
tracer-test/logback-test/pom.xml (1 hunks)

Files skipped from review due to trivial changes (26)

pom.xml
sofa-tracer-plugins/sofa-tracer-datasource-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-dubbo-2.6.x-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-dubbo-common-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-dubbo-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-flexible-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-httpclient-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-kafkamq-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-mongodb-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-okhttp-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-rabbitmq-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-redis-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-resttmplate-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-rocketmq-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-spring-cloud-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-springmessage-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-springmvc-plugin/pom.xml
sofa-tracer-plugins/sofa-tracer-zipkin-plugin/pom.xml
tracer-all/pom.xml
tracer-core/pom.xml
tracer-extensions/pom.xml
tracer-sofa-boot-starter/pom.xml
tracer-test/core-test/pom.xml
tracer-test/log4j-test/pom.xml
tracer-test/log4j2-test/pom.xml
tracer-test/logback-test/pom.xml

Additional comments not posted (4)

tracer-core/src/main/java/com/alipay/common/tracer/core/span/SofaTracerSpan.java (4)

42-42: Import of ConcurrentHashMap is correctly added to support thread-safe operations on maps.

58-58: Switching to ConcurrentHashMap for tagsWithStr enhances thread safety, aligning with the PR's objective to fix concurrency issues.

60-60: Using ConcurrentHashMap for tagsWithBool is appropriate for concurrent access, ensuring thread safety.

62-62: The replacement of LinkedHashMap with ConcurrentHashMap for tagsWithNumber is a prudent choice for managing concurrent modifications.

glmapper · 2024-05-27T06:59:53Z

@xzchaoo pls provide 3.1.4-SNAPSHOT version branch to receive new pr

coderabbitai

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 f85dab0 and 59f2366.

Files selected for processing (2)

tracer-core/src/main/java/com/alipay/common/tracer/core/span/SofaTracerSpan.java (2 hunks)
tracer-sofa-boot-starter/pom.xml (1 hunks)

Files skipped from review as they are similar to previous changes (2)

tracer-core/src/main/java/com/alipay/common/tracer/core/span/SofaTracerSpan.java
tracer-sofa-boot-starter/pom.xml

xzchaoo

LGTM

coderabbitai

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 59f2366 and cc6ccc5.

Files selected for processing (1)

tracer-core/src/test/java/com/alipay/common/tracer/core/tracertest/SofaTracerTest.java (2 hunks)

coderabbitai · 2024-05-30T10:12:46Z

tracer-core/src/test/java/com/alipay/common/tracer/core/tracertest/SofaTracerTest.java

+                File file = customFileLog(TracerTestLogEnum.RPC_CLIENT
+                        .getDefaultLogName());
+                String absolutePath = file.getAbsolutePath();
+                System.out.println("path is ????"+absolutePath);


Ensure file resources are properly released.

The method FileUtils.readLines opens a file stream that should be properly closed to avoid resource leaks. Consider using a try-with-resources statement or manually closing the stream in a finally block.

Refactor to improve readability and maintainability.

The current implementation mixes file handling and business logic in a single block. Consider separating these concerns for clearer code. For example, file handling could be moved to a separate method, and the business logic could focus solely on processing the file contents.

Consider handling potential IOException more gracefully.

The current implementation throws an AssertionError if an IOException occurs. It might be more appropriate to handle this exception directly within the test, perhaps logging the error or using a more specific assertion to handle this case. This would make the test more robust and self-contained.

coderabbitai

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 cc6ccc5 and dfd2603.

Files selected for processing (1)

tracer-core/src/test/java/com/alipay/common/tracer/core/tracertest/SofaTracerTest.java (2 hunks)

Files skipped from review as they are similar to previous changes (1)

tracer-core/src/test/java/com/alipay/common/tracer/core/tracertest/SofaTracerTest.java

coderabbitai

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 dfd2603 and 640ced8.

Files selected for processing (1)

tracer-core/src/test/java/com/alipay/common/tracer/core/TestUtil.java (1 hunks)

Files skipped from review due to trivial changes (1)

tracer-core/src/test/java/com/alipay/common/tracer/core/TestUtil.java

sofastack-cla bot added size/M First-time contributor cla:no labels May 27, 2024

coderabbitai bot reviewed May 27, 2024

View reviewed changes

Fixed span clone concurrency issues

59f2366

ZijieSong force-pushed the 3.x-concurrent_tags branch from f85dab0 to 59f2366 Compare May 29, 2024 16:09

sofastack-cla bot added cla:yes size/S and removed size/M cla:no labels May 29, 2024

coderabbitai bot reviewed May 29, 2024

View reviewed changes

xzchaoo approved these changes May 29, 2024

View reviewed changes

ZijieSong requested a review from xzchaoo May 30, 2024 04:26

coderabbitai bot reviewed May 30, 2024

View reviewed changes

ZijieSong force-pushed the 3.x-concurrent_tags branch from 640ced8 to 59f2366 Compare May 30, 2024 11:18

ZijieSong merged commit 478608a into sofastack:master May 30, 2024
2 of 3 checks passed

ZijieSong deleted the 3.x-concurrent_tags branch May 30, 2024 11:23

coderabbitai bot mentioned this pull request Sep 14, 2024

fix unit tests #540

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed span clone concurrency issues #518

Fixed span clone concurrency issues #518

ZijieSong commented May 27, 2024 •

edited by coderabbitai bot

Loading

sofastack-cla bot commented May 27, 2024

coderabbitai bot commented May 27, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

glmapper commented May 27, 2024

coderabbitai bot left a comment

xzchaoo left a comment

coderabbitai bot left a comment

coderabbitai bot May 30, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

Fixed span clone concurrency issues #518

Fixed span clone concurrency issues #518

Conversation

ZijieSong commented May 27, 2024 • edited by coderabbitai bot Loading

Motivation:

Modification:

Summary by CodeRabbit

sofastack-cla bot commented May 27, 2024

coderabbitai bot commented May 27, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

glmapper commented May 27, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

xzchaoo left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot May 30, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

ZijieSong commented May 27, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 27, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)