[google_maps_flutter] Add Advanced Markers support #7882

aednlaxer · 2024-10-16T11:26:56Z

This PR adds Advanced Markers support to google_maps_flutter as discussed in #155526. The document from the issue offers several options to implement Advanced Markers support, this PR uses option 1 (Advanced Marker Dart class is a subclass Marker class).

Summary of changes:

Add map capability check
Add AdvancedMarker class
Add MarkerCollisionBehavior enum to control Advanced Marker's behavior when it collides with another marker
Add PinConfig bitmap descriptor for customizing Advanced Marker's pin and icon
Add markerType parameter to indicate that Advanced Markers should be used
Rename cloudMapId to mapId

Notes:

native implementations need to know what kind of marker should be used, this is needed to use correct marker options, cluster manager and marker controller. Indicating marker type is done by using a markerType option when creating a GoogleMap (could be marker or advancedMarker). Default option is marker
cloudMapId is deprecated in favor of mapId. New name follows SDKs, documentation and Cloud Console naming.
web implementation uses generics because gmaps.Marker and gmaps.AdvancedMarkerElement are not related to each other and should be handled differently
legacy markers are deprecated but still supported in Maps Javascript API. google_maps_flutter still uses them by default in this PR because of backward-compatibility. #130472 is related, package users will be able to use Advanced Markers to fix the deprecation warning
Advanced Markers example on iOS doesn't show advanced markers, seems to be a known issue
Using Flutter widget as Advanced Marker icon (so called View Marker) is not part of this PR, this was discussed in the document and later removed as we agreed that it should be a separate issue

Resolves #155526

Pre-launch Checklist

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

reidbaker

High level android code review. I am concerned by having to runtime type check class.

That said thank you for opening this pull request.

packages/google_maps_flutter/google_maps_flutter/example/android/app/build.gradle

...r_android/android/src/main/java/io/flutter/plugins/googlemaps/ClusterManagersController.java

...flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapController.java

...ps_flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapFactory.java

...ps_flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/MarkerController.java

stuartmorgan-g

I've only looked at the app-facing and platform interface packages so far, but there are some fundamental structure questions at the interface layer.

...ages/google_maps_flutter/google_maps_flutter/example/lib/readme_sample_advanced_markers.dart

packages/google_maps_flutter/google_maps_flutter/example/lib/clustering.dart

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

packages/google_maps_flutter/google_maps_flutter/example/lib/marker_icons.dart

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/glyph.dart

...gle_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/map_configuration.dart

...s_flutter/google_maps_flutter_platform_interface/lib/src/types/map_widget_configuration.dart

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/marker.dart

stuartmorgan-g

App-facing and platform interface look good, so once the platform reviews are in this can be split apart.

...ps_flutter_platform_interface/lib/src/method_channel/method_channel_google_maps_flutter.dart

...oogle_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/advanced_marker.dart

aednlaxer · 2025-05-19T12:16:27Z

@reidbaker @vashworth could you please give this another round of review? All comments should be resolved now

aednlaxer · 2025-05-19T12:28:39Z

Linux_web web_platform_tests_wasm_shard_3 master is failing because innerHtml returns a different object type on Flutter main:

Flutter stable: String?
Flutter main: JSAny

@ditman is this something that should be type-checked in tests or is there a better way to deal with it?

ditman · 2025-05-19T22:07:34Z

@aednlaxer this has to do with (possible) differences in implementation of those types in JS vs WASM (the failing tests are WASM ones, it seems).

Have you tried compiling your demo app with --wasm and seeing if it actually fails, or is it a problem with the tests? If we're using dart:html in tests that's a problem-ish, we should move away from that and use package:web and dart:js_interop instead.

I can't take a look right now, but will try to figure out a patch later this week.

(PS: I suspect this needs a strategic .toDart/.toJS in the failing assertion, when the type is JSAny? probably/maybe :))

vashworth · 2025-05-20T01:24:55Z

packages/google_maps_flutter/google_maps_flutter_ios/lib/src/google_maps_flutter_ios.dart

    style: config.style,
  );
 }

