Merge 6be5774001 into 91156e5936

[Snyk] Upgrade sass from 1.78.0 to 1.79.4

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.16.0]
+
+- Fix issue #449 Discord RPC stuck on "Browsing Tidal".
+- Fix issue #448 Add option to disable the discord rpc idle text
+- Notifications are now send at the end of the update process, allowing other events to happen sooner.
+
 ## [5.15.0]
 
 - Added all missing swagger/openApi info with the help of [Times-Z](https://github.com/Times-Z)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tidal-hifi",
-  "version": "5.15.0",
+  "version": "5.16.0",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "ts-dist/main.js",
   "scripts": {
@@ -42,21 +42,20 @@
   "dependencies": {
     "@electron/remote": "^2.1.2",
     "@types/swagger-jsdoc": "^6.0.4",
-    "axios": "^1.7.2",
+    "@xhayper/discord-rpc": "^1.2.0",
+    "axios": "^1.7.7",
     "cors": "^2.8.5",
-    "discord-rpc": "^4.0.1",
     "electron-store": "^8.2.0",
-    "express": "^4.19.2",
+    "express": "^4.21.1",
     "hotkeys-js": "^3.13.7",
     "mpris-service": "^2.1.2",
     "request": "^2.88.2",
-    "sass": "^1.77.7",
+    "sass": "^1.79.4",
     "swagger-ui-express": "^5.0.1"
   },
   "devDependencies": {
     "@mastermindzh/prettier-config": "^1.0.0",
     "@types/cors": "^2.8.17",
-    "@types/discord-rpc": "^4.0.8",
     "@types/express": "^4.17.21",
     "@types/node": "^20.14.10",
     "@types/request": "^2.48.12",
@@ -81,4 +80,4 @@
     "typescript": "^5.5.3"
   },
   "prettier": "@mastermindzh/prettier-config"
-}
+}

src/constants/settings.ts

