Firebase-ios-sdk: FR: Support for "iPad apps for Mac" aka Marzipan/Catalyst

[siburb]

[REQUIRED] Step 2: Describe your environment

• Xcode version: 11
• Firebase Component: All

[REQUIRED] Step 3: Describe the problem

Steps to reproduce:

Attempting to build an iPad app for Mac, but it uses Firebase via Cocoapods, but we receive a lot of the following error:

Building for UIKit for Mac, but the linked framework '<frameworkName>.framework' was built for <unknown>. You may need to restrict the platforms for which this framework should be linked in the target editor.

Apparently, the Firebase binaries need to be built using Xcode 11 with the "Mac" option checked.

Relevant Code:

[ryanwilson]

Thanks for the report, @siburb! There are some docs and sessions we need to catch up on in order to find out how to get this working for folks. We're working on it and will update this issue as we find out more :)

[paulb777]

And, as always, PRs are welcome!

[EliteTechnicalCare]

Any update on this? I would love my iPad / Mac apps to all run on FB back end.

[morganchen12]

No update yet. In terms of infrastructure, adding Catalyst support would mean adding most of the support for AppKit apps as well. We're in the process of figuring that out and will have more to share soon.

[EliteTechnicalCare]

Are there any work arounds like building it for mac and the importing it into a project?

[morganchen12]

Theoretically what you're describing should be possible, since Catalyst apps are built on macOS apps, but will only work for the existing macOS-compatible libraries and defeats the purpose of Catalyst (at that point you're just building an AppKit app). You could then create a bundle using Firebase and load it into your Catalyst app.

[guidedways]

I really hope it's not going to only work for Catalyst supported apps. We really need this to work for all macOS apps with or without Catalyst.

[morganchen12]

AppKit support is also on our list of things to do. Fortunately, the Firebase website wouldn't need to distinguish between the two (i.e. console can display both as platform macOS), so much of the work is overlapping.

[appfrilans]

Is it possible to include firebase for macOS (UIKit for Mac) via pod 'FirebaseCore' ? I tried to make a separate target and set it in its own CocoaPods target (platform :macos, '10.15'), but importing via "import FirebaseCore" just gives me an error:

No such module 'FirebaseCore'

Any ideas? Or is this way impossible?

[ryanwilson]

@appfrilans as far as I can tell, UIKit for Mac apps need an XCFramework instead of regular frameworks (please someone jump in and correct me if this is incorrect 🙂) - CocoaPods doesn't currently support that. I'm installing Catalina beta now on and hope to get XCFrameworks built for the open source pods that currently support macOS, I'll be updating this thread as I discover things (may not be until early next week that I'm successful, but I'll try to get something ASAP).

[jonas-sleepcycle]

Here are someone who have gotten iOS frameworks working for UIKit for mac (not macOS though):

https://forums.developer.apple.com/message/362577

[ryanwilson]

Thanks for the link, I tried a bunch last night but only ran into multiple errors with no real feedback, only an error message: The operation couldn’t be completed. (XCBCore.XCFrameworkValidationError error 8.).

To add a snippet of information from the above link, Catalyst frameworks must be built against the iOS SDK not the macOS SDK.

We're currently relying on CocoaPods for the framework build during our zip file as well, still trying to figure out the best way to build for the new platform. There's very little documentation on XCFrameworks and the tool doesn't provide much information on failures - but we're trying and will continue to try 😄

[EliteTechnicalCare]

Thanks for the link, I tried a bunch last night but only ran into multiple errors with no real feedback, only an error message: The operation couldn’t be completed. (XCBCore.XCFrameworkValidationError error 8.).

To add a snippet of information from the above link, Catalyst frameworks must be built against the iOS SDK not the macOS SDK.

We're currently relying on CocoaPods for the framework build during our zip file as well, still trying to figure out the best way to build for the new platform. There's very little documentation on XCFrameworks and the tool doesn't provide much information on failures - but we're trying and will continue to try 😄

Does the new Xcode Beta provide a better error or the same useless nondescript ones?

[ryanwilson]