+PlatformMarkerType? _platformMarkerTypeFromMarkerType(MarkerType? markerType) {


Github won't let me add a comment on the line, but collisionBehavior needs to be added to _platformMarkerFromMarker function above. Currently collisionBehavior is always being set to null. There should also probably be a test that should have caught this.

Great catch, thanks! I've added a test for updateMarkers that works with AdvancedMarkers and a check for collisionBehavior there. Do you think it's worth adding a test just for _platformMarkerTypeFromMarkerType?

….com:CodemateLtd/packages into feature/google-maps-advanced-markers-support

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

camsim99

Overall, the Android implementation looks good to me! Left some questions regarding testing.

camsim99 · 2025-05-28T19:45:51Z

...google_maps_flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/Convert.java

+      final String backgroundColorKey = "backgroundColor";
+      final String borderColorKey = "borderColor";
+      final String glyphTextKey = "glyphText";
+      final String glyphTextColorKey = "glyphTextColor";
+      final String glyphColorKey = "glyphColor";
+      final String glyphBitmapDescriptorKey = "glyphBitmapDescriptor";


Are these used?

camsim99 · 2025-05-28T19:57:25Z

...le_maps_flutter_android/android/src/test/java/io/flutter/plugins/googlemaps/ConvertTest.java

@@ -327,6 +328,20 @@ public void GetBitmapFromBytesThrowsErrorIfInvalidImageData() {
    fail("Expected an IllegalArgumentException to be thrown");
  }

+  @Test
+  public void GetBitmapFromPinConfig() {


Can this test be modified to ensure that PinConfigs are created as expected?

camsim99 · 2025-05-28T19:58:47Z

...ter_android/android/src/test/java/io/flutter/plugins/googlemaps/GoogleMapControllerTest.java

Can you add a test for isAdvancedMarkersAvailable?

camsim99 · 2025-05-28T20:08:38Z

..._maps_flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/MarkerBuilder.java

@@ -115,6 +120,13 @@ public void setZIndex(float zIndex) {
    markerOptions.zIndex(zIndex);
  }

+  @Override
+  public void setCollisionBehavior(@AdvancedMarkerOptions.CollisionBehavior int collisionBehavior) {


I think it may be nice to add setCollisionBehavior tests for the two implementation in this PR.

camsim99 · 2025-05-28T20:18:39Z

...gle_maps_flutter/google_maps_flutter_android/example/integration_test/google_maps_tests.dart

@@ -1949,6 +2040,33 @@ void googleMapsTests() {
    // https://github.com/flutter/flutter/issues/131071
    skip: true,
  );
+
+  testWidgets('markerWithPinConfig', (WidgetTester tester) async {


Is this testing anything? Can we remove it?

github-actions bot added p: google_maps_flutter platform-android platform-ios platform-web labels Oct 16, 2024

aednlaxer marked this pull request as ready for review October 21, 2024 07:12

aednlaxer requested review from cbracken, reidbaker, ditman and stuartmorgan-g as code owners October 21, 2024 07:13

reidbaker reviewed Oct 28, 2024

View reviewed changes

stuartmorgan-g added the triage-ios Should be looked at in iOS triage label Nov 21, 2024

stuartmorgan-g requested changes Nov 21, 2024

View reviewed changes

aednlaxer requested review from hellohuanlin, jmagman, tarrinneal, LouiseHsu, loic-sharma, bparrishMines, camsim99, matanlurey, gmackall, domesticmouse, yjbanov, jonahwilliams, Piinks, Hixie, gspencergoog, sokoloff06, chunhtai and goderbauer as code owners December 19, 2024 08:04

aednlaxer added 3 commits April 15, 2025 10:45

Restore icon anchor

3dc400a

Fix missing semicolon

67200fa

Fix iOS tests

c8f6b0c

stuartmorgan-g reviewed Apr 17, 2025

View reviewed changes

aednlaxer added 3 commits April 22, 2025 10:19

Revert trailing comma

e55ce2a

Change AdvancedMarker's zIndex type to int

3f8622b

Merge branch 'main' into feature/google-maps-advanced-markers-support

1b77530

ash2moon requested a review from reidbaker April 29, 2025 18:35

aednlaxer added 4 commits May 15, 2025 15:43

Merge branch 'main' into feature/google-maps-advanced-markers-support

dfb41b3

Fix duplicated test name

1b37387

Annotate collisionBehavior parameter (Java)

bc92715

Remove duplicated line

b0857e8

aednlaxer requested a review from vashworth May 19, 2025 12:16

reidbaker requested review from camsim99 and removed request for reidbaker May 19, 2025 18:10

vashworth reviewed May 20, 2025

View reviewed changes

aednlaxer added 6 commits May 20, 2025 13:54

Fix collision behavior not being set correctly on iOS

439d97a

Convert innerHTML to String

517d3be

Tweak marker to platform marker conversion

351e375

Merge branch 'main' into feature/google-maps-advanced-markers-support

cc63ced

Ignore decimal point

f35b350

Merge branch 'feature/google-maps-advanced-markers-support' of github…

28b0072

….com:CodemateLtd/packages into feature/google-maps-advanced-markers-support

ditman reviewed May 22, 2025

View reviewed changes

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

aednlaxer added 3 commits May 22, 2025 10:28

Fix num to String conversion of an icon size

a91792c

Merge branch 'main' into feature/google-maps-advanced-markers-support

fc48a9b

Merge branch 'main' into feature/google-maps-advanced-markers-support

14e4778

camsim99 reviewed May 28, 2025

View reviewed changes

[google_maps_flutter] Add Advanced Markers support #7882

Are you sure you want to change the base?

[google_maps_flutter] Add Advanced Markers support #7882

Uh oh!

Conversation

aednlaxer commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

reidbaker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aednlaxer commented May 19, 2025

Uh oh!

aednlaxer commented May 19, 2025

Uh oh!

ditman commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vashworth May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aednlaxer May 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

camsim99 left a comment

Choose a reason for hiding this comment

Uh oh!

camsim99 May 28, 2025

Choose a reason for hiding this comment

Uh oh!

camsim99 May 28, 2025

Choose a reason for hiding this comment

Uh oh!

camsim99 May 28, 2025

Choose a reason for hiding this comment

Uh oh!

camsim99 May 28, 2025

Choose a reason for hiding this comment

Uh oh!

camsim99 May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aednlaxer commented Oct 16, 2024 •

edited

Loading

ditman commented May 19, 2025 •

edited

Loading

vashworth May 20, 2025 •

edited

Loading