split webhook creation into two to avoid dangling webhooks

Isaiah-Turner · Isaiah-Turner · commit bf0acd71c1a5 · 2025-08-18T14:48:09.000-07:00
diff --git a/src/infrastructure/figma/figma-service.test.ts b/src/infrastructure/figma/figma-service.test.ts
@@ -31,6 +31,7 @@ import {
 } from './transformers';
 
 import { getConfig } from '../../config';
+import { FigmaFileWebhookEventType } from '../../domain/entities';
 import {
 	generateConnectUserInfo,
 	generateFigmaDesignIdentifier,
@@ -888,14 +889,14 @@ describe('FigmaService', () => {
 		});
 	});
 
-	describe('createFileContextWebhooks', () => {
+	describe('createWebhookForFile', () => {
 		beforeEach(() => {
 			jest
 				.spyOn(figmaAuthService, 'getCredentials')
 				.mockResolvedValue(MOCK_CREDENTIALS);
 		});
 
-		it('should create a FILE_UPDATE and DEV_MODE_STATUS_UPDATE webhook for a file', async () => {
+		it('should create a webhook for a file', async () => {
 			const fileUpdateWebhookId = uuidv4();
 			const devModeStatusUpdateWebhookId = uuidv4();
 
@@ -933,8 +934,16 @@ describe('FigmaService', () => {
 					description,
 				} as PostWebhookResponse);
 
-			await figmaService.createFileContextWebhooks(
+			await figmaService.createWebhookForFile(
 				fileKey,
+				FigmaFileWebhookEventType.FILE_UPDATE,
+				passcode,
+				MOCK_CONNECT_USER_INFO,
+			);
+
+			await figmaService.createWebhookForFile(
+				fileKey,
+				FigmaFileWebhookEventType.DEV_MODE_STATUS_UPDATE,
 				passcode,
 				MOCK_CONNECT_USER_INFO,
 			);
@@ -977,8 +986,9 @@ describe('FigmaService', () => {
 			);
 
 			await expect(() =>
-				figmaService.createFileContextWebhooks(
+				figmaService.createWebhookForFile(
 					teamId,
+					FigmaFileWebhookEventType.FILE_UPDATE,
 					connectInstallationSecret,
 					MOCK_CONNECT_USER_INFO,
 				),
@@ -995,8 +1005,9 @@ describe('FigmaService', () => {
 			jest.spyOn(figmaClient, 'createWebhook').mockRejectedValue(error);
 
 			await expect(() =>
-				figmaService.createFileContextWebhooks(
+				figmaService.createWebhookForFile(
 					teamId,
+					FigmaFileWebhookEventType.FILE_UPDATE,
 					connectInstallationSecret,
 					MOCK_CONNECT_USER_INFO,
 				),
@@ -1010,8 +1021,9 @@ describe('FigmaService', () => {
 			jest.spyOn(figmaClient, 'createWebhook').mockRejectedValue(expectedError);
 
 			await expect(() =>
-				figmaService.createFileContextWebhooks(
+				figmaService.createWebhookForFile(
 					teamId,
+					FigmaFileWebhookEventType.FILE_UPDATE,
 					connectInstallationSecret,
 					MOCK_CONNECT_USER_INFO,
 				),
diff --git a/src/infrastructure/figma/figma-service.ts b/src/infrastructure/figma/figma-service.ts
@@ -26,6 +26,7 @@ import type {
 	AtlassianDesign,
 	ConnectUserInfo,
 	FigmaDesignIdentifier,
+	FigmaFileWebhookEventType,
 	FigmaOAuth2UserCredentials,
 	FigmaUser,
 } from '../../domain/entities';
@@ -323,63 +324,45 @@ export class FigmaService {
 		});
 
 	/**
-	 * Creates a FILE_UPDATE webhook and a DEV_MODE_STATUS_UPDATE webhook for the provided file.
+	 * Creates a webhook of the specified event type for the provided file.
 	 * @throws {UnauthorizedFigmaServiceError} Not authorized to access Figma.
 	 * @throws {PaidPlanRequiredFigmaServiceError} A Figma paid plan is required to perform this operation.
 	 */
-	createFileContextWebhooks = async (
+	createWebhookForFile = async (
 		fileKey: string,
+		eventType: FigmaFileWebhookEventType,
 		passcode: string,
 		user: ConnectUserInfo,
-	): Promise<{
-		fileWebhook: PostWebhookResponse;
-		devModeStatusUpdateWebhook: PostWebhookResponse;
-	}> =>
-		this.withErrorTranslation(async () => {
-			const { accessToken } = await figmaAuthService.getCredentials(user);
-
-			const fileUpdateRequest: PostWebhookRequestBody = {
-				event_type: 'FILE_UPDATE',
-				context: 'file',
-				context_id: fileKey,
-				endpoint: buildAppUrl('figma/webhook').toString(),
-				passcode,
-				description: 'Figma for Jira Cloud',
-			};
-
-			const devModeStatusUpdateRequest: PostWebhookRequestBody = {
-				...fileUpdateRequest,
-				event_type: 'DEV_MODE_STATUS_UPDATE',
-			};
-
-			try {
-				const [fileWebhook, devModeStatusUpdateWebhook] = await Promise.all([
-					figmaClient.createWebhook(fileUpdateRequest, accessToken),
-					figmaClient.createWebhook(devModeStatusUpdateRequest, accessToken),
-				]);
-
-				return {
-					fileWebhook,
-					devModeStatusUpdateWebhook,
-				};
-			} catch (e: unknown) {
-				if (
-					e instanceof BadRequestHttpClientError &&
-					isOfSchema(e.response, ERROR_RESPONSE_SCHEMA)
-				) {
-					// Figma allows to create webhooks only on paid plans.
-					// See https://www.figma.com/pricing/.
-					if (e.response.message == 'Access Denied') {
-						throw new PaidPlanRequiredFigmaServiceError(
-							'A Figma paid plan is required to perform this operation.',
-							e,
-						);
-					}
+	): Promise<PostWebhookResponse> => {
+		const { accessToken } = await figmaAuthService.getCredentials(user);
+		const postWebhookRequest: PostWebhookRequestBody = {
+			event_type: eventType,
+			context: 'file',
+			context_id: fileKey,
+			endpoint: buildAppUrl('figma/webhook').toString(),
+			passcode,
+			description: 'Figma for Jira Cloud',
+		};
+		try {
+			return await figmaClient.createWebhook(postWebhookRequest, accessToken);
+		} catch (e: unknown) {
+			if (
+				e instanceof BadRequestHttpClientError &&
+				isOfSchema(e.response, ERROR_RESPONSE_SCHEMA)
+			) {
+				// Figma allows to create webhooks only on paid plans.
+				// See https://www.figma.com/pricing/.
+				if (e.response.message == 'Access Denied') {
+					throw new PaidPlanRequiredFigmaServiceError(
+						'A Figma paid plan is required to perform this operation.',
+						e,
+					);
 				}
-
-				throw e;
 			}
-		});
+
+			throw e;
+		}
+	};
 
 	/**
 	 * Tries to delete the given webhook.
diff --git a/src/infrastructure/repositories/figma-file-webhook-repository.ts b/src/infrastructure/repositories/figma-file-webhook-repository.ts
@@ -33,6 +33,32 @@ export class FigmaFileWebhookRepository {
 		return this.mapToFigmaFileWebhook(dbModel);
 	};
 
+	/**
+	 * @internal
+	 * Required for tests only.
+	 */
+	getAll = async (): Promise<FigmaFileWebhook[]> => {
+		const dbModels = await prismaClient.get().figmaFileWebhook.findMany();
+
+		return dbModels.map((dbModel) => this.mapToFigmaFileWebhook(dbModel));
+	};
+
+	findByFileKeyAndEventTypeAndConnectInstallationId = async (
+		fileKey: string,
+		eventType: FigmaFileWebhookEventType,
+		connectInstallationId: string,
+	): Promise<FigmaFileWebhook | null> => {
+		const dbModel = await prismaClient.get().figmaFileWebhook.findFirst({
+			where: {
+				fileKey,
+				eventType,
+				connectInstallationId: BigInt(connectInstallationId),
+			},
+		});
+
+		return dbModel ? this.mapToFigmaFileWebhook(dbModel) : null;
+	};
+
 	findManyByFileKeyAndConnectInstallationId = async (
 		fileKey: string,
 		connectInstallationId: string,
diff --git a/src/usecases/on-design-associated-with-issue-use-case.test.ts b/src/usecases/on-design-associated-with-issue-use-case.test.ts
@@ -83,20 +83,18 @@ describe('onDesignAssociatedWithIssueUseCase', () => {
 		jest
 			.spyOn(
 				figmaFileWebhookRepository,
-				'findManyByFileKeyAndConnectInstallationId',
+				'findByFileKeyAndEventTypeAndConnectInstallationId',
 			)
-			.mockResolvedValue([]);
+			.mockResolvedValue(null);
 		const fileWebhook = generateWebhookV2(figmaDesignId.fileKey, 'FILE_UPDATE');
 		const devModeStatusUpdateWebhook = generateWebhookV2(
 			figmaDesignId.fileKey,
 			'DEV_MODE_STATUS_UPDATE',
 		);
-		const createFileContextWebhooksMock = jest
-			.spyOn(figmaService, 'createFileContextWebhooks')
-			.mockResolvedValue({
-				fileWebhook,
-				devModeStatusUpdateWebhook,
-			});
+		const createWebhookForFileMock = jest
+			.spyOn(figmaService, 'createWebhookForFile')
+			.mockResolvedValueOnce(fileWebhook)
+			.mockResolvedValueOnce(devModeStatusUpdateWebhook);
 		jest
 			.spyOn(figmaFileWebhookRepository, 'upsert')
 			.mockResolvedValue({} as FigmaFileWebhook);
@@ -118,39 +116,64 @@ describe('onDesignAssociatedWithIssueUseCase', () => {
 			connectInstallation: params.connectInstallation,
 		});
 		expect(
-			figmaFileWebhookRepository.findManyByFileKeyAndConnectInstallationId,
+			figmaFileWebhookRepository.findByFileKeyAndEventTypeAndConnectInstallationId,
 		).toHaveBeenCalledWith(
 			figmaDesignId.fileKey,
+			'FILE_UPDATE',
 			params.connectInstallation.id,
 		);
-		expect(figmaService.createFileContextWebhooks).toHaveBeenCalledWith(
+		expect(
+			figmaFileWebhookRepository.findByFileKeyAndEventTypeAndConnectInstallationId,
+		).toHaveBeenCalledWith(
+			figmaDesignId.fileKey,
+			'DEV_MODE_STATUS_UPDATE',
+			params.connectInstallation.id,
+		);
+		expect(figmaService.createWebhookForFile).toHaveBeenCalledWith(
+			figmaDesignId.fileKey,
+			'FILE_UPDATE',
+			expect.any(String),
+			{
+				connectInstallationId: params.connectInstallation.id,
+				atlassianUserId: params.atlassianUserId,
+			},
+		);
+		expect(figmaService.createWebhookForFile).toHaveBeenCalledWith(
 			figmaDesignId.fileKey,
+			'DEV_MODE_STATUS_UPDATE',
 			expect.any(String),
 			{
 				connectInstallationId: params.connectInstallation.id,
 				atlassianUserId: params.atlassianUserId,
 			},
 		);
 
-		const passcode = createFileContextWebhooksMock.mock.calls[0][1];
+		const passcode = createWebhookForFileMock.mock.calls[0][2];
 		expect(figmaFileWebhookRepository.upsert).toHaveBeenNthCalledWith(
 			1,
 			expect.objectContaining({
 				webhookId: fileWebhook.id,
-				webhookPasscode: passcode,
-				connectInstallationId: params.connectInstallation.id,
-				creatorAtlassianUserId: params.atlassianUserId,
+				fileKey: figmaDesignId.fileKey,
 				eventType: 'FILE_UPDATE',
+				webhookPasscode: passcode,
+				createdBy: {
+					connectInstallationId: params.connectInstallation.id,
+					atlassianUserId: params.atlassianUserId,
+				},
 			}),
 		);
+		const secondPasscode = createWebhookForFileMock.mock.calls[1][2];
 		expect(figmaFileWebhookRepository.upsert).toHaveBeenNthCalledWith(
 			2,
 			expect.objectContaining({
 				webhookId: devModeStatusUpdateWebhook.id,
-				webhookPasscode: passcode,
-				connectInstallationId: params.connectInstallation.id,
-				creatorAtlassianUserId: params.atlassianUserId,
+				fileKey: figmaDesignId.fileKey,
 				eventType: 'DEV_MODE_STATUS_UPDATE',
+				webhookPasscode: secondPasscode,
+				createdBy: {
+					connectInstallationId: params.connectInstallation.id,
+					atlassianUserId: params.atlassianUserId,
+				},
 			}),
 		);
 	});
@@ -188,22 +211,30 @@ describe('onDesignAssociatedWithIssueUseCase', () => {
 		jest
 			.spyOn(
 				figmaFileWebhookRepository,
-				'findManyByFileKeyAndConnectInstallationId',
+				'findByFileKeyAndEventTypeAndConnectInstallationId',
 			)
-			.mockResolvedValue([fileWebhook, devModeStatusUpdateWebhook]);
-
-		jest.spyOn(figmaService, 'createFileContextWebhooks');
+			.mockResolvedValueOnce(fileWebhook)
+			.mockResolvedValueOnce(devModeStatusUpdateWebhook);
+		jest.spyOn(figmaService, 'createWebhookForFile');
 		jest.spyOn(figmaFileWebhookRepository, 'upsert');
 
 		await onDesignAssociatedWithIssueUseCaseParams.execute(params);
 
 		expect(
-			figmaFileWebhookRepository.findManyByFileKeyAndConnectInstallationId,
+			figmaFileWebhookRepository.findByFileKeyAndEventTypeAndConnectInstallationId,
 		).toHaveBeenCalledWith(
 			figmaDesignId.fileKey,
+			'FILE_UPDATE',
+			params.connectInstallation.id,
+		);
+		expect(
+			figmaFileWebhookRepository.findByFileKeyAndEventTypeAndConnectInstallationId,
+		).toHaveBeenCalledWith(
+			figmaDesignId.fileKey,
+			'DEV_MODE_STATUS_UPDATE',
 			params.connectInstallation.id,
 		);
-		expect(figmaService.createFileContextWebhooks).toHaveBeenCalledTimes(0);
+		expect(figmaService.createWebhookForFile).toHaveBeenCalledTimes(0);
 		expect(figmaFileWebhookRepository.upsert).toHaveBeenCalledTimes(0);
 	});
 
diff --git a/src/usecases/on-design-associated-with-issue-use-case.ts b/src/usecases/on-design-associated-with-issue-use-case.ts
diff --git a/src/web/routes/entities-v2/integration.test.ts b/src/web/routes/entities-v2/integration.test.ts
