Correct serving modern build to macOS companion app

[steverep]

Proposed change

Adds an additional regex for the user agent to match the macOS companion app. It will match a minimum macOS version based on the minimum major Safari version returned by browserslist. As of today, that's v17 so macOS 12+ will get the modern build with this correction. This should be minimal maintenance. The gulp task will throw whenever we need to add another version pair to the map.

The macOS map is for supported Safari, so this does make the assumption that users keep Safari relatively up to date, but I think it's the best we can do given the deficiency in Apple's API.

See the long code comment I added and #21695 (comment) for more details on why this is necessary.

Also refactored a bit so the regex is just generated once instead of once per page.

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

  • Enhanced HTML entry generation to better handle user agent strings for different browsers.
  • Introduced support for detecting Home Assistant on macOS with specific version mappings.

• Improvements

  • Centralized logic for obtaining template variables to improve error handling and readability.
  • Streamlined path resolution in template rendering processes.

• Task Updates

  • Updated development and production page generation tasks to ensure consistent environment variable availability.

[coderabbitai]

Walkthrough

Walkthrough

The recent enhancements to the HTML entry generation script significantly improve its functionality and maintainability. Key updates include the integration of new user agent regex handling, a helper function to streamline template variable management, and improved path resolution methods. These changes aim to boost adaptability across different browser environments, enhance error handling, and ensure consistent access to necessary variables during template rendering.

Changes

File	Change Summary
build-scripts/gulp/entry-html.js	- Added imports from browserslist-useragent-regexp for dynamic user agent handling.
	- Introduced HA_MACOS_REGEX for Home Assistant user agents on macOS.
	- Defined SAFARI_TO_MACOS mapping for Safari versions.
	- Implemented getCommonTemplateVars to centralize common template variable retrieval.
	- Updated renderTemplate to use the new resolve method for path handling.
	- Modified genPagesDevTask and genPagesProdTask to include commonVars for consistency.

---

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

[steverep]

I also opened a WebKit bug report so we can perhaps remove this in the future.

cc: @bgoncal

[piitaya]

Seems good to me 👌