Add support for deploying new blocking triggers

CHANGELOG.md

@@ -1 +1 @@
-- Added new command `dataconnect:sql:shell` which run queries against Data Connect CloudSQL instances (#7778).
+- Add support for deploying new blocking triggers. (#6384)

src/deploy/functions/services/auth.ts

@@ -45,14 +45,18 @@
     }
   }
 
   private configChanged(
     newConfig: identityPlatform.BlockingFunctionsConfig,
     config: identityPlatform.BlockingFunctionsConfig,
   ) {
     if (
       newConfig.triggers?.beforeCreate?.functionUri !==
         config.triggers?.beforeCreate?.functionUri ||
-      newConfig.triggers?.beforeSignIn?.functionUri !== config.triggers?.beforeSignIn?.functionUri
+      newConfig.triggers?.beforeSignIn?.functionUri !==
+        config.triggers?.beforeSignIn?.functionUri ||
+      newConfig.triggers?.beforeSendEmail?.functionUri !==
+        config.triggers?.beforeSendEmail?.functionUri ||
+      newConfig.triggers?.beforeSendSms?.functionUri !== config.triggers?.beforeSendSms?.functionUri
     ) {
       return true;
     }
@@ -79,16 +83,34 @@
       newBlockingConfig.triggers = {
         ...newBlockingConfig.triggers,
         beforeCreate: {
           functionUri: endpoint.uri!,
         },
       };
-    } else {
+    } else if (endpoint.blockingTrigger.eventType === events.v1.BEFORE_SIGN_IN_EVENT) {
       newBlockingConfig.triggers = {
         ...newBlockingConfig.triggers,
         beforeSignIn: {
           functionUri: endpoint.uri!,
         },
       };
+    } else if (endpoint.blockingTrigger.eventType === events.v1.BEFORE_SEND_EMAIL_EVENT) {
+      newBlockingConfig.triggers = {
+        ...newBlockingConfig.triggers,
+        beforeSendEmail: {
+          functionUri: endpoint.uri!,
+        },
+      };
+    } else if (endpoint.blockingTrigger.eventType === events.v1.BEFORE_SEND_SMS_EVENT) {
+      newBlockingConfig.triggers = {
+        ...newBlockingConfig.triggers,
+        beforeSendSms: {
+          functionUri: endpoint.uri!,
+        },
+      };
+    } else {
+      throw new FirebaseError(
+        `Received invalid blocking trigger event type ${endpoint.blockingTrigger.eventType}`,
+      );
     }
 
     newBlockingConfig.forwardInboundCredentials = {
@@ -121,7 +143,9 @@
     const blockingConfig = await identityPlatform.getBlockingFunctionsConfig(endpoint.project);
     if (
       endpoint.uri !== blockingConfig.triggers?.beforeCreate?.functionUri &&
-      endpoint.uri !== blockingConfig.triggers?.beforeSignIn?.functionUri
+      endpoint.uri !== blockingConfig.triggers?.beforeSignIn?.functionUri &&
+      endpoint.uri !== blockingConfig.triggers?.beforeSendEmail?.functionUri &&
+      endpoint.uri !== blockingConfig.triggers?.beforeSendSms?.functionUri
     ) {
       return;
     }
@@ -135,6 +159,12 @@
     if (endpoint.uri === blockingConfig.triggers?.beforeSignIn?.functionUri) {
       delete blockingConfig.triggers?.beforeSignIn;
     }
+    if (endpoint.uri === blockingConfig.triggers?.beforeSendEmail?.functionUri) {
+      delete blockingConfig.triggers?.beforeSendEmail;
+    }
+    if (endpoint.uri === blockingConfig.triggers?.beforeSendSms?.functionUri) {
+      delete blockingConfig.triggers?.beforeSendSms;
+    }
 
     await identityPlatform.setBlockingFunctionsConfig(endpoint.project, blockingConfig);
   }

src/deploy/functions/services/index.ts

@@ -45,7 +45,7 @@
   name: "noop",
   api: "",
   ensureTriggerRegion: noop,
   validateTrigger: noop,
   registerTrigger: noop,
   unregisterTrigger: noop,
 };
@@ -56,7 +56,7 @@
   api: "pubsub.googleapis.com",
   requiredProjectBindings: noopProjectBindings,
   ensureTriggerRegion: noop,
   validateTrigger: noop,
   registerTrigger: noop,
   unregisterTrigger: noop,
 };
