[cloud_firestore] Add macOS support #1706

cbenhagen · 2019-12-23T17:25:47Z

Description

Add macOS support.

Related Issues

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.

ditman · 2019-12-23T19:58:40Z

There's a big refactor of this package in here to add web support, where the core plugin is being federated (there's a new platform interface and a whatever changes were needed to the core).

Do you mind trying to integrate the PR above with your code and see if it's still working as expected?

Thanks!

cbenhagen · 2019-12-23T20:02:46Z

I am aware of that PR but I don't expect it to break anything as this is just a copy of the ios implementation. I am happy to rebase and copy all changes once that PR is merged.

ditman · 2019-12-23T20:13:54Z

I am aware of that PR but I don't expect it to break anything as this is just a copy of the ios implementation. I am happy to rebase and copy all changes once that PR is merged.

@cbenhagen cool! I'm not setup to do macos PRs (can't run tests yet), but you tagged the right people here!

edeuss · 2019-12-24T01:24:28Z

@cbenhagen Yes! Thank you for working on this.

phest · 2020-02-04T07:36:48Z

I've attempted to add this to the example in the Firebase for Flutter codelab by adding this to the pubspec file:

dependency_overrides:
  cloud_firestore:
    git:
      url: https://github.com/cbenhagen/flutterfire
      ref: cloud_firestore_macos
      path: packages/cloud_firestore/cloud_firestore

It now seems to correctly grab the required pods when building for mac, but at runtime I'm getting this exception:

