refactor: Simpler logging with loglevel

7 files changed, 74 insertions, 22 deletions

diff --git a/packages/main/package.json b/packages/main/package.json
index 5010092..c4670a8 100644
--- a/packages/main/package.json
+++ b/packages/main/package.json
@@ -12,10 +12,11 @@
   "dependencies": {
     "@sophie/service-shared": "workspace:*",
     "@sophie/shared": "workspace:*",
-    "consola": "^2.15.3",
     "electron": "16.0.5",
     "json5": "^2.2.0",
     "lodash": "^4.17.21",
+    "loglevel": "^1.8.0",
+    "loglevel-plugin-prefix": "^0.8.4",
     "mobx": "^6.3.10",
     "mobx-state-tree": "^5.1.0",
     "ms": "^2.1.3"
diff --git a/packages/main/src/controllers/config.ts b/packages/main/src/controllers/config.ts
index b6aba35..7187ab4 100644
--- a/packages/main/src/controllers/config.ts
+++ b/packages/main/src/controllers/config.ts
@@ -18,18 +18,17 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import consola from 'consola';
 import { debounce } from 'lodash';
 import ms from 'ms';
 import { applySnapshot, getSnapshot, onSnapshot } from 'mobx-state-tree';
 
 import type { ConfigPersistenceService } from '../services/ConfigPersistenceService';
 import type { Config, ConfigSnapshotOut } from '../stores/Config';
-import { Disposer } from '../utils';
+import { Disposer, getLogger } from '../utils';
 
 const DEFAULT_CONFIG_DEBOUNCE_TIME = ms('1s');
 
-const logger = consola.withTag('sophie:controller:config');
+const logger = getLogger('controller:config');
 
 export async function initConfig(
   config: Config,
@@ -71,7 +70,7 @@ export async function initConfig(
     logger.info('Config file was not found');
     try {
       await writeConfig();
-      logger.success('Created config file');
+      logger.info('Created config file');
     } catch (err) {
       logger.error('Failed to initialize config');
     }
diff --git a/packages/main/src/controllers/nativeTheme.ts b/packages/main/src/controllers/nativeTheme.ts
index 6548771..9f9bc21 100644
--- a/packages/main/src/controllers/nativeTheme.ts
+++ b/packages/main/src/controllers/nativeTheme.ts
@@ -18,14 +18,13 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import consola from 'consola';
 import { nativeTheme } from 'electron';
 import { autorun } from 'mobx';
 
 import type { MainStore } from '../stores/MainStore';
-import { Disposer } from '../utils';
+import { Disposer, getLogger } from '../utils';
 
-const logger = consola.withTag('sophie:controller:nativeTheme');
+const logger = getLogger('controller:nativeTheme');
 
 export function initNativeTheme(store: MainStore): Disposer {
   logger.debug('Initializing controller');
diff --git a/packages/main/src/utils.ts b/packages/main/src/utils/index.ts
index 0d469dd..9a57e02 100644
--- a/packages/main/src/utils.ts
+++ b/packages/main/src/utils/index.ts
@@ -21,3 +21,5 @@
 import { IDisposer } from 'mobx-state-tree';
 
 export type Disposer = IDisposer;
+
+export { getLogger } from './logging';
diff --git a/packages/main/src/utils/logging.ts b/packages/main/src/utils/logging.ts
new file mode 100644
index 0000000..9f1133f
--- /dev/null
+++ b/packages/main/src/utils/logging.ts
@@ -0,0 +1,49 @@
+/*
+ * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
+ *
+ * This file is part of Sophie.
+ *
+ * Sophie is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import loglevel, { Logger } from 'loglevel';
+import prefix from 'loglevel-plugin-prefix';
+
+const isDevelopment = import.meta.env.MODE === 'development';
+
+if (isDevelopment) {
+  loglevel.enableAll();
+}
+
+prefix.reg(loglevel);
+prefix.apply(loglevel, {
+  format(level, name, timestamp) {
+    let shortName = 'global';
+    if (name !== undefined) {
+      const nameSegments = name.split(':');
+      const lastSegment = nameSegments.pop();
+      shortName = [...nameSegments.map((segment) => segment[0]), lastSegment].join(':');
+    }
+    if (isDevelopment) {
+      // `watch.js` already appends timestamps.
+      return `${level} (${shortName})`;
+    }
+    return `[${timestamp}] ${level} (${shortName})`;
+  },
+});
+
+export function getLogger(loggerName: string): Logger {
+  return loglevel.getLogger(`sophie:${loggerName}`);
+}
diff --git a/packages/main/vite.config.js b/packages/main/vite.config.js
index d6f9373..bdb0ca1 100644
--- a/packages/main/vite.config.js
+++ b/packages/main/vite.config.js
@@ -20,12 +20,6 @@ const config = makeConfig({
     'global.process.env': 'global.process["env"]',
     'globalThis.process.env': 'globalThis.process["env"]',
   },
-  resolve: {
-    alias: {
-      // Force resolve consola to the nodejs version.
-      consola: 'consola/dist/consola.js',
-    },
-  },
   build: {
     target: node,
     lib: {
diff --git a/yarn.lock b/yarn.lock
index 3040ea2..d50d999 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -1204,11 +1204,12 @@ __metadata:
     "@types/lodash": ^4.14.178
     "@types/ms": ^0.7.31
     "@types/node": ^17.0.5
-    consola: ^2.15.3
     electron: 16.0.5
     electron-devtools-installer: ^3.2.0
     json5: ^2.2.0
     lodash: ^4.17.21
+    loglevel: ^1.8.0
+    loglevel-plugin-prefix: ^0.8.4
     mobx: ^6.3.10
     mobx-state-tree: ^5.1.0
     ms: ^2.1.3
@@ -2586,13 +2587,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"consola@npm:^2.15.3":
-  version: 2.15.3
-  resolution: "consola@npm:2.15.3"
-  checksum: 8ef7a09b703ec67ac5c389a372a33b6dc97eda6c9876443a60d76a3076eea0259e7f67a4e54fd5a52f97df73690822d090cf8b7e102b5761348afef7c6d03e28
-  languageName: node
-  linkType: hard
-
 "console-control-strings@npm:^1.0.0, console-control-strings@npm:^1.1.0":
   version: 1.1.0
   resolution: "console-control-strings@npm:1.1.0"
@@ -5308,6 +5302,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"loglevel-plugin-prefix@npm:^0.8.4":
+  version: 0.8.4
+  resolution: "loglevel-plugin-prefix@npm:0.8.4"
+  checksum: 5fe0632fa04263e083f87204107a06aa53e40a3537e08752539f5c0fd9a0ef112fe9ba6bdaed791502156c67a4ff7993a2b2871404615f0163f4c49649c362e4
+  languageName: node
+  linkType: hard
+
+"loglevel@npm:^1.8.0":
+  version: 1.8.0
+  resolution: "loglevel@npm:1.8.0"
+  checksum: 41aeea17de24aba8dba68084a31fe9189648bce4f39c1277e021bb276c3c53a75b0d337395919cf271068ad40ecefabad0e4fdeb4a8f11908beee532b898f4a7
+  languageName: node
+  linkType: hard
+
 "loose-envify@npm:^1.1.0, loose-envify@npm:^1.4.0":
   version: 1.4.0
   resolution: "loose-envify@npm:1.4.0"