[google_maps_flutter] Fix the visual jarring during the first gesture on the map #2629

cyanglaz · 2020-04-01T23:38:21Z

Description

Instead of workaround in the first delegate callback. We reset the camera location when we know the frame of the GMSMapView is changed. This prevents any unwanted artifacts introduced due to the previous workaround.

Related Issues

flutter/flutter#53428
flutter/flutter#27550

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
No, this is not a breaking change.

cyanglaz · 2020-04-01T23:40:05Z

We don't have a good way currently to test the visual animation on google map, can we get an exemption from testing? As it is a simple change. @amirh

amirh · 2020-04-01T23:49:55Z

test?

amirh · 2020-04-13T16:19:13Z

packages/google_maps_flutter/google_maps_flutter/ios/Classes/GoogleMapController.m

+                        change:(NSDictionary*)change
+                       context:(void*)context {
+  if (object == _mapView && [keyPath isEqualToString:@"frame"]) {
+    [_mapView moveCamera:[GMSCameraUpdate setCamera:_mapView.camera]];


What's the intended behavior if a the map frame is resized while it's being animated?

In that case, this method will get called multiple times. However, since we are always setting the camera to the same location, it shouldn't have any behavior effects.

animateWithCameraUpdate is implemented by multiple calls to moveCamera?

I made this only happens once during initialization, so it shouldn't have any side effects that you worried about.

amirh · 2020-04-13T16:20:25Z

packages/google_maps_flutter/google_maps_flutter/example/test_driver/google_maps_e2e.dart

+    // `onMapCreated` is called before the map is actually ready on the platform thread.
+    // Wait for a second until the map is settled down.
+    await tester.pumpAndSettle();
+    await Future.delayed(Duration(seconds: 1));


Do we have a reliable way to detect when it's ready?

Unless we add a new callback API in the google map, something like "onMapRendered". This can be in a separate PR tho.

We should do that, I'm not blocking this PR since we're trading a 3 seconds timer with a 1 second one , but we should at least add a TODO.

cyanglaz · 2020-04-15T17:27:48Z

@amirh Ready for another review.

ditman · 2020-04-21T19:49:18Z

This PR is compatible with the upcoming google_maps_flutter federation PR.

googlebot · 2020-04-21T19:54:22Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

googlebot · 2020-04-21T20:00:09Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

amirh · 2020-04-23T17:45:42Z

packages/google_maps_flutter/google_maps_flutter/ios/Classes/GoogleMapController.m

+      // We ignore this type of changes.
+      return;
+    }
+    _cameraDidInitialSetup = YES;


Why not remove the observer here instead of on the next frame change?

good point! Thanks. will change.

amirh · 2020-04-23T17:48:53Z

packages/google_maps_flutter/google_maps_flutter/ios/Classes/GoogleMapController.m

@@ -511,8 +526,8 @@ - (void)mapView:(GMSMapView*)mapView didLongPressAtCoordinate:(CLLocationCoordin

 static NSDictionary* PointToJson(CGPoint point) {
  return @{
-    @"x" : @((int)point.x),
-    @"y" : @((int)point.y),
+    @"x" : @((int)(point.x + 0.5)),


This is to round to the closest int.
The current code is getting a floor, which is less accurate.
updating to use lroundf to make it more self explanatory.

amirh · 2020-04-23T17:55:13Z

packages/google_maps_flutter/google_maps_flutter/ios/Classes/GoogleMapController.m

+    CGRect bounds = _mapView.bounds;
+    if (CGRectEqualToRect(bounds, CGRectZero)) {
+      // Rerely, frame can change without actually changing the size of the view;
+      // eg, consider a frame change such as: (0, 0, 0, 0) -> (10, 10, 0, 0)


You mean (0, 0, 0, 0) -> (10, 10, 10, 10) ?
Is this not the change we get any time we "move" a map? (is that rare?)

I see why we can ignore these changes - this whole thing is working around an issue with our initial frame being sized to zero, but if a consequent frame is zero there's nothing to workaround really... (what I'm saying the code makes sense to me, the comment makes less sense)

How about just:

// The workaround is to fix an issue that the camera location is not current when // the size of the map is zero at initialization. // So We only care about the size of the `_mapView`, ignore the frame changes when the size is zero.

amirh · 2020-04-23T17:57:15Z

packages/google_maps_flutter/google_maps_flutter/example/test_driver/google_maps_e2e.dart

@@ -906,5 +940,5 @@ void main() {
    final GoogleMapInspector inspector = await inspectorCompleter.future;
    final Uint8List bytes = await inspector.takeSnapshot();
    expect(bytes?.isNotEmpty, true);
-  });
+  }, skip: true);


why are we skipping this?

skipped by mistake, will fix

cyanglaz

@amirh Updated based on your comment! PTAL

cyanglaz · 2020-04-23T19:05:58Z

packages/google_maps_flutter/google_maps_flutter/example/test_driver/google_maps_e2e.dart

@@ -906,5 +940,5 @@ void main() {
    final GoogleMapInspector inspector = await inspectorCompleter.future;
    final Uint8List bytes = await inspector.takeSnapshot();
    expect(bytes?.isNotEmpty, true);
-  });
+  }, skip: true);


