Skip to content

Conversation

jvmi7
Copy link
Contributor

@jvmi7 jvmi7 commented Feb 5, 2025

Make env variables optional

@jvmi7 jvmi7 requested a review from a team as a code owner February 5, 2025 23:23
Copy link

netlify bot commented Feb 5, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit cb3ff12
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/67a3f2fc31dd60000892638a
😎 Deploy Preview https://deploy-preview-1320--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

📝 Walkthrough

Walkthrough

The changes update the initialization logic in the GrowthBook module and adjust the attribute handling in the theme configuration. In the lib/growthbook.ts file, the error handling for missing environment variables (NEXT_PUBLIC_GROWTHBOOK_API_HOST and NEXT_PUBLIC_GROWTHBOOK_CLIENT_KEY) has been removed; instead, default empty string values are assigned when these variables are undefined. The block that previously relied on a try-catch structure has been replaced with an if statement that checks for the presence of the environment variables before invoking the init() method. In the theme.config.tsx file, the data-website-id attribute within a script tag now falls back to an empty string if the corresponding environment variable is not set, ensuring a defined value is always present.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application
    participant GB as GrowthBook

    App->>GB: Request initialization
    GB->>GB: Read env vars (apiHost, clientKey)
    alt Both env vars are set
        GB->>GB: Call init() method
    else Env vars missing
        GB->>GB: Use default empty string values
    end
Loading

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

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: 0

🧹 Nitpick comments (1)
lib/growthbook.ts (1)

9-11: Consider adding a debug log for initialization status.

While the initialization check is correct, adding a debug log would help track when GrowthBook is initialized vs skipped.

 if (process.env.NEXT_PUBLIC_GROWTHBOOK_API_HOST && process.env.NEXT_PUBLIC_GROWTHBOOK_CLIENT_KEY) {
+  console.debug('Initializing GrowthBook with provided credentials');
   growthbook.init();
+} else {
+  console.debug('Skipping GrowthBook initialization due to missing credentials');
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8c50387 and cb3ff12.

📒 Files selected for processing (2)
  • lib/growthbook.ts (1 hunks)
  • theme.config.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules - docs-optimism
  • GitHub Check: Header rules - docs-optimism
  • GitHub Check: Pages changed - docs-optimism
  • GitHub Check: pr-workflow
🔇 Additional comments (2)
lib/growthbook.ts (1)

5-6: LGTM! Safely handles undefined environment variables.

The fallback to empty strings ensures the code doesn't throw errors when environment variables are not defined.

theme.config.tsx (1)

137-137: LGTM! Consistent handling of optional environment variable.

The fallback to empty string aligns with the PR's objective and matches the pattern used in GrowthBook configuration.

@bradleycamacho bradleycamacho merged commit 841c115 into main Feb 5, 2025
8 checks passed
@bradleycamacho bradleycamacho deleted the make-env-optional branch February 5, 2025 23:32
bradleycamacho added a commit that referenced this pull request Feb 6, 2025
Copy link

@Abuchtela Abuchtela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge to main

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.

3 participants