@@ -27,9 +27,7 @@ export const settings = {
   enableDiscord: "enableDiscord",
   discord: {
     detailsPrefix: "discord.detailsPrefix",
-    buttonText: "discord.buttonText",
     includeTimestamps: "discord.includeTimestamps",
-    showSong: "discord.showSong",
     idleText: "discord.idleText",
     usingText: "discord.usingText",
   },

src/features/api/swagger.json

@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "TIDAL Hi-Fi API",
-    "version": "5.15.0",
+    "version": "5.16.0",
     "description": "",
     "license": {
       "name": "MIT",

src/pages/settings/preload.ts

@@ -20,11 +20,6 @@ const switchesWithSettings = {
     classToHide: "discord_options",
     settingsKey: settings.enableDiscord,
   },
-  discord_show_song: {
-    switch: "discord_show_song",
-    classToHide: "discord_show_song_options",
-    settingsKey: settings.discord.showSong,
-  },
 };
 
 let adBlock: HTMLInputElement,
@@ -54,12 +49,7 @@ let adBlock: HTMLInputElement,
   ListenBrainzToken: HTMLInputElement,
   listenbrainz_delay: HTMLInputElement,
   enableWaylandSupport: HTMLInputElement,
-  discord_details_prefix: HTMLInputElement,
+  discord_details_prefix: HTMLInputElement
-  discord_include_timestamps: HTMLInputElement,
-  discord_button_text: HTMLInputElement,
-  discord_show_song: HTMLInputElement,
-  discord_idle_text: HTMLInputElement,
-  discord_using_text: HTMLInputElement;
 
 addCustomCss(app);
 
@@ -148,11 +138,6 @@ function refreshSettings() {
     ListenBrainzToken.value = settingsStore.get(settings.ListenBrainz.token);
     listenbrainz_delay.value = settingsStore.get(settings.ListenBrainz.delay);
     discord_details_prefix.value = settingsStore.get(settings.discord.detailsPrefix);
-    discord_include_timestamps.checked = settingsStore.get(settings.discord.includeTimestamps);
-    discord_button_text.value = settingsStore.get(settings.discord.buttonText);
-    discord_show_song.checked = settingsStore.get(settings.discord.showSong);
-    discord_idle_text.value = settingsStore.get(settings.discord.idleText);
-    discord_using_text.value = settingsStore.get(settings.discord.usingText);
 
     // set state of all switches with additional settings
     Object.values(switchesWithSettings).forEach((settingSwitch) => {
@@ -265,12 +250,7 @@ window.addEventListener("DOMContentLoaded", () => {
   ListenBrainzAPI = get("ListenBrainzAPI");
   ListenBrainzToken = get("ListenBrainzToken");
   discord_details_prefix = get("discord_details_prefix");
-  discord_include_timestamps = get("discord_include_timestamps");
   listenbrainz_delay = get("listenbrainz_delay");
-  discord_button_text = get("discord_button_text");
-  discord_show_song = get("discord_show_song");
-  discord_using_text = get("discord_using_text");
-  discord_idle_text = get("discord_idle_text");
 
   refreshSettings();
   addInputListener(adBlock, settings.adBlock);
@@ -305,13 +285,4 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(ListenBrainzToken, settings.ListenBrainz.token);
   addInputListener(listenbrainz_delay, settings.ListenBrainz.delay);
   addInputListener(discord_details_prefix, settings.discord.detailsPrefix);
-  addInputListener(discord_include_timestamps, settings.discord.includeTimestamps);
-  addInputListener(discord_button_text, settings.discord.buttonText);
-  addInputListener(
-    discord_show_song,
-    settings.discord.showSong,
-    switchesWithSettings.discord_show_song
-  );
-  addInputListener(discord_idle_text, settings.discord.idleText);
-  addInputListener(discord_using_text, settings.discord.usingText);
 });

src/pages/settings/settings.html

@@ -226,64 +226,13 @@
               </label>
             </div>
             <div id="discord_options">
-
               <div class="group__option" class="hidden">
                 <div class="group__description">
-                  <h4>Idle Text</h4>
+                  <h4>Details prefix</h4>
-                  <p>The text displayed on Discord's rich presence while idling in the app.</p>
+                  <p>Prefix for the "details" field of Discord's rich presence.</p>
-                  <input id="discord_idle_text" type="text" class="text-input" name="discord_idle_text" />
+                  <input id="discord_details_prefix" type="text" class="text-input" name="discord_details_prefix" />
                 </div>
               </div>
-
-              <div class="group__option" class="hidden">
-                <div class="group__description">
-                  <h4>Using Tidal Text</h4>
-                  <p>The text displayed on Discord's rich presence while "showSong" is turned off</p>
-                  <input id="discord_using_text" type="text" class="text-input" name="discord_using_text" />
-                </div>
-              </div>
-
-              <div class="group__option" class="hidden">
-                <div class="group__description">
-                  <h4>Show media</h4>
-                  <p>Show the current media in the Discord client</p>
-                </div>
-                <label class="switch">
-                  <input id="discord_show_song" type="checkbox" />
-                  <span class="switch__slider"></span>
-                </label>
-              </div>
-
-              <div id="discord_show_song_options" class="hidden">
-
-                <div class="group__option" class="hidden">
-                  <div class="group__description">
-                    <h4>Include timestamps</h4>
-                    <p>Show current/end playtime in the Discord client</p>
-                  </div>
-                  <label class="switch">
-                    <input id="discord_include_timestamps" type="checkbox" />
-                    <span class="switch__slider"></span>
-                  </label>
-                </div>
-
-                <div class="group__option" class="hidden">
-                  <div class="group__description">
-                    <h4>Details prefix</h4>
-                    <p>Prefix for the "details" field of Discord's rich presence.</p>
-                    <input id="discord_details_prefix" type="text" class="text-input" name="discord_details_prefix" />
-                  </div>
-                </div>
-
-                <div class="group__option">
-                  <div class="group__description">
-                    <h4>Button text</h4>
-                    <p>Text to display on the button below the media information.</p>
-                    <input id="discord_button_text" type="text" class="text-input" name="discord_button_text" />
-                  </div>
-                </div>
-              </div>
-
             </div>
           </div>
           <div class="group">
@@ -457,7 +406,7 @@
           <h4>TIDAL Hi-Fi</h4>
           <div class="about-section__version">
             <a target="_blank" rel="noopener"
-              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.15.0">5.15.0</a>
+              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.16.0">5.16.0</a>
           </div>
           <div class="about-section__links">
             <a target="_blank" rel="noopener" href="https://github.com/mastermindzh/tidal-hifi/"
@@ -480,4 +429,4 @@
   </div>
 </body>
 
-</html>
+</html>

src/preload.ts

@@ -394,18 +394,30 @@ function updateMediaInfo(mediaInfo: MediaInfo, notify: boolean) {
   if (mediaInfo) {
     currentMediaInfo = mediaInfo;
     ipcRenderer.send(globalEvents.updateInfo, mediaInfo);
-    if (settingsStore.get(settings.notifications) && notify) {
-      if (currentNotification) currentNotification.close();
-      currentNotification = new Notification({
-        title: mediaInfo.title,
-        body: mediaInfo.artists,
-        icon: mediaInfo.icon,
-      });
-      currentNotification.show();
-    }
-
     updateMpris(mediaInfo);
     updateListenBrainz(mediaInfo);
+    if (notify) {
+      sendNotification(mediaInfo);
+    }
+  }
+}
+
+/**
+ * send a desktop notification if enabled in settings
+ * @param mediaInfo
+ * @param notify Whether to notify
+ */
+async function sendNotification(mediaInfo: MediaInfo) {
+  if (settingsStore.get(settings.notifications)) {
+    if (currentNotification) {
+      currentNotification.close();
+    }
+    currentNotification = new Notification({
+      title: mediaInfo.title,
+      body: mediaInfo.artists,
+      icon: mediaInfo.icon,
+    });
+    currentNotification.show();
   }
 }
 

src/scripts/discord.ts

@@ -1,4 +1,4 @@
-import { Client, Presence } from "discord-rpc";
+import { Client, SetActivity } from "@xhayper/discord-rpc";
 import { app, ipcMain } from "electron";
 import { globalEvents } from "../constants/globalEvents";
 import { settings } from "../constants/settings";
@@ -12,72 +12,89 @@ const clientId = "833617820704440341";
 
 export let rpc: Client;
 
+const ACTIVITY_LISTENING = 2;
+const MAX_RETRIES = 5;
+const RETRY_DELAY = 10000;
+
 const observer = () => {
   if (rpc) {
-    rpc.setActivity(getActivity());
+    updateActivity();
   }
 };
 
 const defaultPresence = {
-  largeImageKey: "tidal-hifi-icon",
+  smallImageKey: "tidal-hifi-icon",
-  largeImageText: `TIDAL Hi-Fi ${app.getVersion()}`,
+  smallImageText: `TIDAL Hi-Fi ${app.getVersion()}`,
   instance: false,
+  type: ACTIVITY_LISTENING
 };
 
-const getActivity = (): Presence => {
+const updateActivity = () => {
-  const presence: Presence = { ...defaultPresence };
-
   if (mediaInfo.status === MediaStatus.paused) {
-    presence.details =
+    rpc.user?.clearActivity();
-      settingsStore.get<string, string>(settings.discord.idleText) ?? "Browsing Tidal";
   } else {
-    const showSong = settingsStore.get<string, boolean>(settings.discord.showSong) ?? false;
+    rpc.user?.setActivity(getActivity());
-    if (showSong) {
-      const { includeTimestamps, detailsPrefix, buttonText } = getFromStore();
-      includeTimeStamps(includeTimestamps);
-      setPresenceFromMediaInfo(detailsPrefix, buttonText);
-    } else {
-      presence.details =
-        settingsStore.get<string, string>(settings.discord.usingText) ?? "Playing media on TIDAL";
-    }
   }
+};
+
+const getActivity = (): SetActivity => {
+  const presence: SetActivity = { ...defaultPresence };
+
+  includeTimeStamps();
+  setPresenceFromMediaInfo();
+
   return presence;
 
-  function getFromStore() {
+  /**
-    const includeTimestamps =
+   * Pad a string using spaces to at least 2 characters
-      settingsStore.get<string, boolean>(settings.discord.includeTimestamps) ?? true;
+   * @param input string to pad with 2 characters
-    const detailsPrefix =
+   * @returns
-      settingsStore.get<string, string>(settings.discord.detailsPrefix) ?? "Listening to ";
+   */
-    const buttonText =
+  function pad(input: string): string {
-      settingsStore.get<string, string>(settings.discord.buttonText) ?? "Play on TIDAL";
+    return input.padEnd(2, " ");
-
-    return { includeTimestamps, detailsPrefix, buttonText };
   }
 
-  function setPresenceFromMediaInfo(detailsPrefix: string, buttonText: string) {
+  function setPresenceFromMediaInfo() {
+    // discord requires a minimum of 2 characters
+    const title = pad(mediaInfo.title);
+    const album = pad(mediaInfo.album);
+    const artists = pad(mediaInfo.artists);
+
+    const detailsPrefix = settingsStore.get<string, string>(settings.discord.detailsPrefix) ?? "Listening to ";
+    presence.details = `${detailsPrefix}${title}`;
+    presence.state = artists ? artists : "unknown artist(s)";
     if (mediaInfo.url) {
-      presence.details = `${detailsPrefix}${mediaInfo.title}`;
-      presence.state = mediaInfo.artists ? mediaInfo.artists : "unknown artist(s)";
       presence.largeImageKey = mediaInfo.image;
-      if (mediaInfo.album) {
+      if (album) presence.largeImageText = album;
-        presence.largeImageText = mediaInfo.album;
-      }
-      presence.buttons = [{ label: buttonText, url: mediaInfo.url }];
-    } else {
-      presence.details = `Watching ${mediaInfo.title}`;
-      presence.state = mediaInfo.artists;
     }
   }
 
-  function includeTimeStamps(includeTimestamps: boolean) {
+  function includeTimeStamps() {
-    if (includeTimestamps) {
       const currentSeconds = convertDurationToSeconds(mediaInfo.current);
       const durationSeconds = convertDurationToSeconds(mediaInfo.duration);
       const date = new Date();
-      const now = (date.getTime() / 1000) | 0;
+      const now = Math.floor(date.getTime() / 1000);
-      const remaining = date.setSeconds(date.getSeconds() + (durationSeconds - currentSeconds));
+      presence.startTimestamp = now - currentSeconds;
-      presence.startTimestamp = now;
+      presence.endTimestamp = presence.startTimestamp + durationSeconds;
-      presence.endTimestamp = remaining;
+  }
+};
+
+/**
+ * Try to login to RPC and retry if it errors
+ * @param retryCount Max retry count
+ */
+const connectWithRetry = async (retryCount = 0) => {
+  try {
+    await rpc.login();
+    Logger.log('Connected to Discord');
+    rpc.on("ready", updateActivity);
+    Object.values(globalEvents).forEach(event => ipcMain.on(event, observer));
+  } catch (error) {
+    if (retryCount < MAX_RETRIES) {
+      Logger.log(`Failed to connect to Discord, retrying in ${RETRY_DELAY/1000} seconds... (Attempt ${retryCount + 1}/${MAX_RETRIES})`);
+      setTimeout(() => connectWithRetry(retryCount + 1), RETRY_DELAY);
+    } else {
+      Logger.log('Failed to connect to Discord after maximum retry attempts');
     }
   }
 };
@@ -86,18 +103,8 @@ const getActivity = (): Presence => {
  * Set up the discord rpc and listen on globalEvents.updateInfo
  */
 export const initRPC = () => {
-  rpc = new Client({ transport: "ipc" });
+  rpc = new Client({ transport: {type: "ipc"}, clientId });
-  rpc.login({ clientId }).then(
+  connectWithRetry();
-    () => {
-      rpc.on("ready", () => {
-        rpc.setActivity(getActivity());
-      });
-      ipcMain.on(globalEvents.updateInfo, observer);
-    },
-    () => {
-      Logger.log("Can't connect to Discord, is it running?");
-    }
-  );
 };
 
 /**
@@ -105,7 +112,7 @@ export const initRPC = () => {
  */
 export const unRPC = () => {
   if (rpc) {
-    rpc.clearActivity();
+    rpc.user?.clearActivity();
     rpc.destroy();
     rpc = null;
     ipcMain.removeListener(globalEvents.updateInfo, observer);

src/scripts/settings.ts

@@ -42,12 +42,10 @@ export const settingsStore = new Store({
     enableCustomHotkeys: false,
     enableDiscord: false,
     discord: {
-      showSong: true,
       idleText: "Browsing Tidal",
       usingText: "Playing media on TIDAL",
       includeTimestamps: true,
       detailsPrefix: "Listening to ",
-      buttonText: "Play on Tidal",
     },
     ListenBrainz: {
       enabled: false,
@@ -88,16 +86,8 @@ export const settingsStore = new Store({
         migrationStore.get(settings.ListenBrainz.delay) ?? 5000
       );
     },
-    "5.8.0": (migrationStore) => {
-      console.log("running migrations for 5.8.0");
-      migrationStore.set(
-        settings.discord.includeTimestamps,
-        migrationStore.get(settings.discord.includeTimestamps) ?? true
-      );
-    },
     "5.9.0": (migrationStore) => {
       buildMigration("5.9.0", migrationStore, [
-        { key: settings.discord.showSong, value: "true" },
         { key: settings.discord.idleText, value: "Browsing Tidal" },
         {
           key: settings.discord.usingText,
@@ -114,7 +104,7 @@ export const settingsStore = new Store({
       buildMigration("5.15.0", migrationStore, [
         { key: settings.advanced.tidalUrl, value: "https://listen.tidal.com" },
       ]);
-    },
+    }
   },
 });