Merge branch 'main' into totp-mfa-unenroll

Author: jamespb97

.github/workflows/create_test_patches.yml

@@ -51,7 +51,7 @@ jobs:
           timeout_minutes: 15
           retry_wait_seconds: 60
           max_attempts: 3
-          command: DETOX_DISABLE_POSTINSTALL=1 yarn && yarn lerna:prepare
+          command: DETOX_DISABLE_POSTINSTALL=1 yarn
 
       - name: Create Patches
         env:

.github/workflows/linting.yml

@@ -43,7 +43,7 @@ jobs:
           timeout_minutes: 15
           retry_wait_seconds: 30
           max_attempts: 3
-          command: yarn && yarn lerna:prepare
+          command: yarn
       - name: Lint
         uses: nick-fields/retry@v3
         with:
@@ -83,7 +83,7 @@ jobs:
           timeout_minutes: 15
           retry_wait_seconds: 30
           max_attempts: 3
-          command: yarn && yarn lerna:prepare
+          command: yarn
       - name: Lint
         run: yarn tsc:compile
       - uses: actions/cache/save@v4
@@ -118,7 +118,7 @@ jobs:
           timeout_minutes: 15
           retry_wait_seconds: 30
           max_attempts: 3
-          command: yarn && yarn lerna:prepare
+          command: yarn
       - name: Yarn Install (Website)
         uses: nick-fields/retry@v3
         with:

.github/workflows/publish.yml

@@ -30,7 +30,7 @@ jobs:
           timeout_minutes: 15
           retry_wait_seconds: 60
           max_attempts: 3
-          command: yarn && yarn lerna:prepare
+          command: yarn
       - name: GIT Setup
         # Alter branding of release commit, despite GITHUB_TOKEN having real owner
         run: |

.github/workflows/scripts/functions/package.json

@@ -9,17 +9,17 @@
     "logs": "firebase functions:log"
   },
   "engines": {
-    "node": "18"
+    "node": "22"
   },
   "main": "lib/index.js",
   "dependencies": {
     "firebase-admin": "^13.4.0",
-    "firebase-functions": "^6.3.2"
+    "firebase-functions": "^6.4.0"
   },
   "devDependencies": {
     "firebase-functions-test": "^3.4.1",
-    "firebase-tools": "^14.9.0",
-    "typescript": "^5.8.3"
+    "firebase-tools": "^14.14.0",
+    "typescript": "^5.9.2"
   },
   "private": true
 }

.github/workflows/scripts/functions/src/fetchAppCheckToken.ts

@@ -7,16 +7,15 @@
  *  See License file for more information.
  */
 
-import * as admin from 'firebase-admin';
-import * as functions from 'firebase-functions/v2';
-import { CallableRequest } from 'firebase-functions/v2/https';
+import { getAppCheck } from 'firebase-admin/app-check';
+import { CallableRequest, onCall } from 'firebase-functions/v2/https';
+import { getAdminApp } from '.';
 
 // Note: this will only work in a live environment, not locally via the Firebase emulator.
-export const fetchAppCheckTokenV2 = functions.https.onCall(
-  async (req: CallableRequest<{ appId: string }>) => {
-    const { appId } = req.data;
-    const expireTimeMillis = Math.floor(Date.now() / 1000) + 60 * 60;
-    const result = await admin.appCheck().createToken(appId);
-    return { ...result, expireTimeMillis };
-  },
-);
+export const fetchAppCheckTokenV2 = onCall(async (req: CallableRequest<{ appId: string }>) => {
+  const { appId } = req.data;
+  const expireTimeMillis = Math.floor(Date.now() / 1000) + 60 * 60;
+  getAdminApp();
+  const result = await getAppCheck().createToken(appId);
+  return { ...result, expireTimeMillis };
+});

.github/workflows/scripts/functions/src/index.ts

@@ -1,23 +1,28 @@
-import * as functions from 'firebase-functions/v2';
-import { CallableRequest } from 'firebase-functions/v2/https';
+import { App, initializeApp } from 'firebase-admin/app';
+import { logger } from 'firebase-functions/v2';
+import { CallableRequest, onRequest, onCall } from 'firebase-functions/v2/https';
 
