[google_maps_flutter] Ground overlay support - platform impls #8563

jokerttu · 2025-02-04T17:49:59Z

This PR contains platform implementations for the ground overlays support (#8432).

Linked issue: flutter/flutter#26479

Pre-launch Checklist

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

ditman · 2025-02-05T21:14:11Z

Looking at web stuff!

stuartmorgan

Android and iOS LGTM; I did a full review of both. Please wait for @ditman's review covering web before landing though.

stuartmorgan · 2025-02-06T20:00:16Z

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

+   * @return the identifier of the ground overlay.
+   * @throws IllegalArgumentException if required fields are missing or invalid.
+   */
+  static String interpretGroundOverlayOptions(


The return and the parameters should get nullability annotations.

stuartmorgan · 2025-02-06T20:00:32Z

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

+   */
+  @VisibleForTesting
+  public static @NonNull Messages.PlatformDoublePair buildGroundOverlayAnchorForPigeon(
+      GroundOverlay groundOverlay) {


stuartmorgan · 2025-02-06T20:10:47Z

...ndroid/android/src/test/java/io/flutter/plugins/googlemaps/GroundOverlaysControllerTest.java

+  }
+
+  // Helper method to generate 1x1 pixel base64 encoded png test image
+  private String generateBase64Image() {


This can be pulled out of the other file into a test helper file, rather than duplicating the code.

Moved to TestImageUtils.java

stuartmorgan · 2025-02-06T20:47:50Z

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FGMGroundOverlayController.h

+@property(nonatomic, strong, nullable) NSNumber *zoomLevel;
+
+/// Initializes an instance of this class with a GMSGroundOverlay, a map view, and identifier.
+- (instancetype _Nullable)initWithGroundOverlay:(GMSGroundOverlay *)groundOverlay


Does nullable instancetype not work? (I can never remember the exact set of cases where nullable doesn't work).

I removed the nullable annotation from these instance initialisations as they do not explicitly return nil.
There isn't any handling for null instances on code either.
I would assume that self = [super init]; returns instance, and if not, something is really broken.

stuartmorgan · 2025-02-06T20:52:12Z

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

+      bitmapScaling: MapBitmapScaling.none,
+    );
+
+    if (groundOverlayInfo.position != null) {


Nit: If you make locals for groundOverlay.position and groundOverlay.bounds just before the if block, and use the locals everywhere after that (including the conditions), you won't need most of the force-unwraps below.

stuartmorgan · 2025-02-06T20:55:26Z

(@ash-google Feel free to review as well, I just had already looked over the mobile platforms in the main PR so I went ahead and did a review here to cover those.)

ash-google · 2025-02-08T04:37:01Z

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

+    sink.setClickable(groundOverlay.getClickable());
+    sink.setImage(toBitmapDescriptor(groundOverlay.getImage(), assetManager, density, wrapper));
+    if (groundOverlay.getPosition() != null) {
+      assert groundOverlay.getWidth() != null;


This should have an assertion message indicating why it is required or at least log an error saying that width is required.

ash-google · 2025-02-08T04:37:58Z

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

+    // adjust the width accordingly.
+    double west = bounds.southwest.longitude;
+    double east = bounds.northeast.longitude;
+    double width = (west <= east) ? (east - west) : (360.0 - (west - east));


Can we extract these constants into local constants with good naming so it's easier to understand why we need these magic numbers?

@ash-google is this what you were looking for? cdf4d25

ash-google · 2025-02-08T04:53:40Z

Did a second look over Android and LGTM. Let's wait for @ditman for web.

jokerttu · 2025-02-10T12:36:02Z

There is some crash issues on Android integration tests: Linux_android android_device_tests_shard_1 master
Haven't been able to re-produce the crash issue (with same sdk version as tests are runned). Not yet sure if these crashes are related to ground overlay implementation or not. These tests do not fail on each run, but quite often, so I would like to be sure if this is something that is not related to these changes.

stuartmorgan · 2025-02-10T16:35:43Z

There is some crash issues on Android integration tests: Linux_android android_device_tests_shard_1 master

It's flutter/flutter#159731. We're seeing flare-ups of this on other PRs that touch maps, so I don't think it's related. We've seen spikes in this crash in our CI before, potentially due to server-side changes in Google Maps.

matijakevic · 2025-02-12T12:10:47Z

I tested this implementation a bit on Android. Unfortunately, I ran into an issue which occurs when ground overlay images change quickly (<250ms interval). This results in a quick but noticeable black flicker.

The images are stored in-memory as Uint8List and loaded through BytesMapBitmap.

The GroundOverlay has the same unchanging groundOverlayId all the time, only the image is changing.

I am not sure what causes this, maybe the thread that updates the ground overlays doesn't manage to decode bitmaps from raw data quickly enough?

I attached a video demonstrating this on Xiaomi 12T. Maybe I could try creating minimal reproducible example if needed.

out.mp4

reidbaker · 2025-02-12T16:29:25Z

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

+    sink.setClickable(groundOverlay.getClickable());
+    sink.setImage(toBitmapDescriptor(groundOverlay.getImage(), assetManager, density, wrapper));
+    if (groundOverlay.getPosition() != null) {
+      assert groundOverlay.getWidth() != null


By default asserts are stripped in java. If you want to check this value then you will need to throw an exception or log or do some other form of error handling.

reidbaker · 2025-02-12T16:30:30Z

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

+      boolean isCreatedWithBounds) {
+
+    // Dummy image is used as image is required field of PlatformGroundOverlay and converting image
+    // back to image descriptor is not currently supported.


Can you add a link to what layer of the stack does not support this functionality? Also why is it safe to use a dummy image?

This is used only by inpector api, for testing purposes. App facing widget stores groundoverlays on dart implementation, and there is no real reason to fetch the data back, other than testing.
Image is mandatory field on PlatformGroundOverlay (and it should be kept non-nullable), therefore image must be set for the object.
The image is description either contains set of bytes, or path to asset. This info is converted to format google maps uses (BitmapDescription), and the original data is not stored on native code.
So converting read and possibly rescaled asset bitmap back orginal instruction with asset url is not currently possible without storing the original PlatformImageDescriptor to memory; which is not optimal.
Therefore using dummy image here should be fine?

reidbaker · 2025-02-12T16:35:05Z

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

+    Messages.PlatformGroundOverlay result =
+        Convert.groundOverlayToPigeon(mockGroundOverlay, "overlay_1", false);
+
+    Assert.assertEquals("overlay_1", result.getGroundOverlayId());


Consider extracting a helper method that takes a actual ground overlay object and expected values and handles the assertions for equals. It would make new tests easier to write/review.

reidbaker · 2025-02-12T16:35:57Z

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

@@ -21,6 +20,7 @@ const double _kInitialZoomLevel = 5;
 const CameraPosition _kInitialCameraPosition =
    CameraPosition(target: _kInitialMapCenter, zoom: _kInitialZoomLevel);
 const String _kCloudMapId = '000000000000000'; // Dummy map ID.
+const double _floatTolerance = 1e-8;


Can you add a comment for why this value was chosen?

reidbaker · 2025-02-12T16:36:36Z

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

@@ -995,7 +995,7 @@ void googleMapsTests() {
  },
      // TODO(cyanglaz): un-skip the test when we can test this on CI with API key enabled.
      // https://github.com/flutter/flutter/issues/57057
-      skip: Platform.isAndroid);
+      skip: true);


Did you mean to skip this for all platforms? if so should it be deleted instead?

No, this was committed by accident. Not related to this PR.

This is a legacy of this file starting its life as a copy of the integration tests in google_maps_flutter. In the context of google_maps_flutter_android, Platform.isAndroid is just a confusing way of writing true, so this change was good.

if so should it be deleted instead?

I would prefer we keep it, because of the TODO above. We are starting to see features that do not work without an API key, so we will need to fix the CI limitation at some point. (I was working on it with infra folks a while ago, but that got derailed.)

This is true; but already reverted this change before I saw @stuartmorgan:n comment about this, as this was chore change, not related to ground overlay at all. I can commit this back, if it is ok to have unrelated changes in the PR as well.

It's fine either way; if you've already reverted it don't worry about adding it back unless you feel like it.

reidbaker · 2025-02-12T16:37:37Z

packages/google_maps_flutter/google_maps_flutter_android/example/lib/ground_overlay.dart

+    assert(_groundOverlay != null);
+    setState(() {
+      _groundOverlay = _groundOverlay!.copyWith(
+          bearingParam: _groundOverlay!.bearing >= 350


Can you add a comment explaining where these magic numbers come from?
I believe this is just bumping the bearing 10 degrees and making sure we dont go over 360 but that is after reading the whole pr.

Is this ok?

jokerttu added 3 commits February 4, 2025 19:34

[google_maps_flutter_ios] Adds support for ground overlay

174caf4

[google_maps_flutter_android] Adds support for ground overlay

12792be

[google_maps_flutter_web] Adds support for ground overlay

37d71fb

github-actions bot added p: google_maps_flutter platform-android platform-ios platform-web labels Feb 4, 2025

jokerttu added 2 commits February 5, 2025 18:53

[google_maps_flutter_android] Improve convert functions

b84b657

[google_maps_flutter_ios] Add missing tests and address review comments

43522ae

jokerttu force-pushed the feat/google_maps_flutter_ground_overlay_support_platform_impl branch from a859a4d to 43522ae Compare February 5, 2025 17:15

jokerttu marked this pull request as ready for review February 5, 2025 17:37

jokerttu requested review from cbracken, reidbaker and ditman as code owners February 5, 2025 17:37

jokerttu mentioned this pull request Feb 5, 2025

[google_maps_flutter] Support for Ground Overlay #8432

Open

11 tasks

stuartmorgan added triage-ios Should be looked at in iOS triage triage-android Should be looked at in Android triage triage-web Should be looked at in web triage labels Feb 5, 2025

reidbaker requested a review from ash-google February 6, 2025 20:20

stuartmorgan removed triage-ios Should be looked at in iOS triage triage-android Should be looked at in Android triage labels Feb 6, 2025

stuartmorgan reviewed Feb 6, 2025

View reviewed changes

Improve tests and null annotations

8f1be2b

ash-google approved these changes Feb 8, 2025

View reviewed changes

jokerttu added 2 commits February 10, 2025 11:55

[google_maps_flutter_android] Add missing license block.

323326b

[google_maps_flutter_ios] Improve example app

26d8c93

[google_maps_flutter_android] Improve ground overlay conversions

cdf4d25

reidbaker reviewed Feb 12, 2025

View reviewed changes

[google_maps_flutter_android] Address android review comments

29a8e41

jokerttu requested a review from reidbaker February 19, 2025 08:39

reidbaker approved these changes Feb 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[google_maps_flutter] Ground overlay support - platform impls #8563

[google_maps_flutter] Ground overlay support - platform impls #8563

jokerttu commented Feb 4, 2025 •

edited

Loading

ditman commented Feb 5, 2025

stuartmorgan left a comment

stuartmorgan Feb 6, 2025

stuartmorgan Feb 6, 2025

stuartmorgan Feb 6, 2025

jokerttu Feb 7, 2025

stuartmorgan Feb 6, 2025

jokerttu Feb 7, 2025

stuartmorgan Feb 6, 2025

stuartmorgan commented Feb 6, 2025

ash-google Feb 8, 2025

ash-google Feb 8, 2025

jokerttu Feb 11, 2025

ash-google commented Feb 8, 2025

jokerttu commented Feb 10, 2025 •

edited

Loading

stuartmorgan commented Feb 10, 2025

matijakevic commented Feb 12, 2025

reidbaker Feb 12, 2025

reidbaker Feb 12, 2025

jokerttu Feb 14, 2025 •

edited

Loading

reidbaker Feb 12, 2025

reidbaker Feb 12, 2025

jokerttu Feb 17, 2025

reidbaker Feb 12, 2025

jokerttu Feb 14, 2025

stuartmorgan Feb 14, 2025

jokerttu Feb 17, 2025

stuartmorgan Feb 18, 2025

reidbaker Feb 12, 2025

jokerttu Feb 17, 2025

[google_maps_flutter] Ground overlay support - platform impls #8563

Are you sure you want to change the base?

[google_maps_flutter] Ground overlay support - platform impls #8563

Conversation

jokerttu commented Feb 4, 2025 • edited Loading

Pre-launch Checklist

ditman commented Feb 5, 2025

stuartmorgan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stuartmorgan commented Feb 6, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ash-google commented Feb 8, 2025

jokerttu commented Feb 10, 2025 • edited Loading

stuartmorgan commented Feb 10, 2025

matijakevic commented Feb 12, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jokerttu Feb 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jokerttu commented Feb 4, 2025 •

edited

Loading

jokerttu commented Feb 10, 2025 •

edited

Loading

jokerttu Feb 14, 2025 •

edited

Loading