Skip to content

Commit 01daf7b

Browse files
tomast1337tomast1337
authored
Merge pull request #24 from OpenNBS/feature/song-webhook-tests
Feature/song webhook tests
2 parents 568a2b1 + 24e3eee commit 01daf7b

File tree

3 files changed

+279
-6
lines changed

3 files changed

+279
-6
lines changed

‎server/src/song/song-webhook/song-webhook.service.spec.ts‎

Lines changed: 260 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,260 @@
1+
import { ConfigModule, ConfigService } from '@nestjs/config';
2+
import { getModelToken } from '@nestjs/mongoose';
3+
import { Test, TestingModule } from '@nestjs/testing';
4+
import { Model } from 'mongoose';
5+
6+
import { SongWebhookService } from './song-webhook.service';
7+
import { Song as SongEntity, SongWithUser } from '../entity/song.entity';
8+
import { getUploadDiscordEmbed } from '../song.util';
9+
10+
jest.mock('../song.util', () => ({
11+
getUploadDiscordEmbed: jest.fn(),
12+
}));
13+
14+
const mockSongModel = {
15+
find: jest.fn().mockReturnThis(),
16+
sort: jest.fn().mockReturnThis(),
17+
populate: jest.fn().mockReturnThis(),
18+
save: jest.fn(),
19+
};
20+
21+
describe('SongWebhookService', () => {
22+
let service: SongWebhookService;
23+
let _songModel: Model<SongEntity>;
24+
let _configService: ConfigService;
25+
26+
beforeEach(async () => {
27+
const module: TestingModule = await Test.createTestingModule({
28+
imports: [ConfigModule.forRoot()],
29+
providers: [
30+
SongWebhookService,
31+
{
32+
provide: getModelToken(SongEntity.name),
33+
useValue: mockSongModel,
34+
},
35+
{
36+
provide: 'DISCORD_WEBHOOK_URL',
37+
useValue: 'http://localhost/webhook',
38+
},
39+
],
40+
}).compile();
41+
42+
service = module.get<SongWebhookService>(SongWebhookService);
43+
_songModel = module.get<Model<SongEntity>>(getModelToken(SongEntity.name));
44+
_configService = module.get<ConfigService>(ConfigService);
45+
});
46+
47+
it('should be defined', () => {
48+
expect(service).toBeDefined();
49+
});
50+
51+
describe('postSongWebhook', () => {
52+
it('should post a new webhook message for a song', async () => {
53+
const song: SongWithUser = {
54+
publicId: '123',
55+
uploader: { username: 'testuser', profileImage: 'testimage' },
56+
} as SongWithUser;
57+
58+
(getUploadDiscordEmbed as jest.Mock).mockReturnValue({});
59+
60+
global.fetch = jest.fn().mockResolvedValue({
61+
json: jest.fn().mockResolvedValue({ id: 'message-id' }),
62+
});
63+
64+
const result = await service.postSongWebhook(song);
65+
66+
expect(result).toBe('message-id');
67+
expect(fetch).toHaveBeenCalledWith('http://localhost/webhook?wait=true', {
68+
method: 'POST',
69+
headers: {
70+
'Content-Type': 'application/json',
71+
},
72+
body: JSON.stringify({}),
73+
});
74+
});
75+
76+
it('should return null if there is an error', async () => {
77+
const song: SongWithUser = {
78+
publicId: '123',
79+
uploader: { username: 'testuser', profileImage: 'testimage' },
80+
} as SongWithUser;
81+
82+
(getUploadDiscordEmbed as jest.Mock).mockReturnValue({});
83+
84+
global.fetch = jest.fn().mockRejectedValue(new Error('Error'));
85+
86+
const result = await service.postSongWebhook(song);
87+
88+
expect(result).toBeNull();
89+
});
90+
});
91+
92+
describe('updateSongWebhook', () => {
93+
it('should update the webhook message for a song', async () => {
94+
const song: SongWithUser = {
95+
publicId: '123',
96+
webhookMessageId: 'message-id',
97+
uploader: { username: 'testuser', profileImage: 'testimage' },
98+
} as SongWithUser;
99+
100+
(getUploadDiscordEmbed as jest.Mock).mockReturnValue({});
101+
102+
global.fetch = jest.fn().mockResolvedValue({});
103+
104+
await service.updateSongWebhook(song);
105+
106+
expect(fetch).toHaveBeenCalledWith(
107+
'http://localhost/webhook/messages/message-id',
108+
{
109+
method: 'PATCH',
110+
headers: {
111+
'Content-Type': 'application/json',
112+
},
113+
body: JSON.stringify({}),
114+
},
115+
);
116+
});
117+
118+
it('should log an error if there is an error', async () => {
119+
const song: SongWithUser = {
120+
publicId: '123',
121+
webhookMessageId: 'message-id',
122+
uploader: { username: 'testuser', profileImage: 'testimage' },
123+
} as SongWithUser;
124+
125+
(getUploadDiscordEmbed as jest.Mock).mockReturnValue({});
126+
127+
global.fetch = jest.fn().mockRejectedValue(new Error('Error'));
128+
129+
const loggerSpy = jest.spyOn(service['logger'], 'error');
130+
131+
await service.updateSongWebhook(song);
132+
133+
expect(loggerSpy).toHaveBeenCalledWith(
134+
'Error updating Discord webhook',
135+
expect.any(Error),
136+
);
137+
});
138+
});
139+
140+
describe('deleteSongWebhook', () => {
141+
it('should delete the webhook message for a song', async () => {
142+
const song: SongWithUser = {
143+
publicId: '123',
144+
webhookMessageId: 'message-id',
145+
uploader: { username: 'testuser', profileImage: 'testimage' },
146+
} as SongWithUser;
147+
148+
global.fetch = jest.fn().mockResolvedValue({});
149+
150+
await service.deleteSongWebhook(song);
151+
152+
expect(fetch).toHaveBeenCalledWith(
153+
'http://localhost/webhook/messages/message-id',
154+
{
155+
method: 'DELETE',
156+
},
157+
);
158+
});
159+
160+
it('should log an error if there is an error', async () => {
161+
const song: SongWithUser = {
162+
publicId: '123',
163+
webhookMessageId: 'message-id',
164+
uploader: { username: 'testuser', profileImage: 'testimage' },
165+
} as SongWithUser;
166+
167+
global.fetch = jest.fn().mockRejectedValue(new Error('Error'));
168+
169+
const loggerSpy = jest.spyOn(service['logger'], 'error');
170+
171+
await service.deleteSongWebhook(song);
172+
173+
expect(loggerSpy).toHaveBeenCalledWith(
174+
'Error deleting Discord webhook',
175+
expect.any(Error),
176+
);
177+
});
178+
});
179+
180+
describe('syncSongWebhook', () => {
181+
it('should update the webhook message if the song is public', async () => {
182+
const song: SongWithUser = {
183+
publicId: '123',
184+
webhookMessageId: 'message-id',
185+
visibility: 'public',
186+
uploader: { username: 'testuser', profileImage: 'testimage' },
187+
} as SongWithUser;
188+
189+
const updateSpy = jest.spyOn(service, 'updateSongWebhook');
190+
191+
await service.syncSongWebhook(song);
192+
193+
expect(updateSpy).toHaveBeenCalledWith(song);
194+
});
195+
196+
it('should delete the webhook message if the song is not public', async () => {
197+
const song: SongWithUser = {
198+
publicId: '123',
199+
webhookMessageId: 'message-id',
200+
visibility: 'private',
201+
uploader: { username: 'testuser', profileImage: 'testimage' },
202+
} as SongWithUser;
203+
204+
const deleteSpy = jest.spyOn(service, 'deleteSongWebhook');
205+
206+
await service.syncSongWebhook(song);
207+
208+
expect(deleteSpy).toHaveBeenCalledWith(song);
209+
});
210+
211+
it('should post a new webhook message if the song is public and does not have a message', async () => {
212+
const song: SongWithUser = {
213+
publicId: '123',
214+
visibility: 'public',
215+
uploader: { username: 'testuser', profileImage: 'testimage' },
216+
} as SongWithUser;
217+
218+
const postSpy = jest.spyOn(service, 'postSongWebhook');
219+
220+
await service.syncSongWebhook(song);
221+
222+
expect(postSpy).toHaveBeenCalledWith(song);
223+
});
224+
225+
it('should return null if the song is not public and does not have a message', async () => {
226+
const song: SongWithUser = {
227+
publicId: '123',
228+
visibility: 'private',
229+
uploader: { username: 'testuser', profileImage: 'testimage' },
230+
} as SongWithUser;
231+
232+
const result = await service.syncSongWebhook(song);
233+
234+
expect(result).toBeNull();
235+
});
236+
});
237+
238+
describe('syncAllSongsWebhook', () => {
239+
it('should synchronize the webhook messages for all songs', async () => {
240+
const songs: SongWithUser[] = [
241+
{
242+
publicId: '123',
243+
uploader: { username: 'testuser', profileImage: 'testimage' },
244+
save: jest.fn(),
245+
} as unknown as SongWithUser,
246+
];
247+
248+
mockSongModel.find.mockReturnValue({
249+
sort: jest.fn().mockReturnThis(),
250+
populate: jest.fn().mockResolvedValue(songs),
251+
});
252+
253+
const syncSpy = jest.spyOn(service, 'syncSongWebhook');
254+
255+
await (service as any).syncAllSongsWebhook();
256+
257+
expect(syncSpy).toHaveBeenCalledWith(songs[0]);
258+
});
259+
});
260+
});

