Skip to content
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

fix(web): use REEARTH_ prefix for frontend runtime envvars #37

Merged
merged 1 commit into from
Dec 8, 2024

Conversation

KeisukeYamashita
Copy link
Contributor

@KeisukeYamashita KeisukeYamashita commented Dec 8, 2024

Overview

Currently, the runtime is using the REEARTH_WEB_ prefix.
We have decided to use REEARTH_ instead .

What I've done

Migrated to respect runtime environment variables to pick up REEARTH_ prefixed environment variables.

What I haven't done

How I tested

Which point I want you to review particularly

Memo

Summary by CodeRabbit

  • New Features
    • Expanded environment variable processing to include all variables starting with REEARTH_.
  • Bug Fixes
    • Ensured variable values are correctly wrapped in quotes based on specified conditions.

Copy link

coderabbitai bot commented Dec 8, 2024

Walkthrough

The script 40-envsubst-on-reearth-config.sh has been modified to change the filtering condition in the wrap_reearth_variables function. It now processes all environment variables that start with REEARTH_ instead of only those starting with REEARTH_WEB. The wrapping logic for variable values remains unchanged, ensuring proper formatting while maintaining the original control flow and error handling.

Changes

File Path Change Summary
web/docker/40-envsubst-on-reearth-config.sh Updated wrap_reearth_variables to filter all environment variables starting with REEARTH_ instead of just REEARTH_WEB.

Suggested reviewers

  • airslice
  • rot1024

Poem

In the garden where bunnies play,
New changes hop in, brightening the day.
Variables wrapped with care and delight,
All start with REEARTH, oh what a sight!
With each little tweak, we dance and we cheer,
For progress is sweet, and the future is near! 🐇✨


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

@github-actions github-actions bot added the web label Dec 8, 2024
Copy link

netlify bot commented Dec 8, 2024

Deploy Preview for reearth-classic ready!

Name Link
🔨 Latest commit afc1d7d
🔍 Latest deploy log https://app.netlify.com/sites/reearth-classic/deploys/6755a65f3868ce0008689b62
😎 Deploy Preview https://deploy-preview-37--reearth-classic.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

@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

🧹 Outside diff range and nitpick comments (1)
web/docker/40-envsubst-on-reearth-config.sh (1)

Line range hint 26-34: Document the environment variable prefix change.

Consider adding a comment above the wrap_reearth_variables function to document that it processes all REEARTH_ prefixed variables for frontend configuration.

+# Processes all REEARTH_ prefixed environment variables for frontend configuration.
+# Values are wrapped in quotes unless they are empty, null, true, false, or JSON formatted.
 wrap_reearth_variables() {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b564122 and afc1d7d.

📒 Files selected for processing (1)
  • web/docker/40-envsubst-on-reearth-config.sh (1 hunks)
🔇 Additional comments (1)
web/docker/40-envsubst-on-reearth-config.sh (1)

27-27: LGTM, but verify template compatibility.

The change from REEARTH_WEB_ to REEARTH_ prefix aligns with the standardization goal. However, we should ensure this broader scope doesn't introduce unintended side effects.

Let's verify the template's expected variables and potential conflicts:

✅ Verification successful

The change from REEARTH_WEB_ to REEARTH_ prefix is safe and verified.

The template file web/docker/reearth_config.json.template shows all expected environment variables are already using the REEARTH_ prefix. The change aligns with the existing configuration structure and doesn't introduce any conflicts. The script correctly processes all necessary environment variables for the frontend configuration.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check template file for expected variables and identify all REEARTH_ prefixed vars

# Check what variables the template expects
echo "Variables expected by template:"
if [ -f "/opt/reearth/reearth_config.json.template" ]; then
  grep -o '\$REEARTH_[A-Z_]*' "/opt/reearth/reearth_config.json.template" | sort -u
fi

# List all REEARTH_ environment variables in the codebase
echo -e "\nAll REEARTH_ prefixed variables in codebase:"
rg '\$REEARTH_[A-Z_]*' --type sh --no-filename | grep -o '\$REEARTH_[A-Z_]*' | sort -u

Length of output: 357


Script:

#!/bin/bash
# Let's check the template file content and location
echo "Searching for template files:"
fd -t f "config.*template"

echo -e "\nChecking config generation script:"
cat web/docker/40-envsubst-on-reearth-config.sh

echo -e "\nChecking for any other REEARTH_ environment variable usage:"
rg "REEARTH_" -B2 -A2

Length of output: 52481

@KeisukeYamashita KeisukeYamashita merged commit 07f6774 into main Dec 8, 2024
14 checks passed
@KeisukeYamashita KeisukeYamashita deleted the rename-parse-env branch December 8, 2024 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant