Merge pull request #10 from Iterable/MOB-11130-add-firebase-setup-for-android

[MOB-11130] add-firebase-setup-for-android

Author: lposen

.eslintrc.js

@@ -17,7 +17,7 @@ module.exports = {
       ],
       parser: '@typescript-eslint/parser',
       parserOptions: {
-        project: true,
+        project: ['./tsconfig.json', './plugin/tsconfig.json'],
         tsconfigRootDir: __dirname,
       },
       rules: {

.gitignore

@@ -59,3 +59,4 @@ yarn-error.log
 # Generated files
 example/ios/
 example/android/
+example/google-services.json

README.md

@@ -2,6 +2,21 @@
 
 ## Instructions
 
+### Adding push capabilities to android
+
+Add the path to your google-services.json file to the app file under
+`expo.android.googleServicesFile`.  EG: If the google services file was added to
+the root of the app, the expo file would look like this:
+```json
+{
+  "expo": {
+    "android": {
+      "googleServicesFile": "./google-services.json"
+    }
+  }
+}
+```
+
 ### Adding Deeplinks 
 
 #### iOS

example/app.json

@@ -44,4 +44,4 @@
       ]
     ]
   }
-}
+}

plugin/src/withPushNotifications/index.ts

@@ -2,11 +2,15 @@ import { ConfigPlugin, withPlugins } from 'expo/config-plugins';
 
 import { type ConfigPluginPropsWithDefaults } from '../withIterable.types';
 import { withIosPushNotifications } from './withIosPushNotifications';
+import { withAndroidPushNotifications } from './withAndroidPushNotifications';
 
 export const withPushNotifications: ConfigPlugin<
   ConfigPluginPropsWithDefaults
 > = (config, props) => {
-  return withPlugins(config, [[withIosPushNotifications, props]]);
+  return withPlugins(config, [
+    [withIosPushNotifications, props],
+    [withAndroidPushNotifications, props],
+  ]);
 };
 
 export default withPushNotifications;

plugin/src/withPushNotifications/withAndroidPushNotifications.constants.ts

@@ -0,0 +1,11 @@
+export const GOOGLE_SERVICES_CLASS_PATH = 'com.google.gms:google-services';
+export const GOOGLE_SERVICES_PLUGIN = 'com.google.gms.google-services';
+export const GOOGLE_SERVICES_VERSION = '4.4.2';
+
+export const FIREBASE_BOM_CLASS_PATH = 'com.google.firebase:firebase-bom';
+export const FIREBASE_BOM_VERSION = '32.8.1';
+
+export const FIREBASE_MESSAGING_CLASS_PATH =
+  'com.google.firebase:firebase-messaging';
+
+export const DEFAULT_GOOGLE_SERVICES_PATH = 'app/google-services.json';

plugin/src/withPushNotifications/withAndroidPushNotifications.ts

