[google_maps_flutter] Add Google maps flutter platform interface #2577

cylyl · 2020-03-04T23:56:53Z

Description

A common platform interface for the google_maps_flutter plugin.

This interface allows platform-specific implementations of the google_maps_flutter plugin, as well as the plugin itself, to ensure they are supporting the same interface.

Related Issues

flutter/flutter#45292

Checklist

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.

cylyl · 2020-03-06T11:04:10Z

follow up with #2582

ditman · 2020-03-18T18:21:30Z

Wow, this is great! Thanks for the contribution @cylyl! (I've just found out about this, I've been working in Google maps for web for the last couple of weeks or so)

ditman

Hey, thanks for the PR!

I added some comments with what we have learned writing platform interfaces and plugins in the last couple of months!

I have time to work on this. If you give me permissions in your repo/branch, I can clone it and tackle some of the changes that I wrote about here.

Again, thank you very much for the contribution, really appreciated!

packages/google_maps_flutter/google_maps_flutter/example/ios/.gitignore

packages/google_maps_flutter/google_maps_flutter/example/pubspec.yaml

packages/google_maps_flutter/google_maps_flutter/example/test/widget_test.dart

packages/google_maps_flutter/google_maps_flutter/example/web/index.html

...utter/google_maps_flutter_platform_interface/lib/google_maps_flutter_platform_interface.dart

...s_flutter/google_maps_flutter_platform_interface/lib/method_channel_google_maps_flutter.dart

...ter/google_maps_flutter_platform_interface/test/method_channel_google_maps_flutter_test.dart

cylyl · 2020-03-20T16:22:26Z

Hey, thanks for the PR!

I added some comments with what we have learned writing platform interfaces and plugins in the last couple of months!

I have time to work on this. If you give me permissions in your repo/branch, I can clone it and tackle some of the changes that I wrote about here.

Again, thank you very much for the contribution, really appreciated!

invite sent!

...s_flutter/google_maps_flutter_platform_interface/lib/method_channel_google_maps_flutter.dart

ditman · 2020-03-20T23:06:27Z

packages/google_maps_flutter/google_maps_flutter/lib/src/controller.dart

-  final MethodChannel channel;
+  MethodChannel get channel {
+    return _googleMapsFlutterPlatform.channel;
+  }


The plugin cannot use the MethodChannel for anything. The MethodChannel is only used as an implementation of the GoogleMaps platform for certain devices. We need to remove the need for an instance of the channel within the plugin (I'll give this a try later as well!)

This is required for the e2e tests (which won't work in mobile, then). This is an issue for the full migration.

ditman · 2020-03-25T01:10:23Z

Hey @cylyl, are you testing the lib in mobile (device or emu) to make sure that this is still working as expected, could you take a look at my changes and see if they make sense to you? Thanks!

cylyl · 2020-03-25T01:19:36Z

l

ok

ditman · 2020-03-30T22:17:12Z

Hey @cylyl I intend to rebase the branch with the latest master and push-force. Do you have any work in progress in the google_maps_flutter_platform_interface branch of your repo?

* Make the method_channel implementation private, so it can't be imported from other packages. * Fix all the problems with Future<void> functions not returning a future.

ditman · 2020-04-02T17:54:00Z

@cylyl note that there has been a new method added to the platform_interface that you might want to check if it can be implemented: takeSnapshot

harryterkelsen

Mostly LGTM but needs to be split up so the platform interface changes can land before the plugin changes

harryterkelsen

Mostly LGTM but needs to be split up so the platform interface changes can land before the plugin changes

ditman · 2020-04-02T21:13:06Z

Mostly LGTM but needs to be split up so the platform interface changes can land before the plugin changes

You're right, I'll get that done ASAP.

cyanglaz

Left some nits, this PR is too long to be an afternoon review :) Will continue reviewing tomorrow when i have a refreshed mind :)

packages/google_maps_flutter/google_maps_flutter/CHANGELOG.md

packages/google_maps_flutter/google_maps_flutter/example/.gitignore

..._maps_flutter/example/android/app/src/main/kotlin/io/flutter/plugins/example/MainActivity.kt

packages/google_maps_flutter/google_maps_flutter/example/ios/.gitignore

...utter/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

packages/google_maps_flutter/google_maps_flutter/example/ios/Runner/AppDelegate.swift

packages/google_maps_flutter/google_maps_flutter/example/ios/Runner/Runner-Bridging-Header.h

packages/google_maps_flutter/google_maps_flutter/example/pubspec.yaml

packages/google_maps_flutter/google_maps_flutter/lib/src/controller.dart

cyanglaz

Did another round of review, left some comments. :)

packages/google_maps_flutter/google_maps_flutter_platform_interface/README.md

...ges/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/events/map_event.dart

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

cyanglaz · 2020-04-03T20:53:25Z

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

+
+  /// Updates configuration options of the map user interface.
+  ///
+  /// Change listeners are notified once the update has been made on the


What are change listeners? Could we include a reference here?
ditto below.

I have no idea, this comment comes verbatim from the old implementation.

cyanglaz · 2020-04-03T20:57:23Z

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

