Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
feat(secret-approval): enhance email notification handling with error tracking and optional failure throwing
Victor Hugo dos Santosda9e1098054f
diff --git a/backend/src/ee/services/pit/pit-service.ts b/backend/src/ee/services/pit/pit-service.tsindex ccba59201d..f163dbec2c 100644--- a/backend/src/ee/services/pit/pit-service.ts+++ b/backend/src/ee/services/pit/pit-service.ts@@ -33,6 +33,7 @@ import { TPermissionServiceFactory } from "../permission/permission-service-typeimport { shouldApplyPolicy } from "../secret-approval-policy/secret-approval-policy-fns";import { TSecretApprovalPolicyServiceFactory } from "../secret-approval-policy/secret-approval-policy-service";import { TSecretApprovalRequestServiceFactory } from "../secret-approval-request/secret-approval-request-service";+import { TCreateSecretApprovalSideEffectsDTO } from "../secret-approval-request/secret-approval-request-types";type TPitServiceFactoryDep = {folderCommitService: TFolderCommitServiceFactory;@@ -46,7 +47,7 @@ type TPitServiceFactoryDep = {projectEnvDAL: Pick<TProjectEnvDALFactory, "findOne">;secretApprovalRequestService: Pick<TSecretApprovalRequestServiceFactory,- "generateSecretApprovalRequest" | "generateSecretApprovalRequestV2Bridge"+ "generateSecretApprovalRequest" | "generateSecretApprovalRequestV2Bridge" | "createSecretApprovalSideEffects">;secretApprovalPolicyService: Pick<TSecretApprovalPolicyServiceFactory, "getSecretApprovalPolicy">;projectDAL: Pick<TProjectDALFactory, "checkProjectUpgradeStatus" | "findProjectBySlug" | "findById">;@@ -686,6 +687,8 @@ export const pitServiceFactory = ({}}+ // Notifying approvers reaches Slack, Teams and SMTP, so it waits until the request has committed+ let approvalSideEffects: TCreateSecretApprovalSideEffectsDTO | undefined;const response = await folderCommitDAL.transaction(async (trx) => {const targetFolder = await folderDAL.findBySecretPath(projectId, environment, secretPath, trx);if (!targetFolder)@@ -865,8 +868,28 @@ export const pitServiceFactory = ({changes.secrets?.delete?.map((el) => ({secretKey: el.secretKey})) ?? []- }+ },+ trx,+ skipPostProcessing: true});+ approvalSideEffects = {+ secretApprovalRequest: { id: approval.id, policyId: approval.policyId, commits: approval.commits },+ projectId,+ environment,+ secretPath,+ secretKeys: [+ ...new Set(+ [+ ...(changes.secrets?.create ?? []),+ ...(changes.secrets?.update ?? []),+ ...(changes.secrets?.delete ?? [])+ ].map((el) => el.secretKey)+ )+ ],+ actor,+ actorId,+ actorOrgId+ };return {approvalId: approval.id,commitId,@@ -999,6 +1022,17 @@ export const pitServiceFactory = ({};});+ if (approvalSideEffects) {+ try {+ await secretApprovalRequestService.createSecretApprovalSideEffects(approvalSideEffects);+ } catch (error) {+ logger.error(+ error,+ `Failed to notify approvers of secret change request [requestId=${approvalSideEffects.secretApprovalRequest.id}] [projectId=${projectId}]`+ );+ }+ }+return response;};diff --git a/backend/src/ee/services/secret-approval-request/secret-approval-request-fns.test.ts b/backend/src/ee/services/secret-approval-request/secret-approval-request-fns.test.tsindex 7147be7c99..51d0709a7e 100644--- a/backend/src/ee/services/secret-approval-request/secret-approval-request-fns.test.ts+++ b/backend/src/ee/services/secret-approval-request/secret-approval-request-fns.test.ts@@ -1,14 +1,18 @@-import { describe, expect, test } from "vitest";+import { describe, expect, test, vi } from "vitest";import { OrderByDirection } from "@app/lib/types";import {compareSecretApprovalRequests,mergeSecretApprovalRequestPages,+ sendApprovalEmailsFn,TSecretApprovalRequestSortable} from "./secret-approval-request-fns";import { SecretApprovalRequestOrderBy } from "./secret-approval-request-types";+vi.mock("@app/lib/config/env", () => ({ getConfig: () => ({ SITE_URL: "https://app.test" }) }));+vi.mock("@app/lib/logger", () => ({ logger: { info: vi.fn(), error: vi.fn(), warn: vi.fn(), debug: vi.fn() } }));+const request = (overrides: Partial<TSecretApprovalRequestSortable> & { id: string }): TSecretApprovalRequestSortable => ({@@ -122,3 +126,55 @@ describe("mergeSecretApprovalRequestPages", () => {expect(merged.approvals.map((el) => el.id)).toEqual(["legacy-old", "global-old", "legacy-new", "global-new"]);});});++describe("sendApprovalEmailsFn", () => {+ const build = () => {+ const deps = {+ secretApprovalPolicyDAL: {+ findById: vi.fn().mockResolvedValue({+ userApprovers: [+ { userId: "user-2", firstName: "Bob", email: "[email protected]" },+ { userId: "user-3", firstName: "Eve", email: "[email protected]" }+ ]+ })+ },+ projectDAL: {+ findProjectWithOrg: vi+ .fn()+ .mockResolvedValue({ id: "project-1", name: "Project", orgId: "org-1", organization: { name: "Org" } })+ },+ smtpService: { sendMail: vi.fn().mockResolvedValue(undefined) },+ notificationService: { createUserNotifications: vi.fn().mockResolvedValue(undefined) }+ };+ const run = () =>+ sendApprovalEmailsFn({+ ...(deps as unknown as Omit<Parameters<typeof sendApprovalEmailsFn>[0], "projectId" | "secretApprovalRequest">),+ projectId: "project-1",+ secretApprovalRequest: { id: "request-1", policyId: "policy-1" }+ });+ return { deps, run };+ };++ test("resolves with no failures when every email is delivered", async () => {+ const { deps, run } = build();++ await expect(run()).resolves.toEqual([]);+ expect(deps.smtpService.sendMail).toHaveBeenCalledTimes(2);+ });++ test("a failed email does not reject: it is returned and the next approver is still emailed", async () => {+ const { deps, run } = build();+ const smtpError = new Error("Invalid login: 535 Authentication Credentials Invalid");+ deps.smtpService.sendMail.mockRejectedValueOnce(smtpError);++ await expect(run()).resolves.toEqual([smtpError]);+ expect(deps.smtpService.sendMail).toHaveBeenCalledTimes(2);+ expect(deps.smtpService.sendMail).toHaveBeenLastCalledWith(+ expect.objectContaining({ recipients: ["[email protected]"] })+ );+ expect(deps.notificationService.createUserNotifications).toHaveBeenCalledWith([+ expect.objectContaining({ userId: "user-2" }),+ expect.objectContaining({ userId: "user-3" })+ ]);+ });+});diff --git a/backend/src/ee/services/secret-approval-request/secret-approval-request-fns.ts b/backend/src/ee/services/secret-approval-request/secret-approval-request-fns.tsindex f16ed4818f..d3e1b4165b 100644--- a/backend/src/ee/services/secret-approval-request/secret-approval-request-fns.ts+++ b/backend/src/ee/services/secret-approval-request/secret-approval-request-fns.ts@@ -26,7 +26,7 @@ export const sendApprovalEmailsFn = async ({projectId,secretApprovalRequest,notificationService-}: TSendApprovalEmails) => {+}: TSendApprovalEmails): Promise<unknown[]> => {const cfg = getConfig();const policy = await secretApprovalPolicyDAL.findById(secretApprovalRequest.policyId);@@ -44,6 +44,7 @@ export const sendApprovalEmailsFn = async ({})));+ const failures: unknown[] = [];for await (const reviewerUser of policy.userApprovers) {try {await smtpService.sendMail({@@ -63,8 +64,11 @@ export const sendApprovalEmailsFn = async ({error,`Failed to send secret change request email to approver [requestId=${secretApprovalRequest.id}] [userId=${reviewerUser.userId}]`);+ failures.push(error);}}++ return failures;};export type TSecretUpdateCommitCandidate = {diff --git a/backend/src/ee/services/secret-approval-request/secret-approval-request-merge-fns.test.ts b/backend/src/ee/services/secret-approval-request/secret-approval-request-merge-fns.test.tsindex 8ac7cafef7..9670bfe6e0 100644--- a/backend/src/ee/services/secret-approval-request/secret-approval-request-merge-fns.test.ts+++ b/backend/src/ee/services/secret-approval-request/secret-approval-request-merge-fns.test.ts@@ -13,6 +13,9 @@ import {TSecretApprovalBridgeCommit} from "./secret-approval-request-merge-fns";+vi.mock("@app/lib/config/env", () => ({ getConfig: () => ({ SITE_URL: "https://app.test" }) }));+vi.mock("@app/lib/logger", () => ({ logger: { info: vi.fn(), error: vi.fn(), warn: vi.fn(), debug: vi.fn() } }));+const commit = (overrides: Record<string, unknown>) =>({id: `commit-${String(overrides.key)}`,@@ -168,3 +171,46 @@ describe("buildRequestedByActor", () => {expect(buildRequestedByActor({})).toBeUndefined();});});++describe("notifySecretApprovalBypass", () => {+ const build = () => {+ const deps = {+ userDAL: {+ findOne: vi.fn().mockResolvedValue({ firstName: "Alice", lastName: "Smith", email: "[email protected]" }),+ find: vi.fn().mockResolvedValue([+ { id: "user-2", email: "[email protected]" },+ { id: "user-3", email: "[email protected]" }+ ])+ },+ notificationService: { createUserNotifications: vi.fn().mockResolvedValue(undefined) },+ smtpService: { sendMail: vi.fn().mockResolvedValue(undefined) }+ };+ const fns = secretApprovalRequestMergeFnsFactory(+ deps as unknown as Parameters<typeof secretApprovalRequestMergeFnsFactory>[0]+ );+ const run = () =>+ fns.notifySecretApprovalBypass({+ project: { id: "project-1", name: "Project", orgId: "org-1" },+ environmentName: "Development",+ secretPath: "/",+ actorId: "user-1",+ approverUserIds: ["user-2", "user-3"],+ bypassReason: "hotfix"+ });+ return { deps, run };+ };++ test("a failed bypass email does not reject, and approvers still get the in-app notification", async () => {+ const { deps, run } = build();+ deps.smtpService.sendMail.mockRejectedValueOnce(new Error("Invalid login: 535 Authentication Credentials Invalid"));++ await expect(run()).resolves.toBeUndefined();+ expect(deps.smtpService.sendMail).toHaveBeenCalledWith(+ expect.objectContaining({ recipients: ["[email protected]", "[email protected]"] })+ );+ expect(deps.notificationService.createUserNotifications).toHaveBeenCalledWith([+ expect.objectContaining({ userId: "user-2" }),+ expect.objectContaining({ userId: "user-3" })+ ]);+ });+});diff --git a/backend/src/ee/services/secret-approval-request/secret-approval-request-service.ts b/backend/src/ee/services/secret-approval-request/secret-approval-request-service.tsindex 3c3a79f1c3..33b4b9e747 100644--- a/backend/src/ee/services/secret-approval-request/secret-approval-request-service.ts+++ b/backend/src/ee/services/secret-approval-request/secret-approval-request-service.ts@@ -1633,8 +1633,18 @@ export const secretApprovalRequestServiceFactory = ({return secretChangeGlobalRequestBridgeService.createSecretChangeRequestSideEffects(dto);}- const { secretApprovalRequest, projectId, environment, secretPath, secretKeys, actor, actorId, actorOrgId, tx } =- dto;+ const {+ secretApprovalRequest,+ projectId,+ environment,+ secretPath,+ secretKeys,+ actor,+ actorId,+ actorOrgId,+ tx,+ throwOnEmailFailure+ } = dto;const user =actor === ActorType.IDENTITY? undefined@@ -1674,7 +1684,7 @@ export const secretApprovalRequestServiceFactory = ({}});- await sendApprovalEmailsFn({+ const emailFailures = await sendApprovalEmailsFn({projectDAL,secretApprovalPolicyDAL,secretApprovalRequest,@@ -1731,6 +1741,8 @@ export const secretApprovalRequestServiceFactory = ({}}).catch(() => {});++ if (throwOnEmailFailure && emailFailures.length) throw emailFailures[0];};const generateSecretApprovalRequestV2Bridge = async (diff --git a/backend/src/ee/services/secret-approval-request/secret-approval-request-types.ts b/backend/src/ee/services/secret-approval-request/secret-approval-request-types.tsindex cea86636be..7d7e128b3a 100644--- a/backend/src/ee/services/secret-approval-request/secret-approval-request-types.ts+++ b/backend/src/ee/services/secret-approval-request/secret-approval-request-types.ts@@ -122,6 +122,7 @@ export type TCreateSecretApprovalSideEffectsDTO = {secretPath: string;secretKeys: string[];tx?: Knex;+ throwOnEmailFailure?: boolean;} & Omit<TProjectPermission, "actorAuthMethod">;export type TMergeSecretApprovalRequestDTO = {diff --git a/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-fns.test.ts b/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-fns.test.tsindex bd2c62cf09..8ee32310f6 100644--- a/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-fns.test.ts+++ b/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-fns.test.ts@@ -451,4 +451,50 @@ describe("runSecretChangeRequestSideEffects", () => {}));});++ const twoMailableApprovers = [+ { id: "user-2", firstName: "Bob", email: "[email protected]" },+ { id: "user-3", firstName: "Eve", email: "[email protected]" }+ ];++ test("keeps going when an approver email fails: next approver, webhook and telemetry still run", async () => {+ const { fns, deps } = buildFns({ approvers: twoMailableApprovers });+ deps.smtpService.sendMail.mockRejectedValueOnce(new Error("Invalid login: 535 Authentication Credentials Invalid"));++ await expect(fns.runSecretChangeRequestSideEffects(input)).resolves.toBeUndefined();++ expect(deps.smtpService.sendMail).toHaveBeenCalledTimes(2);+ expect(deps.smtpService.sendMail).toHaveBeenLastCalledWith(+ expect.objectContaining({ recipients: ["[email protected]"] })+ );+ expect(deps.notificationService.createUserNotifications).toHaveBeenCalled();+ expect(deps.queueService.queue).toHaveBeenCalledWith(+ QueueName.SecretWebhook,+ QueueJobs.SecWebhook,+ expect.anything(),+ expect.anything()+ );+ expect(deps.telemetryService.sendPostHogEvents).toHaveBeenCalled();+ });++ test("with throwOnEmailFailure, rethrows the email error only after every other side effect ran", async () => {+ const { fns, deps } = buildFns({ approvers: twoMailableApprovers });+ deps.smtpService.sendMail.mockRejectedValueOnce(new Error("Invalid login: 535 Authentication Credentials Invalid"));++ await expect(fns.runSecretChangeRequestSideEffects({ ...input, throwOnEmailFailure: true })).rejects.toThrow(+ "535 Authentication Credentials Invalid"+ );++ expect(deps.smtpService.sendMail).toHaveBeenCalledTimes(2);+ expect(deps.queueService.queue).toHaveBeenCalled();+ expect(deps.telemetryService.sendPostHogEvents).toHaveBeenCalled();+ });++ test("with throwOnEmailFailure, resolves when every email is delivered", async () => {+ const { fns } = buildFns({ approvers: twoMailableApprovers });++ await expect(+ fns.runSecretChangeRequestSideEffects({ ...input, throwOnEmailFailure: true })+ ).resolves.toBeUndefined();+ });});diff --git a/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-fns.ts b/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-fns.tsindex 70c52f4c3d..6e3df7e7b2 100644--- a/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-fns.ts+++ b/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-fns.ts@@ -84,6 +84,7 @@ export type TSecretChangeRequestSideEffectsDTO = {actorId: string;actorOrgId: string;tx?: Knex;+ throwOnEmailFailure?: boolean;};export type TSecretChangeGlobalRequestFnsFactory = ReturnType<typeof secretChangeGlobalRequestFnsFactory>;@@ -201,9 +202,9 @@ export const secretChangeGlobalRequestFnsFactory = ({}: Pick<TSecretChangeRequestSideEffectsDTO, "policy" | "tx"> & {requestId: string;projectId: string;- }) => {+ }): Promise<unknown[]> => {const approverUserIds = unique(policy.userApprovers.map((approver) => approver.userId));- if (!approverUserIds.length) return;+ if (!approverUserIds.length) return [];const approvers = await userDAL.find({ $in: { id: approverUserIds } }, { tx });const project = await projectDAL.findProjectWithOrg(projectId, tx);@@ -220,6 +221,7 @@ export const secretChangeGlobalRequestFnsFactory = ({})));+ const failures: unknown[] = [];for await (const approver of approvers) {if (!approver.email) continue;try {@@ -239,8 +241,11 @@ export const secretChangeGlobalRequestFnsFactory = ({error,`Failed to send secret change request email to approver [requestId=${requestId}] [userId=${approver.id}]`);+ failures.push(error);}}++ return failures;};const queueChangeRequestWebhook = async ({@@ -315,7 +320,8 @@ export const secretChangeGlobalRequestFnsFactory = ({actor,actorId,actorOrgId,- tx+ tx,+ throwOnEmailFailure}: TSecretChangeRequestSideEffectsDTO) => {const findUser = () => userDAL.findById(actorId, tx);const user =@@ -351,7 +357,12 @@ export const secretChangeGlobalRequestFnsFactory = ({}});- await $sendApproverNotifications({ policy, requestId: approvalRequest.id, projectId: project.id, tx });+ const emailFailures = await $sendApproverNotifications({+ policy,+ requestId: approvalRequest.id,+ projectId: project.id,+ tx+ });try {await queueChangeRequestWebhook({@@ -389,6 +400,8 @@ export const secretChangeGlobalRequestFnsFactory = ({}}).catch(() => {});++ if (throwOnEmailFailure && emailFailures.length) throw emailFailures[0];};return { resolveRequester, queueChangeRequestWebhook, runSecretChangeRequestSideEffects };diff --git a/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-service.ts b/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-service.tsindex 0e4eff22bf..b624e3aeb8 100644--- a/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-service.ts+++ b/backend/src/ee/services/secret-change-global-request-bridge/secret-change-global-request-bridge-service.ts@@ -575,7 +575,8 @@ export const secretChangeGlobalRequestBridgeServiceFactory = ({actor,actorId,actorOrgId,- tx+ tx,+ throwOnEmailFailure}) => {const { approvalRequest, secretChangeRequest } = await $findSecretChangeRequestOrThrow(secretApprovalRequest.id,@@ -597,7 +598,8 @@ export const secretChangeGlobalRequestBridgeServiceFactory = ({actor,actorId,actorOrgId,- tx+ tx,+ throwOnEmailFailure});};diff --git a/backend/src/services/external-migration/external-migration-queue.ts b/backend/src/services/external-migration/external-migration-queue.tsindex a5aa5870a6..b838cc48c7 100644--- a/backend/src/services/external-migration/external-migration-queue.ts+++ b/backend/src/services/external-migration/external-migration-queue.ts@@ -286,7 +286,8 @@ export const externalMigrationQueueFactory = ({secretKeys,actor,actorId,- actorOrgId+ actorOrgId,+ throwOnEmailFailure: true});} catch (error) {// rethrown so the job's retries apply: a reviewer who never hears about the request is worse than a