Launching lib/main.dart on macOS in debug mode...
2020-02-03 23:12:17.852 firebasetest[66424:623933] Configuring the default Firebase app...
2020-02-03 23:12:17.857 firebasetest[66424:623933] Configured the default Firebase app __FIRAPP_DEFAULT.
2020-02-03 23:12:19.063 firebasetest[66424:623933] Error: Message responses can be sent only once. Ignoring duplicate response on channel 'plugins.flutter.io/cloud_firestore'.
[ERROR:flutter/lib/ui/ui_dart_state.cc(157)] Unhandled Exception: PlatformException(invalid_query, FIRInvalidArgumentException, FirebaseApp instance may not be nil. Use FirebaseApp.app() if you'd like to use the default FirebaseApp instance.)
#0      StandardMethodCodec.decodeEnvelope 
package:flutter/…/services/message_codecs.dart:569
#1      MethodChannel._invokeMethod 
package:flutter/…/services/platform_channel.dart:156
<asynchronous suspension>
#2      MethodChannel.invokeMethod 
package:flutter/…/services/platform_channel.dart:329
#3      Query.snapshots.<anonymous closure> 
package:cloud_firestore/src/query.dart:61
#4      _runGuarded  (dart:async/stream_controller.dart:814:24)
#5      _BroadcastStreamController._subscribe  (dart:async/broadcast_stream_controller.dart:215:7)
#6      _ControllerStream._createSubscription  (dart:async/stream_controller.dart:827:19)
#7      _StreamImpl.listen  (dart:async/stream_impl.dart:475:9)
#8      _StreamBuilderBaseState._subscribe 
package:flutter/…/widgets/async.dart:135
#9      _StreamBuilderBaseState.initState 
package:flutter/…/widgets/async.dart:1
...

I've added the same Googleservice-Info.plist used in the ios folder, as well as the same bundle ID.

Any idea what the issue may be? Does running firestore on mac require any other changes, perhaps platform specific dart code?

into cloud_firestore_macos

cbenhagen · 2020-02-12T18:02:29Z

@phest You would also need to add overrides for firebase_core and maybe firebase_auth.

ditman

Someone with experience in Obj-C (~~@collinjackson?~~ (ah, I see @franciscojma86 now!)) should review this! Very cool!

PS: would it make sense to split this into a cloud_firestore_darwin package that contains the ios and macos platforms, instead of adding more stuff to the "core" plugin?

packages/cloud_firestore/cloud_firestore/darwin/Classes/UserAgent.h

packages/cloud_firestore/cloud_firestore/macos/Classes/FLTCloudFirestorePlugin.m

packages/cloud_firestore/cloud_firestore/darwin/Classes/FLTCloudFirestorePlugin.m

franciscojma86

LGTM modulo @ditman comments

phest · 2020-02-12T20:14:10Z

dependency_overrides:
  firebase_core:
    git:
      url: https://github.com/cbenhagen/flutterfire
      ref: firebase_core_macos
      path: packages/firebase_core/firebase_core
  cloud_firestore:
    git:
      url: https://github.com/cbenhagen/flutterfire
      ref: cloud_firestore_macos
      path: packages/cloud_firestore/cloud_firestore

@cbenhagen thank you. Did you mean like so ☝️? I'm seeing the compiler error below. Tried re-creating the XCode project from scratch but no luck.

[   +4 ms] In file included from
(sdk path)/flutter/.pub-cache/git/flutterfire-4cd588bb535e2a2146c3c4d3290f1c297fd0c0ea/packages/firebase_core/firebase_core/darw
in/Classes/FLTFirebaseCorePlugin.m:5:
[        ]
(sdk path)/flutter/.pub-cache/git/flutterfire-4cd588bb535e2a2146c3c4d3290f1c297fd0c0ea/packages/firebase_core/firebase_core/darw
in/Classes/FLTFirebaseCorePlugin.h:5:9: fatal error: 'Flutter/Flutter.h' file not found
[        ] #import <Flutter/Flutter.h>
[        ]         ^~~~~~~~~~~~~~~~~~~
[        ] 1 error generated.
[   +5 ms] ** BUILD FAILED **
[   +1 ms] The following build commands failed:
[        ] 	CompileC
(project path)/build/macos/Build/Intermediates.noindex/Pods.build/Debug/firebase_core.build/Objects-normal/x
86_64/FLTFirebaseCorePlugin.o
[sdk path]/flutter/.pub-cache/git/flutterfire-4cd588bb535e2a2146c3c4d3290f1c297fd0c0ea/packages/firebase_core/firebase_core/darw
in/Classes/FLTFirebaseCorePlugin.m normal x86_64 objective-c com.apple.compilers.llvm.clang.1_0.compiler
[        ] (1 failure)
[  +37 ms] Building macOS application... (completed in 3.4s)
[   +4 ms] "flutter run" took 6,783ms.
Build process failed

cbenhagen · 2020-02-12T21:09:26Z

@phest yes that was what I meant but it seems I messed something up.

@ditman there is no darwin entrypoint. We symlink files from that directory to share them between iOS and macOS.

cbenhagen · 2020-02-12T21:17:55Z

@phest I removed that header file. Please update and retry.

cbenhagen · 2020-02-12T21:30:47Z

@phest you don't have to try. It doesn't work currently. If you need a solution today, copy the files in darwin to the macos directory for both plugins instead of symlinking.

@collinjackson / @franciscojma86 the compiler does not like when I remove the header file from the darwin directory. It seems to look in that dir for the header instead of where the .m is linked to. Ideas?

packages/cloud_firestore/cloud_firestore/darwin/Classes/UserAgent.h

collinjackson · 2020-02-12T21:33:07Z

@phest you don't have to try. It doesn't work currently. @collinjackson / @franciscojma86 the compiler does not like when I remove the header file from the darwin directory. It seems to look in that dir for the header instead of where the .m is linked to. Ideas?

I am investigating. (edit: waiting to see if the tests pass)

packages/cloud_firestore/cloud_firestore/macos/cloud_firestore.podspec

franciscojma86 · 2020-02-12T22:46:21Z

@cbenhagen I just noticed that you also need to add a macos directory to the example app to run the macos integration tests. I'm going to try and add that myself and send you a patch. Sorry about that

cbenhagen · 2020-02-12T22:48:44Z

@franciscojma86 you can just commit to my branch as well.

packages/cloud_firestore/cloud_firestore/pubspec.yaml

ditman · 2020-02-13T22:38:14Z

(Restarted all failing checks)

cbenhagen · 2020-02-14T07:35:58Z

@ditman please restart again. Looks like there was a network issue.

ditman · 2020-02-14T20:16:42Z

Yep, they all look like network connectivity issues, restarted.

edeuss · 2020-02-15T06:21:59Z

Looks like all checks have passed @ditman . Thanks for working on this @cbenhagen !

cbenhagen · 2020-02-17T17:05:35Z

@franciscojma86 this one should be ready to merge and release as well :)

franciscojma86 · 2020-02-19T18:35:38Z

