Adding support for SMS Blocking functions CLI (#7628)

* Blocking function SMS --------- Co-authored-by: Brian Li <blidd@google.com> Co-authored-by: joehan <joehanley@google.com> Co-authored-by: Mathusan Selvarajah <mathusans52@gmail.com>
firebase · Oct 17, 2024 · 576dc21 · 576dc21
1 parent b0f2478
commit 576dc21
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,2 @@
-- Re-add a dialog to let users know TLS is being provisioned in App Hosting (#7595)
-- Improve Firebase Data Connect postgres security by granting fine grained SQL privileges to the users the need it. (#7578)
-- Remove `dataconnect:sql:migrate` command hard dependency on 'roles/cloudsql.admin'. (#7578)
-- Add support for setting the encryption configuration of restored firestore databases (#7483)
-- Added support for deploying `beforeEmailSent` blocking functions. (#6384)
+- Add support for deploying `beforeEmailSent` blocking function. (#6384)
+- Add support for `beforeSmsSent` auth blocking triggers. (#6733)
diff --git a/src/deploy/functions/services/auth.ts b/src/deploy/functions/services/auth.ts
@@ -55,7 +55,8 @@ export class AuthBlockingService implements Service {
       newConfig.triggers?.beforeSignIn?.functionUri !==
         config.triggers?.beforeSignIn?.functionUri ||
       newConfig.triggers?.beforeSendEmail?.functionUri !==
-        config.triggers?.beforeSendEmail?.functionUri
+        config.triggers?.beforeSendEmail?.functionUri ||
+      newConfig.triggers?.beforeSendSms?.functionUri !== config.triggers?.beforeSendSms?.functionUri
     ) {
       return true;
     }
@@ -99,6 +100,13 @@ export class AuthBlockingService implements Service {
           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}`,
@@ -136,7 +144,8 @@ export class AuthBlockingService implements Service {
     if (
       endpoint.uri !== blockingConfig.triggers?.beforeCreate?.functionUri &&
       endpoint.uri !== blockingConfig.triggers?.beforeSignIn?.functionUri &&
-      endpoint.uri !== blockingConfig.triggers?.beforeSendEmail?.functionUri
+      endpoint.uri !== blockingConfig.triggers?.beforeSendEmail?.functionUri &&
+      endpoint.uri !== blockingConfig.triggers?.beforeSendSms?.functionUri
     ) {
       return;
     }
@@ -153,6 +162,9 @@ export class AuthBlockingService implements Service {
     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);
   }

diff --git a/src/deploy/functions/services/index.ts b/src/deploy/functions/services/index.ts
@@ -141,6 +141,7 @@ const EVENT_SERVICE_MAPPING: Record<events.Event, Service> = {
   "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,

diff --git a/src/functions/constants.ts b/src/functions/constants.ts
@@ -7,10 +7,12 @@ export const BLOCKING_LABEL_KEY_TO_EVENT: Record<string, (typeof AUTH_BLOCKING_E
   "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",
 };
diff --git a/src/functions/events/v1.ts b/src/functions/events/v1.ts
@@ -4,10 +4,13 @@ export const BEFORE_SIGN_IN_EVENT = "providers/cloud.auth/eventTypes/user.before
 
 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];
diff --git a/src/gcp/identityPlatform.ts b/src/gcp/identityPlatform.ts
@@ -42,6 +42,7 @@ export interface BlockingFunctionsConfig {
     beforeCreate?: BlockingFunctionsEventDetails;
     beforeSignIn?: BlockingFunctionsEventDetails;
     beforeSendEmail?: BlockingFunctionsEventDetails;
+    beforeSendSms?: BlockingFunctionsEventDetails;
   };
   forwardInboundCredentials?: BlockingFunctionsOptions;
 }