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

Read your own group writes #415

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Read your own group writes #415

merged 3 commits into from
Jan 15, 2025

Conversation

mkysel
Copy link
Collaborator

@mkysel mkysel commented Jan 15, 2025

This does not solve all possible cases of read-your-own-writes, but it makes things a little bit easier.

This guarantees that when a node confirms a payer write, future reads will return the data.

This does not guarantee:

  • the same for blockchain writes
  • a different node will have the data

I added the debug log so we can see how long the delay is. In general, it is usually one busy-wait cycle. But could be more on busy systems. It is rarely 0 cycles.

Relates to #358

Summary by CodeRabbit

  • New Features

    • Added tracking of last processed envelope ID in publish worker
    • Implemented wait mechanism for gateway publish completion
    • Enhanced server test infrastructure with dynamic port allocation
  • Tests

    • Added new test to verify server's ability to read its own writes immediately after publishing
  • Chores

    • Improved test configuration by dynamically assigning ports and populating mock configurations

@mkysel mkysel requested a review from a team as a code owner January 15, 2025 20:17
Copy link

coderabbitai bot commented Jan 15, 2025

Warning

Rate limit exceeded

@mkysel has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 40 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between af1e73e and 2219372.

📒 Files selected for processing (1)
  • pkg/api/message/service.go (2 hunks)

Walkthrough

This pull request introduces enhancements to the message publishing mechanism and testing infrastructure. In the publishWorker, a new lastProcessed atomic field is added to track the last processed envelope ID in a thread-safe manner. The Service struct gains a waitForGatewayPublish method to ensure complete processing of envelopes before returning. In the server tests, a dynamic port allocation mechanism is implemented, and a new test is added to verify immediate read-after-write functionality.

Changes

File Change Summary
pkg/api/message/publishWorker.go Added lastProcessed atomic.Int64 field to track last processed envelope ID
pkg/api/message/service.go Added waitForGatewayPublish method to block until envelope processing completes; modified PublishPayerEnvelopes to use new method
pkg/server/server_test.go Introduced getNextOpenPort() for dynamic port allocation; updated NewTestServer; added TestReadOwnWritesGuarantee test

Sequence Diagram

sequenceDiagram
    participant Client
    participant Service
    participant PublishWorker
    
    Client->>Service: Publish Envelope
    Service->>PublishWorker: Stage Envelope
    PublishWorker->>PublishWorker: Process Envelope
    PublishWorker-->>Service: Update lastProcessed
    Service->>Service: Wait for Processing
    Service-->>Client: Return Response
Loading

Possibly related PRs

  • API Mock Improvements #394: Modifications to API test setup with NewTestAPIServer returning ApiServerMocks, potentially relevant to testing the new publish functionality

Suggested reviewers

  • richardhuaaa

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

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

🧹 Nitpick comments (1)
pkg/server/server_test.go (1)

215-279: Enhance test coverage for read-your-own-writes guarantee.

While the test verifies the basic functionality, consider adding test cases for:

  1. Multiple concurrent writes
  2. Error cases (e.g., timeout scenarios)
  3. Performance under load

Would you like me to generate additional test cases to improve coverage?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93e176c and af1e73e.

📒 Files selected for processing (3)
  • pkg/api/message/publishWorker.go (3 hunks)
  • pkg/api/message/service.go (2 hunks)
  • pkg/server/server_test.go (5 hunks)
🔇 Additional comments (5)
pkg/api/message/publishWorker.go (2)

17-24: LGTM! Thread-safe tracking of processed envelopes.

The lastProcessed field using atomic.Int64 ensures thread-safe tracking of envelope IDs.


97-97: LGTM! Proper update of the last processed ID.

The ID is stored after successful processing, ensuring accurate tracking.

pkg/api/message/service.go (1)

353-353: LGTM! Ensures read-your-own-writes guarantee.

The call to waitForGatewayPublish ensures that the write is processed before responding to the client.

pkg/server/server_test.go (2)

33-44: LGTM! Dynamic port allocation improves test reliability.

Using dynamic port allocation prevents port conflicts in parallel test execution.


76-79: LGTM! Proper configuration of the Payer options.

The Payer configuration now includes the private key, ensuring proper authentication.

pkg/api/message/service.go Outdated Show resolved Hide resolved
@mkysel mkysel merged commit 5a22840 into main Jan 15, 2025
7 checks passed
@mkysel mkysel deleted the mkysel/read-your-own-group-writes branch January 15, 2025 20:58
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.

2 participants