Sorry just saw this one :). I resolved the conflicts, once tests pass again I'll land it. Thanks!

Add macOS support

95a9b4d

googlebot added the cla: yes label Dec 23, 2019

cbenhagen requested review from collinjackson and kroikie as code owners December 23, 2019 17:27

cbenhagen force-pushed the cloud_firestore_macos branch from 78192b3 to 95a9b4d Compare December 23, 2019 17:28

collinjackson requested a review from franciscojma86 January 8, 2020 20:37

franciscojma86 mentioned this pull request Jan 14, 2020

[cloud_functions] Add macOS support #1707

Merged

13 tasks

franciscojma86 added the blocked: customer-response Waiting for customer response, e.g. more information was requested. label Jan 29, 2020

Merge branch 'master' of https://github.com/FirebaseExtended/flutterfire

93bd085

into cloud_firestore_macos

Share implementation between iOS and macOS

a4cf81b

cbenhagen force-pushed the cloud_firestore_macos branch from 26d2f4d to a4cf81b Compare February 12, 2020 18:04

ditman reviewed Feb 12, 2020

View reviewed changes

franciscojma86 approved these changes Feb 12, 2020

View reviewed changes

Fix version number

8075b01

collinjackson approved these changes Feb 12, 2020

View reviewed changes

packages/cloud_firestore/cloud_firestore/darwin/Classes/UserAgent.h Outdated Show resolved Hide resolved

Remove UserAgent.h

5106e9c

franciscojma86 reviewed Feb 12, 2020

View reviewed changes

packages/cloud_firestore/cloud_firestore/macos/cloud_firestore.podspec Outdated Show resolved Hide resolved

cbenhagen added 4 commits February 13, 2020 08:30

Add macos dir to example

86d57f9

Depend on firebase_core 0.4.4

878f294

Define platform in podspec

faf3e10

Allow outgoing connections

7d61d05

ditman reviewed Feb 13, 2020

View reviewed changes

packages/cloud_firestore/cloud_firestore/pubspec.yaml Show resolved Hide resolved

Add .xcworkspace

29ea70d

collinjackson self-requested a review February 17, 2020 01:30

collinjackson approved these changes Feb 17, 2020

View reviewed changes

cbenhagen requested a review from ditman February 17, 2020 07:55

Merge branch 'master' into cloud_firestore_macos

5781411

franciscojma86 merged commit 0b13c92 into firebase:master Feb 19, 2020

cbenhagen deleted the cloud_firestore_macos branch February 19, 2020 19:06

firebase locked and limited conversation to collaborators Aug 5, 2020

[cloud_firestore] Add macOS support #1706

[cloud_firestore] Add macOS support #1706

Uh oh!

Conversation

cbenhagen commented Dec 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Checklist

Breaking Change

Uh oh!

ditman commented Dec 23, 2019

Uh oh!

cbenhagen commented Dec 23, 2019

Uh oh!

ditman commented Dec 23, 2019

Uh oh!

edeuss commented Dec 24, 2019

Uh oh!

phest commented Feb 4, 2020

Uh oh!

cbenhagen commented Feb 12, 2020

Uh oh!

ditman left a comment • 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!

Uh oh!

Uh oh!

Uh oh!

franciscojma86 left a comment

Choose a reason for hiding this comment

Uh oh!

phest commented Feb 12, 2020

Uh oh!

cbenhagen commented Feb 12, 2020

Uh oh!

cbenhagen commented Feb 12, 2020

Uh oh!

cbenhagen commented Feb 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

collinjackson commented Feb 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

franciscojma86 commented Feb 12, 2020

Uh oh!

cbenhagen commented Feb 12, 2020

Uh oh!

Uh oh!

ditman commented Feb 13, 2020

Uh oh!

cbenhagen commented Feb 14, 2020

Uh oh!

ditman commented Feb 14, 2020

Uh oh!

edeuss commented Feb 15, 2020

Uh oh!

cbenhagen commented Feb 17, 2020

Uh oh!

franciscojma86 commented Feb 19, 2020

Uh oh!

Uh oh!

cbenhagen commented Dec 23, 2019 •

edited

Loading

ditman left a comment •

edited

Loading

cbenhagen commented Feb 12, 2020 •

edited

Loading

collinjackson commented Feb 12, 2020 •

edited

Loading