Skip to content
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.

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

[web] Removes patchCanvasKitModule. #42941

Merged
merged 3 commits into from Jun 27, 2023

Conversation

ditman
Copy link
Member

@ditman ditman commented Jun 16, 2023

This must land after flutter/flutter#129032

Flutter web uses requireJS in debug mode to assemble a DDC-compiled app from a bunch of small files ("modules").

This caused that canvaskit.js (then, but probably all other modules that used a browserify-like loading header) didn't work because it attempted to use the define function provided by Flutter's instance of requireJS (which kept the defined modules private, rather than as globals on the page, as the users of the JS expected).

A fix was added to flutter/engine to trick loaders into not using the requireJS module loader, but a recent change in the fix's js-interop layer subtly changed its JS output on the page (objects went from undefined to null), causing this:

After flutter/flutter#129032, the engine fix shouldn't be required anymore, so this PR removes it.

Issues

Testing

  • Manually tested with some test apps, and miscellanous JS scripts as reported by users.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides.
  • I listed at least one issue that this PR fixes in the description above.
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt. See testing the engine for instructions on writing and running engine tests.
  • I updated/added relevant documentation (doc comments with ///).
  • I signed the CLA.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Copy link
Contributor

@harryterkelsen harryterkelsen left a comment

Choose a reason for hiding this comment

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

LGTM

@flutter-dashboard

This comment was marked as resolved.

@ditman
Copy link
Member Author

ditman commented Jun 21, 2023

I think I'll test this by initializing an engine (ensuring that it's downloaded canvaskit) and then checking that module and module.exports don't exist.

fluttermirroringbot pushed a commit to flutter/flutter that referenced this pull request Jun 23, 2023
Flutter web uses requireJS in `debug` mode to assemble a DDC-compiled app from a bunch of small files ("modules").

This caused that `canvaskit.js` (and all other modules that used a browserify-like loading header) didn't work because they attempted to use the `define` function provided by Flutter's instance of `requireJS` (which kept the defined modules private, rather than as globals on the page, as the users of the JS expected).

A [fix](flutter/engine#27342) was added to `flutter/engine` to trick loaders into *not* using the `requireJS` module loader, but a recent change in the fix's js-interop layer *subtly* changed its JS output on the page (objects went from `undefined` to `null`), causing this:

* #126131 (and others)

This PR hides a bit of code that is commonly used by module loaders to decide that they may use the `define` function provided by requireJS (so the engine workaround can be removed).

## Next steps

* flutter/engine#42941

## Issues

Partially addresses: #126131 (and others)

## Tests

* Added a unit test to ensure the `delete` stays
* Manually tested with the Gallery app in `debug` mode with a bunch of user-supplied scripts that currently fail to load.
  * Also tested hot restart as suggested by @nshahan
After flutter/flutter#129032, this shouldn't be needed anymore.
@ditman ditman force-pushed the web-mitigate-browserify-hack branch from 8e09381 to cfa7b1a Compare June 26, 2023 21:30
@ditman
Copy link
Member Author

ditman commented Jun 26, 2023

Added a test for the change.

(Also rename other initialization tests inside the initialization directory to not start with initialization, because there's too many initializations in those paths!)

@ditman ditman added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 26, 2023
@auto-submit auto-submit bot merged commit f320b8c into flutter:main Jun 27, 2023
28 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 27, 2023
fluttermirroringbot pushed a commit to flutter/flutter that referenced this pull request Jun 27, 2023
…129599)

flutter/engine@715eff2...f320b8c

2023-06-27 ditman@gmail.com [web] Removes patchCanvasKitModule. (flutter/engine#42941)
2023-06-26 skia-flutter-autoroll@skia.org Roll ANGLE from cafbf6e2660f to cba77bceb26c (1 revision) (flutter/engine#43222)
2023-06-26 bdero@google.com [Impeller] Fix CPU Porter-Duff blends (flutter/engine#43217)
2023-06-26 skia-flutter-autoroll@skia.org Roll Skia from c1effc01211e to 370132bcadb1 (2 revisions) (flutter/engine#43221)
2023-06-26 skia-flutter-autoroll@skia.org Roll ANGLE from 4a4b13cc6931 to cafbf6e2660f (2 revisions) (flutter/engine#43219)
2023-06-26 skia-flutter-autoroll@skia.org Roll Skia from 4ae209493390 to c1effc01211e (4 revisions) (flutter/engine#43218)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC jsimmons@google.com,rmistry@google.com,zra@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
@ditman ditman deleted the web-mitigate-browserify-hack branch June 27, 2023 19:21
kjlubick pushed a commit to kjlubick/engine that referenced this pull request Jul 14, 2023
**This must land _after_ flutter/flutter#129032

Flutter web uses requireJS in `debug` mode to assemble a DDC-compiled app from a bunch of small files ("modules").

This caused that `canvaskit.js` (then, but probably all other modules that used a browserify-like loading header) didn't work because it attempted to use the `define` function provided by Flutter's instance of `requireJS` (which kept the defined modules private, rather than as globals on the page, as the users of the JS expected).

A [fix](flutter#27342) was added to `flutter/engine` to trick loaders into *not* using the `requireJS` module loader, but a recent change in the fix's js-interop layer *subtly* changed its JS output on the page (objects went from `undefined` to `null`), causing this:

* flutter/flutter#126131 (and others)

After flutter/flutter#129032, the engine fix shouldn't be required anymore, so this PR removes it.

## Issues

* Fixes flutter/flutter#126131 (and possibly others)

## Testing

* Manually tested with some test apps, and miscellanous JS scripts as reported by users.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App platform-web Code specifically for the web engine
Projects
None yet
3 participants