[google_maps_flutter] Clean up google_maps_flutter plugin #3206

math1man · 2020-10-26T19:43:35Z

Description

Clean up google_maps_flutter plugin. This change should not have any functional differences.

A few minor formatting changes and additions of @nullable annotations
Removed pass-through of activityHashCode. In the legacy plugin use case, the value is derived from registrar.getActivity(). In the new plugin use case, the value should never be used because it uses DefaultLifecycleCallbacks instead of ActivityLifecycleCallbacks.
Replaced custom lifecycle state ints with androidx.lifecycle.Lifecycle.State enum. Also simplify paused/stopped states, which don't need their own dedicated states. Paused == started and stopped == created.
Fixed a bug where the Lifecycle object was being leaked onDetachFromActivity by nulling out the field.
Moved GoogleMapListener to its own file. Declaring multiple top level classes in the same file is bad practice.

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.

1. A few minor formatting changes and additions of @nullable annotations 2. Removed pass-through of activityHashCode. In the legacy plugin use case, the value is always -1 (which has been inlined). In the new plugin use case, the value should never be used because it uses DefaultLifecycleCallbacks instead of ActivityLifecycleCallbacks. 3. Replaced custom lifecycle state ints with androidx.lifecycle.Lifecycle.State enum. Also simplify paused/stopped states, which don't need their own dedicated states. Paused == started and stopped == created. 4. Fixed a bug where the Lifecycle object was being leaked onDetachFromActivity by nulling out the field. 5. Moved GoogleMapListener to its own file. Declaring multiple top level classes in the same file is bad practice.

…and init() methods.

amirh

Thanks! and thanks for the great PR description, it really helps walking through this PR.

Left a few nits, overall looks good.

One thing to check - in the PR description it says that activityHashCode is -1 for the legacy plugin, my understanding is that it is -1 for the v2 (new) embedding, am I correct?

amirh · 2020-10-26T22:40:29Z

...oogle_maps_flutter/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapBuilder.java

@@ -7,13 +7,14 @@
 import android.app.Application;
 import android.content.Context;
 import android.graphics.Rect;
+import androidx.annotation.Nullable;


Do we need to add androidx.annotation to the plugin's build.gradle?

Various classes in the plugin already depend on this annotation or the NonNull equivalent, so it appears not.

Probably wrong that we didn't have it so far, I think these get brought in by the Android embedding right now, though for consistency with other dependencies and for future compatibility (in the very unlikely event that the embedding is going to drop the dependency) I'd be explicit about the dependencies.

amirh · 2020-10-26T22:56:16Z

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

