From ca2bb9420057f8c32cd0a46d85ca11334fcde9d5 Mon Sep 17 00:00:00 2001
From: Panagiotis Papadopoulos <pano_90@gmx.net>
Date: Wed, 22 Jan 2025 18:57:06 +0100
Subject: [PATCH] refactor(server/utils): isElectron - replace fn with boolean

this values cannot change during runtime,
=> there is no need to have these checks
as dynamic function, instead just
export the boolean value directly
---
 src/app.ts                       |  4 ++--
 src/routes/api/clipper.ts        |  2 +-
 src/routes/api/files.ts          |  2 +-
 src/routes/csrf_protection.ts    |  2 +-
 src/routes/index.ts              |  5 ++---
 src/routes/routes.ts             |  4 ++--
 src/routes/setup.ts              |  4 ++--
 src/services/app_icon.ts         |  2 +-
 src/services/auth.ts             |  8 ++++----
 src/services/keyboard_actions.ts |  4 +---
 src/services/port.ts             |  2 +-
 src/services/request.ts          |  2 +-
 src/services/sql_init.ts         |  2 +-
 src/services/utils.ts            | 20 ++++++++------------
 src/services/ws.ts               |  4 ++--
 src/www.ts                       |  6 +++---
 16 files changed, 33 insertions(+), 40 deletions(-)

diff --git a/src/app.ts b/src/app.ts
index 3977daf2e..549c02b71 100644
--- a/src/app.ts
+++ b/src/app.ts
@@ -35,7 +35,7 @@ app.use((req, res, next) => {
     return next();
 });
 
