search

fluxninja / aperture

Rate limiting, caching, and request prioritization for modern workloads
https://docs.fluxninja.com
Apache License 2.0
641 stars 25 forks source link

Update code snippets for UI docs #3116

Closed karansohi closed 10 months ago

karansohi commented 10 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 10 months ago

Walkthrough

The aperture-js SDK has undergone a revamp in its concurrency management. A function for limiting concurrency has been removed, and a new approach based on user tiers has been introduced. The example code now includes added comments to clarify the flow of concurrency scheduling, and new async functions have been introduced to manage UI concurrency tokens and scheduling, hinting at a more structured and user-tiered concurrency strategy.

Changes

File Path Change Summary
.../aperture-js/example/basic_usage.ts Removed handleConcurrencyLimit, added sendRequestForTier, updated userTiers.
.../aperture-js/example/concurrency_scheduler.ts Added comments to mark the start and end of concurrency scheduling.
.../aperture-js/example/ui_snippets.ts New async functions for UI concurrency tokens and scheduling flows.

Poem

🐇 "In the land of code and bits, 🌟 Where the data flows and fits, 🎉 We rejigged the concurrency dance, 🚀 Now each tier gets a fair chance."

Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - You can directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging `@coderabbitai` in a comment. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - You can tag `@coderabbitai` in a PR comment and ask questions about the PR and the codebase. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.` - `@coderabbitai read the files in the src/scheduler package and generate README in the markdown format.` 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. ### 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.