feat(web): validate configuration file on launch

[KeisukeYamashita]

Overview

What I've done

What I haven't done

How I tested

Which point I want you to review particularly

Memo

Ref:

• feat(web): validate reearth_config.json on container launch reearth-cms#1388
• chore(web): validate Re:Earth configuration on container startup reearth-visualizer#1390

Summary by CodeRabbit

• Chores

  • Enhanced the container build process with the installation of a JSON processing utility to improve infrastructure support.

• Bug Fixes

  • Introduced robust validation for generated JSON configuration files, catching errors early to ensure a smoother experience.

[coderabbitai]

Walkthrough

This update enhances two components of the project. In the Dockerfile, a new command installs jq via the apk package manager using a cache mount. In the shell script, a JSON validation step is introduced using jq to check the generated configuration file, with an error message and exit if the JSON is invalid. Both changes introduce additional error checking and utility installations without modifying existing functionality.

Changes

File(s)	Change Summary
web/Dockerfile	Added a RUN command using a cache mount to install jq via apk without caching. Placed between environment variable declarations and COPY commands.
web/docker/40-envsubst-onreearth-config.sh	Introduced a new JSON validation step with jq. The script checks the JSON in the configuration file, prints an error to stderr, and exits with code 1 if invalid.

Sequence Diagram(s)

sequenceDiagram
    participant Script as 40-envsubst-on-reearth-config.sh
    participant jq as JSON Validator (jq)
    Script->>jq: Pass generated JSON configuration file
    alt JSON is valid
        jq-->>Script: Return valid output
        Script->>Script: Continue execution
    else JSON is invalid
        jq-->>Script: Emit error output
        Script->>Script: Print error message and exit (code 1)
    end

Loading

Poem

Hoppin’ down the code lane, I smile so bright,
With jq by my side, ensuring JSON is right.
A cache mount in Docker, neat and swift,
And error checks that give our script a lift.
CodeRabbit cheers as we hop to new heights! 🐇
In this garden of code, every fix feels light.
Happy binkies to our changes, day and night!

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.

---

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

[netlify]

✅ Deploy Preview for reearth-classic ready!

Name	Link
🔨 Latest commit	e470e05
🔍 Latest deploy log	https://app.netlify.com/sites/reearth-classic/deploys/67a22e0f48670900070f8d85
😎 Deploy Preview	https://deploy-preview-42--reearth-classic.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

web/docker/40-envsubst-on-reearth-config.sh (1)

39-42: JSON Validation Block is Correctly Implemented.
The new block utilizes jq empty to verify the generated JSON configuration file. This check effectively catches invalid JSON before proceeding, ensuring the startup fails fast in case of configuration errors. For enhanced clarity, consider including additional context (e.g., the file path or a suggestion to check the configuration source) in the error message if applicable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8761c46 and e470e05.

📒 Files selected for processing (2)

• web/Dockerfile (1 hunks)
• web/docker/40-envsubst-on-reearth-config.sh (1 hunks)

🔇 Additional comments (1)

web/Dockerfile (1)

62-64: jq Installation Addition is Well-Integrated.
The addition of the command using a cache mount to install jq via apk is correctly set up to support the JSON validation step in the shell script. This should improve build performance by leveraging the cached package data. Ensure that the version of jq installed meets the minimum requirements for your JSON validation needs.