Feature/2.11.0

.github/workflows/electron-all-build.yml

@@ -25,7 +25,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest,"macos-11"]
-        node-version: [16.x]
+        node-version: [20.x]
 
     steps:
       - name: Checkout

wowup-electron/.gitignore

@@ -8,6 +8,7 @@
 /app-builds
 /release
 /build
+/app/utils/*.js
 main.js
 ipc-events.js
 app-updater.js

wowup-electron/angular.json

@@ -99,7 +99,7 @@
         "extract-i18n": {
           "builder": "@angular-devkit/build-angular:extract-i18n",
           "options": {
-            "browserTarget": "angular-electron:build"
+            "buildTarget": "angular-electron:build"
           }
         },
         "test": {

wowup-electron/app/app-updater.ts

@@ -1,5 +1,5 @@
 import { app, BrowserWindow, ipcMain } from "electron";
-import * as log from "electron-log";
+import * as log from "electron-log/main";
 import { autoUpdater } from "electron-updater";
 import { IPC_APP_CHECK_UPDATE, IPC_APP_INSTALL_UPDATE, IPC_APP_UPDATE_STATE } from "../src/common/constants";
 import { AppUpdateDownloadProgress, AppUpdateEvent, AppUpdateState } from "../src/common/wowup/models";

wowup-electron/app/curse-folder-scanner.ts

@@ -1,6 +1,6 @@
 import * as path from "path";
 import * as _ from "lodash";
-import * as log from "electron-log";
+import * as log from "electron-log/main";
 import { exists, readDirRecursive } from "./file.utils";
 import * as fsp from "fs/promises";
 import { firstValueFrom, from, mergeMap, toArray } from "rxjs";

wowup-electron/app/file.utils.ts

@@ -1,5 +1,5 @@
 import { exec } from "child_process";
-import * as log from "electron-log";
+import * as log from "electron-log/main";
 import * as fsp from "fs/promises";
 import { max, sumBy } from "lodash";
 import * as path from "path";

wowup-electron/app/ipc-events.ts

@@ -11,7 +11,7 @@ import {
   shell,
   systemPreferences,
 } from "electron";
-import * as log from "electron-log";
+import * as log from "electron-log/main";
 import * as globrex from "globrex";
 import * as _ from "lodash";
 import { nanoid } from "nanoid";
@@ -151,6 +151,7 @@ async function getSymlinkDirs(basePath: string, files: fs.Dirent[]): Promise<Sym
   return _.filter(symlinkDirs, (symDir) => symDir.isDir);
 }
 
+/* eslint-disable @typescript-eslint/no-redundant-type-constituents */
 function handle(
   channel: RendererChannels,
   listener: (event: IpcMainInvokeEvent, ...args: any[]) => Promise<void> | any
@@ -499,9 +500,9 @@ export function initializeIpcHandlers(window: BrowserWindow): void {
   handle("decode-product-db", async (evt, filePath: string) => {
     const productDbData = await fsp.readFile(filePath);
     const productDb = ProductDb.decode(productDbData);
-    setImmediate(() => {
+    setTimeout(() => {
       console.log("productDb", JSON.stringify(productDb));
-    });
+    },1);
 
     return productDb;
   });

wowup-electron/app/main.ts

@@ -1,6 +1,6 @@
 import { dialog } from "electron";
 import { app, BrowserWindow, BrowserWindowConstructorOptions, powerMonitor } from "electron";
-import * as log from "electron-log";
+import * as log from "electron-log/main";
 import { find } from "lodash";
 import * as minimist from "minimist";
 import { arch as osArch, release as osRelease, type as osType } from "os";
@@ -44,12 +44,14 @@ import { initializeDefaultPreferences } from "./preferences";
 import { PUSH_NOTIFICATION_EVENT, pushEvents } from "./push";
 import { getPreferenceStore, initializeStoreIpcHandlers } from "./stores";
 import * as windowState from "./window-state";
+import { validateGpuCache } from "./utils/gpu-cache-buster";
 
 // LOGGING SETUP
 // Override the default log path so they aren't a pain to find on Mac
 const LOG_PATH = join(app.getPath("userData"), "logs");
 app.setAppLogsPath(LOG_PATH);
-log.transports.file.resolvePath = (variables: log.PathVariables) => {
+log.initialize();
+log.transports.file.resolvePathFn = (variables) => {
   return join(LOG_PATH, variables.fileName ?? "log-file.txt");
 };
 log.info("Main starting");
@@ -73,6 +75,8 @@ if (platform.isWin) {
   require("win-ca");
 }
 
+validateGpuCache(app)
+
 // VARIABLES
 const startedAt = Date.now();
 const argv = minimist(process.argv.slice(1), {
@@ -152,16 +156,35 @@ function getProtocol(arg: string) {
 // initialization and is ready to create browser windows.
 // Some APIs can only be used after this event occurs.
 // Added 400 ms to fix the black background issue while using transparent window. More details at https://github.com/electron/electron/issues/15947
-if (app.isReady()) {
-  log.info(`App already ready: ${Date.now() - startedAt}ms`);
-} else {
-  app.once("ready", () => {
+app
+  .whenReady()
+  .then(() => {
+    powerMonitor.on("resume", () => {
+      log.info("powerMonitor resume");
+      win?.webContents?.send(IPC_POWER_MONITOR_RESUME);
+    });
+
+    powerMonitor.on("suspend", () => {
+      log.info("powerMonitor suspend");
+      win?.webContents?.send(IPC_POWER_MONITOR_SUSPEND);
+    });
+
+    powerMonitor.on("lock-screen", () => {
+      log.info("powerMonitor lock-screen");
+      win?.webContents?.send(IPC_POWER_MONITOR_LOCK);
+    });
+
+    powerMonitor.on("unlock-screen", () => {
+      log.info("powerMonitor unlock-screen");
+      win?.webContents?.send(IPC_POWER_MONITOR_UNLOCK);
+    });
+
     log.info(`App ready: ${Date.now() - startedAt}ms`);
-    // setTimeout(() => {
     createWindow();
-    // }, 400);
+  })
+  .catch((e) => {
+    log.error("whenready failed", e);
   });
-}
 
 app.on("before-quit", () => {
   windowState.saveWindowConfig(win);
@@ -207,26 +230,6 @@ if (platform.isMac) {
   });
 }
 
-powerMonitor.on("resume", () => {
-  log.info("powerMonitor resume");
-  win?.webContents?.send(IPC_POWER_MONITOR_RESUME);
-});
-
-powerMonitor.on("suspend", () => {
-  log.info("powerMonitor suspend");
-  win?.webContents?.send(IPC_POWER_MONITOR_SUSPEND);
-});
-
-powerMonitor.on("lock-screen", () => {
-  log.info("powerMonitor lock-screen");
-  win?.webContents?.send(IPC_POWER_MONITOR_LOCK);
-});
-
-powerMonitor.on("unlock-screen", () => {
-  log.info("powerMonitor unlock-screen");
-  win?.webContents?.send(IPC_POWER_MONITOR_UNLOCK);
-});
-
 let lastCrash = 0;
 
 const crashMap = new Map<string, number>();
@@ -247,7 +250,7 @@ function onChildProcessCrashed(details: Electron.Details) {
   if (ct >= 3) {
     dialog.showErrorBox(
       "Child Process Failure",
-      `Child process ${details.serviceName} has crashed too many times, app will now exit`
+      `Child process ${details.serviceName} has crashed too many times, app will now exit`,
     );
     app.quit();
   }

wowup-electron/app/preferences.ts

@@ -15,7 +15,7 @@ import {
 } from "../src/common/constants";
 import { WowUpReleaseChannelType } from "../src/common/wowup/wowup-release-channel-type";
 import { getPreferenceStore } from "./stores";
-import * as log from "electron-log";
+import * as log from "electron-log/main";
 
 export function initializeDefaultPreferences() {
   const isBetaBuild = app.getVersion().toLowerCase().indexOf("beta") != -1;

wowup-electron/app/preload.ts

@@ -2,8 +2,7 @@
 /// <reference path="../src/common/wowup.d.ts" />
 
 import { ipcRenderer, IpcRendererEvent, shell, OpenExternalOptions } from "electron";
-import * as log from "electron-log";
-import { join } from "path";
+import * as log from "electron-log/renderer";
 import * as platform from "./platform";
 
 if (!process.isMainFrame) {
@@ -38,10 +37,6 @@ const LOG_PATH = getArg("log-path");
 const USER_DATA_PATH = getArg("user-data-path");
 const BASE_BG_COLOR = getArg("base-bg-color");
 
-log.transports.file.resolvePath = (variables: log.PathVariables) => {
-  return join(LOG_PATH, variables.fileName);
-};
-
 function onRendererEvent(channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void) {
   ipcRenderer.on(channel, listener);
 }

wowup-electron/app/push.ts

@@ -1,4 +1,4 @@
-import * as log from "electron-log";
+import * as log from "electron-log/main";
 import { EventEmitter } from "events";
 
 export const PUSH_NOTIFICATION_EVENT = "push-notification";

wowup-electron/app/utils/gpu-cache-buster.ts

@@ -0,0 +1,81 @@
+import * as fs from "fs";
+import { join } from "path";
+import * as log from "electron-log/main";
+
+/**
+ * There appears to be some issue with Ubuntu and the GPUCache system of electron
+ * https://github.com/WowUp/WowUp.CF/issues/63
+ *
+ * User from an app with similar issue discovered deleting the folder and letting the app rebuild it appears to fix it.
+ * https://github.com/ferdium/ferdium-app/issues/1265
+ *
+ * Added in a version file to the GPU cache folder that should get checked and delete the folder before the initial
+ * cache is generated hopefully fixing this issue
+ */
+
+const GPU_CACHE_FOLDER = "GPUCache";
+const GPU_VERSION_FILE = ".wuversion";
+
+interface VersionFileData {
+  version: string;
+}
+
+export function validateGpuCache(app: Electron.App) {
+  try {
+    const cacheDir = join(app.getPath("userData"), GPU_CACHE_FOLDER);
+    const cacheExists = fileExists(cacheDir);
+    if (cacheExists) {
+      const files = fs.readdirSync(cacheDir);
+      const verFile = files.find((f) => f === GPU_VERSION_FILE);
+      if (verFile === undefined) {
+        removeDir(cacheDir);
+      } else {
+        const verFile = readVersionFile(cacheDir);
+        if (verFile.version !== app.getVersion()) {
+          removeDir(cacheDir);
+        } else {
+          return;
+        }
+      }
+    }
+
+    fs.mkdirSync(cacheDir);
+    createVersionFile(app.getVersion(), cacheDir);
+  } catch (e) {
+    log.error("failed to validate GPU Cache", e);
+  }
+  // app.relaunch();
+}
+
+function removeDir(path: string) {
+  fs.rmSync(path, { force: true, recursive: true });
+}
+
+function fileExists(path: string) {
+  try {
+    fs.accessSync(path);
+    return true;
+  } catch (e) {
+    log.warn(`File does not exist: ${path}`);
+    log.warn(e.message);
+    return false;
+  }
+}
+
+function readVersionFile(cacheDir: string): VersionFileData {
+  const filePath = join(cacheDir, GPU_VERSION_FILE);
+  const fileData = fs.readFileSync(filePath, { encoding: "utf-8" });
+  const versionData: VersionFileData = JSON.parse(fileData);
+  return versionData;
+}
+
+function createVersionFile(version: string, cacheDir: string) {
+  const versionData: VersionFileData = {
+    version,
+  };
+
+  const filePath = join(cacheDir, GPU_VERSION_FILE);
+  const verFileData = JSON.stringify(versionData);
+
+  fs.writeFileSync(filePath, verFileData, { encoding: "utf-8" });
+}

wowup-electron/app/window-state.ts

@@ -1,5 +1,5 @@
 import { app, BrowserWindow, BrowserWindowConstructorOptions, Display, Rectangle, screen } from "electron";
-import * as log from "electron-log";
+import * as log from "electron-log/main";
 
 import { IPC_WINDOW_RESUME, MIN_VISIBLE_ON_SCREEN, WINDOW_MIN_HEIGHT, WINDOW_MIN_WIDTH } from "../src/common/constants";
 import * as platform from "./platform";