@@ -67,7 +67,7 @@
   api: "storage.googleapis.com",
   requiredProjectBindings: obtainStorageBindings,
   ensureTriggerRegion: ensureStorageTriggerRegion,
   validateTrigger: noop,
   registerTrigger: noop,
   unregisterTrigger: noop,
 };
@@ -78,7 +78,7 @@
   api: "firebasealerts.googleapis.com",
   requiredProjectBindings: noopProjectBindings,
   ensureTriggerRegion: ensureFirebaseAlertsTriggerRegion,
   validateTrigger: noop,
   registerTrigger: noop,
   unregisterTrigger: noop,
 };
@@ -92,7 +92,7 @@
   api: "firebasedatabase.googleapis.com",
   requiredProjectBindings: noopProjectBindings,
   ensureTriggerRegion: ensureDatabaseTriggerRegion,
   validateTrigger: noop,
   registerTrigger: noop,
   unregisterTrigger: noop,
 };
@@ -140,6 +140,8 @@
   "google.firebase.firebasealerts.alerts.v1.published": firebaseAlertsService,
   "providers/cloud.auth/eventTypes/user.beforeCreate": authBlockingService,
   "providers/cloud.auth/eventTypes/user.beforeSignIn": authBlockingService,
+  "providers/cloud.auth/eventTypes/user.beforeSendEmail": authBlockingService,
+  "providers/cloud.auth/eventTypes/user.beforeSendSms": authBlockingService,
   "google.firebase.database.ref.v1.written": databaseService,
   "google.firebase.database.ref.v1.created": databaseService,
   "google.firebase.database.ref.v1.updated": databaseService,

src/functions/constants.ts

@@ -6,8 +6,13 @@ export const BLOCKING_LABEL = "deployment-blocking";
 export const BLOCKING_LABEL_KEY_TO_EVENT: Record<string, (typeof AUTH_BLOCKING_EVENTS)[number]> = {
   "before-create": "providers/cloud.auth/eventTypes/user.beforeCreate",
   "before-sign-in": "providers/cloud.auth/eventTypes/user.beforeSignIn",
+  "before-send-email": "providers/cloud.auth/eventTypes/user.beforeSendEmail",
+  "before-send-sms": "providers/cloud.auth/eventTypes/user.beforeSendSms",
 };
+
 export const BLOCKING_EVENT_TO_LABEL_KEY: Record<(typeof AUTH_BLOCKING_EVENTS)[number], string> = {
   "providers/cloud.auth/eventTypes/user.beforeCreate": "before-create",
   "providers/cloud.auth/eventTypes/user.beforeSignIn": "before-sign-in",
+  "providers/cloud.auth/eventTypes/user.beforeSendEmail": "before-send-email",
+  "providers/cloud.auth/eventTypes/user.beforeSendSms": "before-send-sms",
 };

src/functions/events/v1.ts

@@ -2,6 +2,15 @@ export const BEFORE_CREATE_EVENT = "providers/cloud.auth/eventTypes/user.beforeC
 
 export const BEFORE_SIGN_IN_EVENT = "providers/cloud.auth/eventTypes/user.beforeSignIn";
 
-export const AUTH_BLOCKING_EVENTS = [BEFORE_CREATE_EVENT, BEFORE_SIGN_IN_EVENT] as const;
+export const BEFORE_SEND_EMAIL_EVENT = "providers/cloud.auth/eventTypes/user.beforeSendEmail";
+
+export const BEFORE_SEND_SMS_EVENT = "providers/cloud.auth/eventTypes/user.beforeSendSms";
+
+export const AUTH_BLOCKING_EVENTS = [
+  BEFORE_CREATE_EVENT,
+  BEFORE_SIGN_IN_EVENT,
+  BEFORE_SEND_EMAIL_EVENT,
+  BEFORE_SEND_SMS_EVENT,
+] as const;
 
 export type Event = (typeof AUTH_BLOCKING_EVENTS)[number];

src/gcp/identityPlatform.ts

@@ -41,6 +41,8 @@ export interface BlockingFunctionsConfig {
   triggers?: {
     beforeCreate?: BlockingFunctionsEventDetails;
     beforeSignIn?: BlockingFunctionsEventDetails;
+    beforeSendEmail?: BlockingFunctionsEventDetails;
+    beforeSendSms?: BlockingFunctionsEventDetails;
   };
   forwardInboundCredentials?: BlockingFunctionsOptions;
 }