Bugfix/discord tray icon incompatibility (#741)

* Fixes false positive virus detection problems with Windows build

* Initial fix

* Adds logging

* Refactoring

* More refactoring

* Smalle changes

* Some renames

* Works

* Works well

* Major rewrite

.github/workflows/merge.yml

@@ -86,24 +86,33 @@ jobs:
         runs-on: windows-2019
         if: github.event.pull_request.merged == true
         steps:
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@master
-              with:
-                  node-version: '20.x'
-            - name: install dependencies
-              run: npm install
-            - name: run unit tests
-              run: npm run test
-            - name: build
-              run: npm run electron:windows
-            - name: fetch current version
-              id: ver_name
-              uses: notiz-dev/github-action-json-property@release
-              with:
-                  path: 'package.json'
-                  prop_path: 'version'
-            - name: upload build artifacts
-              uses: actions/upload-artifact@v4
-              with:
-                  name: dopamine-merge-win
-                  path: release\Dopamine-*.exe
+          - uses: actions/checkout@v2
+          - uses: actions/setup-node@master
+            with:
+              node-version: '20.x'
+          - name: Install dependencies
+            run: npm install
+          - name: Run unit tests
+            run: npm run test
+          - name: Build
+            run: npm run electron:windows
+          - name: Fetch current version
+            id: ver_name
+            uses: notiz-dev/github-action-json-property@release
+            with:
+              path: 'package.json'
+              prop_path: 'version'
+          - name: Download and Install 7-Zip
+            run: |
+              curl -L -o 7z.exe https://www.7-zip.org/a/7z2201-x64.exe
+              Start-Process -FilePath 7z.exe -ArgumentList '/S' -Wait
+          - name: Create 7z Archive With Only EXE Files
+            shell: cmd
+            run: |
+              cd release
+              "C:\Program Files\7-Zip\7z.exe" a ../dopamine-nightly-win.7z Dopamine-*.exe
+          - name: Upload Build Artifact
+            uses: actions/upload-artifact@v4
+            with:
+              name: dopamine-nightly-win
+              path: dopamine-nightly-win.7z

.github/workflows/nightly.yml

@@ -82,26 +82,35 @@ jobs:
                   path: release/Dopamine-*.dmg
 
     nightly_build_on_win:
-        runs-on: windows-2019
-        steps:
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@master
-              with:
-                  node-version: '20.x'
-            - name: install dependencies
-              run: npm install
-            - name: run unit tests
-              run: npm run test
-            - name: build
-              run: npm run electron:windows
-            - name: fetch current version
-              id: ver_name
-              uses: notiz-dev/github-action-json-property@release
-              with:
-                  path: 'package.json'
-                  prop_path: 'version'
-            - name: upload build artifacts
-              uses: actions/upload-artifact@v4
-              with:
-                  name: dopamine-nightly-win
-                  path: release\Dopamine-*.exe
+      runs-on: windows-2019
+      steps:
+        - uses: actions/checkout@v2
+        - uses: actions/setup-node@master
+          with:
+            node-version: '20.x'
+        - name: Install dependencies
+          run: npm install
+        - name: Run unit tests
+          run: npm run test
+        - name: Build
+          run: npm run electron:windows
+        - name: Fetch current version
+          id: ver_name
+          uses: notiz-dev/github-action-json-property@release
+          with:
+            path: 'package.json'
+            prop_path: 'version'
+        - name: Download and Install 7-Zip
+          run: |
+            curl -L -o 7z.exe https://www.7-zip.org/a/7z2201-x64.exe
+            Start-Process -FilePath 7z.exe -ArgumentList '/S' -Wait
+        - name: Create 7z Archive With Only EXE Files
+          shell: cmd
+          run: |
+            cd release
+            "C:\Program Files\7-Zip\7z.exe" a ../dopamine-nightly-win.7z Dopamine-*.exe
+        - name: Upload Build Artifact
+          uses: actions/upload-artifact@v4
+          with:
+            name: dopamine-nightly-win
+            path: dopamine-nightly-win.7z

main.ts

@@ -14,6 +14,10 @@ import * as Store from 'electron-store';
 import * as path from 'path';
 import * as url from 'url';
 import { Worker } from 'worker_threads';
+import { DiscordApi } from './main/api/discord/discord-api';
+import { SensitiveInformation } from './main/common/application/sensitive-information';
+import { DiscordApiCommand } from './main/api/discord/discord-api-command';
+import { DiscordApiCommandType } from './main/api/discord/discord-api-command-type';
 
 /**
  * Command line parameters
@@ -35,6 +39,8 @@ const globalAny: any = global; // Global does not allow setting custom propertie
 const settings: Store<any> = new Store();
 const args: string[] = process.argv.slice(1);
 const isServing: boolean = args.some((val) => val === '--serve');
+const discordApi = new DiscordApi(SensitiveInformation.discordClientId);
+
 let mainWindow: BrowserWindow | undefined;
 let tray: Tray;
 let isQuitting: boolean;
@@ -480,6 +486,10 @@ try {
             isQuit = true;
         });
 
+        app.on('will-quit', () => {
+            discordApi.shutdown();
+        });
+
         app.whenReady().then(() => {
             // See: https://github.com/electron/electron/issues/23757
             protocol.registerFileProtocol('file', (request, callback) => {
@@ -544,7 +554,7 @@ try {
         });
 
         ipcMain.on('indexing-worker', (event: any, arg: any) => {
-            const workerThread = new Worker(path.join(__dirname, 'main/workers/indexing-worker.js'), {
+            const workerThread = new Worker(path.join(__dirname, 'main/background-work/workers/indexing-worker.js'), {
                 workerData: { arg },
             });
 
@@ -607,6 +617,14 @@ try {
             log.info('[Main] [clear-file-queue] Clearing file queue');
             globalAny.fileQueue = [];
         });
+
+        ipcMain.on('discord-api-command', (event: any, command: DiscordApiCommand) => {
+            if (command.commandType === DiscordApiCommandType.SetPresence) {
+                discordApi.setPresence(command.args!);
+            } else if (command.commandType === DiscordApiCommandType.ClearPresence) {
+                discordApi.clearPresence();
+            }
+        });
     }
 } catch (e) {
     log.error(`[Main] [Main] Could not start. Error: ${e.message}`);

main/api/discord/discord-api-command-type.ts

@@ -0,0 +1,4 @@
+export enum DiscordApiCommandType {
+    SetPresence,
+    ClearPresence,
+}

main/api/discord/discord-api-command.ts

@@ -0,0 +1,9 @@
+import { PresenceArgs } from './presence-args';
+import { DiscordApiCommandType } from './discord-api-command-type';
+
+export class DiscordApiCommand {
+    public constructor(
+        public commandType: DiscordApiCommandType,
+        public args: PresenceArgs | undefined,
+    ) {}
+}

main/api/discord/discord-api.ts

@@ -0,0 +1,100 @@
+import { Client, Presence } from 'discord-rpc';
+import log from 'electron-log';
+import { PresenceArgs } from './presence-args';
+
+export class DiscordApi {
+    private readonly _clientId: string;
+    private _client: Client;
+    private _isReady: boolean;
+    private _presenceToSetWhenReady: PresenceArgs | undefined;
+    private _isReconnecting: boolean = false;
+
+    public constructor(clientId: string) {
+        this._clientId = clientId;
+    }
+
+    private reconnect(): void {
+        if (this._isReconnecting) {
+            log.info('[DiscordApi] [reconnect] Already attempting to reconnect. Skipping...');
+            return;
+        }
+
+        this._isReconnecting = true;
+        this._isReady = false;
+        this._client = new Client({ transport: 'ipc' });
+
+        this._client.on('ready', () => {
+            log.info('[DiscordApi] [ready] Discord client is ready!');
+            this._isReady = true;
+
+            if (this._presenceToSetWhenReady) {
+                this.setPresence(this._presenceToSetWhenReady);
+                this._presenceToSetWhenReady = undefined;
+            }
+        });
+
+        this._client.on('disconnected', () => {
+            log.info('[DiscordApi] [disconnected] Discord client disconnected. Attempting to reconnect...');
+            this._isReady = false;
+            this.login();
+        });
+
+        this.login();
+    }
+
+    private async login(): Promise<void> {
+        try {
+            await this._client.login({ clientId: this._clientId });
+            log.info('[DiscordApi] [login] Successfully logged into Discord client');
+        } catch (error) {
+            log.error(`[DiscordApi] [login] Failed to log into Discord client: ${error}`);
+        } finally {
+            this._isReconnecting = false;
+        }
+    }
+
+    public setPresence(args: PresenceArgs): void {
+        if (!this._isReady) {
+            log.warn('[DiscordApi] [setPresence] Discord client is not ready. Attempting reconnect.');
+            this._presenceToSetWhenReady = args;
+            this.reconnect();
+
+            return;
+        }
+
+        const presence: Presence = {
+            details: `${args.title}`,
+            state: `${args.artists}`,
+            largeImageKey: args.largeImageKey,
+            largeImageText: args.largeImageText,
+            smallImageKey: args.smallImageKey,
+            smallImageText: args.smallImageText,
+        };
+
+        if (args.shouldSendTimestamps && args.startTime) {
+            presence.startTimestamp = Math.floor(args.startTime / 1000);
+        }
+
+        this._client.setActivity(presence);
+        log.info(`[DiscordApi] [setPresence] Rich Presence updated: ${presence.state} - ${presence.details} (${presence.smallImageKey})`);
+    }
+
+    public clearPresence(): void {
+        this._presenceToSetWhenReady = undefined;
+
+        if (!this._isReady) {
+            log.warn('[DiscordApi] [clearPresence] Discord client is not ready. Cannot clear presence.');
+            return;
+        }
+
+        this._client.clearActivity();
+        log.info('[DiscordApi] [clearPresence] Rich Presence cleared.');
+    }
+
+    public shutdown(): void {
+        this._presenceToSetWhenReady = undefined;
+
+        this._client.destroy();
+        log.info('[DiscordApi] [shutdown] Discord client destroyed.');
+    }
+}

main/api/discord/presence-args.ts

@@ -0,0 +1,10 @@
+export interface PresenceArgs {
+    title: string;
+    artists: string;
+    smallImageKey?: string;
+    smallImageText?: string;
+    largeImageKey?: string;
+    largeImageText?: string;
+    shouldSendTimestamps?: boolean;
+    startTime?: number;
+}

main/ioc/ioc.js → main/background-work/ioc/ioc.js

@@ -1,6 +1,6 @@
 const { DateTime } = require('../common/date-time');
 const { FileAccess } = require('../common/io/file-access');
-const { WorkerProxy } = require('../workers/worker-proxy');
+const { WorkerProxy } = require('../worker-proxy');
 const { DatabaseFactory } = require('../data/database.factory');
 const { FolderRepository } = require('../data/folder-repository');
 const { FolderTrackRepository } = require('../data/folder-track-repository');

main/common/application/sensitive-information.ts

@@ -0,0 +1,3 @@
+export class SensitiveInformation {
+    public static readonly discordClientId: string = '826521040275636325';
+}

src/app/app.component.ts

@@ -83,7 +83,7 @@ export class AppComponent implements OnInit {
 
         this.audioVisualizer.initialize();
         await this.addToPlaylistMenu.initializeAsync();
-        this.discordService.setRichPresenceFromSettings();
+        this.discordService.initialize();
         await this.appearanceService.applyAppearanceAsync();
         this.translatorService.applyLanguage();
         this.trayService.updateTrayContextMenu();

src/app/app.module.ts

@@ -171,8 +171,6 @@ import { ArtistInformationService } from './services/artist-information/artist-i
 import { ArtistService } from './services/artist/artist.service';
 import { CollectionService } from './services/collection/collection.service';
 import { DialogService } from './services/dialog/dialog.service';
-import { DiscordService } from './services/discord/discord.service';
-import { PresenceUpdater } from './services/discord/presence-updater';
 import { ElectronService } from './services/electron.service';
 import { FileService } from './services/file/file.service';
 import { FolderService } from './services/folder/folder.service';
@@ -516,7 +514,6 @@ export function appInitializerFactory(translate: TranslateService, injector: Inj
         WebSearchApi,
         MetadataPatcher,
         TracksColumnsOrdering,
-        PresenceUpdater,
         SemanticZoomHeaderAdder,
         DefaultThemesCreator,
         ArtistsPersister,

src/app/common/application/sensitive-information.ts

@@ -2,5 +2,4 @@ export class SensitiveInformation {
     public static readonly lastfmApiKey: string = '1be93666a6e8d3d79b05b1c74682cb62';
     public static readonly lastfmSharedSecret: string = 'c71f3fbae4ee6be95664d5406261094e';
     public static readonly fanartApiKey: string = '80d1c44e9b315f0c1963857e4d671a85';
-    public static readonly discordClientId: string = '826521040275636325';
 }

src/app/services/discord/discord-api-command-type.ts

@@ -0,0 +1,4 @@
+export enum DiscordApiCommandType {
+    SetPresence,
+    ClearPresence,
+}