Making thread blockage on subscribe configurable

[J0sueTM]

closes #8

• feat: make thread block configurable
• fix(test): recognize msg param on handler fn

Summary by CodeRabbit

• New Features

  • Introduced a new blocking? option to control thread blocking behavior during subscription.
  • Enhanced subscription logic to improve reconnection handling in case of connection issues.

• Bug Fixes

  • Improved the robustness of state updates in test cases.

[coderabbitai]

Walkthrough

Walkthrough

Recent updates to the pubsub.clj file introduce a new blocking? option to control thread blocking behavior during subscription and improve reconnection handling. Changes in pubsub_test.clj involve modifying a handler function to better manage state updates with a simplified argument signature. These enhancements increase flexibility and robustness in the subscription mechanism.

Changes

File	Change Summary
src/.../pubsub.clj	Added blocking? option, refactored subscription logic for better reconnection.
test/.../pubsub_test.clj	Modified handler function to take an underscore variable and update state via swap!.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Publisher
    participant Subscriber

    Client ->> Publisher: subscribe!(client, workers, options)
    alt blocking? is true
        Publisher -->> Subscriber: block thread
    else blocking? is false
        Publisher -->> Subscriber: non-blocking
    end
    note over Publisher, Subscriber: Improved reconnection handling logic

Loading

Poem

The rabbit hops with code refined,
Options set, blocking well-defined.
Threads now dance with nimble grace,
Reconnects handled, a robust embrace.
🐇 In the pub/sub world so bright,
Flexibility takes flight! 🌟

---

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between eb0b830 and 22f4f41.

Files selected for processing (2)

• src/com/moclojer/rq/pubsub.clj (1 hunks)
• test/com/moclojer/rq/pubsub_test.clj (1 hunks)

Additional comments not posted (1)

test/com/moclojer/rq/pubsub_test.clj (1)

17-18: Improved clarity and maintainability.

The handler function has been modified to use a named function that takes an underscore variable as an argument. This change standardizes the handler function's definition and improves clarity.

[coderabbitai]

Tip

Codebase Verification

Ensure correct usage of the blocking? option in all calls to subscribe!.

The subscribe! function has been updated to include a new option blocking?. While the pubsub.clj file seems to utilize this option correctly, the test file pubsub_test.clj does not explicitly mention it. Please verify that all calls to subscribe! across the codebase correctly utilize the new blocking? option.

• test/com/moclojer/rq/pubsub_test.clj: Ensure the blocking? option is correctly utilized.

Analysis chain

Enhanced flexibility and robustness.

The subscribe! function has been updated to include a new option blocking?. The subscription logic has been refactored to handle reconnection more efficiently. These changes enhance the flexibility and robustness of the subscription mechanism.

However, ensure that all function calls to subscribe! correctly utilize the new blocking? option.

Also applies to: 115-139

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `subscribe!` correctly utilize the new `blocking?` option.

# Test: Search for the function usage. Expect: Correct usage of the new `blocking?` option.
rg --type clojure -A 5 $'subscribe!'

Length of output: 1174