Skip to content

Feature / Async Local Storage Alternative #1054

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 5 commits into from
Aug 19, 2024

Conversation

thekevinbrown
Copy link
Member

@thekevinbrown thekevinbrown commented Aug 19, 2024

Creates an alternative approach to context isolation for runtime environments where AsyncLocalStorage isn't supported, e.g. stackblitz/webcontainer-core#1169

We use webcontainers to run https://demo.graphweaver.com, so this is primarily to support that environment, but can be used at will from any environment this way.

Summary by CodeRabbit

  • New Features

    • Added support for environments without AsyncLocalStorage using a new workaround mechanism.
    • Introduced a mutex to manage access to the workaround storage, ensuring single request processing in restricted environments.
  • Chores

    • Updated dependency list to include async-mutex, enhancing concurrency management capabilities.

Copy link
Contributor

coderabbitai bot commented Aug 19, 2024

Warning

Rate limit exceeded

@thekevinbrown has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 37 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

Files that changed from the base of the PR and between 0a924e0 and 0be59de.

Walkthrough

The recent updates enhance the RequestContext class's compatibility with environments lacking AsyncLocalStorage. A new workaround mechanism has been introduced, featuring a static property for storing request context and a mutex to ensure safe access. Additionally, the async-mutex library has been added as a dependency to facilitate concurrency management, thereby improving the robustness and performance of asynchronous operations.

Changes

File Change Summary
src/packages/core/package.json Added dependency "async-mutex": "0.5.0" to manage concurrency in asynchronous programming.
src/packages/core/src/request-context.ts Introduced workaroundStorage and mutex in RequestContext for environments without AsyncLocalStorage. Updated create and currentRequestContext methods.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RequestContext
    participant AsyncLocalStorage
    participant WorkaroundStorage

    Client->>RequestContext: Create context
    alt AsyncLocalStorage enabled
        RequestContext->>AsyncLocalStorage: Store context
    else AsyncLocalStorage disabled
        RequestContext->>WorkaroundStorage: Store context using mutex
    end
    RequestContext-->>Client: Context created
Loading

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>.
    • 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 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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a4e0d70 and 0a924e0.

Files ignored due to path filters (1)
  • src/pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (2)
  • src/packages/core/package.json (1 hunks)
  • src/packages/core/src/request-context.ts (3 hunks)
Additional context used
Biome
src/packages/core/src/request-context.ts

[error] 48-48: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)


[error] 49-49: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)


[error] 58-58: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)

Additional comments not posted (3)
src/packages/core/package.json (1)

34-34: Dependency addition approved.

The addition of the async-mutex library is appropriate for managing concurrency in environments without AsyncLocalStorage.

src/packages/core/src/request-context.ts (2)

46-53: Logic approved, correct this usage.

The logic for switching between AsyncLocalStorage and the workaround is sound. However, correct the use of this in static contexts as previously suggested.

Tools
Biome

[error] 48-48: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)


[error] 49-49: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)


Line range hint 63-69: Context creation logic approved.

The createContext method is well-implemented and aligns with the class's purpose.

Tools
Biome

[error] 48-48: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)


[error] 49-49: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)


[error] 58-58: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)

@thekevinbrown thekevinbrown merged commit 51985ae into main Aug 19, 2024
13 checks passed
@thekevinbrown thekevinbrown deleted the feature/async-local-storage-alternative branch August 19, 2024 04:12
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