Dynamic Environment Validation: Introduced Flags for Service-Specific Configuration.

[DrHazemAli]

Summary

I really enjoy working on this project. It’s well-designed, and contributing to it feels both rewarding and inspiring. I’m excited to be part of its growth and look forward to helping make it even better!

However, This PR adds a new feature that dynamically validates environment variables based on the services enabled in the .env file. It addresses #228 by simplifying the configuration process and making it more modular for service-specific setups.

Key Changes

1. Service Enable Flags:

   • Added ENABLE_CLERK, ENABLE_STRIPE, and ENABLE_RESEND flags to enable or disable specific services dynamically.

2. Dynamic Schema Validation:

   • The server schema now conditionally includes service-specific fields based on the flags' state.
   • Example: If ENABLE_STRIPE=false, STRIPE_SECRET_KEY and STRIPE_WEBHOOK_SECRET are not required.

3. Improved Modularity:

   • Each app can define only the required variables for its active services, reducing unnecessary configuration complexity.

How to Use

1. Add the service enable flags to your .env file:

   ENABLE_CLERK=true
   ENABLE_STRIPE=false
   ENABLE_RESEND=true

2. Include the required environment variables for the services you enable:

   # Clerk (if ENABLE_CLERK=true)
   CLERK_SECRET_KEY=sk_your_clerk_secret_key
   CLERK_WEBHOOK_SECRET=whsec_your_clerk_webhook_secret
   
   # Resend (if ENABLE_RESEND=true)
   RESEND_AUDIENCE_ID=your_resend_audience_id
   RESEND_FROM=your_resend_from_email
   RESEND_TOKEN=re_your_resend_token

3. Restart your development server after making changes:

   pnpm dev

Benefits

• Reduces configuration overhead by requiring only the variables for enabled services.
• Improves flexibility and modularity in managing service-specific configurations.
• Simplifies the development and deployment workflow.

Related Issues

Closes #228

Checklist

• My code follows the code style of this project.
• I have performed a self-review of my code.
• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation, if necessary.
• I have added tests that prove my fix is effective or my feature works.
• New and existing tests pass locally with my changes.

[vercel]

@DrHazemAli is attempting to deploy a commit to the Hayden Bleasel Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• packages/env/index.ts is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

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

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.

[DrHazemAli]

Reviewed

[yamz8]

very useful for this project!,
@haydenbleasel do you plan to merge it?

[haydenbleasel]

Nice work @DrHazemAli! This is awesome. I have used this and a couple of other related issues as inspiration for #332. Going to close this in favor of it, but I appreciate the work you put into this!