Does the new Xcode Beta provide a better error or the same useless nondescript ones?

Unfortunately this was last night with the new beta.

[ryanwilson]

Good news: I was able to build some static x86_64 libraries that should work with UIKit for Mac apps.

Bad news: The way we currently package the frameworks with lipo fails since there are two libraries with the same architecture (simulator is also x86_64).

I'll try to use the -library and -headers parameters from xcodebuild -create-xcframework and see if I can package an XCFramework that works in a Catalyst app.

[dreampiggy]

as far as I can tell, UIKit for Mac apps need an XCFramework instead of regular frameworks (please someone jump in and correct me if this is incorrect 🙂)

Is this true ? I can build a normal UIKit for macOS with x86_64 architecture. The .xcframework is only one collection form of multiple individual .frameworks.

[girishw]

Any updates on this? This would be critical for many apps.

[ryanwilson]

Still working away, apologies for the radio silence.

I'll post when I can get something to work for FirebaseCore since that's what I'm starting with. I've been able to build a slice that works with UIKit for Mac, but currently am battling code-signing since it's now required for frameworks built for the new platform, as well as getting a module imported.

as far as I can tell, UIKit for Mac apps need an XCFramework instead of regular frameworks (please someone jump in and correct me if this is incorrect 🙂)

Is this true ? I can build a normal UIKit for macOS with x86_64 architecture. The .xcframework is only one collection form of multiple individual .frameworks.

Sorry for the confusion, I was thinking more from a distribution standpoint. Yes one can make a standard .framework that works with UIKit for Mac apps, but in order to have a "fat library" that is one .framework that works with all platforms we'd need to switch to .xcframeworks. It's either that, or ship multiple .frameworks for the same SDK and leave it up to the developer to add the ones with the right architecture to the right targets in their app - it's pretty messy and error-prone.

[ryanwilson]

As a side note - if anyone has successfully taken a CocoaPod and built it to support both UIKit for Mac as well as iOS + simulator, please share any resources you can 😄

[filippozanfini]

Hi, has anyone taken a look at this solution? https://github.com/firebase/firebase-ios-sdk/issues/583#issuecomment-502055434

@ryanwilson

[ryanwilson]

@kaleidscpe must have missed that, will take a look when I can.

Otherwise I have an xcframework for FirebaseCore, GoogleUtilities, and FirebaseStorage although I'm having some difficulties getting Storage working - there's a +load that's not getting called which causes the Storage instance returned to be nil.

This is the +load call:
https://github.com/firebase/firebase-ios-sdk/blob/d8a0e5e61bfaf5f3a8f6ca93a356b39c1d94eb47/Firebase/Storage/FIRStorageComponent.m#L54

Adding +ObjC to my linker flags did not work. Still investigating.

[ryanwilson]

Turns out it was a silly project configuration error and I got it up and running. Once I verify things I'll probably create a GitHub release with the compiled XCFrameworks for testing purposes. Note: these will only be the open source frameworks to start (the ones available in this GitHub repo).

[jlubeck]

@ryanwilson any chance you can share your findings with the GoogleMaps devs? Looks like the same error is also happening with that SDK, but I can't find a Github repo for GoogleMaps to create a ticket...

[bbrv2018]

Good afternoon, we are super happy that you will allow us to use Firebase for our iPad app on the Mac. Any idea when the new frameworks will be released? We had to abstract all our call to Firebase from our App to get it working at the moment.
Thank you very much!

[khatchik]

Hey @ryanwilson, I am working with Atlassian and trying to ship Jira's Mac App.
Do you know if this ticket will also include porting the crashlytics library?
If the answer is no, do you know to whom should I raise a ticket for this?

Thanks mate!

[jlaws]

@ryanwilson you should take a look at how the Realm team got it working

https://github.com/realm/realm-cocoa/issues/6163

They recommend using a Swift Package for realm in place of cocoapods since they can live side by side.

[stevekellogg]

Just wondering.. Is there any ETA as to when we might have a build to start working with? ALSO, will this have all of the capabilities of the current iOS build?

