refactor: extract event names to const

Author: manuel-rw

src/clients/discord/discord.event-subscriber.service.ts

@@ -2,6 +2,7 @@ import { Injectable, Scope } from '@nestjs/common';
 import { OnEvent } from '@nestjs/event-emitter';
 import { DiscordVoiceService } from './discord.voice.service';
 import { PlaybackService } from '../../playback/playback.service';
+import { EventNames } from '../../events/names';
 
 @Injectable({ scope: Scope.DEFAULT })
 export class DiscordEventSubscriberService {
@@ -10,7 +11,7 @@ export class DiscordEventSubscriberService {
     private readonly playbackService: PlaybackService,
   ) {}
 
-  @OnEvent('internal.voice.controls.setVolume')
+  @OnEvent(EventNames.Controls.SetVolume)
   private onChangeVolume({ volume }: { volume: number }) {
     this.discordVoiceService.changeCurrentResourceVolume(volume);
     this.playbackService.setVolume(volume);

src/clients/discord/discord.voice.service.ts

@@ -31,6 +31,7 @@ import { JellyfinStreamBuilderService } from '../jellyfin/jellyfin.stream.builde
 import { JellyfinWebSocketService } from '../jellyfin/jellyfin.websocket.service';
 
 import { buildErrorMessage, buildMessage } from './discord.message.builder';
+import { EventNames } from '../../events/names';
 
 @Injectable()
 export class DiscordVoiceService implements OnModuleDestroy {
@@ -59,7 +60,7 @@ export class DiscordVoiceService implements OnModuleDestroy {
     }
   }
 
-  @OnEvent('internal.audio.track.announce')
+  @OnEvent(EventNames.Circuit.AnnounceTrack)
   handleOnNewTrack(track: Track) {
     const url = track.getStreamUrl(this.jellyfinStreamBuilder);
     const resource = createAudioResource(url, {
@@ -215,26 +216,26 @@ export class DiscordVoiceService implements OnModuleDestroy {
   /**
    * Pauses the current audio player
    */
-  @OnEvent('internal.voice.controls.pause')
+  @OnEvent(EventNames.Controls.Pause)
   pause() {
     this.createAndReturnOrGetAudioPlayer().pause();
     const track = this.playbackService.getPlaylistOrDefault().getActiveTrack();
     if (track) {
       track.playing = false;
     }
-    this.eventEmitter.emit('playback.state.pause', true);
+    this.eventEmitter.emit(EventNames.Circuit.Paused, true);
   }
 
   /**
    * Stops the audio player
    */
-  @OnEvent('internal.voice.controls.stop')
+  @OnEvent(EventNames.Controls.Stop)
   stop(force: boolean): boolean {
     const hasStopped = this.createAndReturnOrGetAudioPlayer().stop(force);
     if (hasStopped) {
       const playlist = this.playbackService.getPlaylistOrDefault();
       this.eventEmitter.emit(
-        'internal.audio.track.finish',
+        EventNames.Circuit.FinishedTrack,
         playlist.getActiveTrack(),
       );
       playlist.clear();
@@ -251,7 +252,7 @@ export class DiscordVoiceService implements OnModuleDestroy {
     if (track) {
       track.playing = true;
     }
-    this.eventEmitter.emit('playback.state.pause', false);
+    this.eventEmitter.emit(EventNames.Circuit.Paused, false);
   }
 
   /**
@@ -269,7 +270,7 @@ export class DiscordVoiceService implements OnModuleDestroy {
    * Checks if the current state is paused or not and toggles the states to the opposite.
    * @returns The new paused state - true: paused, false: unpaused
    */
-  @OnEvent('internal.voice.controls.togglePause')
+  @OnEvent(EventNames.Controls.TogglePause)
   togglePaused(): boolean {
     if (this.isPaused()) {
       this.unpause();
@@ -399,7 +400,7 @@ export class DiscordVoiceService implements OnModuleDestroy {
 
       if (finishedTrack) {
         finishedTrack.playing = false;
-        this.eventEmitter.emit('internal.audio.track.finish', finishedTrack);
+        this.eventEmitter.emit(EventNames.Circuit.FinishedTrack, finishedTrack);
       }
 
       const hasNextTrack = playlist.hasNextTrackInPlaylist();

src/clients/jellyfin/jellyfin.websocket.service.ts

@@ -19,6 +19,7 @@ import {
 import { JellyfinSearchService } from './search/jellyfin.search.service';
 import { JellyfinService } from './jellyfin.service';
 import { z } from 'zod';
+import { EventNames } from '../../events/names';
 
 @Injectable()
 export class JellyfinWebSocketService implements OnModuleDestroy {
@@ -135,19 +136,19 @@ export class JellyfinWebSocketService implements OnModuleDestroy {
   ) {
     switch (request.Command) {
       case PlaystateCommand.PlayPause:
-        this.eventEmitter.emit('internal.voice.controls.togglePause');
+        this.eventEmitter.emit(EventNames.Controls.TogglePause);
         break;
       case PlaystateCommand.Pause:
-        this.eventEmitter.emit('internal.voice.controls.pause');
+        this.eventEmitter.emit(EventNames.Controls.Pause);
         break;
       case PlaystateCommand.Stop:
-        this.eventEmitter.emit('internal.voice.controls.stop');
+        this.eventEmitter.emit(EventNames.Controls.Stop);
         break;
       case PlaystateCommand.NextTrack:
-        this.eventEmitter.emit('internal.audio.track.next');
+        this.eventEmitter.emit(EventNames.Circuit.NextTrack);
         break;
       case PlaystateCommand.PreviousTrack:
-        this.eventEmitter.emit('internal.audio.track.previous');
+        this.eventEmitter.emit(EventNames.Circuit.PreviousTrack);
         break;
       default:
         this.logger.warn(
@@ -192,7 +193,7 @@ export class JellyfinWebSocketService implements OnModuleDestroy {
 
     switch (data.Name) {
       case 'SetVolume':
-        this.eventEmitter.emit('internal.voice.controls.setVolume', {
+        this.eventEmitter.emit(EventNames.Controls.SetVolume, {
           volume: data.Arguments.Volume,
         });
         break;

src/clients/jellyfin/jellyfinPlayStateService.ts

@@ -14,6 +14,7 @@ import { Interval } from '@nestjs/schedule';
 import { Track } from '../../models/track';
 
 import { PlaybackService } from '../../playback/playback.service';
+import { EventNames } from '../../events/names';
 
 @Injectable()
 export class JellyfinPlayStateService {
@@ -48,7 +49,7 @@ export class JellyfinPlayStateService {
     this.logger.debug('Reported playback capabilities successfully');
   }
 
-  @OnEvent('internal.audio.track.announce')
+  @OnEvent(EventNames.Circuit.AnnounceTrack)
   private async onPlaybackNewTrack(track: Track) {
     this.logger.debug(`Reporting playback start on track '${track.id}'`);
     await this.playStateApi.reportPlaybackStart({
@@ -59,7 +60,7 @@ export class JellyfinPlayStateService {
     });
   }
 
-  @OnEvent('internal.audio.track.finish')
+  @OnEvent(EventNames.Circuit.FinishedTrack)
   private async onPlaybackFinished(track: Track) {
     if (!track) {
       this.logger.error(
@@ -76,13 +77,13 @@ export class JellyfinPlayStateService {
     });
   }
 
-  @OnEvent('playback.state.pause')
+  @OnEvent(EventNames.Circuit.Paused)
   private async onPlaybackPause(paused: boolean) {
     const track = this.playbackService.getPlaylistOrDefault().getActiveTrack();
 
     if (!track) {
       this.logger.error(
-        'Unable to report changed playstate to Jellyfin because no track was active',
+        'Unable to report changed play state to Jellyfin because no track was active',
       );
       return;
     }

src/events/names.ts

@@ -0,0 +1,15 @@
+export const EventNames = {
+  Controls: {
+    SetVolume: 'internal.voice.controls.setVolume',
+    Pause: 'internal.voice.controls.pause',
+    Stop: 'internal.voice.controls.stop',
+    TogglePause: 'internal.voice.controls.togglePause',
+  },
+  Circuit: {
+    AnnounceTrack: 'internal.audio.track.announce',
+    FinishedTrack: 'internal.audio.track.finish',
+    Paused: 'playback.state.pause',
+    PreviousTrack: 'internal.audio.track.previous',
+    NextTrack: 'internal.audio.track.next',
+  },
+};

src/models/playlist.ts

@@ -1,6 +1,7 @@
 import { EventEmitter2 } from '@nestjs/event-emitter';
 
 import { Track } from './track';
+import { EventNames } from '../events/names';
 
 export class Playlist {
   tracks: Track[];
@@ -151,7 +152,7 @@ export class Playlist {
     }
 
     const currentTrack = this.getActiveTrack();
-    this.eventEmitter.emit('internal.audio.track.finish', currentTrack);
+    this.eventEmitter.emit(EventNames.Circuit.FinishedTrack, currentTrack);
   }
 
   private announceTrackChange() {
@@ -166,7 +167,7 @@ export class Playlist {
     }
 
     activeTrack.playing = true;
-    this.eventEmitter.emit('internal.audio.track.announce', activeTrack);
+    this.eventEmitter.emit(EventNames.Circuit.AnnounceTrack, activeTrack);
   }
 
   private isActiveTrackOutOfSync(): boolean {

src/playback/playback.service.ts

@@ -2,6 +2,7 @@ import { Injectable } from '@nestjs/common';
 import { EventEmitter2, OnEvent } from '@nestjs/event-emitter';
 
 import { Playlist } from '../models/playlist';
+import { EventNames } from '../events/names';
 
 @Injectable()
 export class PlaybackService {
@@ -36,12 +37,12 @@ export class PlaybackService {
     return this.volume;
   }
 
-  @OnEvent('internal.audio.track.previous')
+  @OnEvent(EventNames.Circuit.PreviousTrack)
   private handlePreviousTrackEvent() {
     this.getPlaylistOrDefault().setPreviousTrackAsActiveTrack();
   }
 
-  @OnEvent('internal.audio.track.next')
+  @OnEvent(EventNames.Circuit.NextTrack)
   private handleNextTrackEvent() {
     this.getPlaylistOrDefault().setNextTrackAsActiveTrack();
   }