feat: add better error logging

XeroxDev · Feb 13, 2024 · 6408555 · 6408555
1 parent ad39dd8
commit 6408555
Show file tree

Hide file tree

Showing 12 changed files with 22 additions and 2 deletions.
diff --git a/src/actions/default.action.ts b/src/actions/default.action.ts
@@ -20,6 +20,7 @@ export abstract class DefaultAction<Instance> extends StreamDeckAction<
         this.socket = YTMD.COMPANION.socketClient;
         this.rest = YTMD.COMPANION.restClient;
         console.info(`Initialized ${actionName}`);
+        plugin.logMessage(`Initialized ${actionName}`);
     }
 
     abstract onContextAppear(event: WillAppearEvent): void;

diff --git a/src/actions/like-dislike.action.ts b/src/actions/like-dislike.action.ts
@@ -46,10 +46,12 @@ export class LikeDislikeAction extends DefaultAction<LikeDislikeAction> {
     onKeypressUp(event: KeyUpEvent): void {
         if (this.likeStatus === LikeStatus.LIKE) this.rest.toggleLike().catch(reason => {
             console.error(reason);
+            this.plugin.logMessage(`Error while like toggle. like status: ${this.likeStatus}, event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
             this.plugin.showAlert(event.context)
         });
         else if (this.likeStatus === LikeStatus.DISLIKE) this.rest.toggleDislike().catch(reason => {
             console.error(reason);
+            this.plugin.logMessage(`Error while dislike toggle. like status: ${this.likeStatus}, event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
             this.plugin.showAlert(event.context)
         });
     }

diff --git a/src/actions/mute.action.ts b/src/actions/mute.action.ts
@@ -60,6 +60,7 @@ export class MuteAction extends DefaultAction<MuteAction> {
 
             this.rest.setVolume(this.volume).catch(reason => {
                 console.error(reason);
+                this.plugin.logMessage(`Error while setting volume. volume: ${this.volume}, event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
                 this.plugin.showAlert(event.context)
             });
 
@@ -71,6 +72,7 @@ export class MuteAction extends DefaultAction<MuteAction> {
 
         this.rest.setVolume(this.volume).catch(reason => {
             console.error(reason);
+            this.plugin.logMessage(`Error while setting volume. volume: ${this.volume}, event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
             this.plugin.showAlert(event.context)
         });
     }

diff --git a/src/actions/next-prev-action.ts b/src/actions/next-prev-action.ts
@@ -23,10 +23,12 @@ export class NextPrevAction extends DefaultAction<NextPrevAction> {
     onKeypressUp(event: KeyUpEvent) {
         if (this.nextOrPrev === 'NEXT') this.rest.next().catch(reason => {
             console.error(reason);
+            this.plugin.logMessage(`Error while next. event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
             this.plugin.showAlert(event.context)
         });
         else this.rest.previous().catch(reason => {
             console.error(reason);
+            this.plugin.logMessage(`Error while previous. event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
             this.plugin.showAlert(event.context)
         })
     }

diff --git a/src/actions/play-pause.action.ts b/src/actions/play-pause.action.ts
@@ -113,6 +113,7 @@ export class PlayPauseAction extends DefaultAction<PlayPauseAction> {
         if (!settings?.action) {
             this.rest.playPause().catch(reason => {
                 console.error(reason);
+                this.plugin.logMessage(`Error while playPause toggle. context: ${JSON.stringify(context)}, error: ${JSON.stringify(reason)}`);
                 this.plugin.showAlert(context)
             })
             return;
@@ -121,18 +122,21 @@ export class PlayPauseAction extends DefaultAction<PlayPauseAction> {
             case 'PLAY':
                 this.rest.play().catch(reason => {
                     console.error(reason);
+                    this.plugin.logMessage(`Error while play. context: ${JSON.stringify(context)}, error: ${JSON.stringify(reason)}`);
                     this.plugin.showAlert(context)
                 });
                 break;
             case 'PAUSE':
                 this.rest.pause().catch(reason => {
                     console.error(reason);
+                    this.plugin.logMessage(`Error while pause. context: ${JSON.stringify(context)}, error: ${JSON.stringify(reason)}`);
                     this.plugin.showAlert(context)
                 });
                 break;
             default:
                 this.rest.playPause().catch(reason => {
                     console.error(reason);
+                    this.plugin.logMessage(`Error while playPause toggle. context: ${JSON.stringify(context)}, error: ${JSON.stringify(reason)}`);
                     this.plugin.showAlert(context)
                 });
                 break;

diff --git a/src/actions/repeat.action.ts b/src/actions/repeat.action.ts
@@ -31,7 +31,6 @@ export class RepeatAction extends DefaultAction<RepeatAction> {
         found = {
             context: event.context,
             method: (state: StateOutput) => {
-                console.log("Repeat mode", state.player.queue?.repeatMode);
                 if (state.player.queue?.repeatMode === undefined || state.player.queue.repeatMode === null || state.player.queue.repeatMode === this.currentMode) {
                     return;
                 }
@@ -89,9 +88,9 @@ export class RepeatAction extends DefaultAction<RepeatAction> {
                 mode = RepeatMode.ONE;
                 break;
         }
-        console.log("Repeat mode", mode);
         this.rest.repeatMode(mode).catch(reason => {
             console.error(reason);
+            this.plugin.logMessage(`Error while setting repeat mode. mode: ${mode}, event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
             this.plugin.showAlert(event.context)
         })
     }

diff --git a/src/actions/shuffle.action.ts b/src/actions/shuffle.action.ts
@@ -17,6 +17,7 @@ export class ShuffleAction extends DefaultAction<ShuffleAction> {
             .then(() => this.plugin.showOk(event.context))
             .catch(reason => {
                 console.error(reason);
+                this.plugin.logMessage(`Error while shuffle. event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
                 this.plugin.showAlert(event.context)
             });
     }

diff --git a/src/actions/song-info.action.ts b/src/actions/song-info.action.ts
@@ -36,6 +36,7 @@ export class SongInfoAction extends DefaultAction<SongInfoAction> {
             context: event.context,
             method: (state: StateOutput) => this.handleSongInfo(event, state).catch(reason => {
                 console.error(reason);
+                this.plugin.logMessage(`Error while executing handleSongInfo. state: ${JSON.stringify(state)}, event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
                 this.plugin.showAlert(event.context)
             })
         };
@@ -70,6 +71,7 @@ export class SongInfoAction extends DefaultAction<SongInfoAction> {
     public onKeypressUp(event: KeyUpEvent): void {
         this.rest.playPause().catch(reason => {
             console.error(reason);
+            this.plugin.logMessage(`Error while playPause toggle (song info). event: ${JSON.stringify(event)}, error: ${JSON.stringify(reason)}`);
             this.plugin.showAlert(event.context)
         });
     }

diff --git a/src/actions/vol-change.action.ts b/src/actions/vol-change.action.ts
@@ -62,6 +62,7 @@ export class VolChangeAction extends DefaultAction<VolChangeAction> {
             this.currentVolume = newVolume;
             this.rest.setVolume(newVolume <= 0 ? 0 : newVolume >= 100 ? 100 : newVolume).catch(reason => {
                 console.error(reason);
+                this.plugin.logMessage(`Error while setting volume. volume: ${newVolume}, context: ${JSON.stringify(context)}, error: ${JSON.stringify(reason)}`);
                 this.plugin.showAlert(context)
             });
             await this.wait(500);

diff --git a/src/pis/play-pause.pi.ts b/src/pis/play-pause.pi.ts
@@ -85,6 +85,7 @@ export class PlayPausePi extends PisAbstract {
     }
 
     private authErrorCatched(err: any) {
+        this.pi.logMessage(`Auth error: ${JSON.stringify(err)}`);
         let msg = "";
         if (err satisfies ErrorOutput) {
             msg = err.message;

diff --git a/src/ytmd-pi.ts b/src/ytmd-pi.ts
@@ -135,8 +135,12 @@ export class YTMDPi extends StreamDeckPropertyInspectorHandler {
     private setupLocalization() {
         this.fetchLocalizationFile(this.info.application.language ?? 'en', (b, s) => {
             if (!b) {
+                this.logMessage(`Failed to load the localization file. Reason: ${s}. Using default language.`);
                 // try to load the default language
                 this.fetchLocalizationFile('en', (b2, s2) => {
+                    if (!b2) {
+                        this.logMessage(`Failed to load the default localization file. Reason: ${s2}.`);
+                    }
                     this.localization = (s2 as LocalizationInterface).PI;
                     this.translateHtml();
                 });

diff --git a/src/ytmd.ts b/src/ytmd.ts
@@ -29,6 +29,7 @@ export class YTMD extends StreamDeckPluginHandler {
             YTMD._COMPANION.socketClient.connect();
         } catch (e) {
             console.error(e);
+            this.logMessage(`Error while connecting. error: ${JSON.stringify(e)}`);
         }
         new PlayPauseAction(this, ActionTypes.PLAY_PAUSE);
         new NextPrevAction(this, ActionTypes.NEXT_TRACK, 'NEXT');