+      Map<String, dynamic> creationParams,
+      Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
+      PlatformViewCreatedCallback onPlatformViewCreated) {
+    if (defaultTargetPlatform == TargetPlatform.android) {


It's a little weird that the platform_interface contains platform specific code, is there a way we can avoid this?

This is the MethodChannel implementation, which can be platform-specific (at least for the devices that use MethodChannel).

It needs to live in this package, so it can be the "default" implementation, if the plugin is not overriding anything.

(This code is platform-specific already, because it uses MethodChannels, pretty much)

...maps_flutter_platform_interface/lib/src/platform_interface/google_maps_flutter_platform.dart

ditman · 2020-04-04T01:42:26Z

The tests that are failing are those that are using methods on the google_map_inspector.dart class that calls directly methods in the MethodChannel. I'll try to debug those next.

ditman · 2020-04-07T00:18:34Z

The failing tests were a flake. I ran them manually (and asked on discord) and eventually they passed in Cirrus. I'll split this PR in two; one with the platform_interface only code, and another one with the core plugin changes.

ditman · 2020-04-07T00:48:11Z

I have published the platform_interface-only PR here: #2637. @cylyl please take a look there, it needs you to accept the CLA (because I brought over your commits to my repo)

cylyl · 2020-04-08T13:08:32Z

I have published the platform_interface-only PR here: #2637. @cylyl please take a look there, it needs you to accept the CLA (because I brought over your commits to my repo)

look great!

ditman · 2020-04-08T19:35:40Z

Please @cylyl, can you add the following comment in my PR? It is needed to authorize me to push changes with your username from my repository:

@googlebot I consent.

Here is a similar (not identical) example in another PR.

Thanks!

cylyl · 2020-04-09T03:26:14Z

#2637

googlebot added the cla: yes label Mar 4, 2020

cylyl closed this Mar 6, 2020

cylyl reopened this Mar 9, 2020

ditman suggested changes Mar 19, 2020

View reviewed changes

ditman reviewed Mar 20, 2020

View reviewed changes

...s_flutter/google_maps_flutter_platform_interface/lib/method_channel_google_maps_flutter.dart Outdated Show resolved Hide resolved

ditman reviewed Mar 20, 2020

View reviewed changes

...s_flutter/google_maps_flutter_platform_interface/lib/method_channel_google_maps_flutter.dart Outdated Show resolved Hide resolved

ditman reviewed Mar 20, 2020

View reviewed changes

cylyl and others added 17 commits April 1, 2020 15:31

add google_maps_flutter_platform_interface

5a7a89a

removed unused_local_variable

910c6ae

format

5afbe02

format

4c0ac1f

format#

5276fbc

update CHANGELOG

9c35d4c

Move MethodChannel code to MethodChannelGoogleMapsFlutter

0d99e15

Update dependencies

152bd4a

add buildView method

6c2a92c

update pubspec

73d23a2

bugs fix

25099ab

Some adjustments to the PR.

cf190ef

* Make the method_channel implementation private, so it can't be imported from other packages. * Fix all the problems with Future<void> functions not returning a future.

dartfmt -w .

ae0c68d

Expose the MethodChannel so e2e tests are happy.

35798fa

Move platform into src so we can create a barrel file to export stuff.

c43d0aa

Create barrel file to export only certain things from src

fc9ba91

Adjust imports in platform interface

3228de6

cylyl reopened this Apr 2, 2020

harryterkelsen suggested changes Apr 2, 2020

View reviewed changes

ditman requested a review from cyanglaz April 2, 2020 21:16

cyanglaz reviewed Apr 2, 2020

View reviewed changes

ditman added 3 commits April 3, 2020 12:13

Revert changes to the example.

63f5d0d

Remove .gitignore from example dir

99346d6

Appease the analyzer.

f5a6013

cyanglaz reviewed Apr 3, 2020

View reviewed changes

ditman added 5 commits April 3, 2020 14:48

Appease analyze some more.

545500b

Rename _controller to _mapEventStreamController

609200f

Update some docs on the platform

a3efd0f

Document MapEvent constructors.

98e0952

Document method_channel class

5057b0a

ditman mentioned this pull request Apr 7, 2020

[google_maps_flutter] Introduce Platform Interface package. #2637

Merged

12 tasks

cylyl closed this Apr 9, 2020

cylyl reopened this Apr 9, 2020

cylyl closed this Apr 15, 2020

This was referenced Apr 20, 2020

[google_maps_flutter] Migrate plugin to platform_interface API. #2674

Merged

[google_maps_flutter_platform_interface] Bump to 1.0.1 version. #2677

Merged

cylyl reopened this Apr 21, 2020

cylyl closed this Apr 21, 2020

[google_maps_flutter] Add Google maps flutter platform interface #2577

[google_maps_flutter] Add Google maps flutter platform interface #2577

Uh oh!

Conversation

cylyl commented Mar 4, 2020

Description

Related Issues

Checklist

Breaking Change

Uh oh!

cylyl commented Mar 6, 2020

Uh oh!

ditman commented Mar 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ditman 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!

cylyl commented Mar 20, 2020

Uh oh!

Uh oh!

Uh oh!

ditman Mar 20, 2020

Choose a reason for hiding this comment

Uh oh!

ditman Mar 22, 2020

Choose a reason for hiding this comment

Uh oh!

ditman commented Mar 25, 2020

Uh oh!

cylyl commented Mar 25, 2020

Uh oh!

ditman commented Mar 30, 2020

Uh oh!

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

Uh oh!

Uh oh!

harryterkelsen left a comment

Choose a reason for hiding this comment

Uh oh!

harryterkelsen left a comment

Choose a reason for hiding this comment

Uh oh!

ditman commented Apr 2, 2020

Uh oh!

cyanglaz 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!

cyanglaz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cyanglaz Apr 3, 2020

Choose a reason for hiding this comment

Uh oh!

ditman Apr 3, 2020

Choose a reason for hiding this comment

ditman commented Mar 18, 2020 •

edited

Loading

ditman commented Apr 2, 2020 •

edited

Loading

ditman commented Apr 7, 2020 •

edited

Loading

ditman commented Apr 8, 2020 •

edited

Loading