This repo contains a Cordova project which builds a test app for the cordova-plugin-firebasex modular plugins, a modularized fork of cordova-plugin-firebase.

Modular plugin structure

The test project uses individual modular Firebase plugins rather than a single monolithic plugin. Each plugin provides a specific area of Firebase functionality:

Plugin	Description
cordova-plugin-firebasex-core	Core Firebase initialization, installations, and shared utilities
cordova-plugin-firebasex-messaging	Cloud Messaging (FCM) and push notifications
cordova-plugin-firebasex-auth	Authentication (email, phone, Google, Apple, OAuth, MFA)
cordova-plugin-firebasex-analytics	Analytics, consent mode, and Google Tag Manager
cordova-plugin-firebasex-crashlytics	Crashlytics crash reporting
cordova-plugin-firebasex-firestore	Cloud Firestore database
cordova-plugin-firebasex-functions	Cloud Functions callable functions
cordova-plugin-firebasex-config	Remote Config
cordova-plugin-firebasex-performance	Performance Monitoring
cordova-plugin-firebasex-inappmessaging	In-App Messaging
cordova-plugin-firebasex	Backward-compatible wrapper providing the unified FirebasePlugin global

The wrapper plugin (cordova-plugin-firebasex) re-exports all modular plugin APIs under the unified FirebasePlugin global, so existing JavaScript code continues to work without changes.

You can install only the plugins you need for your project, but the wrapper should be included if you want backward-compatible access via the FirebasePlugin global.

CLI build instructions

git clone https://github.com/dpa99c/cordova-plugin-firebasex-test.git && cd cordova-plugin-firebasex-test
npm install

cordova platform add ios
cordova run ios

cordova platform add android
cordova run android

Installing individual plugins

If you want to install only specific Firebase plugins (without the wrapper), you can reference them individually. Each plugin (except cordova-plugin-firebasex-core) depends on the core plugin, which will be installed automatically.

For example, to install only Messaging and Analytics:

cordova plugin add cordova-plugin-firebasex-messaging
cordova plugin add cordova-plugin-firebasex-analytics

Note: without the wrapper plugin, APIs will be available on separate globals (FirebasexMessaging, FirebasexAnalytics, etc.) rather than the unified FirebasePlugin.

Plugin variables

Plugin variables are now specified per-plugin. Each plugin only reads variables relevant to its functionality:

Core

Variable	Default	Description
ANDROID_ICON_ACCENT	#FF00FFFF	Accent color for notification icons
IOS_STRIP_DEBUG	false	Strip debug symbols on iOS

Messaging

Variable	Default	Description
FIREBASE_FCM_AUTOINIT_ENABLED	true	Auto-initialize FCM

Auth

Variable	Default	Description
SETUP_RECAPTCHA_VERIFICATION	false	Enable reCAPTCHA verification for phone auth
IOS_ENABLE_APPLE_SIGNIN	false	Enable Apple Sign-In on iOS

Analytics

Variable	Default	Description
FIREBASE_ANALYTICS_COLLECTION_ENABLED	true	Enable analytics collection at startup
FIREBASE_ANALYTICS_WITHOUT_ADS	false	Use analytics without ads support
GOOGLE_ANALYTICS_ADID_COLLECTION_ENABLED	true	Enable advertising ID collection
GOOGLE_ANALYTICS_DEFAULT_ALLOW_ANALYTICS_STORAGE	true	Default analytics storage consent
GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_STORAGE	true	Default ad storage consent
GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_USER_DATA	true	Default ad user data consent
GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_PERSONALIZATION_SIGNALS	true	Default ad personalization consent
IOS_ON_DEVICE_CONVERSION_ANALYTICS	false	Enable on-device conversion analytics on iOS

Crashlytics

Variable	Default	Description
FIREBASE_CRASHLYTICS_COLLECTION_ENABLED	true	Enable Crashlytics collection at startup

Firestore

Variable	Default	Description
IOS_USE_PRECOMPILED_FIRESTORE_POD	false	Use the precompiled Firestore pod for CocoaPods fallback builds only

Performance

Variable	Default	Description
FIREBASE_PERFORMANCE_COLLECTION_ENABLED	true	Enable performance monitoring at startup
ANDROID_FIREBASE_PERFORMANCE_MONITORING	false	Enable the Firebase Performance Gradle plugin

iOS build notes

iOS package ID

The configured package ID for this test project is uk.co.workingedge.firebase.test which I have registered with my Apple Developer Team in order to create an iOS provisioning profile with appropriate permissions.

Therefore in order to test this project on iOS, you will need to change the package ID to one which is associated with your Apple Developer Team and for which you have set appropriate capabilities.

Swift Package Manager

The modular cordova-plugin-firebasex-* plugins use Swift Package Manager on cordova-ios@8+ to resolve the iOS Firebase SDK dependencies. That is the primary path used by this test project, so no Podfile or manual pod install step is required.

If you intentionally stay on cordova-ios@7.x, the retained CocoaPods fallback still works. In that case you will need CocoaPods installed in your build environment and should keep your local specs repo up to date.

Building in Xcode

If building this project with cordova-ios@8+, open platforms/ios/App.xcodeproj in Xcode. If you are using the older CocoaPods fallback on cordova-ios@7.x, continue to open YourProject.xcworkspace instead.

Testing Cloud Messaging

If you want to test FCM using this project, you'll need to do the following:

iOS

• Change the package ID in the config.xml to a package ID which is associated with your Apple Developer Team and for which you have set appropriate capabilities (i.e. enabled Push Notifications).
• Set up a Firebase project and add an iOS app which is configured for your package ID.
• Upload an auth key or APNS certificate for the package ID to the Firebase project
• Download the GoogleService-Info.plist for your app and overwrite the one bundled with this project.
• Build and run your project on an iOS device (iOS Simulator cannot receive push notifications).

Android

• Change the package ID in the config.xml to another package ID.
• Set up a Firebase project and add an Android app which is configured for your package ID.
• Download the google-services.json for your app and overwrite the one bundled with this project.
• Build and run your project on an Android device.

You can send notification (but not data) messages using the Firebase Console.

Messaging client

In order to send both data and notification messages for testing, this repo includes a messaging client written in nodejs to send predefined messages via the FCM v1 HTTP API for testing.

Setup messaging client

In order to setup the messaging client, you first need to download a "service account" private key file from your Firebase project and save it into the root of this repo:

• Open your Firebase project in the Firebase Console
• Go to "Project settings" > "Service accounts" tab
• Press "Generate new private key" and save the file as service-account.json in the root of this cloned project repo.

Send test messages

• In order to send test messages to your device, you first need to find the Firebase token for the app on the device.
• To do this, build and run this app on the device and it should display the token.
• Copy the token value (e.g. connect Safari Web Inspector/Chrome Dev Tools to the Webview)
• You can then send the messages defined in the messages/ directory of this repo using the CLI in the root of the repo

Use the following syntax:

npm run-script send -- --token="<your_device_token>" --message=<message_name>.json

where <your_device_token> is the token you noted down and <message_name> is the name of a message file in the messages/ directory, for example:

npm run-script send -- --message=notification.json --token="cJlSa4UjtO0:APA91bFNDPVnHaS1__UTdNc8kt3uplnxBOcPGBbEO37J0FU3vFgGyud7gWDT2RJ5VmSJ68qFyiCu0y-WWcur7hE8RelRkzlS3RK6edFycpvm4K2szsMqMXOxEy72V9a41u6kaVh7U4nz"

Testing authentication

To test the authentication methods, you must configure each method for the target mobile platform as outlined in the plugin documentation for that method.

Android

Set your server client ID in www/js/config.js - see the Firebase documentation for where to find this. This is used for Google Sign In on Android.

Analytics DebugView

You can enable the local iOS scheme flag used by Firebase Analytics DebugView with:

npm run enableAnalyticsDebug -- --platform=ios

The helper script now detects both the Swift Package Manager App.xcodeproj scheme used by cordova-ios@8+ and the older CocoaPods workspace scheme.

See this page for how to manually enable Firebase Analytics DebugView.