refactor(main): Separate electron API Node.js api (#392)

* chore(main): Remove electronApi loader workaround

* refactoring(main): Rename getName and getVersion to getAppName and getAppVersion

* refactor(main): Separate electron and node.js api

* fix(main): bind initialize method

Author: megahertz

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 5.1.0
+
+- New entry point for NW.js / Node.js apps: `'electron-log/node'`
+
 ## 5.0.0
 
 ### Core

README.md

@@ -53,6 +53,13 @@ only log functions like `info`, `warn` and so on.
 There are a few other ways how a logger can be initialized for a renderer
 process. [Read more](docs/initialize.md).
 
+### Node.js and NW.js
+
+```typescript
+import log from 'electron-log/node';
+log.info('Log from the nw.js or node.js');
+```
+
 ### electron-log v2.x, v3.x, v4.x
 
 If you would like to upgrade to the latest version, read

node.d.ts

@@ -0,0 +1,6 @@
+import { NodeLogger } from './src';
+
+declare const Logger: NodeLogger & {
+  default: NodeLogger;
+};
+export = Logger;

node.js

@@ -0,0 +1,5 @@
+'use strict';
+
+const node = require('./src/node');
+
+module.exports = node;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-log",
-  "version": "5.0.5-beta.2",
+  "version": "5.1.0-beta.1",
   "description": "Just a simple logging module for your Electron application",
   "main": "src/index.js",
   "browser": "src/renderer/index.js",
@@ -24,6 +24,8 @@
     "src/*",
     "main.js",
     "main.d.ts",
+    "node.js",
+    "node.d.ts",
     "preload.js",
     "renderer.js",
     "renderer.d.ts"

src/core/Logger.js

@@ -13,6 +13,7 @@ const scopeFactory = require('./scope');
 class Logger {
   static instances = {};
 
+  dependencies = {};
   errorHandler = null;
   eventLogger = null;
   functions = {};
@@ -26,6 +27,7 @@ class Logger {
 
   constructor({
     allowUnknownLevel = false,
+    dependencies = {},
     errorHandler,
     eventLogger,
     initializeFn,
@@ -37,10 +39,12 @@ class Logger {
   } = {}) {
     this.addLevel = this.addLevel.bind(this);
     this.create = this.create.bind(this);
+    this.initialize = this.initialize.bind(this);
     this.logData = this.logData.bind(this);
     this.processMessage = this.processMessage.bind(this);
 
     this.allowUnknownLevel = allowUnknownLevel;
+    this.dependencies = dependencies;
     this.initializeFn = initializeFn;
     this.isDev = isDev;
     this.levels = levels;
@@ -55,13 +59,13 @@ class Logger {
     }
 
     this.errorHandler = errorHandler;
-    errorHandler?.setOptions({ logFn: this.error });
+    errorHandler?.setOptions({ ...dependencies, logFn: this.error });
 
     this.eventLogger = eventLogger;
-    eventLogger?.setOptions({ logger: this });
+    eventLogger?.setOptions({ ...dependencies, logger: this });
 
     for (const [name, factory] of Object.entries(transportFactories)) {
-      this.transports[name] = factory(this);
+      this.transports[name] = factory(this, dependencies);
     }
 
     Logger.instances[logId] = this;
@@ -97,12 +101,13 @@ class Logger {
     }
 
     return new Logger({
-      ...options,
+      dependencies: this.dependencies,
       errorHandler: this.errorHandler,
       initializeFn: this.initializeFn,
       isDev: this.isDev,
       transportFactories: this.transportFactories,
       variables: { ...this.variables },
+      ...options,
     });
   }
 
@@ -117,7 +122,7 @@ class Logger {
   }
 
   initialize(options = {}) {
-    this.initializeFn({ logger: this, ...options });
+    this.initializeFn({ logger: this, ...this.dependencies, ...options });
   }
 
   logData(data, options = {}) {

src/index.d.ts

@@ -615,7 +615,13 @@ declare namespace Logger {
     ): void;
   }
 
-  interface MainLogger extends Logger {
+  interface NodeLogger extends Logger {
+    errorHandler: ErrorHandler<MainErrorHandlerOptions>;
+    eventLogger: EventLogger;
+    transports: MainTransports;
+  }
+
+  interface MainLogger extends NodeLogger {
     initialize(
       options?: {
         getSessions?: () => object[];
@@ -624,10 +630,6 @@ declare namespace Logger {
         spyRendererConsole?: boolean;
       },
     ): void;
-
-    errorHandler: ErrorHandler<MainErrorHandlerOptions>;
-    eventLogger: EventLogger;
-    transports: MainTransports;
   }
 
   interface RendererLogger extends Logger {

src/index.js

@@ -5,10 +5,14 @@
 const isRenderer = typeof process === 'undefined'
   || (process.type === 'renderer' || process.type === 'worker');
 
+const isMain = typeof process === 'object' && process.type === 'browser';
+
 if (isRenderer) {
   // Makes sense when contextIsolation/sandbox disabled
   require('./renderer/electron-log-preload');
   module.exports = require('./renderer');
-} else {
+} else if (isMain) {
   module.exports = require('./main');
+} else {
+  module.exports = require('./node');
 }

src/main/ElectronExternalApi.js

@@ -0,0 +1,170 @@
+'use strict';
+
+const electron = require('electron');
+const path = require('path');
+const NodeExternalApi = require('../node/NodeExternalApi');
+
+class ElectronExternalApi extends NodeExternalApi {
+  getAppName() {
+    try {
+      return electron.app?.name || electron.app?.getName();
+    } catch {
+      return super.getAppName();
+    }
+  }
+
+  getAppUserDataPath(appName) {
+    return this.getPath('userData') || super.getAppUserDataPath(appName);
+  }
+
+  getAppVersion() {
+    try {
+      return electron.app?.getVersion();
+    } catch {
+      return super.getAppVersion();
+    }
+  }
+
+  getElectronLogPath() {
+    return this.getPath('logs') || super.getElectronLogPath();
+  }
+
+  /**
+   * @private
+   * @param {any} name
+   * @returns {string|undefined}
+   */
+  getPath(name) {
+    try {
+      return electron.app?.getPath(name);
+    } catch {
+      return undefined;
+    }
+  }
+
+  getVersions() {
+    return {
+      app: `${this.getAppName()} ${this.getAppVersion()}`,
+      electron: `Electron ${process.versions.electron}`,
+      os: this.getOsVersion(),
+    };
+  }
+
+  getSystemPathAppData() {
+    return this.getPath('appData') || super.getSystemPathAppData();
+  }
+
+  isDev() {
+    if (electron.app?.isPackaged !== undefined) {
+      return !electron.app.isPackaged;
+    }
+
+    if (typeof process.execPath === 'string') {
+      const execFileName = path.basename(process.execPath).toLowerCase();
+      return execFileName.startsWith('electron');
+    }
+
+    return super.isDev();
+  }
+
+  onAppEvent(eventName, handler) {
+    electron.app?.on(eventName, handler);
+
+    return () => {
+      electron.app?.off(eventName, handler);
+    };
+  }
+
+  onAppReady(handler) {
+    if (electron.app?.isReady()) {
+      handler();
+    } else if (electron.app?.once) {
+      electron.app?.once('ready', handler);
+    } else {
+      handler();
+    }
+  }
+
+  onEveryWebContentsEvent(eventName, handler) {
+    electron.webContents?.getAllWebContents().forEach((webContents) => {
+      webContents.on(eventName, handler);
+    });
+
+    electron.app?.on('web-contents-created', onWebContentsCreated);
+
+    return () => {
+      electron.webContents?.getAllWebContents().forEach((webContents) => {
+        webContents.off(eventName, handler);
+      });
+
+      electron.app?.off('web-contents-created', onWebContentsCreated);
+    };
+
+    function onWebContentsCreated(_, webContents) {
+      webContents.on(eventName, handler);
+    }
+  }
+
+  /**
+   * Listen to async messages sent from opposite process
+   * @param {string} channel
+   * @param {function} listener
+   */
+  onIpc(channel, listener) {
+    electron.ipcMain?.on(channel, listener);
+  }
+
+  onIpcInvoke(channel, listener) {
+    electron.ipcMain?.handle?.(channel, listener);
+  }
+
+  /**
+   * @param {string} url
+   * @param {Function} [logFunction]
+   */
+  openUrl(url, logFunction = console.error) { // eslint-disable-line no-console
+    electron.shell?.openExternal(url).catch(logFunction);
+  }
+
+  setPreloadFileForSessions({
+    filePath,
+    includeFutureSession = true,
+    getSessions = () => [electron.session?.defaultSession],
+  }) {
+    for (const session of getSessions().filter(Boolean)) {
+      setPreload(session);
+    }
+
+    if (includeFutureSession) {
+      this.onAppEvent('session-created', (session) => {
+        setPreload(session);
+      });
+    }
+
+    /**
+     * @param {Session} session
+     */
+    function setPreload(session) {
+      session.setPreloads([...session.getPreloads(), filePath]);
+    }
+  }
+
+  /**
+   * Sent a message to opposite process
+   * @param {string} channel
+   * @param {any} message
+   */
+  sendIpc(channel, message) {
+    electron.BrowserWindow?.getAllWindows().forEach((wnd) => {
+      if (wnd.webContents?.isDestroyed() === false) {
+        wnd.webContents.send(channel, message);
+      }
+    });
+  }
+
+  showErrorBox(title, message) {
+    electron.dialog?.showErrorBox(title, message);
+  }
+}
+
+module.exports = ElectronExternalApi;

src/main/__specs__/index.spec.js

@@ -2,7 +2,7 @@
 
 const log = require('../index');
 
-describe('index', () => {
+describe('main/index', () => {
   it('should contain all methods of Console API', () => {
     const levels = [
       'error',