mirror of
https://github.com/MasterAcnolo/Freedom-Loader.git
synced 2026-09-28 04:21:15 +02:00
refactor(update): add an UI indicator in frontend
disable OS native pop up menu and fix autoupdate crash on rpm and snap #50
This commit is contained in:
@@ -9,7 +9,6 @@
|
||||
*/
|
||||
|
||||
const { autoUpdater } = require("electron-updater");
|
||||
const { dialog } = require("electron");
|
||||
const { logger } = require("../server/logger");
|
||||
|
||||
/**
|
||||
@@ -21,6 +20,26 @@ const { logger } = require("../server/logger");
|
||||
autoUpdater.autoDownload = false;
|
||||
autoUpdater.autoInstallOnAppQuit = false;
|
||||
|
||||
let updateAvailable = false;
|
||||
|
||||
/**
|
||||
* Determines how the update should be handled based on the platform
|
||||
* @returns {"auto" | "snap" | "flatpak" | "linux-native"}
|
||||
*/
|
||||
function getUpdateEnvironment() {
|
||||
if (
|
||||
process.env.APPIMAGE ||
|
||||
process.platform === "win32" ||
|
||||
process.platform === "darwin"
|
||||
) {
|
||||
return "auto";
|
||||
}
|
||||
if (process.env.SNAP) return "snap";
|
||||
if (process.env.FLATPAK_ID) return "flatpak";
|
||||
|
||||
return "linux-native";
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes application auto-update lifecycle.
|
||||
*
|
||||
@@ -32,7 +51,6 @@ autoUpdater.autoInstallOnAppQuit = false;
|
||||
* @param {BrowserWindow} mainWindow - main Electron window instance
|
||||
*/
|
||||
function initAutoUpdater(mainWindow) {
|
||||
|
||||
/**
|
||||
* Triggered when a new version is detected.
|
||||
* Prompts user to install or defer update.
|
||||
@@ -40,23 +58,12 @@ function initAutoUpdater(mainWindow) {
|
||||
autoUpdater.on("update-available", async (info) => {
|
||||
logger.info(`Update available: ${info.version}`);
|
||||
|
||||
const { response } = await dialog.showMessageBox(mainWindow, {
|
||||
type: "info",
|
||||
title: "Update Available",
|
||||
message: `Version ${info.version} is available.`,
|
||||
detail: "Would you like to download and install it now?",
|
||||
buttons: ["Install Update", "Maybe Later"],
|
||||
defaultId: 0,
|
||||
cancelId: 1,
|
||||
mainWindow?.webContents.send("update-available", {
|
||||
version: info.version,
|
||||
environment: getUpdateEnvironment(),
|
||||
});
|
||||
updateAvailable = true;
|
||||
|
||||
if (response === 0) {
|
||||
await autoUpdater.downloadUpdate();
|
||||
} else {
|
||||
mainWindow?.webContents.executeJavaScript(
|
||||
`window.showUpdateBadge && window.showUpdateBadge("${info.version}")`
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
@@ -66,8 +73,10 @@ function initAutoUpdater(mainWindow) {
|
||||
autoUpdater.on("download-progress", (progress) => {
|
||||
logger.info(`Download progress: ${Math.round(progress.percent)}%`);
|
||||
mainWindow?.webContents.send("update-progress", {
|
||||
percent: Math.round(progress.percent),
|
||||
speed: progress.bytesPerSecond,
|
||||
percent: progress.percent,
|
||||
bytesPerSecond: progress.bytesPerSecond,
|
||||
transferred: progress.transferred,
|
||||
total: progress.total,
|
||||
});
|
||||
});
|
||||
|
||||
@@ -78,17 +87,9 @@ function initAutoUpdater(mainWindow) {
|
||||
autoUpdater.on("update-downloaded", async (info) => {
|
||||
logger.info(`Update downloaded: ${info.version}`);
|
||||
|
||||
const { response } = await dialog.showMessageBox(mainWindow, {
|
||||
type: "info",
|
||||
title: "Update Ready",
|
||||
message: `Version ${info.version} has been downloaded.`,
|
||||
detail: "The application will restart to apply the update.",
|
||||
buttons: ["Install Now", "Later"],
|
||||
defaultId: 0,
|
||||
cancelId: 1,
|
||||
});
|
||||
mainWindow?.webContents.send("update-downloaded", info);
|
||||
|
||||
|
||||
if (response === 0) autoUpdater.quitAndInstall();
|
||||
});
|
||||
|
||||
/**
|
||||
@@ -102,14 +103,15 @@ function initAutoUpdater(mainWindow) {
|
||||
* If no update is available, I put this because there is no Linux version before 1.6.0
|
||||
* @type {boolean}
|
||||
*/
|
||||
const isNoUpdateAvailable = /404/.test(msg) || /Cannot find latest.*\.yml/i.test(msg);
|
||||
const isNoUpdateAvailable =
|
||||
/404/.test(msg) || /Cannot find latest.*\.yml/i.test(msg);
|
||||
|
||||
if (isNoUpdateAvailable) {
|
||||
logger.warn("Auto update: no update metadata found (probably no previous release), ignoring", msg);
|
||||
return;
|
||||
}
|
||||
|
||||
logger.error("Auto update error:", msg);
|
||||
logger.error("Auto update error:", err);
|
||||
});
|
||||
|
||||
checkForUpdates();
|
||||
@@ -120,19 +122,7 @@ function initAutoUpdater(mainWindow) {
|
||||
* Separated from init for reusability and testability.
|
||||
*/
|
||||
async function checkForUpdates() {
|
||||
|
||||
/**
|
||||
* Prevents electron-updater from running inside sandboxed environments.
|
||||
* Snap and Flatpak lock the file system in read-only mode, causing the updater to crash.
|
||||
* In these environments, updates are safely handled by snapd or the Flatpak runtime.
|
||||
* Standalone Linux packages (.deb, .rpm, AppImage) will bypass this and update normally.
|
||||
*/
|
||||
if (process.env.SNAP || process.env.FLATPAK_ID) {
|
||||
logger.info("Running as Snap or Flatpak. Updates are managed by the OS store. Skipping electron-updater.");
|
||||
return;
|
||||
}
|
||||
|
||||
if (!require("electron").app.isPackaged) return ;
|
||||
if (!require("electron").app.isPackaged) return;
|
||||
|
||||
try {
|
||||
await autoUpdater.checkForUpdates();
|
||||
@@ -160,4 +150,13 @@ function installUpdate() {
|
||||
autoUpdater.quitAndInstall();
|
||||
}
|
||||
|
||||
module.exports = { initAutoUpdater, downloadUpdate, installUpdate };
|
||||
function isUpdateAvailable() {
|
||||
return updateAvailable;
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
initAutoUpdater,
|
||||
downloadUpdate,
|
||||
installUpdate,
|
||||
isUpdateAvailable,
|
||||
};
|
||||
|
||||
@@ -13,13 +13,14 @@
|
||||
const { ipcMain, dialog, shell } = require("electron");
|
||||
const fs = require("fs");
|
||||
const { logger, logDir } = require("../server/logger");
|
||||
const {configFeatures, featuresPath, devMode} = require("../config");
|
||||
const { configFeatures, featuresPath, devMode } = require("../config");
|
||||
const { getThemes, reloadThemes } = require("./themeManager");
|
||||
const config = require("../config");
|
||||
const { validateDownloadPath, getDefaultDownloadPath } = require("./pathValidator");
|
||||
const { userThemesPath } = require("../server/helpers/path.helpers");
|
||||
const { createSystemTray, destroyTray } = require("./tray");
|
||||
const {sendReport} = require("./sendReport");
|
||||
const { sendReport } = require("./sendReport");
|
||||
const { isUpdateAvailable, downloadUpdate, installUpdate } = require("./autoUpdater");
|
||||
|
||||
/**
|
||||
* Security whitelist for feature flags that can be modified at runtime.
|
||||
@@ -65,7 +66,6 @@ const themeFolderPath = userThemesPath;
|
||||
* @param {Function} getMainWindow - Function returning current BrowserWindow instance
|
||||
*/
|
||||
function registerIpcHandlers(getMainWindow) {
|
||||
|
||||
/**
|
||||
* Returns application version from config.
|
||||
*/
|
||||
@@ -116,17 +116,16 @@ function registerIpcHandlers(getMainWindow) {
|
||||
* Window minimize request from renderer.
|
||||
*/
|
||||
ipcMain.on("window-minimize", () => {
|
||||
// Minimize to tray
|
||||
if (configFeatures.systemTray) {
|
||||
getMainWindow()?.hide();
|
||||
logger.info("Window Minimized in SystemTray (Using Minimize Button)");
|
||||
} else {
|
||||
// Native minimize
|
||||
getMainWindow()?.minimize();
|
||||
logger.info("Window minimized normally");
|
||||
}
|
||||
}
|
||||
);
|
||||
// Minimize to tray
|
||||
if (configFeatures.systemTray) {
|
||||
getMainWindow()?.hide();
|
||||
logger.info("Window Minimized in SystemTray (Using Minimize Button)");
|
||||
} else {
|
||||
// Native minimize
|
||||
getMainWindow()?.minimize();
|
||||
logger.info("Window minimized normally");
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Toggles maximize/unmaximize state of main window.
|
||||
@@ -142,7 +141,6 @@ function registerIpcHandlers(getMainWindow) {
|
||||
*/
|
||||
ipcMain.on("window-close", () => getMainWindow()?.close());
|
||||
|
||||
|
||||
/**
|
||||
* Opens Chromium DevTools in detached mode.
|
||||
*/
|
||||
@@ -153,7 +151,7 @@ function registerIpcHandlers(getMainWindow) {
|
||||
/**
|
||||
* Opens application logs directory in system file explorer.
|
||||
*/
|
||||
ipcMain.on("open-logs", () => logDir && shell.openPath(logDir));
|
||||
ipcMain.on("open-logs", () => logDir && shell.openPath(logDir));
|
||||
|
||||
/**
|
||||
* Opens external website in default browser.
|
||||
@@ -212,6 +210,24 @@ function registerIpcHandlers(getMainWindow) {
|
||||
return await sendReport(params);
|
||||
});
|
||||
|
||||
ipcMain.handle("is-update-available", () => {
|
||||
return isUpdateAvailable();
|
||||
});
|
||||
|
||||
ipcMain.handle("download-update", async () => {
|
||||
return await downloadUpdate();
|
||||
});
|
||||
|
||||
ipcMain.handle("install-update", async () => {
|
||||
return installUpdate();
|
||||
});
|
||||
|
||||
ipcMain.on("open-release-page", () => {
|
||||
shell.openExternal(
|
||||
"https://github.com/MasterAcnolo/Freedom-Loader/releases/latest",
|
||||
);
|
||||
});
|
||||
|
||||
/**
|
||||
* Updates a runtime feature flag and persists it to disk.
|
||||
*
|
||||
@@ -229,47 +245,46 @@ function registerIpcHandlers(getMainWindow) {
|
||||
* @returns {boolean} success state
|
||||
*/
|
||||
ipcMain.handle("set-feature", (event, { key, value }) => {
|
||||
try {
|
||||
if (!FEATURE_WHITELIST.has(key)) {
|
||||
logger.warn(`Rejected feature (not whitelisted): ${key}`);
|
||||
return false;
|
||||
}
|
||||
try {
|
||||
if (!FEATURE_WHITELIST.has(key)) {
|
||||
logger.warn(`Rejected feature (not whitelisted): ${key}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (configFeatures[key] === value) {
|
||||
return true;
|
||||
}
|
||||
if (configFeatures[key] === value) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dynamically intercepts and applies System Tray state changes at runtime.
|
||||
* Instantiates or destroys the tray icon immediately to prevent window
|
||||
* lifecycle desynchronization (e.g., minimizing a window to a non-existent tray).
|
||||
*/
|
||||
if (key === "systemTray") {
|
||||
if (value === true) {
|
||||
logger.info("System Tray enabled dynamically.");
|
||||
createSystemTray(devMode);
|
||||
} else {
|
||||
logger.info("System Tray disabled dynamically.");
|
||||
destroyTray();
|
||||
}
|
||||
}
|
||||
|
||||
configFeatures[key] = value;
|
||||
|
||||
fs.writeFileSync(
|
||||
configFolderPath,
|
||||
JSON.stringify(configFeatures, null, 2),
|
||||
"utf-8"
|
||||
);
|
||||
|
||||
logger.info(`Feature updated: ${key} = ${value}`);
|
||||
return true;
|
||||
|
||||
} catch (err) {
|
||||
logger.error(`set-feature failed (${key}): ${err.message}`);
|
||||
return false;
|
||||
/**
|
||||
* Dynamically intercepts and applies System Tray state changes at runtime.
|
||||
* Instantiates or destroys the tray icon immediately to prevent window
|
||||
* lifecycle desynchronization (e.g., minimizing a window to a non-existent tray).
|
||||
*/
|
||||
if (key === "systemTray") {
|
||||
if (value === true) {
|
||||
logger.info("System Tray enabled dynamically.");
|
||||
createSystemTray(devMode);
|
||||
} else {
|
||||
logger.info("System Tray disabled dynamically.");
|
||||
destroyTray();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
configFeatures[key] = value;
|
||||
|
||||
fs.writeFileSync(
|
||||
configFolderPath,
|
||||
JSON.stringify(configFeatures, null, 2),
|
||||
"utf-8",
|
||||
);
|
||||
|
||||
logger.info(`Feature updated: ${key} = ${value}`);
|
||||
return true;
|
||||
} catch (err) {
|
||||
logger.error(`set-feature failed (${key}): ${err.message}`);
|
||||
return false;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
module.exports = { registerIpcHandlers };
|
||||
module.exports = { registerIpcHandlers };
|
||||
|
||||
Reference in New Issue
Block a user