TIA

[steipete]

Adding my +1 here. We're also currently porting our apps and SDKs to Mac Catalyst, and had to mock Firebase. Happy to help if you're stuck, my DMs are open (@steipete on Twitter)

[girishw]

Same here, +1

[mylogon341]

+1 This is critical for us to be ready. We’ve worked around it up to now but need this 100%. Please respond, Firebase people 🙏🏻

[paulb777]

Thanks for the feedback. Catalyst is a high priority for us, but its progress has been slowed by some urgent issues and summer vacations. We'll get a more concrete update out in the next two or three weeks.

In the meantime, we're happy to look at PRs.

Has anyone else had success with the strategy at https://github.com/firebase/firebase-ios-sdk/issues/583#issuecomment-502055434?

[paulb777]

Related CocoaPods issue at https://github.com/CocoaPods/CocoaPods/issues/8877

[michael-mansour]

+1 this is also very critical for us 🙏🏼

[appfrilans]

+1 Very critical for us as well 👍

[filippozanfini]

I hope to be able to work on my Mac app next month. +1

[Brian-Co]

+1 It’s very critical for us as well! 👍 Would really appreciate being able to work on Catalyst in the coming weeks 😃

[KevinMorais]

+1 also looking forward to implement Firebase (and Google Maps) with Catalyst 🙏🏼

[guidedways]

And I’m hoping plans of porting it to the Mac (normal macOS support without catalyst) are still there.

[EliteTechnicalCare]

Is there at least a rough timeline or a beta release so hopefully we can begin testing our apps and get our apps on the Mac App Store by launch day?

[paulb777]

Added a GitHub Catalyst label to help follow the progress on issues and pull requests.

[paulb777]

We're striving to have iOS SDK support for the open source pods by the time that Catalyst goes out of beta. Closed source pods and binary distribution support will likely take longer.

If you'd like to try it out, see the details below. Make sure your Podfile does not include any closed source pods like FirebaseAnalytics, Firebase/Core, FirebasePerformance or any FirebaseML.

Introduction
At WWDC 2019, Apple announced Catalyst. Catalyst adds UIKit support for macOS apps, which enables iOS apps to be targeted to the Mac with little more than a recompile.

After WWDC, Catalyst support became one of the most requested Firebase features.

Closed Source Pods
Adding support for the closed source pods - FirebaseAnalytics, FirebasePerformance, and the FirebaseML* pods - will require internal build infrastructure changes to support xcframeworks. It’s outside the scope of this document and will be dealt with in another document.

Summary
Here is the status of the open source Firebase libraries. Very little testing has been done beyond building, running unit tests, and some integration tests. In the current master repo or pending PR's all are ready for early evaluation with the exception of FirebaseRemoteConfig, FirebaseInAppMessaging and FirebaseDynamicLinks.

