-
Notifications
You must be signed in to change notification settings - Fork 0
[TASK-178 / 25.06.27] Feature - 센트리 슬랙 웹훅 연동 #38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
d786e46
feature: 센트리 Slack 알림 기능 통합
six-standard 9d11a69
refactor: 쓸모없는 Slack 라우터 제거
six-standard 635b18f
refactor: 코드 및 기능 단순화
six-standard 538c57e
fix: 잘못 커밋된 개발환경 세팅 수정
six-standard 37f8b31
refactor: 타입 개선
six-standard 9db3759
refactor: 필요없는 코드 정리 및 로직 개선
six-standard 19bc8fb
refactor: 필수 값이 없을 경우의 테스트 제거
six-standard 81785ad
refactor: 은다님 제안 반영
six-standard fe71429
refactor: 타입 맞춤
six-standard 5002eff
fix: 오류가 발생할 수 있는 경우 제거
six-standard 3c38b63
refactor: 잘못된 설정값 제거
six-standard 4d46adb
refactor: 오류 처리 개선
six-standard fc761ac
refactor: 참조 링크 위치 개선
six-standard 424607c
fix: 정리되었으나 놓쳐진 코드 제거
six-standard 7db5b02
refactor: invalid body 관련 테스트 추가
six-standard File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Invalid Body값에 대한 실패 케이스 테스트가 없는 것 같네요! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 반영했습니다! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,325 @@ | ||
| 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'); | ||
|
|
||
| // logger 모킹 | ||
| jest.mock('@/configs/logger.config', () => ({ | ||
| error: jest.fn(), | ||
| info: jest.fn(), | ||
| })); | ||
|
|
||
| describe('WebhookController', () => { | ||
| let webhookController: WebhookController; | ||
| let mockRequest: Partial<Request>; | ||
| let mockResponse: Partial<Response>; | ||
| let nextFunction: jest.Mock; | ||
| let mockSendSlackMessage: jest.MockedFunction<typeof sendSlackMessage>; | ||
|
|
||
| beforeEach(() => { | ||
| // WebhookController 인스턴스 생성 | ||
| webhookController = new WebhookController(); | ||
|
|
||
| // Request, Response, NextFunction 모킹 | ||
| mockRequest = { | ||
| body: {}, | ||
| headers: {}, | ||
| }; | ||
|
|
||
| mockResponse = { | ||
| json: jest.fn().mockReturnThis(), | ||
| status: jest.fn().mockReturnThis(), | ||
| }; | ||
|
|
||
| nextFunction = jest.fn(); | ||
| mockSendSlackMessage = sendSlackMessage as jest.MockedFunction<typeof sendSlackMessage>; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| jest.clearAllMocks(); | ||
| }); | ||
|
|
||
| describe('handleSentryWebhook', () => { | ||
| const mockSentryData: SentryWebhookData = { | ||
| action: 'created', | ||
| data: { | ||
| issue: { | ||
| id: 'test-issue-123', | ||
| title: '테스트 오류입니다', | ||
| culprit: 'TestFile.js:10', | ||
| status: 'unresolved', | ||
| count: 5, | ||
| userCount: 3, | ||
| firstSeen: '2024-01-01T12:00:00.000Z', | ||
| permalink: 'https://velog-dashboardv2.sentry.io/issues/test-issue-123/', | ||
| project: { | ||
| id: 'project-123', | ||
| name: 'Velog Dashboard', | ||
| slug: 'velog-dashboard' | ||
| } | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| it('유효한 Sentry 웹훅 데이터로 처리에 성공해야 한다', async () => { | ||
| mockRequest.body = mockSentryData; | ||
| mockSendSlackMessage.mockResolvedValue(); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('🚨 *새로운 오류가 발생했습니다*') | ||
| ); | ||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('🔴 *제목:* 테스트 오류입니다') | ||
| ); | ||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('📍 *위치:* TestFile.js:10') | ||
| ); | ||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('🔗 *상세 보기:* https://velog-dashboardv2.sentry.io/issues/test-issue-123/') | ||
| ); | ||
| expect(mockResponse.status).toHaveBeenCalledWith(200); | ||
| expect(mockResponse.json).toHaveBeenCalledWith({ | ||
| success: true, | ||
| message: 'Sentry 웹훅 처리에 성공하였습니다.', | ||
| data: {}, | ||
| error: null | ||
| }); | ||
| }); | ||
|
|
||
| it('permalink가 없는 경우 기본 URL 패턴을 사용해야 한다', async () => { | ||
| const dataWithoutPermalink = { | ||
| ...mockSentryData, | ||
| data: { | ||
| ...mockSentryData.data, | ||
| issue: { | ||
| ...mockSentryData.data.issue, | ||
| permalink: undefined | ||
| } | ||
| } | ||
| }; | ||
| mockRequest.body = dataWithoutPermalink; | ||
| mockSendSlackMessage.mockResolvedValue(); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('🔗 *상세 보기:* https://velog-dashboardv2.sentry.io/issues/test-issue-123/') | ||
| ); | ||
| }); | ||
|
|
||
| it('resolved 액션에 대해 올바른 메시지를 생성해야 한다', async () => { | ||
| const resolvedData = { | ||
| ...mockSentryData, | ||
| action: 'resolved' as const, | ||
| data: { | ||
| ...mockSentryData.data, | ||
| issue: { | ||
| ...mockSentryData.data.issue, | ||
| status: 'resolved' as const | ||
| } | ||
| } | ||
| }; | ||
| mockRequest.body = resolvedData; | ||
| mockSendSlackMessage.mockResolvedValue(); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('🚨 *오류가 해결되었습니다*') | ||
| ); | ||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('✅ *제목:*') | ||
| ); | ||
| }); | ||
|
|
||
| it('ignored 액션에 대해 올바른 메시지를 생성해야 한다', async () => { | ||
| const ignoredData = { | ||
| ...mockSentryData, | ||
| action: 'ignored' as const, | ||
| data: { | ||
| ...mockSentryData.data, | ||
| issue: { | ||
| ...mockSentryData.data.issue, | ||
| status: 'ignored' as const | ||
| } | ||
| } | ||
| }; | ||
| mockRequest.body = ignoredData; | ||
| 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, | ||
| action: 'unknown_action' as 'created' | ||
| }; | ||
| mockRequest.body = unknownActionData; | ||
| mockSendSlackMessage.mockResolvedValue(); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('오류 이벤트: unknown_action') | ||
| ); | ||
| }); | ||
|
|
||
| it('알 수 없는 상태에 대해 기본 이모지를 사용해야 한다', async () => { | ||
| const unknownStatusData = { | ||
| ...mockSentryData, | ||
| data: { | ||
| ...mockSentryData.data, | ||
| issue: { | ||
| ...mockSentryData.data.issue, | ||
| status: 'unknown_status' as 'unresolved' | ||
| } | ||
| } | ||
| }; | ||
| mockRequest.body = unknownStatusData; | ||
| mockSendSlackMessage.mockResolvedValue(); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('❓ *제목:*') | ||
| ); | ||
| }); | ||
|
|
||
| it('Slack 메시지 전송 실패 시 에러를 전달해야 한다', async () => { | ||
| mockRequest.body = mockSentryData; | ||
| const slackError = new Error('Slack 전송 실패'); | ||
| mockSendSlackMessage.mockRejectedValue(slackError); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| expect(nextFunction).toHaveBeenCalledWith(slackError); | ||
| expect(mockResponse.json).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('빈 body로 요청 시에도 처리해야 한다', async () => { | ||
six-standard marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| mockRequest.body = {}; | ||
| mockSendSlackMessage.mockResolvedValue(); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| // undefined 값들에 대해서도 처리되어야 함 | ||
| expect(mockSendSlackMessage).toHaveBeenCalled(); | ||
| expect(mockResponse.status).toHaveBeenCalledWith(200); | ||
| }); | ||
|
|
||
| it('필수 필드가 없는 경우에도 처리해야 한다', async () => { | ||
| const incompleteData = { | ||
| action: 'created', | ||
| data: { | ||
| issue: { | ||
| id: 'test-123' | ||
| // title, culprit 등 누락 | ||
| } | ||
| } | ||
| }; | ||
| mockRequest.body = incompleteData; | ||
| mockSendSlackMessage.mockResolvedValue(); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| expect(mockSendSlackMessage).toHaveBeenCalledWith( | ||
| expect.stringContaining('🔗 *상세 보기:* https://velog-dashboardv2.sentry.io/issues/test-123/') | ||
| ); | ||
| expect(mockResponse.status).toHaveBeenCalledWith(200); | ||
| }); | ||
| }); | ||
|
|
||
| describe('formatSentryMessage (private method integration test)', () => { | ||
| it('완전한 Sentry 데이터로 올바른 형식의 메시지를 생성해야 한다', async () => { | ||
| const completeData: SentryWebhookData = { | ||
| action: 'created', | ||
| data: { | ||
| issue: { | ||
| id: 'issue-456', | ||
| title: 'TypeError: Cannot read property of undefined', | ||
| culprit: 'components/UserProfile.tsx:25', | ||
| status: 'unresolved', | ||
| count: 12, | ||
| userCount: 8, | ||
| firstSeen: '2024-01-15T14:30:00.000Z', | ||
| permalink: 'https://velog-dashboardv2.sentry.io/issues/issue-456/', | ||
| project: { | ||
| id: 'proj-789', | ||
| name: 'Velog Dashboard V2', | ||
| slug: 'velog-dashboard-v2' | ||
| } | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| mockRequest.body = completeData; | ||
| mockSendSlackMessage.mockResolvedValue(); | ||
|
|
||
| await webhookController.handleSentryWebhook( | ||
| mockRequest as Request, | ||
| mockResponse as Response, | ||
| nextFunction | ||
| ); | ||
|
|
||
| const expectedMessage = `🚨 *새로운 오류가 발생했습니다* | ||
| 🔴 *제목:* TypeError: Cannot read property of undefined | ||
| 📍 *위치:* components/UserProfile.tsx:25 | ||
| 🔗 *상세 보기:* https://velog-dashboardv2.sentry.io/issues/issue-456/`; | ||
|
|
||
| expect(mockSendSlackMessage).toHaveBeenCalledWith(expectedMessage); | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.