‎server/src/song/song-webhook/song-webhook.service.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Injectable, Logger, OnModuleInit } from '@nestjs/common';
1+
import { Inject, Injectable, Logger, OnModuleInit } from '@nestjs/common';
22
import { InjectModel } from '@nestjs/mongoose';
33
import { Model } from 'mongoose';
44

@@ -12,6 +12,8 @@ export class SongWebhookService implements OnModuleInit {
1212
constructor(
1313
@InjectModel(SongEntity.name)
1414
private songModel: Model<SongEntity>,
15+
@Inject('DISCORD_WEBHOOK_URL')
16+
private readonly discordWebhookUrl: string | undefined,
1517
) {}
1618

1719
async onModuleInit() {
@@ -28,7 +30,7 @@ export class SongWebhookService implements OnModuleInit {
2830
* @throws {Error} If the Discord webhook URL is not found.
2931
* @throws {Error} If there is an error sending the webhook message.
3032
*/
31-
const webhookUrl = process.env.DISCORD_WEBHOOK_URL;
33+
const webhookUrl = this.discordWebhookUrl;
3234

3335
if (!webhookUrl) {
3436
this.logger.error('Discord webhook URL not found');
@@ -71,7 +73,7 @@ export class SongWebhookService implements OnModuleInit {
7173
throw new Error('Song does not have a webhook message');
7274
}
7375

74-
const webhookUrl = process.env.DISCORD_WEBHOOK_URL;
76+
const webhookUrl = this.discordWebhookUrl;
7577

7678
if (!webhookUrl) {
7779
this.logger.error('Discord webhook URL not found');
@@ -110,7 +112,7 @@ export class SongWebhookService implements OnModuleInit {
110112
throw new Error('Song does not have a webhook message');
111113
}
112114

113-
const webhookUrl = process.env.DISCORD_WEBHOOK_URL;
115+
const webhookUrl = this.discordWebhookUrl;
114116

115117
if (!webhookUrl) {
116118
this.logger.error('Discord webhook URL not found');
@@ -175,7 +177,7 @@ export class SongWebhookService implements OnModuleInit {
175177
.sort({ createdAt: 1 })
176178
.populate('uploader', 'username profileImage -_id');
177179

178-
for await (const songDocument of songQuery) {
180+
for (const songDocument of await songQuery) {
179181
const webhookMessageId = await this.syncSongWebhook(
180182
songDocument as unknown as SongWithUser,
181183
);

‎server/src/song/song.module.ts‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { SongUploadService } from './song-upload/song-upload.service';
1111
import { SongController } from './song.controller';
1212
import { SongService } from './song.service';
1313
import { SongWebhookService } from './song-webhook/song-webhook.service';
14+
import { ConfigService } from '@nestjs/config';
1415

1516
@Module({
1617
imports: [
@@ -19,7 +20,17 @@ import { SongWebhookService } from './song-webhook/song-webhook.service';
1920
UserModule,
2021
FileModule.forRootAsync(),
2122
],
22-
providers: [SongService, SongUploadService, SongWebhookService],
23+
providers: [
24+
SongService,
25+
SongUploadService,
26+
SongWebhookService,
27+
{
28+
provide: 'DISCORD_WEBHOOK_URL',
29+
useFactory: (configService: ConfigService) =>
30+
configService.getOrThrow('DISCORD_WEBHOOK_URL'),
31+
inject: [ConfigService],
32+
},
33+
],
2334
controllers: [SongController, MySongsController],
2435
exports: [SongService],
2536
})

0 commit comments

Comments
 (0)