• FirebaseCore
• FirebaseABTesting
• FirebaseAuth - Requires developers to the Keychain Sharing Capability to their build settings.
• FirebaseCoreDiagnostics
• FirebaseDatabase - Build fixed in #3512. Support will be published in Firebase 6.7.0.
• FirebaseDynamicLinks - Needs port of UIWebView to WKWebView. Framework dependencies need review. Is FDL useful on macOS?
• FirebaseFirestore - Requires signing workaround(see #3500) for gRPC resource.
• FirebaseFunctions - Functional with one known bug - #3514. Integration testing is blocked because npm is not yet available for Catalyst.
• FirebaseInAppMessaging - Builds but unit tests depend upon FirebaseAnalytics and DynamicLinks. Requires signing workaround(see #3500) for Resources.
• FirebaseInAppMessagingDisplay - Builds but unit tests depend upon XCUIDevice. Requires signing workaround(see #3500) for Resources.
• FirebaseInstallations - Functional, but requires developers to the Keychain Sharing Capability to their build settings.
• FirebaseInstanceID - Functional, but requires developers to the Keychain Sharing Capability to their build settings. Unit tests fixed in #3534.
• FirebaseMessaging - Functional, but requires developers to the Keychain Sharing Capability to their build settings.
• FirebaseRemoteConfig - Blocked on open sourcing, which is planned in the next month.
• FirebaseStorage
• GoogleDataTransport - Build requires updating deleted NSKeyedArchiver API changes(#3525).
• GoogleDataTransportCCTSupport
• GoogleUtilities - GULNetwork tests require Enabling "Incoming Connections" capability in the unit test host app. GULUserDefaults tests fix in #3544. SecTrustEvaluate deprecation should be addressed.

Developing Firebase with Catalyst
Install Catalina and Xcode 11.

For each podspec in https://github.com/firebase/firebase-ios-sdk, run

• pod gen {name here}.podspec --local-sources=./ --auto-open
• Check the Mac box in the App-iOS Build Settings
• Sign the App in the Settings Signing & Capabilities tab
• Click Pods in the Project Manager
• Add Signing to the iOS host app and unit test targets
• Select the Unit-unit scheme
• Run it to build and test

[filippozanfini]

How can I test Firebase with Catalyst support with my app?

[paulb777]

@filippozanfini If you restrict your pods to the ones listed above, add the pod to your app and build. Some extra signing may be required as described above.

If you run into problems, create another issue at this repo with a description of your configuration and we'll try to help.

[filippozanfini]

@paulb777 I don't understand in which path I have to run "pod gen {name here}.podspec --local-sources=./ --auto-open"

[paulb777]

@filippozanfini That's part of the instructions for developing Firebase itself. From a client perspective, using Firebase should be just like using any other CocoaPod for building a Catalyst app.

[filippozanfini]

@paulb777 I updated the pods and now it works correctly. Thank you!

[pangia]

will this also work for manual 'non pod' implementations?

[guidedways]

And what about normal macOS support? Will this work?

[paulb777]

@pangia We've only verified Catalyst for source distributions which is only via CocoaPods or this GitHub repo. We still need to develop a better understanding of xcframeworks and how they integrate with Xcode before setting up binary distributions.

@guidedways Normal macOS support is unchanged. See https://github.com/firebase/firebase-ios-sdk#macos-and-tvos

[girishw]

We're getting pretty close to iOS 13 & Catalina release. Probably a month away or less.

[steipete]

Ah, we're getting close to Catalina's release and neither FirebasePerformance, FirebaseAnalytics nor FirebaseRemoteConfig are ready or have a clear timeline. That's unfortunate, looks like we'll have to ship with mocks.

Note that the new download format should be xcframework, to make things simple with same hw arch but different platform arch (mac vs catalyst). However CocoaPods might need some more time before https://github.com/CocoaPods/CocoaPods/issues/9148 is ready. (Same for Carthage, but there's a PR now)

If you're stuck on converting, my DMs are open, we've had quite a ride bringing PSPDFKit to Catalyst on time, and doing the xcframework conversion.

[paulb777]

@steipete Thanks for creating the detailed CocoaPods xcframework issue!

As of yesterday's release, FirebaseRemoteConfig is now open sourced along with Catalyst support.

We still don't have a timeline for the closed source libraries. In addition to the xcframework challenges you've seen, we need to work through some challenges with Catalina and internal Google build systems.

[steipete]

Wohoo, congrats on open sourcing that one, that's a great step! Thanks!

we need to work through some challenges with Catalina and internal Google build systems.

Been there done that. It's not fun. Took us a month until the Simulator even started without crashing :)

[jpv123]

I'm having trouble with GoogleSignIn needed for Firebase/Auth. Specifically the following error when compiling for Catalyst

GoogleSignIn.framework/GoogleSignIn(GIDEMMErrorHandler_08c50849aae099317ac5d938cd28d2ea.o), building for Mac Catalyst, but linking in object file built for iOS Simulator, file 'GoogleSignIn.framework/GoogleSignIn' for architecture x86_64

[paulb777]

@jpv123 GoogleSignIn is a binary CocoaPod and we don't yet have a Firebase (or CocoaPods) solution for those.

[Brian-Co]

Thanks @jpv123 I actually have the same issue, including with google maps and places pods.
@paulb777 does this means there’s no way to build for Catalyst right now even though you added support for Firebase? Or is there a workaround?

[paulb777]

@Brian-Co As is detailed above, Firebase support is not complete and is only available as community support for the pods released as source from this repo.

Neither Firebase not CocoaPods yet have a solution for binary CocoaPods.

[jpv123]

Thanks @paulb777 for your answer. Do you have any possible ETA for this to be implemented? Unfortunately my knowledge is not so strong on this topics

[steipete]

Is Crashlytics open source? This would be our top priority to get into Catalyst in the next ~2 weeks.

[samedson]

Nothing to report on Crashlytics being open source at this time but we are aware of the excitement around this feature

[michael-mansour]

Hi, when I try to archive my project I get the following error with gRPC-Core:

'openssl_grpc/ssl.h' file not found

'openssl_grpc/bio.h' file not found

'openssl_grpc/bn.h' file not found

'openssl_grpc/rsa.h' file not found

'openssl_grpc/bio.h' file not found

[paulb777]

Investigating gRPC-Core archive issue at #4007

[steipete]

We shipped our Catalyst app (PDF Viewer) and we're REALLY missing Firebase Crashlytics. Is there a rough ETA for it? Is there anything we can do to help/beta-test?

[peterstojanowski]

@samedson Is there any update or ETA on Firebase Crashlytics SDKs? I assume this will replace old Fabric Crashlytics and be compatible with Catalyst?

[samedson]

Hey all, we are working towards providing this support - it's is a high priority for us. We'll let you know when there is news to share.

[guidedways]

@samedson thanks for the update! Can you please also confirm that Firebase support for macOS (i.e. non-Catalyst) is being looked into? We're receiving emails from Google to migrate our code but Firebase isn't fully supported, nor is there support for Analytics.

[samedson]

Right now we have community support for macOS here: https://github.com/firebase/firebase-ios-sdk#macos-and-tvos. More fully fledged support is TBD.

You can currently get Crashlytics on macOS without Analytics by setting it up as an iOS app in the Firebase Console, and including the pods:

pod 'Crashlytics'
pod 'FirebaseCore'

[fishandphil]

Good afternoon.
We are trying to create the Firebase frameworks for our Catalyst App. Is it possible to have a bit more information about the following points:

1) "FirebaseFirestore - Requires signing workaround for gRPC resource."
What is the "workaround", were can we find information about what/how to do?

2) When we do the last step: "Run it to build and test"
What device should we do the "Build For Testing"?

• "Generic iOS Device"
  or
• "My Mac"?
  So far, we have been unable do build FirebaseCore on "My Mac" while it works fine on "Generic iOS Device". However, we were able to build FirebaseFirestore on "My Mac" which also build FirebaseCore I believe. Sadly, when integrating FirebaseFirestore for Catalyst in our project, we are getting about 30 "Undefined symbole" errors for grpc & leveldb.
  Unclear what we are doing wrong.

Thank you very much :)

[paulb777]

@fishandphil

In general, you can search on the Catalyst tag in this Issues list, to get more Catalyst-specific status.

Here are the answers:

1. See #3500. I updated the comment above to clarify this. thanks!
2. "My Mac". There is a known open issue for archiving Firestore (#4007), but we haven't seen any issues in development builds. If you're still having trouble with that, please open another issue with detailed repro instructions.

[girishw]

@paulb777 Need some clarifications on the current state and build instructions :

• Can I install using the currently released Cocoapods (eg Firebase/Core (6.10.0)) or do I need to generate the pods from GitHub source?
• After generating the pods from Github, do I simply reference the local pods from my Podfile?
• Currently, when building from the released Cocoapods I get the following error :

ld: in ..../Documents/ReSchedule/Pods/FirebaseAnalytics/Frameworks/FIRAnalyticsConnector.framework/FIRAnalyticsConnector(FIRConnectorUtils_77ff1e12be6740765c87f1be0d421683.o), building for Mac Catalyst, but linking in object file built for iOS Simulator, file '.....Documents/ReSchedule/Pods/FirebaseAnalytics/Frameworks/FIRAnalyticsConnector.framework/FIRAnalyticsConnector' for architecture x86_64

It looks like Firebase/Core (6.10.0) needs Firebase Analytics.

Thanks

[paulb777]

@girishw

• You can use the released CocoaPods
• Use the pods just as you would for iOS
• As discussed above, FirebaseAnalytics is binary and has no support yet for Catalyst. As you point out, Firebase/Core requires FirebaseAnalytics, so it cannot be in the Podfile. Separately, Firebase/Core is deprecated in favor of directly requesting the Firebase pods required.

[EliteTechnicalCare]

@paulb777
I assume same issue with Crashalytics? Also is there anywhere we can follow the progress on that.

[paulb777]

@EliteTechnicalCare Only the comment above. Feel free to create another issue if you'd like to track Crashlytics for Catalyst specifically.

[Blackjacx]

This could be a game changer: https://github.com/CocoaPods/CocoaPods/issues/9148 (XCFramework support in Cocoapods ✅)

[steipete]

@Blackjacx We (PSPDFKit) did sponsor this particular CocoaPods feature. It will definitely make distribution easier in the future. It's not something that will help the Firebase team here, more additional work I would schedule after the initial support for Catalyst.

[ryanwilson]

It's definitely helpful for zip builds of our open source SDKs - huge thanks @steipete for sponsoring this feature (on behalf of Firebase as well as the whole community)! There's still work to be done to get the closed source SDKs up and running with the internal build system.

[squm]

What is the current status, where I can check the progress on all this, not bothering anyone here at the issues ?

[paulb777]

@squm Good point, thanks! I updated the repo's README today with a summary of the current state of Catalyst support.

I'm going to close this umbrella issue in favor of more specific questions and issues. Please check existing Catalyst issues and create new issues for additional issues and questions.

[girishw]

@paulb777 I am using GoogleSignIn with FirebaseAuth. Where does that fall in all this?

[paulb777]

GoogleSignIn is mostly out of scope for us here, but it's a binary CocoaPod so Catalyst support would require more work. Probably best to follow up directly on one of the GoogleSignIn channels.

[pangia]

I don't see firebase analytics/crashlytics listed in the README. Are these not "_supported_" yet?

[girishw]

I found some requests here: https://github.com/googlesamples/google-services/issues/420

But radio silence.

On Dec 19, 2019, at 11:05 AM, Paul Beusterien [e-mail] wrote:

GoogleSignIn is mostly out of scope for us here, but it's a binary CocoaPod https://github.com/CocoaPods/Specs/blob/master/Specs/d/4/0/GoogleSignIn/5.0.2/GoogleSignIn.podspec.json#L36 so Catalyst support would require more work. Probably best to follow up directly on one of the GoogleSignIn channels https://github.com/CocoaPods/Specs/blob/master/Specs/d/4/0/GoogleSignIn/5.0.2/GoogleSignIn.podspec.json#L36.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub https://github.com/firebase/firebase-ios-sdk/issues/3144?email_source=notifications&email_token=AH3C23BGCM3ZKWSRDIG7GALQZPAZJA5CNFSM4HTZHDMKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHKTKVY#issuecomment-567620951, or unsubscribe https://github.com/notifications/unsubscribe-auth/AH3C23BRBTO5P4KHIVJWY23QZPAZJANCNFSM4HTZHDMA.

[paulb777]

@pangia Follow #4316 for Crashlytics
@girishw I gave a Google-internal bump to the GSI team

[kajensen]

Added tickets for Catalyst support for Analytics (#4563) and RemoteConfig (#4564)

[girishw]

@paulb777 To integrate GoogleSignIn with Firebase Authentication on MacOS, can I use GTMAppAuth (https://github.com/google/GTMAppAuth) with the signIn(withCustomToken:completion:) method?

Is there someplace else I should be asking this question?

[paulb777]

@girishw It's best to open a separate issue to more easily track and assign the question.