Skip to content

🐛 Fix race condition in lambda.register with once option #282

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

Merged
merged 1 commit into from
Jun 9, 2025

Conversation

Milly
Copy link
Contributor

@Milly Milly commented Jun 8, 2025

Ensure the lambda is unregistered before invoking the function when once option is specified, preventing multiple concurrent calls from executing the function more than once.

Update test to cover the case where the lambda is called multiple times before the first call resolves.

Summary by CodeRabbit

  • Refactor

    • Updated internal logic for unregistering one-time lambda functions to unregister before execution begins.
  • Tests

    • Improved tests for one-time lambda function registration to better handle asynchronous behavior and error scenarios.
  • Chores

    • Added a new import mapping for "@core/asyncutil" in configuration.

Ensure the lambda is unregistered before invoking the function when `once`
option is specified, preventing multiple concurrent calls from executing
the function more than once.

Update test to cover the case where the lambda is called multiple times before
the first call resolves.
Copy link

coderabbitai bot commented Jun 8, 2025

Walkthrough

A new import alias for @core/asyncutil was added to the configuration. The lambda registration logic was changed to unregister the lambda before invoking its function instead of after. The related test was updated to handle asynchronous resolution more explicitly and to verify lambda removal behavior using the promise from the second call.

Changes

File(s) Change Summary
deno.jsonc Added "@core/asyncutil" import alias pointing to "jsr:@core/asyncutil@^1.2.0".
lambda/mod.ts Changed lambda unregister logic to occur before awaiting the function, removing try-finally.
lambda/mod_test.ts Updated test to handle async lambda resolution and verify removal using the second call's promise.

Poem

In the land of lambdas, swift and bright,
Unregister comes before the flight.
Async promises now take their turn,
While rabbits watch and tests discern.
A new import hops into view—
Code grows stronger, fresh and new!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5f8e7f4 and cc169d1.

📒 Files selected for processing (3)
  • deno.jsonc (1 hunks)
  • lambda/mod.ts (1 hunks)
  • lambda/mod_test.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: test (macos-latest, 1.x, v9.1.0448, v0.10.0)
  • GitHub Check: test (windows-latest, 1.x, v9.1.0448, v0.10.0)
  • GitHub Check: test (ubuntu-latest, 1.45.0, v9.1.0448, v0.10.0)
  • GitHub Check: test (windows-latest, 1.45.0, v9.1.0448, v0.10.0)
  • GitHub Check: test (macos-latest, 1.45.0, v9.1.0448, v0.10.0)
  • GitHub Check: test (ubuntu-latest, 1.x, v9.1.0448, v0.10.0)
🔇 Additional comments (4)
deno.jsonc (1)

50-50: LGTM! Required dependency for test utilities.

The addition of @core/asyncutil import mapping is necessary for the flushPromises utility used in the updated tests to properly handle asynchronous operations.

lambda/mod.ts (1)

123-124: Excellent fix for the race condition!

Moving the unregister() call before function execution is the correct solution. This ensures that even if multiple concurrent calls are made, only the first one will execute the function since subsequent calls will find the lambda already removed from the dispatcher.

lambda/mod_test.ts (2)

9-9: Good addition of required test utility.

The flushPromises import is necessary for the updated test to properly handle asynchronous timing and ensure microtasks are processed before assertions.


76-98: Excellent test coverage for the race condition fix!

This test properly simulates the race condition scenario:

  1. Promise control: Uses Promise.withResolvers() to create a lambda that won't resolve until manually triggered
  2. Concurrent calls: Makes two calls before resolution to simulate the race condition
  3. Proper timing: Uses flushPromises() to ensure microtasks are processed before resolving
  4. Comprehensive assertions: Verifies the first call succeeds, function is called only once, and second call properly rejects

This is a significant improvement over sequential testing and actually validates the fix works correctly.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

codecov bot commented Jun 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.78%. Comparing base (5f8e7f4) to head (cc169d1).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #282      +/-   ##
==========================================
- Coverage   85.80%   85.78%   -0.02%     
==========================================
  Files          65       65              
  Lines        3458     3455       -3     
  Branches      301      301              
==========================================
- Hits         2967     2964       -3     
  Misses        489      489              
  Partials        2        2              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Milly Milly requested a review from lambdalisue June 8, 2025 10:10
Copy link
Member

@lambdalisue lambdalisue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks

@lambdalisue lambdalisue merged commit 9275154 into main Jun 9, 2025
10 checks passed
@lambdalisue lambdalisue deleted the lambda-register-once branch June 9, 2025 03:19
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