refactor: sends the expected message to StreamLabs

Author: SantiMA10

src/reactions/gitlab/merge-request-opened.ts

@@ -1,26 +1,25 @@
 import { Config } from '../../config';
 import { Reaction, ReactionCanHandleOptions, ReactionHandleOptions } from '../github/reaction';
+import { MergeRequestPayload } from '../../schemas/gitlab/merge-request-payload';
 
-type Payload = any;
-
-export class MergeRequestOpened extends Reaction<Payload> {
-	getStreamLabsMessage({ payload }: ReactionHandleOptions<Payload>): string {
+export class MergeRequestOpened extends Reaction<MergeRequestPayload> {
+	getStreamLabsMessage({ payload }: ReactionHandleOptions<MergeRequestPayload>): string {
 		return `*${payload.user.username}* just opened a merge request in *${payload.repository.name}*`;
 	}
 
-	getTwitchChatMessage({ payload }: ReactionHandleOptions<Payload>): string {
+	getTwitchChatMessage({ payload }: ReactionHandleOptions<MergeRequestPayload>): string {
 		return `${payload.user.username} just opened a merge request in ${payload.repository.homepage}`;
 	}
 
-	canHandle({ payload, event, config }: ReactionCanHandleOptions<Payload>): boolean {
+	canHandle({ payload, event, config }: ReactionCanHandleOptions<MergeRequestPayload>): boolean {
 		return (
 			event === 'Merge Request Hook' &&
 			payload.object_attributes.state === 'opened' &&
 			this.isAllowedByConfig(config, payload)
 		);
 	}
 
-	private isAllowedByConfig(config: Config | undefined, payload: Payload): boolean {
+	private isAllowedByConfig(config: Config | undefined, payload: MergeRequestPayload): boolean {
 		return (
 			!config ||
 			!config.IGNORE_PR_OPENED_BY.includes(payload.user.username) ||

src/schemas/gitlab/merge-request-payload.ts

@@ -0,0 +1,18 @@
+type url = string;
+
+export interface MergeRequestPayload {
+	user: {
+		name: string;
+		username: string;
+		avatar_url: url;
+	};
+	repository: {
+		name: string;
+		url: url;
+		description: string;
+		homepage: url;
+	};
+	object_attributes: {
+		state: 'merged' | 'created' | 'updated' | 'closed' | 'opened';
+	};
+}

test/reactions/gitlab/merge-request-opened.spec.ts

@@ -2,6 +2,7 @@ import { StreamLabsMock } from '../../__mocks__/StreamLabs';
 import { TwitchChatMock } from '../../__mocks__/TwitchChat';
 import { MergeRequestOpened } from '../../../src/reactions/gitlab/merge-request-opened';
 import { Config } from '../../../src/config';
+import { MergeRequestPayload } from '../../../src/schemas/gitlab/merge-request-payload';
 
 describe('MergeRequestOpened', () => {
 	const twitchChat = new TwitchChatMock();
@@ -19,7 +20,7 @@ describe('MergeRequestOpened', () => {
 
 			const result = subject.canHandle({
 				event: 'Merge Request Hook',
-				payload: { object_attributes: { state: 'opened' } },
+				payload: { object_attributes: { state: 'opened' } } as MergeRequestPayload,
 			});
 
 			expect(result).toEqual(true);
@@ -30,7 +31,7 @@ describe('MergeRequestOpened', () => {
 
 			const result = subject.canHandle({
 				event: 'Fork',
-				payload: { object_attributes: { state: 'opened' } },
+				payload: { object_attributes: { state: 'opened' } } as MergeRequestPayload,
 			});
 
 			expect(result).toEqual(false);
@@ -41,7 +42,7 @@ describe('MergeRequestOpened', () => {
 
 			const result = subject.canHandle({
 				event: 'Merge Request Hook',
-				payload: { object_attributes: { state: 'merged' } },
+				payload: { object_attributes: { state: 'merged' } } as MergeRequestPayload,
 			});
 
 			expect(result).toEqual(false);
@@ -52,7 +53,10 @@ describe('MergeRequestOpened', () => {
 
 			const result = subject.canHandle({
 				event: 'Merge Request Hook',
-				payload: { object_attributes: { state: 'opened' }, user: { username: 'SantiMA10' } },
+				payload: {
+					object_attributes: { state: 'opened' },
+					user: { username: 'SantiMA10' },
+				} as MergeRequestPayload,
 				config: { IGNORE_PR_OPENED_BY: ['SantiMA10'] } as Config,
 			});
 
@@ -64,7 +68,10 @@ describe('MergeRequestOpened', () => {
 
 			const result = subject.canHandle({
 				event: 'Merge Request Hook',
-				payload: { object_attributes: { state: 'opened' }, user: { username: 'SantiMA10' } },
+				payload: {
+					object_attributes: { state: 'opened' },
+					user: { username: 'SantiMA10' },
+				} as MergeRequestPayload,
 				config: { IGNORE_PR_OPENED_BY: [] as string[] } as Config,
 			});
 
@@ -79,7 +86,7 @@ describe('MergeRequestOpened', () => {
 				object_attributes: { state: 'opened' },
 				user: { username: 'SantiMA10' },
 				repository: { homepage: 'https://gitlab.com/streamlabs/webhook' },
-			};
+			} as MergeRequestPayload;
 
 			const { twitchChat: response } = await subject.handle({ payload });
 
@@ -94,7 +101,7 @@ describe('MergeRequestOpened', () => {
 			const payload = {
 				user: { username: 'SantiMA10' },
 				repository: { name: 'streamdevs/webhook' },
-			};
+			} as MergeRequestPayload;
 
 			const { streamlabs: response } = await subject.handle({ payload });