Use Brotli compression for modern build

[steverep]

Proposed change

Since aiohttp doesn't support Brotli, this is just proof of the potential gain for now. We either need to help them implement or write a middleware to handle it. Looks like much of the work was done in aio-libs/aiohttp#2945, but it was abandoned and never merged.

Since all major browsers that get served the modern build also support Brotli, this just replaces the gzip files for that bundle and keeps Zopfli for everything else (although it'd be much safer if we first merge #16506).

Zopfli bundle	Brotli bundle	Reduction
4.7 MB	4.1 MB	13%

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 Brotli compression alongside existing Zopfli compression for enhanced file handling.
  • Added new Gulp tasks to parallelize compression processes for improved efficiency.

• Chores

  • Updated project dependencies to include Brotli compression capabilities.

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

[steverep]

This would be unblocked after aio-libs/aiohttp#8063

[bramkragten]

Is this unblocked now? Does the backend support Brotli now?

[steverep]

Nope… Waiting for 3.10 to be released still.

[coderabbitai]

Walkthrough

Walkthrough

The changes enhance the Gulp build process by introducing Brotli compression alongside the existing Zopfli compression. New functions for each compression method streamline file handling and allow for parallel execution of both algorithms. This improves efficiency and flexibility in managing application assets, particularly in terms of file size reduction and processing speed.

Changes

File(s)	Change Summary
build-scripts/gulp/compress.js	Added Brotli compression functionality with new functions compressDistBrotli and compressDistZopfli. Updated Gulp tasks for parallel execution of both compression methods for application and Hass.io outputs.
package.json	Added dependency "gulp-brotli": "3.0.0" to support Brotli compression in the build process.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3d54e18 and fec7c50.

Files selected for processing (2)

• build-scripts/gulp/compress.js (1 hunks)
• package.json (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• package.json

Additional comments not posted (7)

build-scripts/gulp/compress.js (7)

18-24: LGTM! The compressDistBrotli function is well-implemented.

The function correctly uses Brotli compression with the specified options.

---

26-36: LGTM! The compressDistZopfli function is well-implemented.

The function correctly uses Zopfli compression with the specified options.

---

40-41: LGTM! The compressAppBrotli function is well-implemented.

The function correctly calls compressDistBrotli with the appropriate paths.

---

42-43: LGTM! The compressHassioBrotli function is well-implemented.

The function correctly calls compressDistBrotli with the appropriate paths.

---

45-46: LGTM! The compressAppZopfli function is well-implemented.

The function correctly calls compressDistZopfli with the appropriate paths.

---

47-48: LGTM! The compressHassioZopfli function is well-implemented.

The function correctly calls compressDistZopfli with the appropriate paths.

---

50-54: LGTM! The Gulp tasks are well-implemented.

The tasks correctly use gulp.parallel to run Brotli and Zopfli compression in parallel for application and Hass.io files.

---

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]

@bramkragten this is ready to go now. Core is now using aiohttp 3.10 on the dev branch as of home-assistant/core#122409.

I could probably improve the compression speed here by using native streams and better parallelizing, but I'll save that for another day.

cc: @bdraco

[bdraco]

Tested and working as expected with latest frontend bump