refactor: 타입 개선

Author: six-standard

src/controllers/__test__/webhook.controller.test.ts

@@ -2,7 +2,6 @@ import 'reflect-metadata';
 import { Request, Response } from 'express';
 import { WebhookController } from '@/controllers/webhook.controller';
 import { sendSlackMessage } from '@/modules/slack/slack.notifier';
-import { SentryWebhookData } from '@/types';
 
 // Mock dependencies
 jest.mock('@/modules/slack/slack.notifier');
@@ -44,15 +43,16 @@ describe('WebhookController', () => {
   });
 
   describe('handleSentryWebhook', () => {
-    const mockSentryData: SentryWebhookData = {
+    // 실제 동작에 필요한 필수 값만 사용하도록 타입 미적용
+    const mockSentryData = {
       action: 'created',
       data: {
         issue: {
           id: 'test-issue-123',
           title: '테스트 오류입니다',
           culprit: 'TestFile.js:10',
           status: 'unresolved',
-          count: 5,
+          count: "5",
           userCount: 3,
           firstSeen: '2024-01-01T12:00:00.000Z',
           permalink: 'https://velog-dashboardv2.sentry.io/issues/test-issue-123/',
@@ -179,6 +179,61 @@ describe('WebhookController', () => {
       );
     });
 
+    it('assigned 액션에 대해 올바른 메시지를 생성해야 한다', async () => {
+      const assignedData = {
+        ...mockSentryData,
+        action: 'assigned' as const,
+        data: {
+          ...mockSentryData.data,
+          issue: {
+            ...mockSentryData.data.issue,
+            status: 'unresolved' as const
+          }
+        }
+      };
+      mockRequest.body = assignedData;
+      mockSendSlackMessage.mockResolvedValue();
+
+      await webhookController.handleSentryWebhook(
+        mockRequest as Request,
+        mockResponse as Response,
+        nextFunction
+      );
+
+      expect(mockSendSlackMessage).toHaveBeenCalledWith(
+        expect.stringContaining('🚨 *오류가 할당되었습니다*')
+      );
+    });
+
+    it('archived 액션에 대해 올바른 메시지를 생성해야 한다', async () => {
+      const archivedData = {
+        ...mockSentryData,
+        action: 'archived' as const,
+        data: {
+          ...mockSentryData.data,
+          issue: {
+            ...mockSentryData.data.issue,
+            status: 'archived' as const
+          }
+        }
+      };
+      mockRequest.body = archivedData;
+      mockSendSlackMessage.mockResolvedValue();
+
+      await webhookController.handleSentryWebhook(
+        mockRequest as Request,
+        mockResponse as Response,
+        nextFunction
+      );
+
+      expect(mockSendSlackMessage).toHaveBeenCalledWith(
+        expect.stringContaining('🚨 *오류가 아카이브되었습니다*')
+      );
+      expect(mockSendSlackMessage).toHaveBeenCalledWith(
+        expect.stringContaining('📦 *제목:*')
+      );
+    });
+
     it('알 수 없는 액션에 대해 기본 메시지를 생성해야 한다', async () => {
       const unknownActionData = {
         ...mockSentryData,
@@ -281,15 +336,16 @@ describe('WebhookController', () => {
 
   describe('formatSentryMessage (private method integration test)', () => {
     it('완전한 Sentry 데이터로 올바른 형식의 메시지를 생성해야 한다', async () => {
-      const completeData: SentryWebhookData = {
+      // 실제 동작에 필요한 필수 값만 사용하도록 타입 미적용
+      const completeData = {
         action: 'created',
         data: {
           issue: {
             id: 'issue-456',
             title: 'TypeError: Cannot read property of undefined',
             culprit: 'components/UserProfile.tsx:25',
             status: 'unresolved',
-            count: 12,
+            count: "12",
             userCount: 8,
             firstSeen: '2024-01-15T14:30:00.000Z',
             permalink: 'https://velog-dashboardv2.sentry.io/issues/issue-456/',

src/types/models/Sentry.type.ts

@@ -1,6 +1,5 @@
 export type SentryIssueStatus = 'resolved' | 'unresolved' | 'ignored';
-
-export type SentryAction = 'created' | 'resolved' | 'unresolved' | 'ignored';
+export type SentryIssueSubStatus = "archived_until_escalating" | "archived_until_condition_met" | "archived_forever" | "escalating" | "ongoing" | "regressed" | "new"
 
 export interface SentryProject {
   id: string;
@@ -9,23 +8,66 @@ export interface SentryProject {
   platform?: string;
 }
 
+export interface SentryMetadata {
+  filename: string;
+  type: string;
+  value: string;
+}
+
+export interface SentryIssueStatusDetails {
+  inRelease: string;
+  inNextRelease: boolean;
+  inCommit: string;
+  ignoreCount: string;
+  ignoreWindow: string;
+}
+
 export interface SentryIssue {
+  url?: string;
+  web_url?: string;
+  project_url?: string;
   id: string;
+  shareId?: string | null;
+  shortId: string;
   title: string;
-  culprit?: string;
-  status?: SentryIssueStatus;
-  count: number;
+  culprit: string;
+  permalink?: string | null;
+  logger?: string | null;
+  level: string;
+  status: SentryIssueStatus;
+  statusDetails?: SentryIssueStatusDetails;
+  substatus: SentryIssueSubStatus;
+  isPublic: boolean;
+  platform: string;
+  project: SentryProject;
+  type: string;
+  metadata?: SentryMetadata;
+  numComments: number;
+  assignedTo?: string | null;
+  isBookmarked: boolean;
+  isSubscribed: boolean;
+  subscriptionDetails?: string | null;
+  hasSeen: boolean;
+  annotations: [];
+  issueType: string;
+  issueCategory: string;
+  priority: string;
+  priorityLockedAt?: string | null;
+  seerFixabilityScore?: string | null;
+  seerAutofixLastTriggered?: string | null;
+  isUnhandled: boolean;
+  count: string;
   userCount: number;
   firstSeen: string;
-  lastSeen?: string;
-  project?: SentryProject;
-  permalink?: string;
+  lastSeen: string;
 }
 
+// 무조건 오류 생성(created) 메세지만 받도록 해 두었기 때문에, 무조건 해당 타입의 형태로 넘어옵니다
+// 참고: https://docs.sentry.io/organization/integrations/integration-platform/webhooks/issues/
 export interface SentryWebhookData {
-  action: SentryAction;
+  action: 'created';
+  installation: { uuid: string };
   data: {
     issue: SentryIssue;
-    project?: SentryProject;
   };
 }