Skip to content

Proposal to deprecate webGoldenComparator. #161196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
auto-submit merged 3 commits into from
Jan 9, 2025
Merged

Proposal to deprecate webGoldenComparator. #161196

auto-submit merged 3 commits into from
Jan 9, 2025

Conversation

@matanlurey
Copy link
Contributor

@matanlurey matanlurey commented Jan 6, 2025

Towards #160261.

This is a PR and proposal all-in-one to deprecate, and remove, pending the removal of the HTML backend, WebGoldenComparator (and related symbols, webGoldenComparator and DefaultWebGoldenComparator).

The concept of WebGoldenComparator was added because the HTML-based renderer could not support the GoldenFileComparator contract:

flutter/packages/flutter_test/lib/src/_matchers_web.dart

Lines 105 to 108 in 7141c2a

// In the HTML renderer, we don't have the ability to render an element
// to an image directly. Instead, we will use `window.render()` to render
// only the element being requested, and send a request to the test server
// requesting it to take a screenshot through the browser's debug interface.

Once the Skia renderer (and now, SkWasm renderer) were added, it was now possible to support the same API used by the native engine(s). This PR conditionally, if not using the HTML renderer, uses goldenFileComparator instead, which re-uses the same code that previously backed DefaultWebGoldenFileComparator.

No new logic has been introduced in this change. This might need an iteration or two to get right.

Feedback welcome!

@github-actions github-actions bot added a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels. labels Jan 6, 2025
eyebrowsoffire
eyebrowsoffire approved these changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@eyebrowsoffire eyebrowsoffire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@matanlurey matanlurey marked this pull request as ready for review January 8, 2025 20:50
@matanlurey
Copy link
Contributor Author

matanlurey commented Jan 9, 2025

