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

QBittorrent进度验证使用种子总大小而不是选中大小 #700

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

maoruishan
Copy link

@maoruishan maoruishan commented Nov 7, 2024

使用选中的大小计算peer进度时,会导致算出的进度与peer汇报的进度不一致,导致误封

Summary by CodeRabbit

  • New Features

    • Improved torrent size representation by updating the size retrieval method to return total size.
  • Bug Fixes

    • Removed unnecessary commented-out fields for a cleaner and more efficient data structure.

@maoruishan maoruishan requested a review from a team as a code owner November 7, 2024 06:41
Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Walkthrough

The QBittorrentTorrent class has been updated to enhance its structure and functionality. Commented-out fields have been removed to streamline the class, and the getSize() method has been modified to return totalSize instead of size. This change aims to provide a more accurate representation of the torrent's size while maintaining compatibility with the existing interface.

Changes

File Change Summary
src/main/java/com/ghostchu/peerbanhelper/downloader/impl/qbittorrent/impl/QBittorrentTorrent.java Removed commented-out fields; updated getSize() method to return totalSize.

Possibly related PRs

Suggested reviewers

  • Ghost-chu
  • paulzzh

Poem

🐰 In the code where torrents flow,
Fields once cluttered, now they go.
Size now total, clear and bright,
A rabbit's hop towards the light!
Clean and swift, the changes sing,
In the world of code, we bring! 🌟


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 (1)
src/main/java/com/ghostchu/peerbanhelper/downloader/impl/qbittorrent/impl/QBittorrentTorrent.java (1)

Line range hint 115-115: Consider documenting the progress calculation formula

Since the progress verification now uses totalSize, it would be valuable to document the exact formula used for progress calculation (progress * totalSize = expected downloaded amount) to ensure consistent implementation across the codebase.

Consider adding a comment above the progress field:

    @SerializedName("progress")
+   // Progress as a percentage (0.0 to 1.0) of totalSize
    private double progress;

Also applies to: 190-190

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a40524e and d122544.

📒 Files selected for processing (1)
  • src/main/java/com/ghostchu/peerbanhelper/downloader/impl/qbittorrent/impl/QBittorrentTorrent.java (1 hunks)
🔇 Additional comments (2)
src/main/java/com/ghostchu/peerbanhelper/downloader/impl/qbittorrent/impl/QBittorrentTorrent.java (2)

Line range hint 1-186: Clean code improvement: Removed unused fields

The removal of commented-out fields improves code readability while maintaining all necessary functionality. The class structure remains clean with proper use of Lombok and GSON annotations.


190-190: Correct implementation: Using total torrent size for accurate progress tracking

The change to return totalSize instead of size is the right approach for accurate progress verification. This prevents false bans when users download selected files, as it compares progress against the complete torrent size.

Let's verify that this change doesn't conflict with other torrent implementations:

✅ Verification successful

Change to use totalSize is consistent with other implementations

The change from size to totalSize in QBittorrentTorrent is correct and aligns with other implementations:

  • Transmission implementation uses getTotalSize()
  • QBittorrent now uses totalSize
  • Both consistently return the complete torrent size

The TorrentImpl is just a basic implementation and not a real downloader client implementation, so its use of size doesn't impact this change.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other implementations of the Torrent interface
# to ensure consistent size calculation across different clients

# Look for interface definition
echo "Checking Torrent interface definition:"
rg "interface.*Torrent.*\{" -A 10

# Look for other implementations
echo -e "\nChecking other Torrent implementations:"
ast-grep --pattern 'class $_ implements Torrent'

Length of output: 3207


Script:

#!/bin/bash
# Let's search for all Java files that implement the Torrent interface and check their getSize() methods
echo "Searching for Torrent implementations:"
fd -e java | xargs rg "class.*implements.*Torrent" -l

echo -e "\nChecking getSize() method implementations:"
ast-grep --pattern 'public $_ getSize() {
  $$$
}'

# Also search for size-related method definitions in the Torrent interface
echo -e "\nChecking size-related methods in Torrent interface:"
rg "getSize|size" src/main/java/com/ghostchu/peerbanhelper/torrent/Torrent.java

Length of output: 895


Script:

#!/bin/bash
# Let's examine the getSize() implementations in each torrent implementation file
echo "QBittorrent implementation:"
rg "getSize" src/main/java/com/ghostchu/peerbanhelper/downloader/impl/qbittorrent/impl/QBittorrentTorrent.java -B 2 -A 2

echo -e "\nTransmission implementation:"
rg "getSize" src/main/java/com/ghostchu/peerbanhelper/downloader/impl/transmission/TRTorrent.java -B 2 -A 2

echo -e "\nDeluge implementation:"
rg "getSize" src/main/java/com/ghostchu/peerbanhelper/downloader/impl/deluge/DelugeTorrent.java -B 2 -A 2

echo -e "\nTorrentImpl implementation:"
rg "getSize" src/main/java/com/ghostchu/peerbanhelper/torrent/TorrentImpl.java -B 2 -A 2

Length of output: 926

@Ghost-chu Ghost-chu added the on-hold Issue/PR 暂时挂起,不要关闭/合并 label Nov 7, 2024
@Gaojianli Gaojianli self-requested a review November 7, 2024 06:58
@Gaojianli
Copy link
Member

请详细说明此PR并提供误封的例子

@Gaojianli Gaojianli removed the on-hold Issue/PR 暂时挂起,不要关闭/合并 label Nov 7, 2024
@Gaojianli Gaojianli merged commit 21ea4ea into PBH-BTN:master Nov 7, 2024
3 checks passed
@Ghost-chu
Copy link
Collaborator

nice catch

@maoruishan
Copy link
Author

maoruishan commented Nov 7, 2024

请详细说明此PR并提供误封的例子

0953ea1a28b89f4cd3bb39fcb977ce40

这个种子是130G的,我只选了180M的文件。导致这个种子的peer都被封了

@Ghost-chu
Copy link
Collaborator

请详细说明此PR并提供误封的例子

0953ea1a28b89f4cd3bb39fcb977ce40

这个种子是130G的,我只选了188M的文件。导致这个种子的peer都被封了

感谢反馈,我们已合并此更改并将在晚些时候发布修复补丁。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants