chore: implementing Firebase messaging on iOS/Android

.android.env.example

@@ -1,3 +1,11 @@
 export MM_FOX_CODE="EXAMPLE_FOX_CODE"
 export MM_BRANCH_KEY_TEST=
 export MM_BRANCH_KEY_LIVE=
+# Firebase
+export FCM_CONFIG_API_KEY=
+export FCM_CONFIG_AUTH_DOMAIN=
+export FCM_CONFIG_PROJECT_ID=
+export FCM_CONFIG_STORAGE_BUCKET=
+export FCM_CONFIG_MESSAGING_SENDER_ID=
+export FCM_CONFIG_APP_ID=
+export GOOGLE_SERVICES_B64=

.ios.env.example

@@ -1,3 +1,11 @@
 MM_FOX_CODE = EXAMPLE_FOX_CODE
 MM_BRANCH_KEY_TEST =
 MM_BRANCH_KEY_LIVE =
+# Firebase
+FCM_CONFIG_API_KEY=
+FCM_CONFIG_AUTH_DOMAIN=
+FCM_CONFIG_PROJECT_ID=
+FCM_CONFIG_STORAGE_BUCKET=
+FCM_CONFIG_MESSAGING_SENDER_ID=
+FCM_CONFIG_APP_ID=
+GOOGLE_SERVICES_B64=

.js.env.example

@@ -73,3 +73,11 @@ export SECURITY_ALERTS_API_URL="http://localhost:3000"
 
 # Temporary mechanism to enable security alerts API prior to release.
 export SECURITY_ALERTS_API_ENABLED="true"
+# Firebase
+export FCM_CONFIG_API_KEY=""
+export FCM_CONFIG_AUTH_DOMAIN=""
+export FCM_CONFIG_PROJECT_ID=""
+export FCM_CONFIG_STORAGE_BUCKET=""
+export FCM_CONFIG_MESSAGING_SENDER_ID=""
+export FCM_CONFIG_APP_ID=""
+export GOOGLE_SERVICES_B64=""

README.md

@@ -39,6 +39,12 @@ git clone [email protected]:MetaMask/metamask-mobile.git && \
 cd metamask-mobile
 ```
 
+**Firebase Messaging Setup**
+
+Before running the app, keep in mind that MetaMask uses FCM (Firebase Cloud Message) to empower communications. Based on this, you need to have your own Firebase project config file and update your `google-services.json` file in the `android/app` directory as well your .env files, depending on the environment you are running the app (ios/android). Follow the instructions in the link below to get your Firebase project config file.
+
+[Firebase Project Quickstart](https://firebaseopensource.com/projects/firebase/quickstart-js/messaging/readme/#getting_started)
+
 **Install dependencies**
 
 ```bash

android/app/build.gradle

@@ -1,6 +1,7 @@
 apply plugin: "com.android.application"
 apply plugin: "com.facebook.react"
 apply plugin: "io.sentry.android.gradle"
+apply plugin: 'com.google.gms.google-services'
 
 import com.android.build.OutputFile
 

android/app/mock-google-services.json

@@ -0,0 +1,22 @@
+{
+  "project_info": {
+    "project_id": "mockproject-1234",
+    "project_number": "123456789000",
+    "name": "FirebaseQuickstarts",
+    "firebase_url": "https://mockproject-1234.firebaseio.com"
+  },
+  "client": [
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1:123456789000:android:f1bf012572b04063",
+        "client_id": "android:com.google.samples.quickstart.admobexample",
+        "client_type": 1,
+        "android_client_info": {
+          "package_name": "com.google.samples.quickstart.admobexample",
+          "certificate_hash": []
+        }
+      },
+    }
+  ],
+  "configuration_version": "1"
+}

android/build.gradle