@@ -0,0 +1,218 @@
+import {
+  ConfigPlugin,
+  WarningAggregator,
+  withAppBuildGradle,
+  withDangerousMod,
+  withPlugins,
+  withProjectBuildGradle,
+} from 'expo/config-plugins';
+
+import { ConfigPluginPropsWithDefaults } from '../withIterable.types';
+import {
+  DEFAULT_GOOGLE_SERVICES_PATH,
+  FIREBASE_BOM_CLASS_PATH,
+  FIREBASE_BOM_VERSION,
+  FIREBASE_MESSAGING_CLASS_PATH,
+  GOOGLE_SERVICES_CLASS_PATH,
+  GOOGLE_SERVICES_PLUGIN,
+  GOOGLE_SERVICES_VERSION,
+} from './withAndroidPushNotifications.constants';
+
+import path from 'path';
+import fs from 'fs';
+
+interface GradleDependency {
+  classpath: string;
+  version?: string;
+}
+
+/**
+ * Add a dependency to the project build.gradle file.
+ */
+function addProjectDependency(buildGradle: string, options: GradleDependency) {
+  if (!buildGradle.includes(options?.classpath)) {
+    return buildGradle.replace(
+      /dependencies\s?{/,
+      `dependencies {
+        classpath('${options?.classpath}${
+        options?.version ? `:${options?.version}` : ''
+      }')`
+    );
+  } else {
+    return buildGradle;
+  }
+}
+
+interface AppGradleDependency extends GradleDependency {
+  /**
+   * The string to add to the dependencies block.
+   *
+   * If this is not provided, ${classpath}:${version} will be used.
+   */
+  implementation?: string;
+}
+
+/**
+ * Add a dependency to the app build.gradle file.
+ */
+function addAppDependency(buildGradle: string, options: AppGradleDependency) {
+  if (!buildGradle.includes(options?.classpath)) {
+    const implementationString =
+      options?.implementation ??
+      `'${options?.classpath}${
+        options?.version ? `:${options?.version}` : ''
+      }'`;
+    return buildGradle.replace(
+      /dependencies\s?{/,
+      // NOTE: awkard spacing is intentional -- it ensure correct alignment in
+      // the output build.gradle file
+      `dependencies {
+    implementation ${implementationString}`
+    );
+  } else {
+    return buildGradle;
+  }
+}
+
+/**
+ * Add the apply plugin line to the app build.gradle file if it doesn't exist.
+ */
+function addApplyPlugin(appBuildGradle: string, pluginName: string) {
+  // Check for `apply plugin: 'com.google.gms.google-services'`
+  const applyPluginPattern = new RegExp(
+    `apply\\s+plugin:\\s+['"]${pluginName}['"]`
+  );
+  // Check for `plugins { id 'com.google.gms.google-services' }`
+  const pluginIdPattern = new RegExp(`id\\s+['"]${pluginName}['"]`);
+
+  // Make sure the project does not have the plugin already
+  if (
+    !appBuildGradle.match(applyPluginPattern) &&
+    !appBuildGradle.match(pluginIdPattern)
+  ) {
+    return appBuildGradle + `\napply plugin: '${pluginName}'`;
+  }
+
+  return appBuildGradle;
+}
+
+const withFirebaseInProjectBuildGradle: ConfigPlugin<ConfigPluginPropsWithDefaults> =
+  (config) => {
+    return withProjectBuildGradle(config, async (newConfig) => {
+      if (newConfig.modResults.language === 'groovy') {
+        newConfig.modResults.contents = addProjectDependency(
+          newConfig.modResults.contents,
+          {
+            classpath: GOOGLE_SERVICES_CLASS_PATH,
+            version: GOOGLE_SERVICES_VERSION,
+          }
+        );
+      } else {
+        WarningAggregator.addWarningAndroid(
+          '@iterable/expo-plugin',
+          `Cannot automatically configure project build.gradle if it's not groovy`
+        );
+      }
+
+      return newConfig;
+    });
+  };
+
+const withFirebaseInAppBuildGradle: ConfigPlugin<ConfigPluginPropsWithDefaults> =
+  (config) => {
+    return withAppBuildGradle(config, (newConfig) => {
+      if (newConfig.modResults.language === 'groovy') {
+        newConfig.modResults.contents = addApplyPlugin(
+          newConfig.modResults.contents,
+          GOOGLE_SERVICES_PLUGIN
+        );
+        newConfig.modResults.contents = addAppDependency(
+          newConfig.modResults.contents,
+          {
+            classpath: FIREBASE_MESSAGING_CLASS_PATH,
+          }
+        );
+        newConfig.modResults.contents = addAppDependency(
+          newConfig.modResults.contents,
+          {
+            classpath: FIREBASE_BOM_CLASS_PATH,
+            version: FIREBASE_BOM_VERSION,
+            implementation: `platform('${FIREBASE_BOM_CLASS_PATH}:${FIREBASE_BOM_VERSION}')`,
+          }
+        );
+      } else {
+        WarningAggregator.addWarningAndroid(
+          '@iterable/expo-plugin',
+          `Cannot automatically configure app build.gradle if it's not groovy`
+        );
+      }
+      return newConfig;
+    });
+  };
+
+/**
+ * Add the Google Services dependencies to the project and build.gradle file if
+ * they don't exist.
+ * @see Step 4.1 https://support.iterable.com/hc/en-us/articles/360045714132-Installing-Iterable-s-React-Native-SDK#step-4-1-set-up-firebase
+ */
+const withFirebase: ConfigPlugin<ConfigPluginPropsWithDefaults> = (
+  config,
+  props
+) => {
+  return withPlugins(config, [
+    [withFirebaseInProjectBuildGradle, props],
+    [withFirebaseInAppBuildGradle, props],
+  ]);
+};
+
+/**
+ * Copy `google-services.json`
+ * TODO: Add this step to the docs
+ */
+const withCopyAndroidGoogleServices: ConfigPlugin = (config) => {
+  return withDangerousMod(config, [
+    'android',
+    async (config) => {
+      if (!config.android?.googleServicesFile) {
+        throw new Error(
+          'Path to google-services.json is not defined. Please specify the `expo.android.googleServicesFile` field in app.json.'
+        );
+      }
+
+      const srcPath = path.resolve(
+        config.modRequest.projectRoot,
+        config.android.googleServicesFile
+      );
+      const destPath = path.resolve(
+        config.modRequest.platformProjectRoot,
+        DEFAULT_GOOGLE_SERVICES_PATH
+      );
+
+      try {
+        await fs.promises.copyFile(srcPath, destPath);
+      } catch (_) {
+        throw new Error(
+          `Cannot copy google-services.json, because the file ${srcPath} doesn't exist. Please provide a valid path in \`app.json\`.`
+        );
+      }
+      return config;
+    },
+  ]);
+};
+
+export const withAndroidPushNotifications: ConfigPlugin<ConfigPluginPropsWithDefaults> =
+  (config, props) => {
+    if (!config.android?.googleServicesFile) {
+      WarningAggregator.addWarningAndroid(
+        '@iterable/expo-plugin',
+        `Path to google-services.json is not defined, so push notifications will not be enabled.  To enable push notifications, please specify the \`expo.android.googleServicesFile\` field in app.json.`
+      );
+      return config;
+    }
+    return withPlugins(config, [
+      [withFirebase, props],
+      [withCopyAndroidGoogleServices, props],
+    ]);
+  };
+
+export default withAndroidPushNotifications;

plugin/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/index.ts","./src/withiterable.types.ts","./src/withstoreconfigvalues.ts","./src/withpushnotifications/index.ts","./src/withpushnotifications/withiospushnotifications.constants.ts","./src/withpushnotifications/withiospushnotifications.ts"],"version":"5.8.2"}
+{"root":["./src/index.ts","./src/withiterable.types.ts","./src/withstoreconfigvalues.ts","./src/withpushnotifications/index.ts","./src/withpushnotifications/withandroidpushnotifications.constants.ts","./src/withpushnotifications/withandroidpushnotifications.ts","./src/withpushnotifications/withiospushnotifications.constants.ts","./src/withpushnotifications/withiospushnotifications.ts"],"version":"5.8.2"}