Merge pull request #148 from streamdevs/61-release-created

feat: Implement ReleaseCreated

Author: orestes

src/reactions/github/index.ts

@@ -10,6 +10,7 @@ import { Star } from './star';
 import { CheckRun } from './check-run';
 import { IssueAssigned } from './issue-assigned';
 import { SponsorshipCreated } from './sponsorship-created';
+import { ReleaseCreated } from './release-created';
 
 export {
 	Fork,
@@ -39,5 +40,6 @@ export const reactionBuild = ({
 		new IssueOpened(twitchChat, streamlabs),
 		new IssueAssigned(twitchChat, streamlabs),
 		new SponsorshipCreated(twitchChat, streamlabs),
+		new ReleaseCreated(twitchChat, streamlabs),
 	];
 };

src/reactions/github/ping.ts

@@ -3,7 +3,15 @@ import { PingPayload } from '../../schemas/github/ping-payload';
 
 export class Ping extends Reaction<PingPayload> {
 	canHandle({ payload, event }: ReactionCanHandleOptions<PingPayload>): boolean {
-		const compatibleEvents = ['star', 'fork', 'pull_request', 'issues', 'check_run', 'sponsorship'];
+		const compatibleEvents = [
+			'star',
+			'fork',
+			'pull_request',
+			'issues',
+			'check_run',
+			'sponsorship',
+			'release',
+		];
 
 		return (
 			event === 'ping' &&

src/reactions/github/release-created.ts

@@ -0,0 +1,26 @@
+import { Reaction, ReactionCanHandleOptions, ReactionHandleOptions } from './reaction';
+import { ReleaseCreatedPayload } from '../../schemas/github/release-created-payload';
+
+export class ReleaseCreated extends Reaction<ReleaseCreatedPayload> {
+	canHandle({ payload, event }: ReactionCanHandleOptions<ReleaseCreatedPayload>): boolean {
+		return event === 'release' && payload.action === 'published';
+	}
+
+	getStreamLabsMessage({ payload }: ReactionHandleOptions<ReleaseCreatedPayload>): string {
+		const {
+			repository: { full_name: repositoryFullName },
+			release: { tag_name: releaseName },
+		} = payload;
+
+		return `*${repositoryFullName}* version *${releaseName}* has just been released 🚀!`;
+	}
+
+	getTwitchChatMessage({ payload }: ReactionHandleOptions<ReleaseCreatedPayload>): string {
+		const {
+			repository: { full_name: repositoryFullName },
+			release: { tag_name: releaseName, html_url: releaseUrl },
+		} = payload;
+
+		return `${repositoryFullName} version ${releaseName} has just been released 🚀! Check it out ${releaseUrl}`;
+	}
+}

src/schemas/github/release-created-payload.ts

@@ -0,0 +1,9 @@
+import { RepositoryWebhookPayload } from './repository-webhook-payload';
+
+export interface ReleaseCreatedPayload extends RepositoryWebhookPayload {
+	action: 'unpublished' | 'published' | 'created' | 'edited' | 'deleted' | 'prereleased';
+	release: {
+		html_url: string;
+		tag_name: string;
+	};
+}

test/builders/release-created-payload-builder.spec.ts

@@ -0,0 +1,29 @@
+import { ReleaseCreatedPayloadBuilder } from './release-created-payload-builder';
+import { ReleaseCreatedPayload } from '../../src/schemas/github/release-created-payload';
+
+describe('ReleasePayloadBuilder', () => {
+	describe('#constructor', () => {
+		it('instantiates a builder with a default valid payload', () => {
+			const subject = new ReleaseCreatedPayloadBuilder();
+
+			expect(subject.getInstance()).toBeTruthy();
+		});
+	});
+
+	describe('#with', () => {
+		it('merges values correctly', () => {
+			const subject = new ReleaseCreatedPayloadBuilder().with({
+				repository: { html_url: 'hello' },
+			} as Partial<ReleaseCreatedPayload>);
+
+			expect(subject.getInstance()).toEqual(
+				expect.objectContaining({
+					repository: {
+						html_url: 'hello',
+						full_name: 'streamdevs/webhook',
+					},
+				}),
+			);
+		});
+	});
+});

test/builders/release-created-payload-builder.ts

@@ -0,0 +1,29 @@
+import { ReleaseCreatedPayload } from '../../src/schemas/github/release-created-payload';
+import { merge } from 'lodash';
+
+export class ReleaseCreatedPayloadBuilder {
+	private payload: ReleaseCreatedPayload = {
+		sender: {
+			login: 'orestes',
+		},
+		repository: {
+			full_name: 'streamdevs/webhook',
+			html_url: 'http://github.com/streamdevs/webhook',
+		},
+		action: 'created',
+		release: {
+			tag_name: '1.0.0',
+			html_url: 'http://github.com/streamdevs/webhook/releases/1.0.0',
+		},
+	};
+
+	getInstance(): ReleaseCreatedPayload {
+		return this.payload;
+	}
+
+	with(values: Partial<ReleaseCreatedPayload>): ReleaseCreatedPayloadBuilder {
+		this.payload = merge(this.payload, values);
+
+		return this;
+	}
+}

test/reactions/github/release-created.spec.ts

@@ -0,0 +1,70 @@
+import { ReleaseCreated } from '../../../src/reactions/github/release-created';
+import { TwitchChatMock } from '../../__mocks__/TwitchChat';
+import { StreamLabsMock } from '../../__mocks__/StreamLabs';
+import { ReleaseCreatedPayload } from '../../../src/schemas/github/release-created-payload';
+import { ReleaseCreatedPayloadBuilder } from '../../builders/release-created-payload-builder';
+
+describe('ReleaseCreated', () => {
+	let twitchChat: TwitchChatMock;
+	let streamLabs: StreamLabsMock;
+
+	beforeEach(() => {
+		twitchChat = new TwitchChatMock();
+		streamLabs = new StreamLabsMock();
+	});
+
+	describe('#canHandle', () => {
+		it('returns false when the event is not release', () => {
+			const subject = new ReleaseCreated(twitchChat, streamLabs);
+			const event = 'star';
+
+			const payload: ReleaseCreatedPayload = {} as ReleaseCreatedPayload;
+
+			expect(subject.canHandle({ payload, event })).toEqual(false);
+		});
+		it('returns false when the release is not published', () => {
+			const subject = new ReleaseCreated(twitchChat, streamLabs);
+			const event = 'release';
+
+			const payload = new ReleaseCreatedPayloadBuilder().with({ action: 'created' }).getInstance();
+
+			expect(subject.canHandle({ payload, event })).toEqual(false);
+		});
+		it('returns true when the release is published', () => {
+			const subject = new ReleaseCreated(twitchChat, streamLabs);
+			const event = 'release';
+
+			const payload = new ReleaseCreatedPayloadBuilder()
+				.with({ action: 'published' })
+				.getInstance();
+
+			expect(subject.canHandle({ payload, event })).toEqual(true);
+		});
+	});
+
+	describe('#getTwitchChatMessage', () => {
+		it('returns the expected message', () => {
+			const subject = new ReleaseCreated(twitchChat, streamLabs);
+			const payload = new ReleaseCreatedPayloadBuilder()
+				.with({ action: 'published' })
+				.getInstance();
+
+			expect(subject.getTwitchChatMessage({ payload })).toEqual(
+				`streamdevs/webhook version 1.0.0 has just been released 🚀! Check it out http://github.com/streamdevs/webhook/releases/1.0.0`,
+			);
+		});
+	});
+
+	describe('#getStreamLabsMessage', () => {
+		it('returns the expected message', () => {
+			const subject = new ReleaseCreated(twitchChat, streamLabs);
+			const payload = new ReleaseCreatedPayloadBuilder()
+				.with({ action: 'published' })
+				.getInstance();
+
+			expect(subject.getStreamLabsMessage({ payload })).toEqual(
+				`*streamdevs/webhook* version *1.0.0* has just been released 🚀!`,
+			);
+		});
+	});
+});

test/routes/github/release-created.spec.ts

@@ -0,0 +1,52 @@
+import { initServer } from '../../../src/server';
+import { getConfig } from '../../../src/config';
+import { StreamLabs } from '../../../src/services/StreamLabs';
+import { TwitchChat } from '../../../src/services/TwitchChat';
+import { ReleaseCreatedPayloadBuilder } from '../../builders/release-created-payload-builder';
+import { ReleaseCreatedPayload } from '../../../src/schemas/github/release-created-payload';
+import { WebhookResponse } from '../../../src/schemas/webhook-response';
+
+describe('POST /github', () => {
+	let streamLabsSpy: jest.SpyInstance<Promise<void>>;
+	let twitchChatSpy: jest.SpyInstance<Promise<void>>;
+
+	beforeEach(() => {
+		streamLabsSpy = jest.spyOn(StreamLabs.prototype, 'alert');
+		streamLabsSpy.mockImplementationOnce(jest.fn());
+
+		twitchChatSpy = jest.spyOn(TwitchChat.prototype, 'send');
+		twitchChatSpy.mockImplementationOnce(jest.fn());
+	});
+
+	it('handles release events', async () => {
+		const payload = new ReleaseCreatedPayloadBuilder()
+			.with({
+				action: 'published',
+				release: { tag_name: '1.0.0' },
+			} as Partial<ReleaseCreatedPayload>)
+			.getInstance();
+
+		const subject = await initServer(getConfig());
+
+		const response = await subject.inject({
+			method: 'POST',
+			url: '/github',
+			payload,
+			headers: {
+				'x-github-event': 'release',
+			},
+		});
+
+		expect((response.result as WebhookResponse).messages).toEqual(
+			expect.arrayContaining([
+				expect.objectContaining({
+					twitchChat: {
+						message:
+							'streamdevs/webhook version 1.0.0 has just been released 🚀! Check it out http://github.com/streamdevs/webhook/releases/1.0.0',
+						notified: true,
+					},
+				}),
+			]),
+		);
+	});
+});