realtime: allow realtime streams to have it's own redis env vars

[ericallam]

Summary by CodeRabbit

• New Features

  • Expanded configuration options for real-time streaming, offering enhanced flexibility to customize connection settings such as host, port, credentials, and security options.

• Refactor

  • Adopted a consistent naming convention for environment variables related to Redis connections to improve clarity and alignment with the new streaming configuration standards.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 9d4b937

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

[coderabbitai]

Walkthrough

This change introduces a set of new optional configuration properties for real-time streaming Redis in the environment schema. The modifications add several new zod validations with default fallbacks for Redis connection details (host, port, username, password, TLS, and cluster mode). Additionally, the Redis real-time streams service now references the new environment variable names by replacing the old REDIS_ prefix with REALTIME_STREAMS_REDIS_ in its initialization process.

Changes

File(s)	Change Summary
apps/webapp/.../env.server.ts	Added new optional properties to EnvironmentSchema (e.g., REALTIME_STREAMS_REDIS_HOST, REALTIME_STREAMS_REDIS_READER_HOST, etc.) with defaults sourced from existing process.env values.
apps/webapp/.../v1StreamsGlobal.server.ts	Updated Redis configuration in the RedisRealtimeStreams initializer to use new environment variable names with the REALTIME_STREAMS_REDIS_ prefix for host, port, username, password, and TLS check.

Sequence Diagram(s)

sequenceDiagram
    participant Env as Environment Variables
    participant Schema as EnvironmentSchema (env.server.ts)
    participant Service as RedisRealtimeStreams Service (v1StreamsGlobal.server.ts)
    participant Redis as Redis Server

    Env->>Schema: Provide REALTIME_STREAMS_REDIS_* values
    Schema-->>Service: Return validated configuration
    Service->>Redis: Initialize connection with provided config

Loading

Poem

I hop through lines of code with cheer,
New Redis configs now crystal clear.
Environment variables bloom like spring,
With REALTIME settings, our streams now sing.
Carrots and code, what a joy to hear!
🥕✨

---

📜 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 18ad897 and 9d4b937.

📒 Files selected for processing (2)

• apps/webapp/app/env.server.ts (1 hunks)
• apps/webapp/app/services/realtime/v1StreamsGlobal.server.ts (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

apps/webapp/app/services/realtime/v1StreamsGlobal.server.ts (1)

apps/webapp/app/env.server.ts (1)

• env (713-713)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: units / 🧪 Unit Tests
• GitHub Check: typecheck / typecheck

🔇 Additional comments (3)

apps/webapp/app/services/realtime/v1StreamsGlobal.server.ts (2)

8-11: LGTM: Shifting to dedicated Redis configuration environment variables for real-time streams.

The changes correctly update the Redis configuration parameters to use the dedicated real-time streams environment variables instead of the shared Redis variables, providing better isolation and configuration flexibility.

---

13-13: Properly updated TLS configuration.

The TLS configuration check has been updated to use the new environment variable, maintaining consistency with the other Redis parameter changes.

apps/webapp/app/env.server.ts (1)

154-184: LGTM: Well-structured environment variables for real-time streams Redis configuration.

The addition of these environment variables follows the established pattern in the codebase for other Redis-dependent services. The implementation correctly:

1. Makes all variables optional with appropriate fallbacks to the general Redis configuration
2. Includes proper type coercion for numeric values
3. Maintains the same structure as other Redis configurations (host, port, username, password, TLS settings, etc.)
4. Sets sensible defaults that match other similar configurations

This approach provides good backward compatibility while allowing for service-specific Redis configuration.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.