Blockwise progress

[krbvroc1]

Do not remove the block until AFTER the next() call so that handler can access the Block2 option. This allows the handle to keep track of the transfer. For example, keeping track of Block X of Y, or report status every 50 blocks, or on last block signal a completion event

Closes #236

Summary by CodeRabbit

• Bug Fixes
  • Improved message handling in BlockWise to ensure more reliable processing by adjusting the order of operations.

[coderabbitai]

Walkthrough

The handleReceivedMessage function in the BlockWise implementation has been updated to call the next(w, r) function before checking if errG is nil. This change allows for better tracking of blockwise transfer progress by ensuring that the Block2 option is available to the handler.

Changes

File	Change Summary
net/blockwise/blockwise.go	Moved next(w, r) call above the errG condition check.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant BlockWise
    participant Handler

    Client->>BlockWise: Send Message
    BlockWise->>Handler: Call next(w, r)
    Handler-->>BlockWise: Processed Response
    BlockWise->>BlockWise: Check errG
    BlockWise-->>Client: Send Response

Loading

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Allow progress tracking using Block2 option (#236)	✅

Poem

In the code where data flows,
A change was made, as progress shows.
The handler now can see the light,
With Block2 option in its sight.
So onward, packets, swift and bright,
Through code that's clear, and now just right!

---

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
• Mastodon
• Reddit
• LinkedIn

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 ff2c47d and 800eb62.

Files selected for processing (1)

• net/blockwise/blockwise.go (1 hunks)

Additional comments not posted (2)

net/blockwise/blockwise.go (2)

Line range hint 1-1000: Ensure comprehensive testing is in place to verify that the repositioning of the next() call does not introduce regressions in the blockwise transfer process, especially in edge cases.

---

394-394: The repositioning of next(w, r) before the removal of the Block2 option aligns with the PR's objectives to allow handlers to access the Block2 option for progress tracking. Ensure this change integrates well with existing blockwise transfer logic.

[jkralik]

Thx for your contribution. 👍