@@ -24,6 +24,7 @@ buildscript {
 		classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
     classpath("com.facebook.react:react-native-gradle-plugin")
 		classpath("io.sentry:sentry-android-gradle-plugin:4.2.0")
+    classpath("com.google.gms:google-services:4.4.2")
 	}
 	allprojects {
     repositories {

app/util/notifications/methods/fcmHelper.test.ts

@@ -0,0 +1,83 @@
+import {
+  checkPlayServices,
+  registerAppWithFCM,
+  unRegisterAppWithFCM,
+  checkApplicationNotificationPermission,
+  getFcmToken,
+} from './fcmHelper';
+
+jest.mock('@react-native-firebase/app', () => ({
+  utils: () => ({
+    playServicesAvailability: {
+      status: 1,
+      isAvailable: false,
+      hasResolution: true,
+      isUserResolvableError: true,
+    },
+    makePlayServicesAvailable: jest.fn(() => Promise.resolve()),
+    resolutionForPlayServices: jest.fn(() => Promise.resolve()),
+    promptForPlayServices: jest.fn(() => Promise.resolve()),
+  }),
+}));
+
+jest.mock('@react-native-firebase/messaging', () => ({
+  __esModule: true,
+  default: () => ({
+    hasPermission: jest.fn(() => Promise.resolve(true)),
+    subscribeToTopic: jest.fn(),
+    unsubscribeFromTopic: jest.fn(),
+    isDeviceRegisteredForRemoteMessages: false,
+    registerDeviceForRemoteMessages: jest.fn(() =>
+      Promise.resolve('registered'),
+    ),
+    unregisterDeviceForRemoteMessages: jest.fn(() =>
+      Promise.resolve('unregistered'),
+    ),
+    deleteToken: jest.fn(() => Promise.resolve()),
+    requestPermission: jest.fn(() => Promise.resolve(1)),
+    getToken: jest.fn(() => Promise.resolve('fcm-token')),
+  }),
+  FirebaseMessagingTypes: {
+    AuthorizationStatus: {
+      AUTHORIZED: 1,
+      PROVISIONAL: 2,
+    },
+  },
+}));
+
+jest.mock('react-native-permissions', () => ({
+  PERMISSIONS: {
+    ANDROID: {
+      POST_NOTIFICATIONS: 'android.permission.POST_NOTIFICATIONS',
+    },
+  },
+  request: jest.fn(() => Promise.resolve('granted')),
+}));
+
+describe('Firebase and Permission Functions', () => {
+  it('should check checkPlayServices function call for coverage', async () => {
+    await checkPlayServices();
+    const token = await getFcmToken();
+
+    expect(token).toBe('fcm-token');
+  });
+  it('should check registerAppWithFCM function call for coverage', async () => {
+    await registerAppWithFCM();
+
+    const token = await getFcmToken();
+
+    expect(token).toBe('fcm-token');
+  });
+  it('should check unRegisterAppWithFCM function call for coverage', async () => {
+    await unRegisterAppWithFCM();
+    const token = await getFcmToken();
+
+    expect(token).toBe('fcm-token');
+  });
+  it('should check checkApplicationNotificationPermission function call for coverage', async () => {
+    await checkApplicationNotificationPermission();
+    const token = await getFcmToken();
+
+    expect(token).toBe('fcm-token');
+  });
+});

app/util/notifications/methods/fcmHelper.ts

@@ -0,0 +1,99 @@
+import { utils } from '@react-native-firebase/app';
+import messaging, {
+  FirebaseMessagingTypes,
+} from '@react-native-firebase/messaging';
+import Logger from '../../../util/Logger';
+import { PERMISSIONS, request } from 'react-native-permissions';
+
+export async function checkPlayServices() {
+  const { status, isAvailable, hasResolution, isUserResolvableError } =
+    utils().playServicesAvailability;
+  if (isAvailable) return Promise.resolve();
+
+  if (isUserResolvableError || hasResolution) {
+    switch (status) {
+      case 1:
+        return utils().makePlayServicesAvailable();
+      case 2:
+        return utils().resolutionForPlayServices();
+      default:
+        if (isUserResolvableError) return utils().promptForPlayServices();
+        if (hasResolution) return utils().resolutionForPlayServices();
+    }
+  }
+  return Promise.reject(
+    new Error('Unable to find a valid play services version.'),
+  );
+}
+
+export async function registerAppWithFCM() {
+  Logger.log(
+    'registerAppWithFCM status',
+    messaging().isDeviceRegisteredForRemoteMessages,
+  );
+  if (!messaging().isDeviceRegisteredForRemoteMessages) {
+    await messaging()
+      .registerDeviceForRemoteMessages()
+      .then((status: unknown) => {
+        Logger.log('registerDeviceForRemoteMessages status', status);
+      })
+      .catch((error: unknown) => {
+        Logger.log('registerDeviceForRemoteMessages error ', error);
+      });
+  }
+}
+
+export async function unRegisterAppWithFCM() {
+  Logger.log(
+    'unRegisterAppWithFCM status',
+    messaging().isDeviceRegisteredForRemoteMessages,
+  );
+
+  if (messaging().isDeviceRegisteredForRemoteMessages) {
+    await messaging()
+      .unregisterDeviceForRemoteMessages()
+      .then((status: unknown) => {
+        Logger.log('unregisterDeviceForRemoteMessages status', status);
+      })
+      .catch((error: unknown) => {
+        Logger.log('unregisterDeviceForRemoteMessages error ', error);
+      });
+  }
+  await messaging().deleteToken();
+  Logger.log(
+    'unRegisterAppWithFCM status',
+    messaging().isDeviceRegisteredForRemoteMessages,
+  );
+}
+
+export const checkApplicationNotificationPermission = async () => {
+  const authStatus = await messaging().requestPermission();
+
+  const enabled =
+    authStatus === FirebaseMessagingTypes.AuthorizationStatus.AUTHORIZED ||
+    authStatus === FirebaseMessagingTypes.AuthorizationStatus.PROVISIONAL;
+
+  if (enabled) {
+    Logger.log('Authorization status:', authStatus);
+  }
+  request(PERMISSIONS.ANDROID.POST_NOTIFICATIONS)
+    .then((result) => {
+      Logger.log('POST_NOTIFICATIONS status:', result);
+    })
+    .catch((error: unknown) => {
+      Logger.log('POST_NOTIFICATIONS error ', error);
+    });
+};
+
+export const getFcmToken = async () => {
+  let token = null;
+  await checkApplicationNotificationPermission();
+  await registerAppWithFCM();
+  try {
+    token = await messaging().getToken();
+    Logger.log('getFcmToken-->', token);
+  } catch (error) {
+    Logger.log('getFcmToken Device Token error ', error);
+  }
+  return token;
+};

firebase.json

@@ -0,0 +1,7 @@
+{
+  "react-native": {
+    "analytics_auto_collection_enabled": false,
+    "messaging_auto_init_enabled": false,
+    "messaging_ios_auto_register_for_remote_messages": true
+  }
+}

ios/Gemfile.lock

@@ -0,0 +1,12 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+
+BUNDLED WITH
+   2.5.8

ios/GoogleService-Info.plist

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>API_KEY</key>
+	<string>$(FCM_CONFIG_API_KEY)</string>
+	<key>GCM_SENDER_ID</key>
+	<string>$(FCM_CONFIG_MESSAGING_SENDER_ID)</string>
+	<key>PLIST_VERSION</key>
+	<string>1</string>
+	<key>BUNDLE_ID</key>
+	<string>io.metamask.MetaMask</string>
+	<key>PROJECT_ID</key>
+	<string>notifications-dev-e4e6d</string>
+	<key>STORAGE_BUCKET</key>
+	<string>$(FCM_CONFIG_STORAGE_BUCKET)</string>
+	<key>IS_ADS_ENABLED</key>
+	<false></false>
+	<key>IS_ANALYTICS_ENABLED</key>
+	<false></false>
+	<key>IS_APPINVITE_ENABLED</key>
+	<true></true>
+	<key>IS_GCM_ENABLED</key>
+	<true></true>
+	<key>IS_SIGNIN_ENABLED</key>
+	<true></true>
+	<key>GOOGLE_APP_ID</key>
+	<string>$(FCM_CONFIG_APP_ID)</string>
+</dict>
+</plist>