-if (!utils.isElectron()) {
+if (!utils.isElectron) {
     app.use(compression()); // HTTP compression
 }
 
@@ -77,7 +77,7 @@ await import("./services/scheduler.js");
 
 startScheduledCleanup();
 
-if (utils.isElectron()) {
+if (utils.isElectron) {
     (await import("@electron/remote/main/index.js")).initialize();
 }
 
diff --git a/src/routes/api/clipper.ts b/src/routes/api/clipper.ts
index e2b5baba1..4d821e480 100644
--- a/src/routes/api/clipper.ts
+++ b/src/routes/api/clipper.ts
@@ -195,7 +195,7 @@ function processContent(images: Image[], note: BNote, content: string) {
 }
 
 function openNote(req: Request) {
-    if (utils.isElectron()) {
+    if (utils.isElectron) {
         ws.sendMessageToAllClients({
             type: "openNote",
             noteId: req.params.noteId
diff --git a/src/routes/api/files.ts b/src/routes/api/files.ts
index 7ec4a9b3c..b212f2b55 100644
--- a/src/routes/api/files.ts
+++ b/src/routes/api/files.ts
@@ -181,7 +181,7 @@ function saveToTmpDir(fileName: string, content: string | Buffer, entityType: st
 
     log.info(`Saved temporary file ${tmpObj.name}`);
 
-    if (utils.isElectron()) {
+    if (utils.isElectron) {
         chokidar.watch(tmpObj.name).on("change", (path, stats) => {
             ws.sendMessageToAllClients({
                 type: "openedFileUpdated",
diff --git a/src/routes/csrf_protection.ts b/src/routes/csrf_protection.ts
index 514758c5a..225651631 100644
--- a/src/routes/csrf_protection.ts
+++ b/src/routes/csrf_protection.ts
@@ -8,7 +8,7 @@ const doubleCsrfUtilities = doubleCsrf({
         path: "", // empty, so cookie is valid only for the current path
         secure: false,
         sameSite: "strict",
-        httpOnly: !isElectron() // set to false for Electron, see https://github.com/TriliumNext/Notes/pull/966
+        httpOnly: !isElectron // set to false for Electron, see https://github.com/TriliumNext/Notes/pull/966
     },
     cookieName: "_csrf"
 });
diff --git a/src/routes/index.ts b/src/routes/index.ts
index 5996eddf0..0365d9bf8 100644
--- a/src/routes/index.ts
+++ b/src/routes/index.ts
@@ -6,7 +6,7 @@ import config from "../services/config.js";
 import optionService from "../services/options.js";
 import log from "../services/log.js";
 import env from "../services/env.js";
-import utils from "../services/utils.js";
+import { isElectron } from "../services/utils.js";
 import protectedSessionService from "../services/protected_session.js";
 import packageJson from "../../package.json" with { type: "json" };
 import assetPath from "../services/asset_path.js";
@@ -19,7 +19,7 @@ import type BNote from "../becca/entities/bnote.js";
 function index(req: Request, res: Response) {
     const options = optionService.getOptionMap();
 
-    const view = !utils.isElectron() && req.cookies["trilium-device"] === "mobile" ? "mobile" : "desktop";
+    const view = !isElectron && req.cookies["trilium-device"] === "mobile" ? "mobile" : "desktop";
 
     //'overwrite' set to false (default) => the existing token will be re-used and validated
     //'validateOnReuse' set to false => if validation fails, generate a new token instead of throwing an error
@@ -34,7 +34,6 @@ function index(req: Request, res: Response) {
     const theme = options.theme;
     const themeNote = attributeService.getNoteWithLabel("appTheme", theme);
 
-    const isElectron = utils.isElectron();
     res.render(view, {
         device: view,
         csrfToken: csrfToken,
diff --git a/src/routes/routes.ts b/src/routes/routes.ts
index 8387227ec..1de332be0 100644
--- a/src/routes/routes.ts
+++ b/src/routes/routes.ts
@@ -1,6 +1,6 @@
 "use strict";
 
-import utils from "../services/utils.js";
+import { isElectron } from "../services/utils.js";
 import multer from "multer";
 import log from "../services/log.js";
 import express from "express";
@@ -280,7 +280,7 @@ function register(app: express.Application) {
     apiRoute(DEL, "/api/etapi-tokens/:etapiTokenId", etapiTokensApiRoutes.deleteToken);
 
     // in case of local electron, local calls are allowed unauthenticated, for server they need auth
-    const clipperMiddleware = utils.isElectron() ? [] : [auth.checkEtapiToken];
+    const clipperMiddleware = isElectron ? [] : [auth.checkEtapiToken];
 
     route(GET, "/api/clipper/handshake", clipperMiddleware, clipperRoute.handshake, apiResultHandler);
     route(PST, "/api/clipper/clippings", clipperMiddleware, clipperRoute.addClipping, apiResultHandler);
diff --git a/src/routes/setup.ts b/src/routes/setup.ts
index a186ba51d..9ccb4cf33 100644
--- a/src/routes/setup.ts
+++ b/src/routes/setup.ts
@@ -2,14 +2,14 @@
 
 import sqlInit from "../services/sql_init.js";
 import setupService from "../services/setup.js";
-import utils from "../services/utils.js";
+import { isElectron } from "../services/utils.js";
 import assetPath from "../services/asset_path.js";
 import appPath from "../services/app_path.js";
 import type { Request, Response } from "express";
 
 function setupPage(req: Request, res: Response) {
     if (sqlInit.isDbInitialized()) {
-        if (utils.isElectron()) {
+        if (isElectron) {
             handleElectronRedirect();
         } else {
             res.redirect(".");
diff --git a/src/services/app_icon.ts b/src/services/app_icon.ts
index a03a9a937..8bf8209f8 100644
--- a/src/services/app_icon.ts
+++ b/src/services/app_icon.ts
@@ -23,7 +23,7 @@ Terminal=false
  * We overwrite this file during every run as it might have been updated.
  */
 function installLocalAppIcon() {
-    if (!isElectron() || ["win32", "darwin"].includes(os.platform()) || (config.General && config.General.noDesktopIcon)) {
+    if (!isElectron || ["win32", "darwin"].includes(os.platform()) || (config.General && config.General.noDesktopIcon)) {
         return;
     }
 
diff --git a/src/services/auth.ts b/src/services/auth.ts
index a7a729a6e..3e8957100 100644
--- a/src/services/auth.ts
+++ b/src/services/auth.ts
@@ -14,7 +14,7 @@ const noAuthentication = config.General && config.General.noAuthentication === t
 function checkAuth(req: Request, res: Response, next: NextFunction) {
     if (!sqlInit.isDbInitialized()) {
         res.redirect("setup");
-    } else if (!req.session.loggedIn && !isElectron() && !noAuthentication) {
+    } else if (!req.session.loggedIn && !isElectron && !noAuthentication) {
         res.redirect("login");
     } else {
         next();
@@ -24,7 +24,7 @@ function checkAuth(req: Request, res: Response, next: NextFunction) {
 // for electron things which need network stuff
 //  currently, we're doing that for file upload because handling form data seems to be difficult
 function checkApiAuthOrElectron(req: Request, res: Response, next: NextFunction) {
-    if (!req.session.loggedIn && !isElectron() && !noAuthentication) {
+    if (!req.session.loggedIn && !isElectron && !noAuthentication) {
         reject(req, res, "Logged in session not found");
     } else {
         next();
@@ -48,7 +48,7 @@ function checkAppInitialized(req: Request, res: Response, next: NextFunction) {
 }
 
 function checkPasswordSet(req: Request, res: Response, next: NextFunction) {
-    if (!isElectron() && !passwordService.isPasswordSet()) {
+    if (!isElectron && !passwordService.isPasswordSet()) {
         res.redirect("set-password");
     } else {
         next();
@@ -56,7 +56,7 @@ function checkPasswordSet(req: Request, res: Response, next: NextFunction) {
 }
 
 function checkPasswordNotSet(req: Request, res: Response, next: NextFunction) {
-    if (!isElectron() && passwordService.isPasswordSet()) {
+    if (!isElectron && passwordService.isPasswordSet()) {
         res.redirect("login");
     } else {
         next();
diff --git a/src/services/keyboard_actions.ts b/src/services/keyboard_actions.ts
index e17e4dc21..95ee3e7b8 100644
--- a/src/services/keyboard_actions.ts
+++ b/src/services/keyboard_actions.ts
@@ -2,12 +2,10 @@
 
 import optionService from "./options.js";
 import log from "./log.js";
-import { isElectron as getIsElectron, isMac } from "./utils.js";
+import { isElectron, isMac } from "./utils.js";
 import type { KeyboardShortcut } from "./keyboard_actions_interface.js";
 import { t } from "i18next";
 
-const isElectron = getIsElectron();
-
 function getDefaultKeyboardActions() {
     if (!t("keyboard_actions.note-navigation")) {
         throw new Error("Keyboard actions loaded before translations.");
diff --git a/src/services/port.ts b/src/services/port.ts
index 76cbd7bf9..3d7cfe9b2 100644
--- a/src/services/port.ts
+++ b/src/services/port.ts
@@ -18,7 +18,7 @@ let port: number;
 
 if (process.env.TRILIUM_PORT) {
     port = parseAndValidate(process.env.TRILIUM_PORT, "environment variable TRILIUM_PORT");
-} else if (isElectron()) {
+} else if (isElectron) {
     port = env.isDev() ? 37740 : 37840;
 } else {
     port = parseAndValidate(config["Network"]["port"] || "3000", `Network.port in ${dataDir.CONFIG_INI_PATH}`);
diff --git a/src/services/request.ts b/src/services/request.ts
index 0d000cba2..46d2c75e3 100644
--- a/src/services/request.ts
+++ b/src/services/request.ts
@@ -206,7 +206,7 @@ async function getProxyAgent(opts: ClientOpts) {
 async function getClient(opts: ClientOpts): Promise<Client> {
     // it's not clear how to explicitly configure proxy (as opposed to system proxy),
     // so in that case, we always use node's modules
-    if (isElectron() && !opts.proxy) {
+    if (isElectron && !opts.proxy) {
         return (await import("electron")).net as Client;
     } else {
         const { protocol } = url.parse(opts.url);
diff --git a/src/services/sql_init.ts b/src/services/sql_init.ts
index 8c68a3898..fa70a87db 100644
--- a/src/services/sql_init.ts
+++ b/src/services/sql_init.ts
@@ -37,7 +37,7 @@ function isDbInitialized() {
 
 async function initDbConnection() {
     if (!isDbInitialized()) {
-        log.info(`DB not initialized, please visit setup page` + (isElectron() ? "" : ` - http://[your-server-host]:${port} to see instructions on how to initialize Trilium.`));
+        log.info(`DB not initialized, please visit setup page` + (isElectron ? "" : ` - http://[your-server-host]:${port} to see instructions on how to initialize Trilium.`));
 
         return;
     }
diff --git a/src/services/utils.ts b/src/services/utils.ts
index 4140d2c9d..d8f353de8 100644
--- a/src/services/utils.ts
+++ b/src/services/utils.ts
@@ -13,6 +13,12 @@ import { dirname, join } from "path";
 
 const randtoken = generator({ source: "crypto" });
 
+export const isMac = process.platform === "darwin";
+
+export const isWindows = process.platform === "win32";
+
+export const isElectron = !!process.versions["electron"];
+
 export function newEntityId() {
     return randomString(12);
 }
@@ -58,10 +64,6 @@ export function hmac(secret: any, value: any) {
     return hmac.digest("base64");
 }
 
-export function isElectron() {
-    return !!process.versions["electron"];
-}
-
 export function hash(text: string) {
     text = text.normalize();
 
@@ -128,7 +130,7 @@ export function escapeRegExp(str: string) {
 }
 
 export async function crash() {
-    if (isElectron()) {
+    if (isElectron) {
         (await import("electron")).app.exit(1);
     } else {
         process.exit(1);
@@ -314,19 +316,13 @@ export function envToBoolean(val: string | undefined) {
  * @returns the resource dir.
  */
 export function getResourceDir() {
-    if (isElectron() && !env.isDev()) {
+    if (isElectron && !env.isDev()) {
         return process.resourcesPath;
     } else {
         return join(dirname(fileURLToPath(import.meta.url)), "..", "..");
     }
 }
 
-export const isMac = process.platform === "darwin";
-
-export const isWindows = process.platform === "win32";
-    return process.platform === "win32";
-}
-
 export default {
     randomSecureToken,
     randomString,
diff --git a/src/services/ws.ts b/src/services/ws.ts
index aa24e65a2..21e80bc6b 100644
--- a/src/services/ws.ts
+++ b/src/services/ws.ts
@@ -18,7 +18,7 @@ if (env.isDev()) {
     const debounce = (await import("debounce")).default;
     const debouncedReloadFrontend = debounce(() => reloadFrontend("source code change"), 200);
     chokidar
-        .watch(isElectron() ? "dist/src/public" : "src/public")
+        .watch(isElectron ? "dist/src/public" : "src/public")
         .on("add", debouncedReloadFrontend)
         .on("change", debouncedReloadFrontend)
         .on("unlink", debouncedReloadFrontend);
@@ -62,7 +62,7 @@ function init(httpServer: HttpServer, sessionParser: SessionParser) {
     webSocketServer = new WebSocketServer({
         verifyClient: (info, done) => {
             sessionParser(info.req, {}, () => {
-                const allowed = isElectron() || (info.req as any).session.loggedIn || (config.General && config.General.noAuthentication);
+                const allowed = isElectron || (info.req as any).session.loggedIn || (config.General && config.General.noAuthentication);
 
                 if (!allowed) {
                     log.error("WebSocket connection not allowed because session is neither electron nor logged in.");
diff --git a/src/www.ts b/src/www.ts
index 643dbcfef..258f0f272 100644
--- a/src/www.ts
+++ b/src/www.ts
@@ -53,7 +53,7 @@ async function startTrilium() {
      * its startup is slower than focusing the existing process/window. So in the end, it works out without having
      * to do a complex evaluation.
      */
-    if (utils.isElectron()) {
+    if (utils.isElectron) {
         (await import("electron")).app.requestSingleInstanceLock();
     }
 
@@ -71,7 +71,7 @@ async function startTrilium() {
 
     ws.init(httpServer, sessionParser as any); // TODO: Not sure why session parser is incompatible.
 
-    if (utils.isElectron()) {
+    if (utils.isElectron) {
         const electronRouting = await import("./routes/electron.js");
         electronRouting.default(app);
     }
@@ -146,7 +146,7 @@ function startHttpServer() {
             }
         }
 
-        if (utils.isElectron()) {
+        if (utils.isElectron) {
             import("electron").then(({ app, dialog }) => {
                 // Not all situations require showing an error dialog. When Trilium is already open,
                 // clicking the shortcut, the software icon, or the taskbar icon, or when creating a new window,