Ping @goderbauer in particular (or LMK if this is something Kate should be reviewing, I'm not sure)

goderbauer
goderbauer approved these changes Jan 9, 2025
View reviewed changes
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@matanlurey
Copy link
Contributor Author

matanlurey commented Jan 9, 2025

Based on @yjbanov's comment (#160261 (comment)) and the other LGTMs, I'll merge this PR.

@matanlurey matanlurey added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 9, 2025
@auto-submit auto-submit bot added this pull request to the merge queue Jan 9, 2025
Merged via the queue into flutter:master with commit f2e59e7 Jan 9, 2025
101 checks passed
@flutter-dashboard flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 9, 2025
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jan 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 10, 2025
@engine-flutter-autoroll
f2e59e7 Proposal to deprecate webGoldenComparator. (flutter/flutter…
aa8fc04 
…#161196)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jan 10, 2025
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 10, 2025
@engine-flutter-autoroll
f2e59e7 Proposal to deprecate webGoldenComparator. (flutter/flutter…
94ef00c 
…#161196)
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Jan 11, 2025
@engine-flutter-autoroll
Roll Flutter from 4b23b81 to 864d4f5 (50 revisions) (#8408)
f174de6 
Roll Flutter from 4b23b81 to 864d4f5 (50 revisions)

flutter/flutter@4b23b81...864d4f5

2025-01-10 [email protected] Mark complex_layout_scroll_perf_macos__timeline_summary unflaky (flutter/flutter#160997)
2025-01-10 [email protected] Mark hello_world_macos__compile unflaky (flutter/flutter#160998)
2025-01-10 [email protected] Mark animated_complex_opacity_perf_macos__e2e_summary unflaky (flutter/flutter#160996)
2025-01-10 [email protected] Mark integration_ui_test_test_macos unflaky (flutter/flutter#160999)
2025-01-10 [email protected] Mark hot_mode_dev_cycle_macos_target__benchmark unflaky (flutter/flutter#161000)
2025-01-10 [email protected] Add a virtual-display (VD) platform view test, and refactor tests a bit. (flutter/flutter#161349)
2025-01-10 [email protected] Remove `CIRRUS_TASK_NAME` from what I can tell, is always omitted on `LUCI` (flutter/flutter#161391)
2025-01-10 [email protected] Replace the always omitted `CPU` environment variable with `numberOfProcessors`. (flutter/flutter#161392)
2025-01-10 [email protected] We no longer have a separate engine repo. (flutter/flutter#161400)
2025-01-10 [email protected] Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)
2025-01-09 [email protected] integration_test: Add gitignore of golden image (flutter/flutter#161404)
2025-01-09 [email protected] Fix link to engine docs in CONTRIBUTING.md (flutter/flutter#161401)
2025-01-09 [email protected] Roll Packages from 3fc6b7a to 6554751 (11 revisions) (flutter/flutter#161379)
2025-01-09 [email protected] Add `mouseCursor` parameter to `ReorderableListView` (flutter/flutter#160246)
2025-01-09 [email protected] Remove Cirrus CI from Flutter goldens. (flutter/flutter#161396)
2025-01-09 [email protected] remove`useMaterial3: true,` in from the template (flutter/flutter#160525)
2025-01-09 [email protected] Remove `accept_android_sdk_licenses.sh`, which appears unused. (flutter/flutter#161388)
2025-01-09 [email protected] Roll Dart to Version 3.7.0-312.0.dev (flutter/flutter#161394)
2025-01-09 [email protected] Marks Linux analyzer_benchmark to be flaky (flutter/flutter#161307)
2025-01-09 [email protected] [Impeller] fix scaling of trampoline import of GLES textures into Vulkan. (flutter/flutter#161331)
2025-01-09 [email protected] Support DDC library bundle format and remove support for DDC module format (flutter/flutter#161276)
2025-01-09 [email protected] Remove seemingly stale web Cirrus and "Web Installer" instructions (flutter/flutter#161389)
2025-01-09 [email protected] Proposal to deprecate `webGoldenComparator`. (flutter/flutter#161196)
2025-01-09 [email protected] `ImplicitlyAnimatedWidgetState` code cleanup (flutter/flutter#160567)
2025-01-09 [email protected] Exclude `*texture*` as matching for `a: text input` (flutter/flutter#161354)
2025-01-09 [email protected] [Impeller] add opt in flag for SurfaceControl testing. (flutter/flutter#161353)
2025-01-09 [email protected] Roll Dart to Version 3.7.0-307.0.dev (flutter/flutter#161278)
2025-01-09 [email protected] remove formatter from snippet tool (flutter/flutter#161347)
2025-01-09 [email protected] Refactor keyboard manager tests (flutter/flutter#160637)
2025-01-09 [email protected] [flutter_tools] ignore viewpost ime and samsung spam messages. (flutter/flutter#161199)
2025-01-09 [email protected] Revert "[SwiftPM] Add separate feature flag for the app migration (#158897)" (flutter/flutter#161342)
2025-01-09 [email protected] git ignore .ccls-cache (flutter/flutter#161340)
2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[SwiftPM] Turn on by default (#161275)" (flutter/flutter#161339)
2025-01-08 [email protected] Update engine instructions for monorepo (flutter/flutter#161184)
2025-01-08 [email protected] [Impeller] re-enable Adreno 630 (flutter/flutter#161287)
2025-01-08 [email protected] [SwiftPM] Turn on by default (flutter/flutter#161275)
2025-01-08 [email protected] Make the encoding of a `YamlNode` to a `String` more explicit. (flutter/flutter#161270)
2025-01-08 [email protected] Normalize the translation column of the color matrix. (flutter/flutter#161109)
2025-01-08 [email protected] Rename `native_driver` to `android_{driver_extensions|engine_test}` (flutter/flutter#161263)
2025-01-08 [email protected] [Impeller] reland: fix porterduff shader and handle optimized out texture binding in GLES backend. (flutter/flutter#161326)
2025-01-08 [email protected] Updating AVD Dependency for Android 28 Emulator (flutter/flutter#160978)
2025-01-08 [email protected] Adds onHover and onLongPress to IconButton widget (flutter/flutter#160032)
2025-01-08 [email protected] Marks Linux linux_desktop_impeller to be unflaky (flutter/flutter#161302)
2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Impeller] porter duff workarounds for Adreno GPU. (#161273)" (flutter/flutter#161318)
2025-01-08 [email protected] Revert "fixed keyboardDismissBehavior on scroll without a drag" (flutter/flutter#161277)
2025-01-08 [email protected] Revert "use uuid from package:uuid instead of from package:usage" (flutter/flutter#161292)
...
@matanlurey matanlurey mentioned this pull request Jan 16, 2025
Merged
matanlurey added a commit to flutter/website that referenced this pull request Jan 17, 2025
@matanlurey @sfshaza2
Mark WebGoldenComparator deprecated. (#11597)
c7bb137 
Website side of flutter/flutter#161196.

---------

Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 12, 2025
@engine-flutter-autoroll
f2e59e7 Proposal to deprecate webGoldenComparator. (flutter/flutter…
bfe148a 
…#161196)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025
@engine-flutter-autoroll
f2e59e7 Proposal to deprecate webGoldenComparator. (flutter/flutter…
9a4eb58 
…#161196)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025
@engine-flutter-autoroll
f2e59e7 Proposal to deprecate webGoldenComparator. (flutter/flutter…
c7246ff 
…#161196)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025
@engine-flutter-autoroll
f2e59e7 Proposal to deprecate webGoldenComparator. (flutter/flutter…
6449cfc 
…#161196)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2025
@engine-flutter-autoroll
f2e59e7 Proposal to deprecate webGoldenComparator. (flutter/flutter…
4f7ecf0 
…#161196)
androidseb pushed a commit to androidseb/packages that referenced this pull request Jun 8, 2025
@engine-flutter-autoroll @androidseb
Roll Flutter from 4b23b81 to 864d4f5 (50 revisions) (flutter#8408)
0cbe36d 
Roll Flutter from 4b23b81 to 864d4f5 (50 revisions)

flutter/flutter@4b23b81...864d4f5

2025-01-10 [email protected] Mark complex_layout_scroll_perf_macos__timeline_summary unflaky (flutter/flutter#160997)
2025-01-10 [email protected] Mark hello_world_macos__compile unflaky (flutter/flutter#160998)
2025-01-10 [email protected] Mark animated_complex_opacity_perf_macos__e2e_summary unflaky (flutter/flutter#160996)
2025-01-10 [email protected] Mark integration_ui_test_test_macos unflaky (flutter/flutter#160999)
2025-01-10 [email protected] Mark hot_mode_dev_cycle_macos_target__benchmark unflaky (flutter/flutter#161000)
2025-01-10 [email protected] Add a virtual-display (VD) platform view test, and refactor tests a bit. (flutter/flutter#161349)
2025-01-10 [email protected] Remove `CIRRUS_TASK_NAME` from what I can tell, is always omitted on `LUCI` (flutter/flutter#161391)
2025-01-10 [email protected] Replace the always omitted `CPU` environment variable with `numberOfProcessors`. (flutter/flutter#161392)
2025-01-10 [email protected] We no longer have a separate engine repo. (flutter/flutter#161400)
2025-01-10 [email protected] Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)
2025-01-09 [email protected] integration_test: Add gitignore of golden image (flutter/flutter#161404)
2025-01-09 [email protected] Fix link to engine docs in CONTRIBUTING.md (flutter/flutter#161401)
2025-01-09 [email protected] Roll Packages from 3fc6b7a to 6554751 (11 revisions) (flutter/flutter#161379)
2025-01-09 [email protected] Add `mouseCursor` parameter to `ReorderableListView` (flutter/flutter#160246)
2025-01-09 [email protected] Remove Cirrus CI from Flutter goldens. (flutter/flutter#161396)
2025-01-09 [email protected] remove`useMaterial3: true,` in from the template (flutter/flutter#160525)
2025-01-09 [email protected] Remove `accept_android_sdk_licenses.sh`, which appears unused. (flutter/flutter#161388)
2025-01-09 [email protected] Roll Dart to Version 3.7.0-312.0.dev (flutter/flutter#161394)
2025-01-09 [email protected] Marks Linux analyzer_benchmark to be flaky (flutter/flutter#161307)
2025-01-09 [email protected] [Impeller] fix scaling of trampoline import of GLES textures into Vulkan. (flutter/flutter#161331)
2025-01-09 [email protected] Support DDC library bundle format and remove support for DDC module format (flutter/flutter#161276)
2025-01-09 [email protected] Remove seemingly stale web Cirrus and "Web Installer" instructions (flutter/flutter#161389)
2025-01-09 [email protected] Proposal to deprecate `webGoldenComparator`. (flutter/flutter#161196)
2025-01-09 [email protected] `ImplicitlyAnimatedWidgetState` code cleanup (flutter/flutter#160567)
2025-01-09 [email protected] Exclude `*texture*` as matching for `a: text input` (flutter/flutter#161354)
2025-01-09 [email protected] [Impeller] add opt in flag for SurfaceControl testing. (flutter/flutter#161353)
2025-01-09 [email protected] Roll Dart to Version 3.7.0-307.0.dev (flutter/flutter#161278)
2025-01-09 [email protected] remove formatter from snippet tool (flutter/flutter#161347)
2025-01-09 [email protected] Refactor keyboard manager tests (flutter/flutter#160637)
2025-01-09 [email protected] [flutter_tools] ignore viewpost ime and samsung spam messages. (flutter/flutter#161199)
2025-01-09 [email protected] Revert "[SwiftPM] Add separate feature flag for the app migration (#158897)" (flutter/flutter#161342)
2025-01-09 [email protected] git ignore .ccls-cache (flutter/flutter#161340)
2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[SwiftPM] Turn on by default (#161275)" (flutter/flutter#161339)
2025-01-08 [email protected] Update engine instructions for monorepo (flutter/flutter#161184)
2025-01-08 [email protected] [Impeller] re-enable Adreno 630 (flutter/flutter#161287)
2025-01-08 [email protected] [SwiftPM] Turn on by default (flutter/flutter#161275)
2025-01-08 [email protected] Make the encoding of a `YamlNode` to a `String` more explicit. (flutter/flutter#161270)
2025-01-08 [email protected] Normalize the translation column of the color matrix. (flutter/flutter#161109)
2025-01-08 [email protected] Rename `native_driver` to `android_{driver_extensions|engine_test}` (flutter/flutter#161263)
2025-01-08 [email protected] [Impeller] reland: fix porterduff shader and handle optimized out texture binding in GLES backend. (flutter/flutter#161326)
2025-01-08 [email protected] Updating AVD Dependency for Android 28 Emulator (flutter/flutter#160978)
2025-01-08 [email protected] Adds onHover and onLongPress to IconButton widget (flutter/flutter#160032)
2025-01-08 [email protected] Marks Linux linux_desktop_impeller to be unflaky (flutter/flutter#161302)
2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Impeller] porter duff workarounds for Adreno GPU. (#161273)" (flutter/flutter#161318)
2025-01-08 [email protected] Revert "fixed keyboardDismissBehavior on scroll without a drag" (flutter/flutter#161277)
2025-01-08 [email protected] Revert "use uuid from package:uuid instead of from package:usage" (flutter/flutter#161292)
...
FMorschel pushed a commit to FMorschel/packages that referenced this pull request Jun 9, 2025
@engine-flutter-autoroll @FMorschel
Roll Flutter from 4b23b81 to 864d4f5 (50 revisions) (flutter#8408)
1c1cbd6 
Roll Flutter from 4b23b81 to 864d4f5 (50 revisions)

flutter/flutter@4b23b81...864d4f5

2025-01-10 [email protected] Mark complex_layout_scroll_perf_macos__timeline_summary unflaky (flutter/flutter#160997)
2025-01-10 [email protected] Mark hello_world_macos__compile unflaky (flutter/flutter#160998)
2025-01-10 [email protected] Mark animated_complex_opacity_perf_macos__e2e_summary unflaky (flutter/flutter#160996)
2025-01-10 [email protected] Mark integration_ui_test_test_macos unflaky (flutter/flutter#160999)
2025-01-10 [email protected] Mark hot_mode_dev_cycle_macos_target__benchmark unflaky (flutter/flutter#161000)
2025-01-10 [email protected] Add a virtual-display (VD) platform view test, and refactor tests a bit. (flutter/flutter#161349)
2025-01-10 [email protected] Remove `CIRRUS_TASK_NAME` from what I can tell, is always omitted on `LUCI` (flutter/flutter#161391)
2025-01-10 [email protected] Replace the always omitted `CPU` environment variable with `numberOfProcessors`. (flutter/flutter#161392)
2025-01-10 [email protected] We no longer have a separate engine repo. (flutter/flutter#161400)
2025-01-10 [email protected] Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344)
2025-01-09 [email protected] integration_test: Add gitignore of golden image (flutter/flutter#161404)
2025-01-09 [email protected] Fix link to engine docs in CONTRIBUTING.md (flutter/flutter#161401)
2025-01-09 [email protected] Roll Packages from 3fc6b7a to 6554751 (11 revisions) (flutter/flutter#161379)
2025-01-09 [email protected] Add `mouseCursor` parameter to `ReorderableListView` (flutter/flutter#160246)
2025-01-09 [email protected] Remove Cirrus CI from Flutter goldens. (flutter/flutter#161396)
2025-01-09 [email protected] remove`useMaterial3: true,` in from the template (flutter/flutter#160525)
2025-01-09 [email protected] Remove `accept_android_sdk_licenses.sh`, which appears unused. (flutter/flutter#161388)
2025-01-09 [email protected] Roll Dart to Version 3.7.0-312.0.dev (flutter/flutter#161394)
2025-01-09 [email protected] Marks Linux analyzer_benchmark to be flaky (flutter/flutter#161307)
2025-01-09 [email protected] [Impeller] fix scaling of trampoline import of GLES textures into Vulkan. (flutter/flutter#161331)
2025-01-09 [email protected] Support DDC library bundle format and remove support for DDC module format (flutter/flutter#161276)
2025-01-09 [email protected] Remove seemingly stale web Cirrus and "Web Installer" instructions (flutter/flutter#161389)
2025-01-09 [email protected] Proposal to deprecate `webGoldenComparator`. (flutter/flutter#161196)
2025-01-09 [email protected] `ImplicitlyAnimatedWidgetState` code cleanup (flutter/flutter#160567)
2025-01-09 [email protected] Exclude `*texture*` as matching for `a: text input` (flutter/flutter#161354)
2025-01-09 [email protected] [Impeller] add opt in flag for SurfaceControl testing. (flutter/flutter#161353)
2025-01-09 [email protected] Roll Dart to Version 3.7.0-307.0.dev (flutter/flutter#161278)
2025-01-09 [email protected] remove formatter from snippet tool (flutter/flutter#161347)
2025-01-09 [email protected] Refactor keyboard manager tests (flutter/flutter#160637)
2025-01-09 [email protected] [flutter_tools] ignore viewpost ime and samsung spam messages. (flutter/flutter#161199)
2025-01-09 [email protected] Revert "[SwiftPM] Add separate feature flag for the app migration (#158897)" (flutter/flutter#161342)
2025-01-09 [email protected] git ignore .ccls-cache (flutter/flutter#161340)
2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[SwiftPM] Turn on by default (#161275)" (flutter/flutter#161339)
2025-01-08 [email protected] Update engine instructions for monorepo (flutter/flutter#161184)
2025-01-08 [email protected] [Impeller] re-enable Adreno 630 (flutter/flutter#161287)
2025-01-08 [email protected] [SwiftPM] Turn on by default (flutter/flutter#161275)
2025-01-08 [email protected] Make the encoding of a `YamlNode` to a `String` more explicit. (flutter/flutter#161270)
2025-01-08 [email protected] Normalize the translation column of the color matrix. (flutter/flutter#161109)
2025-01-08 [email protected] Rename `native_driver` to `android_{driver_extensions|engine_test}` (flutter/flutter#161263)
2025-01-08 [email protected] [Impeller] reland: fix porterduff shader and handle optimized out texture binding in GLES backend. (flutter/flutter#161326)
2025-01-08 [email protected] Updating AVD Dependency for Android 28 Emulator (flutter/flutter#160978)
2025-01-08 [email protected] Adds onHover and onLongPress to IconButton widget (flutter/flutter#160032)
2025-01-08 [email protected] Marks Linux linux_desktop_impeller to be unflaky (flutter/flutter#161302)
2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Impeller] porter duff workarounds for Adreno GPU. (#161273)" (flutter/flutter#161318)
2025-01-08 [email protected] Revert "fixed keyboardDismissBehavior on scroll without a drag" (flutter/flutter#161277)
2025-01-08 [email protected] Revert "use uuid from package:uuid instead of from package:usage" (flutter/flutter#161292)
...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@goderbauer goderbauer goderbauer approved these changes

@eyebrowsoffire eyebrowsoffire eyebrowsoffire approved these changes

@yjbanov yjbanov Awaiting requested review from yjbanov

Assignees

No one assigned

Labels

a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@matanlurey @goderbauer @eyebrowsoffire