✨🐛 Add Scobble percent & Fix Last.fm login

.vscode/settings.json

@@ -1,4 +1,7 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
-  "editor.defaultFormatter": "esbenp.prettier-vscode"
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "cSpell.words": [
+    "scrobble"
+  ]
 }

src/main/index.ts

@@ -364,7 +364,8 @@ const store = new Conf<StoreSchema>({
       api_key: "2a69bcf769a7a28a8bf2f6a5100accad",
       secret: "46eea23770a459a49eb4d26cbf46b41c",
       token: null,
-      sessionKey: null
+      sessionKey: null,
+      scrobblePercent: 50
     },
     developer: {
       enableDevTools: false
@@ -384,6 +385,11 @@ const store = new Conf<StoreSchema>({
       if (!store.has("appearance.zoom")) {
         store.set("appearance.zoom", 100);
       }
+    },
+    ">=2.0.1": store => {
+      if (!store.has("lastfm.scrobblePercent")) {
+        store.set("lastfm.scrobblePercent", 50);
+      }
     }
   }
 });

src/main/integrations/last-fm/index.ts

@@ -58,7 +58,6 @@ export default class LastFM implements IIntegration {
     const response = await fetch(`https://ws.audioscrobbler.com/2.0/` + `?${this.createQueryString(params, api_sig)}`);
 
     const json = (await response.json()) as LastfmSessionResponse;
-
     if (json.error) {
       await this.authenticateUser();
     } else if (json.session) {
@@ -95,16 +94,23 @@ export default class LastFM implements IIntegration {
 
       clearTimeout(this.scrobbleTimer);
 
+      // Track must be longer than 30 seconds
+      // https://www.last.fm/api/scrobbling "When is a scrobble a scrobble?"
+      if (state.videoDetails.durationSeconds < 30) {
+        return;
+      }
+
       this.updateNowPlaying(state.videoDetails);
 
+      this.lastfmDetails.scrobblePercent = this.store.get("lastfm.scrobblePercent");
+      const scrobblePercentDecimal = this.lastfmDetails.scrobblePercent / 100;
       const scrobbleTimeRequired = Math.min(
-        // Scrobble the track if it has been played for more than 50% of its duration
-        Math.round(state.videoDetails.durationSeconds / 2),
-        // OR if it has been played for more than 4 minutes
+        // Scrobble the track if it has been played to the percent picked by the user
+        Math.round(state.videoDetails.durationSeconds * scrobblePercentDecimal),
+        // OR if it has been played for more than 4 minutes, scrobble maximum time: https://www.last.fm/api/scrobbling
         240
       );
       const scrobbleTime = new Date().getTime();
-
       this.scrobbleTimer = setTimeout(() => {
         this.scrobbleSong(state.videoDetails, scrobbleTime);
       }, scrobbleTimeRequired * 1000);
@@ -295,9 +301,13 @@ export default class LastFM implements IIntegration {
 
   private async saveSettings(): Promise<void> {
     try {
-      this.store.set("lastfm.sessionKey", safeStorage.encryptString(this.lastfmDetails.sessionKey).toString("hex"));
-      this.store.set("lastfm.token", safeStorage.encryptString(this.lastfmDetails.token).toString("hex"));
-    } catch {
+      if (this.lastfmDetails.sessionKey) {
+        this.store.set("lastfm.sessionKey", safeStorage.encryptString(this.lastfmDetails.sessionKey).toString("hex"));
+      }
+      if (this.lastfmDetails.token) {
+        this.store.set("lastfm.token", safeStorage.encryptString(this.lastfmDetails.token).toString("hex"));
+      }
+    } catch (error) {
       // Do nothing, the values are not valid and can be ignored
     }
   }

src/renderer/windows/settings/Settings.vue

@@ -68,6 +68,7 @@ const shortcutVolumeUp = ref<string>(shortcuts.volumeUp);
 const shortcutVolumeDown = ref<string>(shortcuts.volumeDown);
 
 const lastFMSessionKey = ref<string>(lastFM.sessionKey);
+const scrobblePercent = ref<number>(lastFM.scrobblePercent);
 
 store.onDidAnyChange(async newState => {
   disableHardwareAcceleration.value = newState.general.disableHardwareAcceleration;
@@ -94,6 +95,8 @@ store.onDidAnyChange(async newState => {
   companionServerCORSWildcardEnabled.value = newState.integrations.companionServerCORSWildcardEnabled;
   discordPresenceEnabled.value = newState.integrations.discordPresenceEnabled;
   lastFMEnabled.value = newState.integrations.lastFMEnabled;
+  lastFMSessionKey.value = newState.lastfm.sessionKey;
+  scrobblePercent.value = newState.lastfm.scrobblePercent;
 
   shortcutPlayPause.value = newState.shortcuts.playPause;
   shortcutNext.value = newState.shortcuts.next;
@@ -161,6 +164,7 @@ async function settingsChanged() {
   store.set("integrations.companionServerCORSWildcardEnabled", companionServerCORSWildcardEnabled.value);
   store.set("integrations.discordPresenceEnabled", discordPresenceEnabled.value);
   store.set("integrations.lastFMEnabled", lastFMEnabled.value);
+  store.set("lastfm.scrobblePercent", scrobblePercent.value);
 
   store.set("shortcuts.playPause", shortcutPlayPause.value);
   store.set("shortcuts.next", shortcutNext.value);
@@ -229,6 +233,13 @@ function checkForUpdates() {
   checkingForUpdate.value = true;
 }
 
+async function logoutLastFM() {
+  store.set("lastfm.sessionKey", null);
+  lastFMEnabled.value = false;
+  lastFMSessionKey.value = null;
+  await settingsChanged();
+}
+
 window.ytmd.handleCheckingForUpdate(() => {
   checkingForUpdate.value = true;
 });
@@ -399,7 +410,20 @@ window.ytmd.handleUpdateDownloaded(() => {
                 <span v-else style="color: #ff1100">No</span>
               </p>
             </div>
+            <button v-if="lastFMSessionKey" @click="logoutLastFM">Logout</button>
           </div>
+          <YTMDSetting
+            v-if="lastFMEnabled"
+            v-model="scrobblePercent"
+            class="settings indented"
+            type="range"
+            name="Scrobble percent"
+            description="Determines when a song is scrobbled"
+            min="50"
+            max="95"
+            step="5"
+            @change="settingsChanged"
+          />
         </div>
 
         <div v-if="currentTab === 5" class="shortcuts-tab">

src/shared/store/schema.ts

@@ -1,7 +1,7 @@
 export type StoreSchema = {
   metadata: {
-    version: 1
-  }
+    version: 1;
+  };
   general: {
     disableHardwareAcceleration: boolean;
     hideToTrayOnClose: boolean;
@@ -50,14 +50,15 @@ export type StoreSchema = {
     secret: string;
     token: string | null;
     sessionKey: string | null;
+    scrobblePercent: number;
   };
   developer: {
-    enableDevTools: boolean
-  }
+    enableDevTools: boolean;
+  };
 };
 
 export type MemoryStoreSchema = {
-  discordPresenceConnectionFailed: boolean
+  discordPresenceConnectionFailed: boolean;
   shortcutsPlayPauseRegisterFailed: boolean;
   shortcutsNextRegisterFailed: boolean;
   shortcutsPreviousRegisterFailed: boolean;