@@ -880,7 +856,7 @@ private int getActivityHashCode() {
    if (registrar != null && registrar.activity() != null) {
      return registrar.activity().hashCode();
    } else {
-      return activityHashCode;
+      return -1;


Let's add a comment here explaining that registrar is null for the v2 embedding where the activityHashCode shouldn't be used. If we're certain this isn't being I think we better throw - we better get a clear crash than some strange value that may lead to easy to understand bugs.

Though it's worth noting that this could be considered a breaking change.

amirh · 2020-10-26T22:57:28Z

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

@@ -552,18 +524,22 @@ private void setGoogleMapListener(@Nullable GoogleMapListener listener) {
  }

  // @Override
-  // The minimum supported version of Flutter doesn't have this method on the PlatformView interface, but the maximum
-  // does. This will override it when available even with the annotation commented out.
+  // The minimum supported version of Flutter doesn't have this method on the PlatformView


nit: Please avoid unneeded reformats to keep cleaner blame data.

amirh · 2020-10-26T22:59:33Z

...ogle_maps_flutter/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapListener.java

@@ -0,0 +1,16 @@
+package io.flutter.plugins.googlemaps;


Missing the license header (you can copy from any other file)

Done, thanks

amirh · 2020-10-26T23:09:32Z

...ogle_maps_flutter/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapListener.java

+
+import com.google.android.gms.maps.GoogleMap;
+
+interface GoogleMapListener


I'm fine with moving this here if that's how you prefer it, curious though - is there a reference to a style guide / best practices doc with the determination that multiple top level classes is bad?

I can't find any formal documentation, but it can cause compiler problems. See discussion in https://stackoverflow.com/q/2336692 for example.

1. Add license to GoogleMapListener.java 2. Revert some changes to comment linebreaking in GoogleMapController 3. In GoogleMapController#getActivityHashCode, throw an exception if the hash code cannot be obtained.

math1man · 2020-10-26T23:34:25Z

One thing to check - in the PR description it says that activityHashCode is -1 for the legacy plugin, my understanding is that it is -1 for the v2 (new) embedding, am I correct?

I updated the description to clarify that the value is derived from registrar.getActivity(). What I had been referring to was the legacy new GoogleMapFactory call site in GoogleMapsPlugin#registerWith passed in a value of -1.

amirh · 2020-10-27T03:16:58Z

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

@@ -880,7 +852,11 @@ private int getActivityHashCode() {
    if (registrar != null && registrar.activity() != null) {


Mmmm staring at this snippet a little more I'm worried this may crash with the old embedding when the activity is in the background and some lifecycle event for the same application happens.
We used to cache the activityHashCode, and we stopped caching at #2488 cc @cyanglaz do you remember the context for this change? was it safe to stop caching the activity hashCode in that PR?

amirh · 2020-10-27T03:19:23Z

packages/google_maps_flutter/google_maps_flutter/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.4
+
+* Minor cleanup of Android code.


nit: call out the specific things that were done (especially the leak fix).

amirh

Thanks! this looks good, I'm waiting to hear from @cyanglaz regarding the activityHashCode before landing to make sure we're not introducing a crash with the activityHashCode.

tarektaamali · 2020-10-27T08:43:56Z

please look at this issue has opened more than a year ago .you should fixed .it's happened with all version of the packages

math1man · 2020-10-27T16:48:54Z

please look at this issue has opened more than a year ago .you should fixed .it's happened with all version of the packages

Thanks for the pointer. I don't think this change will address that, but I have some theories on how it might be fixed. I'll look into it in another pull request.

…androidx.annotation gradle dependency.

cyanglaz · 2020-10-27T18:13:01Z

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

@@ -880,7 +852,11 @@ private int getActivityHashCode() {
    if (registrar != null && registrar.activity() != null) {
      return registrar.activity().hashCode();
    } else {
-      return activityHashCode;
+      // This method should only be invoked in cases where registrar != null, and only at lifecycle


This exception can actually throw when some lifecycle event happened when the activity is in the background as mentioned in https://github.com/flutter/plugins/pull/3206/files#r512392320
It is a regression caused by #2488. We should fix it by removing the getActivityHashCode() and use a cached hashCode value like how it was.
I created an issue to track this fix: flutter/flutter#69128

@math1man Do you mind reverting it back to return -1 here and add a TODO to fix the regression?
Something like:

// TODO(cyanglaz): Remove the `getActivityHashCode()` and use a cached hashCode when creating the web view for V1 embedding. // https://github.com/flutter/flutter/issues/69128 return activityHashCode;

Done, thanks for creating that.

…accessed. Updating this behavior will be tracked in flutter/flutter#69128

amirh

LGTM

Thanks!
Will land on green.

1. A few minor formatting changes and additions of @nullable annotations 2. Removed pass-through of activityHashCode. In the legacy plugin use case, the value is always -1 (which has been inlined). In the new plugin use case, the value should never be used because it uses DefaultLifecycleCallbacks instead of ActivityLifecycleCallbacks. 3. Replaced custom lifecycle state ints with androidx.lifecycle.Lifecycle.State enum. Also simplify paused/stopped states, which don't need their own dedicated states. Paused == started and stopped == created. 4. Fixed a bug where the Lifecycle object was being leaked onDetachFromActivity by nulling out the field. 5. Moved GoogleMapListener to its own file. Declaring multiple top level classes in the same file is bad practice.

…utter#3206)" This reverts commit a98bc81

1. A few minor formatting changes and additions of @nullable annotations 2. Removed pass-through of activityHashCode. In the legacy plugin use case, the value is always -1 (which has been inlined). In the new plugin use case, the value should never be used because it uses DefaultLifecycleCallbacks instead of ActivityLifecycleCallbacks. 3. Replaced custom lifecycle state ints with androidx.lifecycle.Lifecycle.State enum. Also simplify paused/stopped states, which don't need their own dedicated states. Paused == started and stopped == created. 4. Fixed a bug where the Lifecycle object was being leaked onDetachFromActivity by nulling out the field. 5. Moved GoogleMapListener to its own file. Declaring multiple top level classes in the same file is bad practice.

…utter#3206)" This reverts commit a98bc81

* master: (48 commits) [video_player] Add toString() to Caption (flutter#3233) [google_maps_flutter_web] Show one InfoWindow at a time. (flutter#3224) [in_app_purchase] Bump version (flutter#3227) [google_maps_flutter] Overhaul lifecycle management in GoogleMapsPlugin (flutter#3213) [in_app_purchase] Remove the custom analysis options, fix failing lints. (flutter#3220) [video_player]Fixes Playing video from asset on Android (flutter#3123) [camera] Added documentation about video not working correctly on Android emulators (flutter#3180) Revert "update api" update api [wifi_info_flutter] Method channel name fixed for android (flutter#3207) [share] Fix bug on iPad where `origin` is null and enable XCUITests in the repo (flutter#3210) [google_maps_flutter] Clean up google_maps_flutter plugin (flutter#3206) Exclude generated_plugin_registrant.cc (flutter#3198) broaden the constraint on package:vm_service (flutter#3208) Remove unnecessary work around from test in prep for vm_service migration (flutter#3209) Add windows directory to examples (flutter#3149) [video_player] Upgrade ExoPlayer (flutter#3204) [android_alarm_manager] Removed deprecated display1 (flutter#3200) [Connectivity] wifi removal (flutter#3173) [wifi_info_flutter] make it ready for initial 1.0.0 release (flutter#3191) ...

1. A few minor formatting changes and additions of @nullable annotations 2. Removed pass-through of activityHashCode. In the legacy plugin use case, the value is always -1 (which has been inlined). In the new plugin use case, the value should never be used because it uses DefaultLifecycleCallbacks instead of ActivityLifecycleCallbacks. 3. Replaced custom lifecycle state ints with androidx.lifecycle.Lifecycle.State enum. Also simplify paused/stopped states, which don't need their own dedicated states. Paused == started and stopped == created. 4. Fixed a bug where the Lifecycle object was being leaked onDetachFromActivity by nulling out the field. 5. Moved GoogleMapListener to its own file. Declaring multiple top level classes in the same file is bad practice.

math1man added 3 commits October 26, 2020 12:26

Update version from 1.0.3 to 1.0.4

50b2004

Update CHANGELOG.md

af030dc

google-cla bot added the cla: yes label Oct 26, 2020

math1man added 5 commits October 26, 2020 12:55

Correct some tabbing

c1bf397

One more formatting fix

ddad09d

Another more formatting fix

1d37fed

Update GoogleMapControllerTest to account for changes to constructor …

a4b98b5

…and init() methods.

Merge remote-tracking branch 'origin/master'

83d2f8b

math1man marked this pull request as ready for review October 26, 2020 22:10

math1man requested a review from cyanglaz as a code owner October 26, 2020 22:10

amirh suggested changes Oct 26, 2020

View reviewed changes

math1man added 2 commits October 26, 2020 16:31

Address comments:

85d8220

1. Add license to GoogleMapListener.java 2. Revert some changes to comment linebreaking in GoogleMapController 3. In GoogleMapController#getActivityHashCode, throw an exception if the hash code cannot be obtained.

Merge remote-tracking branch 'origin/master'

9abdeb8

amirh reviewed Oct 27, 2020

View reviewed changes

math1man added 4 commits October 27, 2020 09:49

Add a lot more details to the CHANGELOG.md

440209e

Merge remote-tracking branch 'origin/master'

602e2ce

Update gradle version to Flutter's recommended version 3.5.0 and add …

af6476d

…androidx.annotation gradle dependency.

Merge remote-tracking branch 'origin/master'

1d58201

cyanglaz reviewed Oct 27, 2020

View reviewed changes

Revert to return -1 from getActivityHashCode() if activity cannot be …

a8ad9c1

…accessed. Updating this behavior will be tracked in flutter/flutter#69128

amirh approved these changes Oct 27, 2020

View reviewed changes

math1man requested a review from amirh October 27, 2020 18:23

amirh merged commit 81bbcd4 into flutter:master Oct 27, 2020

math1man added a commit to math1man/plugins that referenced this pull request Oct 27, 2020

Revert "[google_maps_flutter] Clean up google_maps_flutter plugin (fl…

1733a25

…utter#3206)" This reverts commit a98bc81

math1man added a commit to math1man/plugins that referenced this pull request Oct 27, 2020

Revert "[google_maps_flutter] Clean up google_maps_flutter plugin (fl…

d1ae9cb

…utter#3206)" This reverts commit a98bc81

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[google_maps_flutter] Clean up google_maps_flutter plugin #3206

[google_maps_flutter] Clean up google_maps_flutter plugin #3206

math1man commented Oct 26, 2020 •

edited

Loading

amirh left a comment

amirh Oct 26, 2020

math1man Oct 26, 2020

amirh Oct 27, 2020

amirh Oct 26, 2020

math1man Oct 26, 2020

math1man Oct 26, 2020

amirh Oct 26, 2020

math1man Oct 27, 2020

amirh Oct 26, 2020

math1man Oct 26, 2020

amirh Oct 26, 2020

math1man Oct 26, 2020

math1man commented Oct 26, 2020

amirh Oct 27, 2020

amirh Oct 27, 2020

math1man Oct 27, 2020

amirh left a comment

tarektaamali commented Oct 27, 2020

math1man commented Oct 27, 2020

cyanglaz Oct 27, 2020

math1man Oct 27, 2020

amirh left a comment


		import com.google.android.gms.maps.GoogleMap;

		interface GoogleMapListener

		@@ -880,7 +852,11 @@ private int getActivityHashCode() {
		if (registrar != null && registrar.activity() != null) {

[google_maps_flutter] Clean up google_maps_flutter plugin #3206

[google_maps_flutter] Clean up google_maps_flutter plugin #3206

Conversation

math1man commented Oct 26, 2020 • edited Loading

Description

Checklist

Breaking Change

amirh 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

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

math1man commented Oct 26, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amirh left a comment

Choose a reason for hiding this comment

tarektaamali commented Oct 27, 2020

math1man commented Oct 27, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amirh left a comment

Choose a reason for hiding this comment

math1man commented Oct 26, 2020 •

edited

Loading