Skip to content

Add configurable redis TTL on realtime streams #1725

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
Feb 21, 2025
Merged

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Feb 21, 2025

Summary by CodeRabbit

  • New Features
    • Introduced dynamic configuration options for real-time streaming, allowing adjustments to stream length and message retention.
    • Optimized stream management by consolidating operations for enhanced flexibility.

Copy link

changeset-bot bot commented Feb 21, 2025

⚠️ No Changeset found

Latest commit: d9a5b98

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Walkthrough

This update introduces two new integer configuration properties in the environment schema for real-time streaming: one for the maximum stream length and another for the TTL. The real-time stream service now uses these environment variables instead of hardcoded values, and it consolidates stream commands (xadd and expire) into a single Redis pipeline operation.

Changes

File Path Change Summary
apps/webapp/.../env.server.ts Added two properties to EnvironmentSchema: REALTIME_STREAM_MAX_LENGTH (default: 1000) and REALTIME_STREAM_TTL (default: 86400 seconds).
apps/webapp/.../redisRealtimeStreams.server.ts Replaced hardcoded stream limits with environment variables; updated Redis operations to pipeline xadd and expire commands using the new TTL setting.

Sequence Diagram(s)

sequenceDiagram
    participant S as Realtime Service
    participant Env as Environment Config
    participant R as Redis
    S->>Env: Load REALTIME_STREAM_MAX_LENGTH & REALTIME_STREAM_TTL
    S->>R: Execute xadd (with max length)
    S->>R: Pipeline expire (using TTL)
Loading

Possibly related PRs

Poem

I'm a rabbit in the codefield hopping,
New stream limits have got my tail a-twitching.
Configs now dance with a graceful flow,
Redis and env vars in a pipelined show.
Carrots and code—oh what a refreshing glow! 🥕✨


📜 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 47c2dd6 and d9a5b98.

📒 Files selected for processing (2)
  • apps/webapp/app/env.server.ts (1 hunks)
  • apps/webapp/app/services/realtime/redisRealtimeStreams.server.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • apps/webapp/app/env.server.ts
  • apps/webapp/app/services/realtime/redisRealtimeStreams.server.ts
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: Analyze (javascript-typescript)

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.

@ericallam ericallam merged commit 62e3238 into main Feb 21, 2025
11 checks passed
@ericallam ericallam deleted the ea-branch-16 branch February 21, 2025 16:07
@coderabbitai coderabbitai bot mentioned this pull request Feb 24, 2025
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.

1 participant