Title: perf(common): avoid re-setting unchanged attributes in NgOptimizedImage by jsaguet · Pull Request #71875 · angular/angular · GitHub
Open Graph Title: perf(common): avoid re-setting unchanged attributes in NgOptimizedImage by jsaguet · Pull Request #71875 · angular/angular
X Title: perf(common): avoid re-setting unchanged attributes in NgOptimizedImage by jsaguet · Pull Request #71875 · angular/angular
Description: PR Checklist
The commit message follows our guidelines: https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
PR Type
Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.dev application / infrastructure changes
Other... Please describe: performance
What is the current behavior?
Part of #71873
During hydration, NgOptimizedImage writes all of its host attributes again, with the values that the server rendered. The browser selects the image source again after a write to src, srcset, or sizes, even when the value doesn't change.
What is the new behavior?
private setHostAttribute(name: string, value: string): void {
- this.renderer.setAttribute(this.imgElement, name, value);
+ if (this.placeholder || this.imgElement.getAttribute(name) !== value) {
+ this.renderer.setAttribute(this.imgElement, name, value);
+ }
}
An image that still has a placeholder keeps today's writes. An image that failed before hydration then fires error again, which removes the placeholder. An image that already loaded clears its placeholder before the writes, so it skips them.
Does this PR introduce a breaking change?
Yes
No
The public API doesn't change. The visible differences are repeated events that were a side effect of the rewrite, described under Risks.
Other information
Evidence
On a page with 200 images, hydration takes 28.1 ms instead of 34.8 ms. With 4× CPU throttling, it takes 198.6 ms instead of 247.9 ms. With bound [width], [height], and [sizes], it takes 9.6 ms instead of 23.4 ms. results/timings.txt in the reproduction has the measurements. The benchmark pages have no placeholders, so the this.placeholder condition doesn't affect them.
The extra reads also run during client-side rendering. They add 96–164 ns per image in Chrome 157, which is 19–33 µs for 200 images, compared with about 175 µs per image for hydration on the page above. So they aren't limited to hydration.
Microbenchmark
Each sample runs the 8 writes of setHostAttribute() on 50,000 new images, in an inert document so that the images aren't fetched. The median of 31 samples, in 3 runs:
Case
Without the check
With the check
Difference
Static width and height, already written by core
696–732 ns
828–840 ns
96–144 ns
Bound [width] and [height]
652–664 ns
798–828 ns
146–164 ns
running
Specs in full_app_hydration_spec.ts:
Attributes rendered on the server aren't written again. This spec fails without the check.
An image with a placeholder is written again. This spec fails without the this.placeholder condition.
A value that differs from the server is still written.
A spec in event_replay_spec.ts checks that a load event that fired before hydration is replayed, under domino, which doesn't load images. It passes with and without this change.
No spec covers the placeholder image that already loaded, because setting complete and naturalWidth under domino also runs the dev-mode distortion check, which needs layout.
Test targets for common and platform-server pass, including the Chromium and Firefox suites for common. I couldn't run image-directive:webdriver_tests in my environment. That target fails the same way without this change.
Risks
It affects apps that use NgOptimizedImage.
When nothing else writes the attributes of an image that loaded before hydration, load no longer fires a second time. That's the case for an image with no static sizes attribute (measured in Chrome). A (load) handler on that image then runs once, through event replay, which is on by default. Without event replay, it doesn't run. Listeners added imperatively, such as fromEvent or renderer.listen, aren't covered by event replay and no longer receive that second event.
An image without a placeholder that failed before hydration no longer fires error a second time, and the browser doesn't try to load it again during hydration. (error) handlers use the same event replay path as (load), but no spec covers it.
This change doesn't address the sizes value that changes twice on lazy images. #71873 describes that case.
Open Graph Description: PR Checklist The commit message follows our guidelines: https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md Tests for the changes have been added (for bug...
X Description: PR Checklist The commit message follows our guidelines: https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md Tests for the changes have been added (for bug...
Opengraph URL: https://github.com/angular/angular/pull/71875
X: @github
Domain: github.com
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:6f67f2d5-2792-933f-7473-c9d38b7d8ddb |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | CF84:EAD6D:143B67B:195918C:6B026231 |
| html-safe-nonce | 4dae89a536ba8725b03577b62f23db42e4e636db7c30b107ee9b6095adf21533 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDRjg0OkVBRDZEOjE0M0I2N0I6MTk1OTE4Qzo2QjAyNjIzMSIsInZpc2l0b3JfaWQiOiI2NTY5NTcxNTM2NjkxNDIxNzQ1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 2c538121f78200119e7e82f7fc5e2edb377ab57b9426e58e601a6ae82342a4c9 |
| hovercard-subject-tag | pull_request:5211309400 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/angular/angular/pull/71875/files |
| twitter:image | https://avatars.githubusercontent.com/u/49377434?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/49377434?s=400&v=4 |
| og:image:alt | PR Checklist The commit message follows our guidelines: https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md Tests for the changes have been added (for bug... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/angular/angular git https://github.com/angular/angular.git |
| octolytics-dimension-user_id | 139426 |
| octolytics-dimension-user_login | angular |
| octolytics-dimension-repository_id | 24195339 |
| octolytics-dimension-repository_nwo | angular/angular |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 24195339 |
| octolytics-dimension-repository_network_root_nwo | angular/angular |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width