Fix demo development inside a dev container

[balloob]

Breaking change

Proposed change

Dev container port forwarding got stuck with the listening interface check. This fixes it by listening to all interfaces when run inside a dev container.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (thank you!)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example configuration

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue or discussion:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

• New Features
  • Introduced a new environment variable DEV_CONTAINER to enhance development container detection.
  • Updated the development server to listen on all hosts when running inside a development container.

[coderabbitai]

Walkthrough

Walkthrough

The main changes involve improving the development container setup by adding a specific environment variable and adjusting related scripts. A new environment variable DEV_CONTAINER is introduced to identify a development container. The build script now includes a function to check this environment variable. Additionally, the webpack development server setup has been adjusted to allow listening on all network interfaces when inside a development container.

Changes

Files/Paths	Change Summary
.devcontainer/devcontainer.json	Added environment variable DEV_CONTAINER set to 1.
build-scripts/env.cjs	Introduced function isDevContainer() to check if DEV_CONTAINER is set.
build-scripts/gulp/webpack.js	Adjusted listenHost to "0.0.0.0" when in a development container to allow listening on all network interfaces.

Sequence Diagram(s)

sequenceDiagram
    participant DevContainer as Development Container
    participant Script as env.cjs
    participant Webpack as webpack.js

    DevContainer->>Script: Reads `DEV_CONTAINER` environment variable
    Script->>Webpack: Calls `isDevContainer()`
    Webpack->>Webpack: Adjusts `listenHost` to "0.0.0.0" if `isDevContainer()` returns true

Loading

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 19ee150 and a336dbc.

Files selected for processing (3)

• .devcontainer/devcontainer.json (1 hunks)
• build-scripts/env.cjs (1 hunks)
• build-scripts/gulp/webpack.js (1 hunks)

Additional context used

Path-based instructions (1)

build-scripts/env.cjs (4)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

• Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
• In step-by-step instructions, front the location phrase in the instructional sentence.
• In step-by-step instructions, front the 'goal' in the instructional sentence.
• In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
• do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

---

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

• If "" are used to mark UI strings, replace them by bold.

---

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"

---

Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.

Additional comments not posted (6)

build-scripts/env.cjs (1)

35-37: LGTM! The new function isDevContainer is correctly implemented.

The function aligns well with the existing code structure and follows best practices.

.devcontainer/devcontainer.json (1)

11-11: LGTM! The new environment variable DEV_CONTAINER is correctly added.

The environment variable is appropriately placed and follows best practices.

build-scripts/gulp/webpack.js (4)

43-43: LGTM! The listenHost parameter with a default value of undefined is correctly added.

This change allows for dynamic determination of the appropriate listenHost.

---

45-48: LGTM! The logic to set listenHost based on the environment is correctly implemented.

This change ensures that the application listens to all interfaces when run inside a dev container.

---

46-46: LGTM! The comment explaining the need for the change is clear and helpful.

This comment provides valuable context for future developers.

---

47-47: LGTM! The listenHost is correctly set based on the environment.

This change ensures proper functionality in different environments.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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