search

sofastack / sofa-jraft

A production-grade java implementation of RAFT consensus algorithm.
https://www.sofastack.tech/projects/sofa-jraft/
Apache License 2.0
3.52k stars 1.12k forks source link

fix: async snapshot lost file #1099

Closed bean08 closed 1 week ago

bean08 commented 2 months ago

Motivation:

异步保存snapshot可以提升系统性能。在异步保存snapshot时会存在 多线程并发保存不同的状态机信息到不同文件 的情况，此时com.alipay.sofa.jraft.storage.snapshot.SnapshotWriter#addFile(java.lang.String) 也是并发操作，但对于file信息的存储 com.alipay.sofa.jraft.storage.snapshot.local.LocalSnapshotMetaTable#fileMap 类型是HashMap，它是非线程安全的，在并发调用addFile会出现信息丢失的情况，目前我是靠并发调用addFile前加锁解决的。

Modification:

com.alipay.sofa.jraft.storage.snapshot.local.LocalSnapshotMetaTable#fileMap 的类型改为线程安全的 ConcurrentHashMap

Result:

Summary by CodeRabbit

sofastack-cla[bot] commented 2 months ago

Hi @bean08, 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[bot] commented 2 months ago

Walkthrough

The modification in question transitions the data structure for the fileMap field from a HashMap to a ConcurrentHashMap within the LocalSnapshotMetaTable class. This change enhances thread safety and concurrency control in snapshot metadata management, reflecting a focus on improving the reliability and performance of snapshot operations.

Changes

File Path Change Summary
.../snapshot/local/LocalSnapshotMetaTable.java Swapped HashMap with ConcurrentHashMap for fileMap initialization.

🐰✨
In the realm of code, where snapshots lay,
A change was made, one bright day.
From HashMap's embrace, we did depart,
To ConcurrentHashMap, a thread-safe art.
🌟 For concurrency, we hop and cheer,
In our code's garden, improvements appear!
🐾💻

Recent Review Status **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 890033a64d8ed5c8838463f278b940355553e413 and 47854e526daf888c690bfb7eac9b35a08e891233.
Files selected for processing (1) * jraft-core/src/main/java/com/alipay/sofa/jraft/storage/snapshot/local/LocalSnapshotMetaTable.java (2 hunks)
Additional comments not posted (1)
jraft-core/src/main/java/com/alipay/sofa/jraft/storage/snapshot/local/LocalSnapshotMetaTable.java (1)
`54-54`: Switching `fileMap` to `ConcurrentHashMap` is a solid fix for the concurrency issue. Ensure to assess the performance impact and compatibility of all `fileMap` interactions.
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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
---
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
bean08 commented 2 months ago

已签署CLA但是状态一直是Required

fengjiachun commented 2 months ago

你好，异步保存 snapshot 本身没问题，但是不需要 fileMap 支持并发，我觉得合理的做法应该是上层 join 所有 task，元数据一次写入 fileMap，否则只有部分成功的话我认为是数据损坏

killme2008 commented 2 months ago

你好，异步保存 snapshot 本身没问题，但是不需要 fileMap 支持并发，我觉得合理的做法应该是上层 join 所有 task，元数据一次写入 fileMap，否则只有部分成功的话我认为是数据损坏

Agree

bean08 commented 2 months ago

你好，异步保存 snapshot 本身没问题，但是不需要 fileMap 支持并发，我觉得合理的做法应该是上层 join 所有 task，元数据一次写入 fileMap，否则只有部分成功的话我认为是数据损坏

感谢您的回复，我的场景是 通过jraft构建了一个框架，框架对内部各个组件的snapshot进行SPI化，SPI的实现自行决定保存的文件内容以及方式，只需要告知框架snapshot结果，框架统一对结果进行判断，如果任意SPI异常则整体异常，因此产生了并发的问题。 有理由相信其他人在未深究源码的情况下也会出现类似的问题，基于框架的鲁棒性考虑，我倒是觉得支持并发是有好处的。