Add support for beforeSendEmail trigger #1492
Conversation
| /** Defines the auth event context for blocking events */ | ||
| export interface AuthEventContext extends EventContext { | ||
| locale?: string; | ||
| ipAddress: string; | ||
| userAgent: string; | ||
| additionalUserInfo?: AdditionalUserInfo; | ||
| credential?: Credential; | ||
| emailType?: EmailType; | ||
| } | ||
|
|
||
| /** Defines the auth event for 2nd gen blocking events */ |
There was a problem hiding this comment.
can we add a comment say that for beforeEmailSent and beforeSmsSent, this field will be undefined?
There was a problem hiding this comment.
Shouldn't this field be defined for beforeEmailSent?
There was a problem hiding this comment.
typo, this should be undefined for beforeCreate and beforeSignIn events. May be a comment saying this value is only available for beforeEmailSent trigger.
src/common/providers/identity.ts
Outdated
| @@ -391,6 +399,7 @@ interface DecodedPayloadUserRecordEnrolledFactors { | |||
| export interface DecodedPayloadUserRecord { | |||
| uid: string; | |||
| email?: string; | |||
| email_type?: string; | |||
There was a problem hiding this comment.
we do not need email_type in the userrecord correct?
src/common/providers/identity.ts
Outdated
| ? await auth.getAuth(getApp())._verifyAuthBlockingToken(req.body.data.jwt) | ||
| : await auth.getAuth(getApp())._verifyAuthBlockingToken(req.body.data.jwt, "run.app"); | ||
| const authUserRecord = parseAuthUserRecord(decodedPayload.user_record); | ||
| let authUserRecord: AuthUserRecord | undefined; | ||
| if (decodedPayload.user_record) { |
There was a problem hiding this comment.
may be we should use decodedPayload.event_type value in the if statement. This helps eliminate the backend error.
spec/v2/providers/identity.spec.ts
Outdated
| @@ -41,6 +41,15 @@ const BEFORE_SIGN_IN_TRIGGER = { | |||
| }, | |||
| }; | |||
|
|
|||
| const BEFORE_EMAIL_TRIGGER = { | |||
| eventType: "providers/cloud.auth/eventTypes/user.beforeSendEmail", | |||
| options: { | |||
There was a problem hiding this comment.
we can remove the options here. See comments in v2/providers/identity.ts
| /** Defines the auth event context for blocking events */ | ||
| export interface AuthEventContext extends EventContext { | ||
| locale?: string; | ||
| ipAddress: string; | ||
| userAgent: string; | ||
| additionalUserInfo?: AdditionalUserInfo; | ||
| credential?: Credential; | ||
| emailType?: EmailType; | ||
| } | ||
|
|
||
| /** Defines the auth event for 2nd gen blocking events */ |
There was a problem hiding this comment.
typo, this should be undefined for beforeCreate and beforeSignIn events. May be a comment saying this value is only available for beforeEmailSent trigger.
GCIP now supports a new event type that triggers before emails are sent using Identity Platform. This PR adds a new trigger to respond to the
beforeSendEmailevent type. Based on changes fromblidd.blocking-fn-email.