[google_maps_flutter_web] Migrate to package:web #5254

navaronbracke · 2023-10-28T16:04:51Z

This PR migrates google_maps_flutter_web from dart:html to package:web.

The google_maps package does provide a beta version with support for package:web, which is currently what this PR is depending on. Before landing this change, we should change the dependency to the stable release version of that package.

Fixes flutter/flutter#137374

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.
N/A

Pre-launch Checklist

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

packages/google_maps_flutter/google_maps_flutter_web/lib/src/utils.dart

navaronbracke · 2023-10-28T16:11:27Z

packages/google_maps_flutter/google_maps_flutter_web/lib/src/convert.dart

-        treeSanitizer: NodeTreeSanitizer.trusted,
-      );
-    container.children.add(snippet);
+      ..innerHTML = sanitizeHtml(markerSnippet);


There is no NodeSanitizer anymore, not sure of the implications.

I think the "safe" way to solve this now is to :

https://developer.mozilla.org/en-US/docs/Web/API/TrustedHTML

Then define a setter for HTMLElement that lets us set the innerHTML property with a TrustedHTML instance, rather than the current Node or HTMLElement type.

The sanitizeHtml method could be the implementation of the Trusted Type policy, as described in the MDN example:

const escapeHTMLPolicy = trustedTypes.createPolicy("flutter-sanitize-maps", { createHTML: (String html) => sanitizeHtml(html), // Returns an instance of TrustedHTML }); let el = document.getElementById("myDiv"); const escaped = escapeHTMLPolicy.createHTML(markerSnippet); el.safeInnerHTML = escaped; // safeInnerHTML only accepts TrustedHTML objects.

(The above is a js-ification of what we need to do in Dart though :P)

The support for TrustedHTML is a bit lacking though, neither Safari nor Firefox support it.

neither Safari nor Firefox support it.

The stance until very recently was that they'd never will support it, but that's what the unsafe_html lint is actually looking at 😱

Also Mozilla changed their minds recently!

ditman · 2024-01-10T00:19:53Z

There's progress of the dart-google-maps package migration, here:

a14n/dart-google-maps#122 (comment)

navaronbracke · 2024-01-11T10:03:11Z

I've updated the branch to use the new beta version of google_maps, and made some last adjustments.
Next, I'll have to run the tests to see if any fail. Once the tests pass, we can adjust the version of google_maps and get this into a reviewable state.

Edit: Still have to help the web compiler out a little, still have JS type violations to fix.

navaronbracke · 2024-01-11T10:47:15Z

The google_maps_flutter_web integration tests now pass locally, but I do see a different error in the console still?

Logs

js_primitives.dart:30 ══╡ EXCEPTION CAUGHT BY GESTURES LIBRARY ╞══════════════════════════════════════════════════════════
js_primitives.dart:30 The following StateError was thrown while handling a pointer data packet:
js_primitives.dart:30 Bad state: No element
js_primitives.dart:30 
js_primitives.dart:30 When the exception was thrown, this was the stack:
js_primitives.dart:30 dart-sdk/lib/_internal/js_dev_runtime/private/ddc_runtime/errors.dart 297:3       throw_
js_primitives.dart:30 dart-sdk/lib/core/iterable.dart 702:5                                             firstWhere
js_primitives.dart:30 packages/flutter_test/src/test_text_input_key_handler.dart.js 11893:63            handlePointerEvent
js_primitives.dart:30 packages/flutter/src/gestures/binding.dart.js 370:14                              [_flushPointerEventQueue]
js_primitives.dart:30 packages/flutter/src/gestures/binding.dart.js 345:40                              [_handlePointerDataPacket]
js_primitives.dart:30 lib/_engine/engine/platform_dispatcher.dart 1361:5                                invoke1
js_primitives.dart:30 lib/_engine/engine/platform_dispatcher.dart 286:5                                 invokeOnPointerDataPacket
js_primitives.dart:30 lib/_engine/engine/pointer_binding.dart 398:30                                    [_sendToFramework]
js_primitives.dart:30 lib/_engine/engine/pointer_binding.dart 224:7                                     onPointerData
js_primitives.dart:30 lib/_engine/engine/pointer_binding.dart 978:16                                    <fn>
js_primitives.dart:30 lib/_engine/engine/pointer_binding.dart 930:7                                     <fn>
js_primitives.dart:30 lib/_engine/engine/pointer_binding.dart 531:9                                     loggedHandler
js_primitives.dart:30 dart-sdk/lib/_internal/js_dev_runtime/private/ddc_runtime/operations.dart 550:37  _checkAndCall
js_primitives.dart:30 dart-sdk/lib/_internal/js_dev_runtime/private/ddc_runtime/operations.dart 555:39  dcall
js_primitives.dart:30 ════════════════════════════════════════════════════════════════════════════════════════════════════
js_primitives.dart:30 00:00 +0: TileOverlaysController addTileOverlays
js_primitives.dart:30 00:00 +1: TileOverlaysController changeTileOverlays
js_primitives.dart:30 00:00 +2: TileOverlaysController updating the z index of a hidden layer does not make it visible
js_primitives.dart:30 00:00 +3: TileOverlaysController removeTileOverlays
js_primitives.dart:30 00:00 +4: TileOverlaysController clearTileCache
js_primitives.dart:30 00:01 +5: (tearDownAll)
js_primitives.dart:30 00:01 +6: All tests passed!
js_primitives.dart:30 No widgets found at Offset(1448.7, 217.7).

Some CI tasks still fail because of a version problem with package:web:

Running command: "flutter pub get" in ./all_packages
Resolving dependencies...
Note: web is pinned to version 0.3.0 by flutter_test from the flutter SDK.
See https://dart.dev/go/sdk-version-pinning for details.


Because every version of google_maps_flutter_web from path depends on web ^0.4.0 and every version of flutter_test from sdk depends on web 0.3.0, google_maps_flutter_web from path is incompatible with flutter_test from sdk.
So, because all_packages depends on both flutter_test from sdk and google_maps_flutter_web from path, version solving failed.
Failed to generate native build files via 'flutter pub get'

The new google_maps version requires package:web 0.4.0, so I guess we wait until the packages roller picks it up?

navaronbracke · 2024-01-23T12:51:30Z

packages/google_maps_flutter/google_maps_flutter_web/example/lib/main.dart

@@ -20,6 +20,9 @@ class MyApp extends StatefulWidget {
 class _MyAppState extends State<MyApp> {
  @override
  Widget build(BuildContext context) {
-    return const Text('Testing... Look at the console output for results!');
+    return const Directionality(


I accidentally ran the example app once directly (using flutter run -d chrome) and it did throw an error about a missing Directionality widget

This is fine, the skeleton app is only used to have a Flutter context where things run, but IIRC this particular test does not render a map or anything.

navaronbracke · 2024-01-23T13:00:23Z

I have three failing integration tests, which all relate to the bitmap of the test Tile. Not sure what the resolution is? (this refactor should not have affected the loading of the bitmap)

The markers with custom bitmap icon work test in markers_test.dart fails because the list of bytes does not match the expected list
The produces image tiles test in overlay_test.dart fails due to the image element in the test triggering its onerror handler, even though we only try to load a transparent 16x16 bitmap which we don't get over the network (we decode it ourselves)?
The update test in overlay_test.dart fails the same way as the produces image tiles test

ditman · 2024-01-23T19:09:17Z

We have a thread in discord about the test failures here:

https://discord.com/channels/608014603317936148/608020293944082452/1199091259365662882

navaronbracke · 2024-01-31T14:26:31Z

@ditman The test failure was resolved on my end. Turns out you were right about JS converting stuff to strings, as mentioned in dart-lang/web#91 (comment) See 44e4335 for that fix.

packages/google_maps_flutter/google_maps_flutter_web/lib/src/convert.dart

ditman · 2024-02-14T00:22:33Z

@navaronbracke thanks for keeping this PR fresh, if you don't mind I may be able to push stuff to this branch to fix the annoying bits of CI?

navaronbracke · 2024-02-14T08:10:40Z

Feel free to do so, I'll give it some attention regarding your review comments as well.

packages/google_maps_flutter/google_maps_flutter_web/lib/src/convert.dart

navaronbracke · 2024-02-19T10:27:09Z

@ditman What version bump should this be for google_maps_flutter_web ? I have currently set it to version 0.5.5, as the version is still pre-1.0. However, it would force users to upgrade to the latest stable? Do we pick 0.6.0 instead then?

packages/google_maps_flutter/google_maps_flutter_web/pubspec.yaml

navaronbracke · 2024-02-22T07:41:03Z

@kevmoo With package:web 0.5.0 the TrustedTypes binding was removed. However, I needed it for a small part here.

Could you look into landing dart-lang/web@975e55c officially as 0.5.1 ?

kevmoo · 2024-02-22T16:02:26Z

@navaronbracke – you can always just add your own extensions or helpers, too. Copy-paste here is fine.

navaronbracke · 2024-02-22T16:07:55Z

@navaronbracke – you can always just add your own extensions or helpers, too. Copy-paste here is fine.

I'm aware of that, I did this for the nullable TrustedTypes in this PR. However, the TrustedTypes definition was removed between 0.4.2 and 0.5.0. I guess I'll just copy over the definition.

ditman · 2024-02-28T00:09:53Z

This seems to work fine, and I can't find anything else to say! Let's land this! Thanks for your patience @navaronbracke!

ditman

Let's go!

packages/google_maps_flutter/google_maps_flutter_web/lib/src/map_styler.dart

…kages#5254)

flutter/packages@353086c...6d02f03 2024-02-28 [email protected] Manual roll Flutter from c30f998 to d00bfe8 (32 revisions) (flutter/packages#6222) 2024-02-28 [email protected] [google_maps_flutter] Add `style` to widget (flutter/packages#6192) 2024-02-28 [email protected] Add library annotations for js interop (flutter/packages#6216) 2024-02-28 [email protected] [google_map_flutter] Add style to widget - platform impls (flutter/packages#6205) 2024-02-28 [email protected] [google_maps_flutter_web] Migrate to package:web (flutter/packages#5254) 2024-02-28 [email protected] [pigeon] Remove heap allocation in generated C++ code (flutter/packages#6196) 2024-02-27 [email protected] [pigeon] Allows kotlin generator to skip error class generation (flutter/packages#6183) 2024-02-27 [email protected] [camerax] Implements `setExposureMode` (flutter/packages#6110) 2024-02-27 [email protected] Roll Flutter from b77560e to c30f998 (12 revisions) (flutter/packages#6211) 2024-02-26 [email protected] Add `InkResponse`, `Material` and fix `Opacity` (flutter/packages#6199) 2024-02-26 [email protected] [url_launcher] Add explicit imports of UIKit (flutter/packages#6208) 2024-02-26 [email protected] [pigeon] Fix tool hangs on verbose sub-processes (flutter/packages#6198) 2024-02-26 [email protected] [tool] Ignore GeneratedPluginRegistrant.swift for `format` (flutter/packages#6195) 2024-02-26 [email protected] Roll Flutter from 1e8dd1e to b77560e (8 revisions) (flutter/packages#6207) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] 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://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

This PR migrates `google_maps_flutter_web` from `dart:html` to `package:web`. The `google_maps` package does provide a beta version with support for `package:web`, which is currently what this PR is depending on. Before landing this change, we should change the dependency to the stable release version of that package. Fixes flutter/flutter#137374 *If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].* N/A

github-actions bot added p: google_maps_flutter platform-web labels Oct 28, 2023

navaronbracke commented Oct 28, 2023

View reviewed changes

packages/google_maps_flutter/google_maps_flutter_web/lib/src/utils.dart Show resolved Hide resolved

navaronbracke commented Oct 28, 2023

View reviewed changes

navaronbracke mentioned this pull request Nov 8, 2023

Migrate to package:web a14n/dart-google-maps#122

Closed

navaronbracke changed the title ~~[WIP] [google_maps_flutter_web] Migrate to package:web~~ [google_maps_flutter_web] Migrate to package:web Jan 11, 2024

navaronbracke marked this pull request as ready for review January 11, 2024 10:51

navaronbracke requested a review from ditman as a code owner January 11, 2024 10:51

navaronbracke force-pushed the google_maps_web_pkg_web branch from 15acde3 to e6e5d5a Compare January 11, 2024 11:10

ditman mentioned this pull request Jan 23, 2024

[google_maps_flutter] Marker clustering support #4319

Merged

11 tasks

navaronbracke force-pushed the google_maps_web_pkg_web branch from e6e5d5a to 15acde3 Compare January 23, 2024 09:26

navaronbracke commented Jan 23, 2024

View reviewed changes

navaronbracke commented Jan 31, 2024

View reviewed changes

packages/google_maps_flutter/google_maps_flutter_web/lib/src/convert.dart Outdated Show resolved Hide resolved

ditman mentioned this pull request Feb 13, 2024

[google_maps_flutter_web] Implement my location & my location button #4486

Closed

11 tasks

navaronbracke commented Feb 14, 2024

View reviewed changes

packages/google_maps_flutter/google_maps_flutter_web/lib/src/convert.dart Outdated Show resolved Hide resolved

kevmoo reviewed Feb 20, 2024

View reviewed changes

packages/google_maps_flutter/google_maps_flutter_web/pubspec.yaml Outdated Show resolved Hide resolved

navaronbracke mentioned this pull request Feb 21, 2024

Support package:web ^0.5.0 a14n/dart-google-maps#123

Merged

navaronbracke requested a review from kevmoo February 23, 2024 10:16

navaronbracke added 9 commits February 27, 2024 16:03

fix constructor

aa46171

fix argument

0523daa

handle undefined trusted types policy

e2df4b1

bump version of google_maps_flutter_web

e358399

fix license headers

736aec1

adjust trusted types binding usage

8b4d7bb

fix quotes in pubspec & add ignore for upcoming lint

d8adca1

add JS binding for MapStyler

52baeca

set inner html to trusted html instance

1951a6a

navaronbracke force-pushed the google_maps_web_pkg_web branch from 92b404c to 1951a6a Compare February 27, 2024 15:04

Make getTTPolicy a little bit less generic looking.

6583739

ditman approved these changes Feb 28, 2024

View reviewed changes

ditman added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 28, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Feb 28, 2024

This comment was marked as outdated.

Sign in to view

kevmoo approved these changes Feb 28, 2024

View reviewed changes

kevmoo added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 28, 2024

auto-submit bot merged commit 7cdcf30 into flutter:main Feb 28, 2024
78 checks passed

navaronbracke deleted the google_maps_web_pkg_web branch February 28, 2024 07:10

parlough mentioned this pull request Feb 28, 2024

Internal Error MapStyler dart-lang/sdk#55039

Closed

srujzs reviewed Feb 28, 2024

View reviewed changes

packages/google_maps_flutter/google_maps_flutter_web/lib/src/map_styler.dart Show resolved Hide resolved

packages/google_maps_flutter/google_maps_flutter_web/lib/src/map_styler.dart Show resolved Hide resolved

stuartmorgan mentioned this pull request Feb 28, 2024

[google_maps_flutter] Add style to widget #6192

Merged

11 tasks

engine-flutter-autoroll mentioned this pull request Feb 29, 2024

Roll Packages from 353086c9a61e to 6d02f0359368 (14 revisions) flutter/flutter#144393

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 29, 2024

7cdcf30 [google_maps_flutter_web] Migrate to package:web (flutter/pac…

08f8ffa

…kages#5254)

a14n mentioned this pull request Mar 4, 2024

Error with > 7.00 version : Uncaught (in promise) TypeError: Illegal constructor a14n/dart-google-maps#124

Closed

reidbaker mentioned this pull request Apr 1, 2024

[camera_android_camerax] Move integration_test dependency to tests reidbaker/packages#4

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[google_maps_flutter_web] Migrate to package:web #5254

[google_maps_flutter_web] Migrate to package:web #5254

navaronbracke commented Oct 28, 2023 •

edited by ditman

Loading

navaronbracke Oct 28, 2023

ditman Feb 14, 2024 •

edited

Loading

navaronbracke Feb 14, 2024 •

edited

Loading

ditman Feb 27, 2024 •

edited

Loading

ditman commented Jan 10, 2024

navaronbracke commented Jan 11, 2024 •

edited

Loading

navaronbracke commented Jan 11, 2024 •

edited

Loading

navaronbracke Jan 23, 2024 •

edited

Loading

ditman Feb 14, 2024

navaronbracke commented Jan 23, 2024

ditman commented Jan 23, 2024

navaronbracke commented Jan 31, 2024 •

edited

Loading

ditman commented Feb 14, 2024

navaronbracke commented Feb 14, 2024

navaronbracke commented Feb 19, 2024 •

edited

Loading

navaronbracke commented Feb 22, 2024 •

edited

Loading

kevmoo commented Feb 22, 2024

navaronbracke commented Feb 22, 2024

ditman commented Feb 28, 2024

ditman left a comment

This comment was marked as outdated.

[google_maps_flutter_web] Migrate to package:web #5254

[google_maps_flutter_web] Migrate to package:web #5254

Conversation

navaronbracke commented Oct 28, 2023 • edited by ditman Loading

Pre-launch Checklist

navaronbracke Oct 28, 2023

Choose a reason for hiding this comment

ditman Feb 14, 2024 • edited Loading

Choose a reason for hiding this comment

navaronbracke Feb 14, 2024 • edited Loading

Choose a reason for hiding this comment

ditman Feb 27, 2024 • edited Loading

Choose a reason for hiding this comment

ditman commented Jan 10, 2024

navaronbracke commented Jan 11, 2024 • edited Loading

navaronbracke commented Jan 11, 2024 • edited Loading

navaronbracke Jan 23, 2024 • edited Loading

Choose a reason for hiding this comment

ditman Feb 14, 2024

Choose a reason for hiding this comment

navaronbracke commented Jan 23, 2024

ditman commented Jan 23, 2024

navaronbracke commented Jan 31, 2024 • edited Loading

ditman commented Feb 14, 2024

navaronbracke commented Feb 14, 2024

navaronbracke commented Feb 19, 2024 • edited Loading

navaronbracke commented Feb 22, 2024 • edited Loading

kevmoo commented Feb 22, 2024

navaronbracke commented Feb 22, 2024

ditman commented Feb 28, 2024

ditman left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

navaronbracke commented Oct 28, 2023 •

edited by ditman

Loading

ditman Feb 14, 2024 •

edited

Loading

navaronbracke Feb 14, 2024 •

edited

Loading

ditman Feb 27, 2024 •

edited

Loading

navaronbracke commented Jan 11, 2024 •

edited

Loading

navaronbracke commented Jan 11, 2024 •

edited

Loading

navaronbracke Jan 23, 2024 •

edited

Loading

navaronbracke commented Jan 31, 2024 •

edited

Loading

navaronbracke commented Feb 19, 2024 •

edited

Loading

navaronbracke commented Feb 22, 2024 •

edited

Loading