-// // Start writing Firebase Functions
-// // https://firebase.google.com/docs/functions/typescript
-//
-export const helloWorldV2 = functions.https.onRequest((_, response) => {
-  functions.logger.info('Hello logs!', { structuredData: true });
+let _app: App;
+
+export function getAdminApp(): App {
+  if (!_app) {
+    _app = initializeApp();
+  }
+  return _app;
+}
+
+export const helloWorldV2 = onRequest((_, response) => {
+  logger.info('Hello logs!', { structuredData: true });
   response.send('{ "data": "Hello from Firebase!" }');
 });
 
-export const sleeperV2 = functions.https.onCall(
-  async (req: CallableRequest<{ delay?: number }>) => {
-    functions.logger.info('Sleeper function starting');
-    return await new Promise(() => {
-      functions.logger.info('Sleeping this long: ' + (req.data.delay ?? 3000));
-      setTimeout(() => functions.logger.info('done sleeping'), req.data.delay ?? 3000);
-    });
-  },
-);
+export const sleeperV2 = onCall(async (req: CallableRequest<{ delay?: number }>) => {
+  logger.info('Sleeper function starting');
+  return await new Promise(() => {
+    logger.info('Sleeping this long: ' + (req.data.delay ?? 3000));
+    setTimeout(() => logger.info('done sleeping'), req.data.delay ?? 3000);
+  });
+});
 
 export { testFunctionCustomRegion } from './testFunctionCustomRegion';
 export { testFunctionDefaultRegionV2 } from './testFunctionDefaultRegion';

.github/workflows/scripts/functions/src/sendFCM.ts

@@ -7,19 +7,18 @@
  *  See License file for more information.
  */
 
-import * as functions from 'firebase-functions/v2';
-import { CallableRequest } from 'firebase-functions/v2/https';
-
+import { logger } from 'firebase-functions/v2';
+import { CallableRequest, onCall } from 'firebase-functions/v2/https';
 import { getMessaging, TokenMessage } from 'firebase-admin/messaging';
 
 // Note: this will only work in a live environment, not locally via the Firebase emulator.
-export const sendFCM = functions.https.onCall(
+export const sendFCM = onCall(
   async (req: CallableRequest<{ message: TokenMessage; delay?: number }>) => {
     const { message, delay } = req.data;
     return await new Promise(() => {
-      functions.logger.info('Sleeping this many milliseconds: ' + (delay ?? 0));
+      logger.info('Sleeping this many milliseconds: ' + (delay ?? 0));
       setTimeout(async () => {
-        functions.logger.info('done sleeping');
+        logger.info('done sleeping');
         const result = await getMessaging().send(message);
         return { messageId: result };
       }, delay ?? 0);

.github/workflows/scripts/functions/src/testFunctionCustomRegion.ts

@@ -7,10 +7,11 @@
  *  See License file for more information.
  */
 
-import * as functions from 'firebase-functions/v1';
+import { onCall } from 'firebase-functions/v2/https';
 
-// stay v1 here - v2 functions don't support custom regions well,
-// they require httpsCallableFromUrl which is tested separately
-export const testFunctionCustomRegion = functions
-  .region('europe-west1')
-  .https.onCall(() => 'europe-west1');
+export const testFunctionCustomRegion = onCall(
+  {
+    region: 'europe-west1',
+  },
+  () => 'europe-west1',
+);

.github/workflows/scripts/functions/src/testFunctionDefaultRegion.ts

@@ -7,13 +7,12 @@
  *  See License file for more information.
  */
 
-import * as assert from 'assert';
+import { deepEqual } from 'assert';
 import { FirebaseError } from 'firebase-admin';
-import * as functions from 'firebase-functions/v2';
+import { CallableRequest, onCall, HttpsError } from 'firebase-functions/v2/https';
 import SAMPLE_DATA from './sample-data';
-import { CallableRequest } from 'firebase-functions/v2/https';
 
-export const testFunctionDefaultRegionV2 = functions.https.onCall(
+export const testFunctionDefaultRegionV2 = onCall(
   (req: CallableRequest<{ type: string; asError: boolean; inputData: any }>) => {
     console.log(Date.now(), req.data);
 
@@ -43,16 +42,16 @@ export const testFunctionDefaultRegionV2 = functions.https.onCall(
 
     const { type, asError, inputData } = req.data;
     if (!Object.hasOwnProperty.call(SAMPLE_DATA, type)) {
-      throw new functions.https.HttpsError('invalid-argument', 'Invalid test requested.');
+      throw new HttpsError('invalid-argument', 'Invalid test requested.');
     }
 
     const outputData = SAMPLE_DATA[type];
 
     try {
-      assert.deepEqual(outputData, inputData);
+      deepEqual(outputData, inputData);
     } catch (e) {
       console.error(e);
-      throw new functions.https.HttpsError(
+      throw new HttpsError(
         'invalid-argument',
         'Input and Output types did not match.',
         (e as FirebaseError).message,
@@ -61,7 +60,7 @@ export const testFunctionDefaultRegionV2 = functions.https.onCall(
 
     // all good
     if (asError) {
-      throw new functions.https.HttpsError(
+      throw new HttpsError(
         'cancelled',
         'Response data was requested to be sent as part of an Error payload, so here we are!',
         outputData,

.github/workflows/scripts/functions/src/testFunctionRemoteConfigUpdate.ts

@@ -6,15 +6,18 @@
  *
  *  See License file for more information.
  */
-import * as admin from 'firebase-admin';
-import * as functions from 'firebase-functions/v2';
-import { CallableRequest } from 'firebase-functions/v2/https';
+// import * as admin from 'firebase-admin';
+import { getRemoteConfig } from 'firebase-admin/remote-config';
+import { logger } from 'firebase-functions/v2';
+import { CallableRequest, onCall } from 'firebase-functions/v2/https';
+import { getAdminApp } from '.';
 
-admin.initializeApp();
-const remoteConfig = admin.remoteConfig();
-
-export const testFunctionRemoteConfigUpdateV2 = functions.https.onCall(
-  (
+export const testFunctionRemoteConfigUpdateV2 = onCall(
+  {
+    maxInstances: 1,
+    concurrency: 1,
+  },
+  async (
     req: CallableRequest<{
       operations: {
         delete: string[] | undefined;
@@ -23,61 +26,55 @@ export const testFunctionRemoteConfigUpdateV2 = functions.https.onCall(
       };
     }>,
   ) => {
-    console.log(Date.now(), req);
+    let template = await getRemoteConfig(getAdminApp()).getTemplate();
+    logger.info('received template version: ' + JSON.stringify(template.version));
+    // logger.info('received template: ' + JSON.stringify(template, null, 2));
+
+    if (req.data !== undefined && req.data.operations !== undefined) {
+      modifyTemplate(req.data, template);
+    }
 
-    return new Promise(function (resolve, reject) {
-      remoteConfig
-        .getTemplate()
-        .then((template: any) => {
-          console.log('received template version: ' + JSON.stringify(template.version));
-          // console.log('received template: ' + JSON.stringify(template, null, 2));
+    // validate the template
+    template = await getRemoteConfig(getAdminApp()).validateTemplate(template);
+    logger.info('template is valid after updates.');
+    template = await getRemoteConfig(getAdminApp()).publishTemplate(template);
+    logger.info('template published, new version: ' + JSON.stringify(template.version));
 
-          if (req.data?.operations['delete'] !== undefined) {
-            const deletions = req.data?.operations['delete'];
-            deletions.forEach((deletion: string) => {
-              console.log('deleting key: ' + deletion);
-              if (template.parameters?.deletion !== undefined) {
-                delete template.parameters.deletion;
-              }
-            });
-          }
+    return { templateVersion: template.version?.versionNumber };
+  },
+);
 
-          if (req.data?.operations['add'] !== undefined) {
-            const adds = req.data?.operations['add'];
-            adds.forEach((add: { name: string; value: any }) => {
-              console.log('adding key: ' + JSON.stringify(add));
-              template.parameters[add.name] = {
-                description: 'realtime test parameter',
-                defaultValue: {
-                  value: add.value,
-                },
-              };
-            });
-          }
+function modifyTemplate(data: any, template: any) {
+  if (data.operations['delete'] !== undefined) {
+    const deletions = data.operations['delete'];
+    deletions.forEach((deletion: string) => {
+      logger.info('deleting key: ' + deletion);
+      if (template.parameters[deletion] !== undefined) {
+        delete template.parameters[deletion];
+      }
+    });
+  }
 
-          if (req.data?.operations['update'] !== undefined) {
-            const updates = req.data?.operations['update'];
-            updates.forEach((update: { name: string; value: any }) => {
-              console.log('updating key: ' + JSON.stringify(update));
-              if (template.parameters[update.name] !== undefined) {
-                template.parameters[update.name].defaultValue = update.value;
-              }
-            });
-          }
+  if (data.operations['add'] !== undefined) {
+    const adds = data.operations['add'];
+    adds.forEach((add: { name: string; value: any }) => {
+      logger.info('adding key: ' + JSON.stringify(add));
+      template.parameters[add.name] = {
+        description: 'realtime test parameter',
+        defaultValue: {
+          value: add.value,
+        },
+      };
+    });
+  }
 
-          // validate the template
-          remoteConfig.validateTemplate(template).then(template => {
-            console.log('template is valid after updates.');
-            remoteConfig.publishTemplate(template).then(template => {
-              console.log('template published, new version: ' + JSON.stringify(template.version));
-              resolve({ templateVersion: template.version?.versionNumber });
-            });
-          });
-        })
-        .catch((err: string) => {
-          console.error('remoteConfig.getTemplate failure: ' + err);
-          reject({ status: 'failure', message: err });
-        });
+  if (data.operations['update'] !== undefined) {
+    const updates = data.operations['update'];
+    updates.forEach((update: { name: string; value: any }) => {
+      logger.info('updating key: ' + JSON.stringify(update));
+      if (template.parameters[update.name] !== undefined) {
+        template.parameters[update.name].defaultValue = update.value;
+      }
     });
-  },
-);
+  }
+}