Merge pull request #926 from pano9000:refactor_backend_log

refactor(backend_log): improve `getBackendLog`
TriliumNext · Jan 14, 2025 · 8a7a607 · 8a7a607
2 parents 3f612a1 + bcbf4f4
commit 8a7a607
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/src/routes/api/backend_log.ts b/src/routes/api/backend_log.ts
@@ -1,18 +1,30 @@
 "use strict";
 
-import fs from "fs";
+import { readFile } from "fs/promises";
+import { join } from "path";
 import dateUtils from "../../services/date_utils.js";
 import dataDir from "../../services/data_dir.js";
-const { LOG_DIR } = dataDir;
+import log from "../../services/log.js";
+import { t } from "i18next";
 
-function getBackendLog() {
-    const file = `${LOG_DIR}/trilium-${dateUtils.localNowDate()}.log`;
+const { LOG_DIR } = dataDir;
 
+async function getBackendLog() {
+    const fileName = `trilium-${dateUtils.localNowDate()}.log`;
     try {
-        return fs.readFileSync(file, "utf8");
+        const file = join(LOG_DIR, fileName);
+        return await readFile(file, "utf8");
     } catch (e) {
+        const isErrorInstance = e instanceof Error;
+
         // most probably the log file does not exist yet - https://github.com/zadam/trilium/issues/1977
-        return "";
+        if (isErrorInstance && "code" in e && e.code === "ENOENT") {
+            log.error(e);
+            return t("backend_log.log-does-not-exist", { fileName });
+        }
+
+        log.error(isErrorInstance ? e : `Reading the backend log '${fileName}' failed with an unknown error: '${e}'.`);
+        return t("backend_log.reading-log-failed", { fileName });
     }
 }
 

diff --git a/translations/de/server.json b/translations/de/server.json
@@ -193,5 +193,9 @@
   "test_sync": {
     "not-configured": "Der Synchronisations-Server-Host ist nicht konfiguriert. Bitte konfiguriere zuerst die Synchronisation.",
     "successful": "Die Server-Verbindung wurde erfolgreich hergestellt, die Synchronisation wurde gestartet."
+  },
+  "backend_log": {
+    "log-does-not-exist": "Die Backend-Log-Datei '{{ fileName }}' existiert (noch) nicht.",
+    "reading-log-failed": "Das Lesen der Backend-Log-Datei '{{ fileName }}' ist fehlgeschlagen."
   }
 }
diff --git a/translations/en/server.json b/translations/en/server.json
@@ -246,5 +246,9 @@
     "new-note": "New note",
     "duplicate-note-suffix": "(dup)",
     "duplicate-note-title": "{{ noteTitle }} {{ duplicateNoteSuffix }}"
+  },
+  "backend_log": {
+    "log-does-not-exist": "The backend log file '{{ fileName }}' does not exist (yet).",
+    "reading-log-failed": "Reading the backend log file '{{ fileName }}' failed."
   }
 }