Merge 256832dab6 into aaf7a1b662

Fix Discord RPC Timestamp jitter

.vscode/settings.json

@@ -14,7 +14,6 @@
     "rescrobbler",
     "scrobble",
     "scrobbling",
-    "Songwhip",
     "trackid",
     "tracklist",
     "widevine",

CHANGELOG.md

@@ -4,6 +4,13 @@ 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.17.0]
+
+- Added an option to disable the dynamic title and set it to a static one, [#491](https://github.com/Mastermindzh/tidal-hifi/pull/491)
+- Discord integration now says "Listening to" instead of "playing" [#488](https://github.com/Mastermindzh/tidal-hifi/pull/488) && [#454](https://github.com/Mastermindzh/tidal-hifi/pull/454)
+- Fixed several element names in the dom scraper
+- Removed the Songwhip (they shut down) integration and replaced it with TIDAL's universal link system
+
 ## [5.16.0]
 
 - Fix issue #449 Discord RPC stuck on "Browsing Tidal".

README.md

@@ -48,7 +48,6 @@ The web version of [listen.tidal.com](https://listen.tidal.com) running in elect
 - AlbumArt in integrations ([best-effort](https://github.com/Mastermindzh/tidal-hifi/pull/88#pullrequestreview-840814847))
 - Custom [integrations](#integrations)
   - [ListenBrainz](https://listenbrainz.org/?redirect=false) integration
-  - Songwhip.com integration (hotkey `ctrl + w`)
   - Discord RPC integration (showing "now listening", "Browsing", etc)
     - Flatpak version only works if both Discord and Tidal-HiFi are flatpaks
   - MPRIS integration

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tidal-hifi",
-  "version": "5.16.0",
+  "version": "5.17.0",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "ts-dist/main.js",
   "scripts": {
@@ -42,24 +42,21 @@
   "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.9",
     "cors": "^2.8.5",
-    "discord-rpc": "^4.0.1",
     "electron-store": "^8.2.0",
-    "express": "^4.19.2",
+    "express": "^4.21.2",
     "hotkeys-js": "^3.13.7",
     "mpris-service": "^2.1.2",
-    "request": "^2.88.2",
-    "sass": "^1.77.8",
+    "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",
     "@types/swagger-ui-express": "^4.1.6",
     "@typescript-eslint/eslint-plugin": "^7.16.0",
     "@typescript-eslint/parser": "^7.15.0",

scripts/verifyElements.js

@@ -16,8 +16,9 @@
     search: '[class^="searchField"]',
     shuffle: '*[data-test="shuffle"]',
     repeat: '*[data-test="repeat"]',
-    account: '*[class^="profileOptions"]',
-    settings: '*[data-test^="open-settings"]',
+    account: '*[data-test^="profile-image-button"]',
+    settings: '*[data-test^="sidebar-menu-button"]',
+    openSettings: '*[data-test^="open-settings"]',
     media: '*[data-test="current-media-imagery"]',
     image: "img",
     current: '*[data-test="current-time"]',

src/constants/globalEvents.ts

@@ -10,9 +10,11 @@ export const globalEvents = {
   showSettings: "showSettings",
   storeChanged: "storeChanged",
   error: "error",
-  whip: "whip",
+  getUniversalLink: "getUniversalLink",
   log: "log",
   toggleFavorite: "toggleFavorite",
   toggleShuffle: "toggleShuffle",
   toggleRepeat: "toggleRepeat",
+  axios: "axios",
+  axiosReply: "axiosReply",
 };

src/constants/settings.ts

@@ -55,6 +55,7 @@ export const settings = {
   singleInstance: "singleInstance",
   skipArtists: "skipArtists",
   skippedArtists: "skippedArtists",
+  staticWindowTitle: "staticWindowTitle",
   theme: "theme",
   trayIcon: "trayIcon",
   updateFrequency: "updateFrequency",

src/features/api/swagger.json

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

src/features/sharingService/sharingService.ts

@@ -0,0 +1,10 @@
+export class SharingService {
+  /**
+   * Retrieve the universal link given a regular track link
+   * @param currentUrl
+   * @returns
+   */
+  public static getUniversalLink(currentUrl: string): string {
+    return `${currentUrl}?u`;
+  }
+}

src/features/songwhip/models/Artist.ts

@@ -1,21 +0,0 @@
-import { ServiceLinks } from "./ServiceLinks";
-
-export interface Artist {
-  type: string;
-  id: number;
-  path: string;
-  name: string;
-  sourceUrl: string;
-  sourceCountry: string;
-  url: string;
-  image: string;
-  createdAt: string;
-  updatedAt: string;
-  refreshedAt: string;
-  serviceIds: { [key: string]: string };
-  orchardId: string;
-  spotifyId: string;
-  links: { [key: string]: ServiceLinks[] };
-  linksCountries: string[];
-  description: string;
-}

src/features/songwhip/models/ServiceLinks.ts

@@ -1,4 +0,0 @@
-export interface ServiceLinks {
-  link: string;
-  countries: string[];
-}

src/features/songwhip/models/whip.ts

@@ -1,27 +0,0 @@
-import { Artist } from "./Artist";
-import { ServiceLinks } from "./ServiceLinks";
-
-export interface WhippedResult {
-  status: string;
-  data: {
-    item: {
-      type: string;
-      id: number;
-      path: string;
-      name: string;
-      url: string;
-      sourceUrl: string;
-      sourceCountry: string;
-      releaseDate: string;
-      createdAt: string;
-      updatedAt: string;
-      refreshedAt: string;
-      image: string;
-      isrc: string;
-      isExplicit: boolean;
-      links: { [key: string]: ServiceLinks[] };
-      linksCountries: string[];
-      artists: Artist[];
-    };
-  };
-}

src/features/songwhip/songwhip.ts

@@ -1,32 +0,0 @@
-import { WhippedResult } from "./models/whip";
-import axios from "axios";
-
-export class Songwhip {
-  /**
-   * Call the songwhip API and create a shareable songwhip page
-   * @param currentUrl
-   * @returns
-   */
-  public static async whip(currentUrl: string): Promise<WhippedResult> {
-    try {
-      const response = await axios.post("https://songwhip.com/api/songwhip/create", {
-        url: currentUrl,
-        // doesn't actually matter.. returns everything the same way anyway
-        country: "NL",
-      });
-
-      return response.data;
-    } catch (error) {
-      console.log(JSON.stringify(error));
-    }
-  }
-
-  /**
-   * Transform a songwhip response into a shareable url
-   * @param response
-   * @returns
-   */
-  public static getWhipUrl(response: WhippedResult) {
-    return `https://songwhip.com${response.data.item.url}`;
-  }
-}

src/main.ts

@@ -10,7 +10,7 @@ import {
   releaseInhibitorIfActive,
 } from "./features/idleInhibitor/idleInhibitor";
 import { Logger } from "./features/logger";
-import { Songwhip } from "./features/songwhip/songwhip";
+import { SharingService } from "./features/sharingService/sharingService";
 import { MediaInfo } from "./models/mediaInfo";
 import { MediaStatus } from "./models/mediaStatus";
 import { initRPC, rpc, unRPC } from "./scripts/discord";
@@ -24,6 +24,7 @@ import {
   showSettingsWindow,
 } from "./scripts/settings";
 import { addTray, refreshTray } from "./scripts/tray";
+import { downloadFile } from "./scripts/download";
 let mainInhibitorId = -1;
 
 initialize();
@@ -250,8 +251,18 @@ ipcMain.on(globalEvents.error, (event) => {
   console.log(event);
 });
 
-ipcMain.handle(globalEvents.whip, async (event, url) => {
-  return Songwhip.whip(url);
+ipcMain.on(globalEvents.axios, (event, fileUrl: string, targetPath: string) => {
+  const download = downloadFile(fileUrl, targetPath);
+  download.then(() => {
+    event.reply(globalEvents.axiosReply, fileUrl, targetPath, false);
+  }).catch(() => {
+    // don't send error information, it isn't used anyways
+    event.reply(globalEvents.axiosReply, fileUrl, targetPath, true);
+  });
+});
+
+ipcMain.handle(globalEvents.getUniversalLink, async (event, url) => {
+  return SharingService.getUniversalLink(url);
 });
 
 Logger.watch(ipcMain);

src/pages/settings/preload.ts

@@ -46,6 +46,7 @@ let adBlock: HTMLInputElement,
   singleInstance: HTMLInputElement,
   skipArtists: HTMLInputElement,
   skippedArtists: HTMLInputElement,
+  staticWindowTitle: HTMLInputElement,
   theme: HTMLSelectElement,
   trayIcon: HTMLInputElement,
   updateFrequency: HTMLInputElement,
@@ -140,8 +141,9 @@ function refreshSettings() {
     port.value = settingsStore.get(settings.apiSettings.port);
     singleInstance.checked = settingsStore.get(settings.singleInstance);
     skipArtists.checked = settingsStore.get(settings.skipArtists);
-    theme.value = settingsStore.get(settings.theme);
     skippedArtists.value = settingsStore.get<string, string[]>(settings.skippedArtists).join("\n");
+    staticWindowTitle.checked = settingsStore.get(settings.staticWindowTitle);
+    theme.value = settingsStore.get(settings.theme);
     trayIcon.checked = settingsStore.get(settings.trayIcon);
     updateFrequency.value = settingsStore.get(settings.updateFrequency);
     enableListenBrainz.checked = settingsStore.get(settings.ListenBrainz.enabled);
@@ -261,6 +263,7 @@ window.addEventListener("DOMContentLoaded", () => {
   trayIcon = get("trayIcon");
   skipArtists = get("skipArtists");
   skippedArtists = get("skippedArtists");
+  staticWindowTitle = get("staticWindowTitle");
   singleInstance = get("singleInstance");
   updateFrequency = get("updateFrequency");
   enableListenBrainz = get("enableListenBrainz");
@@ -295,6 +298,7 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(port, settings.apiSettings.port);
   addInputListener(skipArtists, settings.skipArtists);
   addTextAreaListener(skippedArtists, settings.skippedArtists);
+  addInputListener(staticWindowTitle, settings.staticWindowTitle);
   addInputListener(singleInstance, settings.singleInstance);
   addSelectListener(theme, settings.theme);
   addInputListener(trayIcon, settings.trayIcon);

src/pages/settings/settings.html

@@ -106,6 +106,16 @@
                 <span class="switch__slider"></span>
               </label>
             </div>
+            <div class="group__option">
+              <div class="group__description">
+                <h4>Static Window Title</h4>
+                <p>Makes the window title "TIDAL Hi-Fi" instead of changing to the currently playing song.</p>
+              </div>
+              <label class="switch">
+                <input id="staticWindowTitle" type="checkbox" />
+                <span class="switch__slider"></span>
+              </label>
+            </div>
             <div class="group__option">
               <div class="group__description">
                 <h4>Minimize on Close</h4>
@@ -468,7 +478,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.16.0">5.16.0</a>
+              href="https://github.com/Mastermindzh/tidal-hifi/releases/tag/5.17.0">5.17.0</a>
           </div>
           <div class="about-section__links">
             <a target="_blank" rel="noopener" href="https://github.com/mastermindzh/tidal-hifi/"
@@ -491,4 +501,4 @@
   </div>
 </body>
 
-</html>
+</html>

src/preload.ts

@@ -10,13 +10,13 @@ import {
 } from "./features/listenbrainz/listenbrainz";
 import { StoreData } from "./features/listenbrainz/models/storeData";
 import { Logger } from "./features/logger";
-import { Songwhip } from "./features/songwhip/songwhip";
+import { SharingService } from "./features/sharingService/sharingService";
 import { addCustomCss } from "./features/theming/theming";
 import { convertDurationToSeconds } from "./features/time/parse";
 import { MediaInfo } from "./models/mediaInfo";
 import { MediaStatus } from "./models/mediaStatus";
 import { RepeatState } from "./models/repeatState";
-import { downloadFile } from "./scripts/download";
+import { downloadFile } from "./scripts/downloadPreload";
 import { addHotkey } from "./scripts/hotkeys";
 import { ObjectToDotNotation } from "./scripts/objectUtilities";
 import { settingsStore } from "./scripts/settings";
@@ -48,8 +48,9 @@ const elements = {
   search: '[class^="searchField"]',
   shuffle: '*[data-test="shuffle"]',
   repeat: '*[data-test="repeat"]',
-  account: '*[class^="profileOptions"]',
-  settings: '*[data-test^="open-settings"]',
+  account: '*[data-test^="profile-image-button"]',
+  settings: '*[data-test^="sidebar-menu-button"]',
+  openSettings: '*[data-test^="open-settings"]',
   media: '*[data-test="current-media-imagery"]',
   image: "img",
   current: '*[data-test="current-time"]',
@@ -220,9 +221,9 @@ ListenBrainzStore.clear();
 function addHotKeys() {
   if (settingsStore.get(settings.enableCustomHotkeys)) {
     addHotkey("Control+p", function () {
-      elements.click("account");
+      elements.click("settings");
       setTimeout(() => {
-        elements.click("settings");
+        elements.click("openSettings");
       }, 100);
     });
     addHotkey("Control+l", function () {
@@ -254,11 +255,10 @@ function addHotKeys() {
       elements.click("repeat");
     });
     addHotkey("control+w", async function () {
-      const result = await ipcRenderer.invoke(globalEvents.whip, getTrackURL());
-      const url = Songwhip.getWhipUrl(result);
+      const url = SharingService.getUniversalLink(getTrackURL());
       clipboard.writeText(url);
       new Notification({
-        title: `Successfully whipped: `,
+        title: `Universal link generated: `,
         body: `URL copied to clipboard: ${url}`,
       }).show();
     });
@@ -550,6 +550,7 @@ setInterval(function () {
   const artistsArray = elements.getArtistsArray();
   const artistsString = elements.getArtistsString(artistsArray);
   const songDashArtistTitle = `${title} - ${artistsString}`;
+  const staticTitle = "TIDAL Hi-Fi";
   const titleOrArtistsChanged = currentSong !== songDashArtistTitle;
   const current = elements.getText("current");
   const currentStatus = getCurrentlyPlayingStatus();
@@ -594,7 +595,9 @@ setInterval(function () {
     };
 
     // update title, url and play info with new info
-    setTitle(songDashArtistTitle);
+    settingsStore.get(settings.staticWindowTitle)
+      ? setTitle(staticTitle)
+      : setTitle(songDashArtistTitle);
     getTrackURL();
     currentSong = songDashArtistTitle;
     currentPlayStatus = currentStatus;

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,6 +12,10 @@ const clientId = "833617820704440341";
 
 export let rpc: Client;
 
+const ACTIVITY_LISTENING = 2;
+const MAX_RETRIES = 5;
+const RETRY_DELAY = 10000;
+
 const observer = () => {
   if (rpc) {
     updateActivity();
@@ -22,19 +26,20 @@ const defaultPresence = {
   largeImageKey: "tidal-hifi-icon",
   largeImageText: `TIDAL Hi-Fi ${app.getVersion()}`,
   instance: false,
+  type: ACTIVITY_LISTENING
 };
 
 const updateActivity = () => {
   const showIdle = settingsStore.get<string, boolean>(settings.discord.showIdle) ?? true;
   if (mediaInfo.status === MediaStatus.paused && !showIdle) {
-    rpc.clearActivity();
+    rpc.user?.clearActivity();
   } else {
-    rpc.setActivity(getActivity());
+    rpc.user?.setActivity(getActivity());
   }
 };
 
-const getActivity = (): Presence => {
-  const presence: Presence = { ...defaultPresence };
+const getActivity = (): SetActivity => {
+  const presence: SetActivity = { ...defaultPresence };
 
   if (mediaInfo.status === MediaStatus.paused) {
     presence.details =
@@ -50,6 +55,7 @@ const getActivity = (): Presence => {
         settingsStore.get<string, string>(settings.discord.usingText) ?? "Playing media on TIDAL";
     }
   }
+
   return presence;
 
   function getFromStore() {
@@ -97,11 +103,29 @@ const getActivity = (): Presence => {
     if (includeTimestamps) {
       const currentSeconds = convertDurationToSeconds(mediaInfo.current);
       const durationSeconds = convertDurationToSeconds(mediaInfo.duration);
-      const date = new Date();
-      const now = (date.getTime() / 1000) | 0;
-      const remaining = date.setSeconds(date.getSeconds() + (durationSeconds - currentSeconds));
-      presence.startTimestamp = now;
-      presence.endTimestamp = remaining;
+      const now = Math.trunc((Date.now() + 500) / 1000);
+      presence.startTimestamp = now - currentSeconds;
+      presence.endTimestamp = presence.startTimestamp + durationSeconds;
+    }
+  }
+};
+
+/**
+ * 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');
     }
   }
 };
@@ -110,22 +134,8 @@ const getActivity = (): Presence => {
  * Set up the discord rpc and listen on globalEvents.updateInfo
  */
 export const initRPC = () => {
-  rpc = new Client({ transport: "ipc" });
-  rpc.login({ clientId }).then(
-    () => {
-      rpc.on("ready", () => {
-        updateActivity();
-      });
-
-      const { updateInfo, play, pause, playPause } = globalEvents;
-      [updateInfo, play, pause, playPause].forEach((status) => {
-        ipcMain.on(status, observer);
-      });
-    },
-    () => {
-      Logger.log("Can't connect to Discord, is it running?");
-    }
-  );
+  rpc = new Client({ transport: {type: "ipc"}, clientId });
+  connectWithRetry();
 };
 
 /**
@@ -133,7 +143,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/download.ts

@@ -1,5 +1,5 @@
 import fs from "fs";
-import request from "request";
+import axios from "axios";
 
 /**
  * download and save a file
@@ -8,16 +8,20 @@ import request from "request";
  */
 export const downloadFile = function (fileUrl: string, targetPath: string) {
   return new Promise((resolve, reject) => {
-    const req = request({
-      method: "GET",
-      uri: fileUrl,
-    });
+    axios
+      .get(fileUrl, {
+        responseType: "stream",
+      })
+      .then((res) => {
+        const out = fs.createWriteStream(targetPath);
 
-    const out = fs.createWriteStream(targetPath);
-    req.pipe(out);
+        res.data.pipe(out);
 
-    req.on("end", resolve);
+        out.on("finish", resolve);
 
-    req.on("error", reject);
+        out.on("error", reject);
+
+        res.data.on("error", reject);
+      }).catch(reject);
   });
 };

src/scripts/downloadPreload.ts

@@ -0,0 +1,23 @@
+import { ipcRenderer } from "electron";
+import { globalEvents } from "../constants/globalEvents";
+
+/**
+ * download and save a file (renderer version)
+ * @param {string} fileUrl url to download
+ * @param {string} targetPath path to save it at
+ */
+export const downloadFile = function (fileUrl: string, targetPath: string) {
+  return new Promise<void>((resolve, reject) => {
+    const handler = (event: Electron.IpcRendererEvent, newFileUrl: string, newTargetPath: string, error: boolean) => {
+      // it's possible for 2 requests to be running at the same time, so make sure it is the right one
+      // if there is 2 requests with the same fileUrl and targetPath, then it doesn't matter which one we intercept because the data is the same
+      if (fileUrl === newFileUrl && targetPath === newTargetPath) {
+        ipcRenderer.removeListener(globalEvents.axiosReply, handler);
+        if (error) reject();
+        else resolve();
+      }
+    }
+    ipcRenderer.on(globalEvents.axiosReply, handler);
+    ipcRenderer.send(globalEvents.axios, fileUrl, targetPath);
+  });
+};

src/scripts/settings.ts

@@ -69,6 +69,7 @@ export const settingsStore = new Store({
     singleInstance: true,
     skipArtists: false,
     skippedArtists: [""],
+    staticWindowTitle: false,
     theme: "none",
     trayIcon: true,
     updateFrequency: 500,