skipped by mistake, will fix

cyanglaz · 2020-04-23T19:27:18Z

packages/google_maps_flutter/google_maps_flutter/ios/Classes/GoogleMapController.m

+    CGRect bounds = _mapView.bounds;
+    if (CGRectEqualToRect(bounds, CGRectZero)) {
+      // Rerely, frame can change without actually changing the size of the view;
+      // eg, consider a frame change such as: (0, 0, 0, 0) -> (10, 10, 0, 0)


How about just:

// The workaround is to fix an issue that the camera location is not current when // the size of the map is zero at initialization. // So We only care about the size of the `_mapView`, ignore the frame changes when the size is zero.

cyanglaz · 2020-04-23T19:34:19Z

packages/google_maps_flutter/google_maps_flutter/ios/Classes/GoogleMapController.m

@@ -511,8 +526,8 @@ - (void)mapView:(GMSMapView*)mapView didLongPressAtCoordinate:(CLLocationCoordin

 static NSDictionary* PointToJson(CGPoint point) {
  return @{
-    @"x" : @((int)point.x),
-    @"y" : @((int)point.y),
+    @"x" : @((int)(point.x + 0.5)),


This is to round to the closest int.
The current code is getting a floor, which is less accurate.
updating to use lroundf to make it more self explanatory.

cyanglaz · 2020-04-23T19:40:10Z

packages/google_maps_flutter/google_maps_flutter/ios/Classes/GoogleMapController.m

+      // We ignore this type of changes.
+      return;
+    }
+    _cameraDidInitialSetup = YES;


good point! Thanks. will change.

amirh

LGTM

(once presubmits pass)

cyanglaz · 2020-04-23T22:32:43Z

the crash seems to be something new related to google map sdk
https://stackoverflow.com/questions/61397027/androidruntime-fatal-exception-androidmapsapi-zoomtablemanager-java-lang-arra
b/154855417

… on the map (flutter#2629)

googlebot added the cla: yes label Apr 1, 2020

cyanglaz mentioned this pull request Apr 1, 2020

[google_maps_flutter] map "locked up" until after first interaction flutter/flutter#53428

Closed

iapicca mentioned this pull request Apr 3, 2020

[google_maps_flutter] iOS GoogleMap disables gesture events after dragging marker flutter/flutter#53525

Closed

amirh reviewed Apr 13, 2020

View reviewed changes

googlebot added cla: no and removed cla: yes labels Apr 21, 2020

cyanglaz force-pushed the google_map_example_app_fix branch from 4bbb047 to ba74639 Compare April 21, 2020 20:00

googlebot added cla: yes and removed cla: no labels Apr 21, 2020

cyanglaz force-pushed the google_map_example_app_fix branch from ba74639 to 5fea81d Compare April 21, 2020 20:07

fix camera init position workaround

8a7c3bb

cyanglaz force-pushed the google_map_example_app_fix branch from 5fea81d to 8a7c3bb Compare April 21, 2020 20:30

amirh reviewed Apr 23, 2020

View reviewed changes

cyanglaz added 2 commits April 23, 2020 12:41

review fixes

065f141

update the comment

118ff0c

cyanglaz commented Apr 23, 2020

View reviewed changes

amirh approved these changes Apr 23, 2020

View reviewed changes

formatting

9da1b65

Trigger ci

4cbdcb7

cyanglaz merged commit 531ff2b into flutter:master Apr 23, 2020

cyanglaz deleted the google_map_example_app_fix branch April 23, 2020 23:22

EdwinRomelta pushed a commit to EdwinRomelta/plugins that referenced this pull request Jun 11, 2020

[google_maps_flutter] Fix the visual jarring during the first gesture…

21a3b36

… on the map (flutter#2629)

jorgefspereira pushed a commit to jorgefspereira/plugins_flutter that referenced this pull request Oct 10, 2020

[google_maps_flutter] Fix the visual jarring during the first gesture…

2f923c4

… on the map (flutter#2629)

FlutterSu pushed a commit to FlutterSu/flutter-plugins that referenced this pull request Nov 20, 2020

[google_maps_flutter] Fix the visual jarring during the first gesture…

e536ed5

… on the map (flutter#2629)

[google_maps_flutter] Fix the visual jarring during the first gesture on the map #2629

[google_maps_flutter] Fix the visual jarring during the first gesture on the map #2629

Uh oh!

Conversation

cyanglaz commented Apr 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Checklist

Breaking Change

Uh oh!

cyanglaz commented Apr 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

amirh commented Apr 1, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cyanglaz commented Apr 15, 2020

Uh oh!

ditman commented Apr 21, 2020

Uh oh!

googlebot commented Apr 21, 2020

Uh oh!

googlebot commented Apr 21, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cyanglaz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amirh left a comment

Choose a reason for hiding this comment

Uh oh!

cyanglaz commented Apr 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

cyanglaz commented Apr 1, 2020 •

edited

Loading

cyanglaz commented Apr 1, 2020 •

edited

Loading

cyanglaz commented Apr 23, 2020 •

edited

Loading