Preload safe debug shim (#29)

In https://github.com/ferdium/ferdium-app/pull/23 we removed usages of
the debug package due to an electron bug.

This patch aims to restore some debug functionality by introducing a
shim. The shim detect whether if it is being introduced in a preload
script where the electron but would be triggered, and falls back to a
simple replacement for debug. However, in the main and renderer
processes, where a preload script is not being used, we still get full
debug functionality.

In this way, a module can be used both in a preload script and outside
of it, while still preserving debug functionality whenever possible.

Signed-off-by: Kristóf Marussy <kristof@marussy.com>

12 files changed, 41 insertions, 47 deletions

diff --git a/src/features/basicAuth/index.ts b/src/features/basicAuth/index.ts
index dd02a3bdc..ae698cba8 100644
--- a/src/features/basicAuth/index.ts
+++ b/src/features/basicAuth/index.ts
@@ -2,7 +2,7 @@ import { AuthInfo, BrowserWindow, ipcRenderer } from 'electron';
 
 import { state as ModalState } from './store';
 
-const debug = require('debug')('Ferdium:feature:basicAuth');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:basicAuth');
 
 const state = ModalState;
 
diff --git a/src/features/basicAuth/mainIpcHandler.ts b/src/features/basicAuth/mainIpcHandler.ts
index 2f78b1497..5d320df5c 100644
--- a/src/features/basicAuth/mainIpcHandler.ts
+++ b/src/features/basicAuth/mainIpcHandler.ts
@@ -1,6 +1,6 @@
 import { BrowserWindow } from 'electron';
 
-const debug = require('debug')('Ferdium:feature:basicAuth:main');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:basicAuth:main');
 
 export default function mainIpcHandler(mainWindow: BrowserWindow, authInfo) {
   debug('Sending basic auth call', authInfo);
diff --git a/src/features/basicAuth/store.ts b/src/features/basicAuth/store.ts
index 4b71d32fd..e0ae8ba17 100644
--- a/src/features/basicAuth/store.ts
+++ b/src/features/basicAuth/store.ts
@@ -1,7 +1,7 @@
 import { observable } from 'mobx';
 import { ipcRenderer } from 'electron';
 
-const debug = require('debug')('Ferdium:feature:basicAuth');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:basicAuth');
 
 const defaultState = {
   isModalVisible: true,
diff --git a/src/features/communityRecipes/store.ts b/src/features/communityRecipes/store.ts
index afd7d0f01..73eaae8b4 100644
--- a/src/features/communityRecipes/store.ts
+++ b/src/features/communityRecipes/store.ts
@@ -1,8 +1,7 @@
 import { computed } from 'mobx';
 import { FeatureStore } from '../utils/FeatureStore';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:feature:communityRecipes:store');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:communityRecipes:store');
 
 export class CommunityRecipesStore extends FeatureStore {
   stores: any;
@@ -10,13 +9,13 @@ export class CommunityRecipesStore extends FeatureStore {
   actions: any;
 
   start(stores: any, actions: any) {
-    console.log('start');
+    debug('start');
     this.stores = stores;
     this.actions = actions;
   }
 
   stop() {
-    console.log('stop');
+    debug('stop');
     super.stop();
   }
 
diff --git a/src/features/publishDebugInfo/Component.js b/src/features/publishDebugInfo/Component.js
index 3d4e85dbf..ff052a050 100644
--- a/src/features/publishDebugInfo/Component.js
+++ b/src/features/publishDebugInfo/Component.js
@@ -14,7 +14,7 @@ import { DEBUG_API } from '../../config';
 import AppStore from '../../stores/AppStore';
 import ServicesStore from '../../stores/ServicesStore';
 
-const debug = require('debug')('Ferdium:feature:publishDebugInfo');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:publishDebugInfo');
 
 const messages = defineMessages({
   title: {
diff --git a/src/features/publishDebugInfo/index.ts b/src/features/publishDebugInfo/index.ts
index 33b8eb6f5..597bcdc12 100644
--- a/src/features/publishDebugInfo/index.ts
+++ b/src/features/publishDebugInfo/index.ts
@@ -3,7 +3,7 @@ import { state as ModalState } from './store';
 export { default as Component } from './Component';
 
 const state = ModalState;
-const debug = require('debug')('Ferdium:feature:publishDebugInfo');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:publishDebugInfo');
 
 export default function initialize() {
   debug('Initialize publishDebugInfo feature');
diff --git a/src/features/quickSwitch/index.ts b/src/features/quickSwitch/index.ts
index 9d584dc62..9d53d0b2f 100644
--- a/src/features/quickSwitch/index.ts
+++ b/src/features/quickSwitch/index.ts
@@ -3,7 +3,7 @@ import { state as ModalState } from './store';
 export { default as Component } from './Component';
 const state = ModalState;
 
-const debug = require('debug')('Ferdium:feature:quickSwitch');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:quickSwitch');
 
 export default function initialize() {
   debug('Initialize quickSwitch feature');
diff --git a/src/features/serviceProxy/index.ts b/src/features/serviceProxy/index.ts
index b3705b190..e0d667a72 100644
--- a/src/features/serviceProxy/index.ts
+++ b/src/features/serviceProxy/index.ts
@@ -1,8 +1,7 @@
 import { autorun, observable } from 'mobx';
 import { session } from '@electron/remote';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:feature:serviceProxy');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:serviceProxy');
 
 export const config = observable({
   isEnabled: true,
@@ -12,7 +11,7 @@ export default function init(stores: {
   services: { enabled: any };
   settings: { proxy: any };
 }) {
-  console.log('Initializing `serviceProxy` feature');
+  debug('Initializing `serviceProxy` feature');
 
   autorun(() => {
     config.isEnabled = true;
@@ -20,7 +19,7 @@ export default function init(stores: {
     const services = stores.services.enabled;
     const proxySettings = stores.settings.proxy;
 
-    console.log('Service Proxy autorun');
+    debug('Service Proxy autorun');
 
     for (const service of services) {
       const s = session.fromPartition(`persist:service-${service.id}`);
@@ -36,14 +35,14 @@ export default function init(stores: {
           const proxyHost = `${serviceProxyConfig.host}${
             serviceProxyConfig.port ? `:${serviceProxyConfig.port}` : ''
           }`;
-          console.log(
+          debug(
             `Setting proxy config from service settings for "${service.name}" (${service.id}) to`,
             proxyHost,
           );
 
           s.setProxy({ proxyRules: proxyHost })
             .then(() => {
-              console.log(
+              debug(
                 `Using proxy "${proxyHost}" for "${service.name}" (${service.id})`,
               );
             })
diff --git a/src/features/todos/preload.ts b/src/features/todos/preload.ts
index 4ccee39a0..6c8bc1aea 100644
--- a/src/features/todos/preload.ts
+++ b/src/features/todos/preload.ts
@@ -1,10 +1,9 @@
 import { ipcRenderer } from 'electron';
 import { IPC } from './constants';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:feature:todos:preload');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:todos:preload');
 
-console.log('Preloading Todos Webview');
+debug('Preloading Todos Webview');
 
 let hostMessageListener = ({ action }) => {
   switch (action) {
@@ -28,7 +27,7 @@ window['ferdium'] = {
 };
 
 ipcRenderer.on(IPC.TODOS_HOST_CHANNEL, (event, message) => {
-  console.log('Received host message', event, message);
+  debug('Received host message', event, message);
   hostMessageListener(message);
 });
 
diff --git a/src/features/todos/store.js b/src/features/todos/store.js
index 41e632b49..9ece76327 100644
--- a/src/features/todos/store.js
+++ b/src/features/todos/store.js
@@ -18,8 +18,7 @@ import { createActionBindings } from '../utils/ActionBinding';
 import { IPC, TODOS_ROUTES } from './constants';
 import UserAgent from '../../models/UserAgent';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:feature:todos:store');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:todos:store');
 
 export default class TodoStore extends FeatureStore {
   @observable stores = null;
@@ -97,7 +96,7 @@ export default class TodoStore extends FeatureStore {
   // ========== PUBLIC API ========= //
 
   @action start(stores, actions) {
-    console.log('TodoStore::start');
+    debug('TodoStore::start');
     this.stores = stores;
     this.actions = actions;
 
@@ -134,7 +133,7 @@ export default class TodoStore extends FeatureStore {
 
   @action stop() {
     super.stop();
-    console.log('TodoStore::stop');
+    debug('TodoStore::stop');
     this.reset();
     this.isFeatureActive = false;
   }
@@ -163,7 +162,7 @@ export default class TodoStore extends FeatureStore {
   };
 
   @action _setTodosWebview = ({ webview }) => {
-    console.log('_setTodosWebview', webview);
+    debug('_setTodosWebview', webview);
     if (this.webview !== webview) {
       this.webview = webview;
       this.userAgentModel.setWebviewReference(webview);
@@ -171,14 +170,14 @@ export default class TodoStore extends FeatureStore {
   };
 
   @action _handleHostMessage = message => {
-    console.log('_handleHostMessage', message);
+    debug('_handleHostMessage', message);
     if (message.action === 'todos:create') {
       this.webview.send(IPC.TODOS_HOST_CHANNEL, message);
     }
   };
 
   @action _handleClientMessage = ({ channel, message = {} }) => {
-    console.log('_handleClientMessage', channel, message);
+    debug('_handleClientMessage', channel, message);
     switch (message.action) {
       case 'todos:initialized':
         this._onTodosClientInitialized();
@@ -187,7 +186,7 @@ export default class TodoStore extends FeatureStore {
         this._goToService(message.data);
         break;
       default:
-        console.log('Other message received', channel, message);
+        debug('Other message received', channel, message);
         if (this.stores.services.isTodosServiceAdded) {
           this.actions.service.handleIPCMessage({
             serviceId: this.stores.services.isTodosServiceAdded.id,
@@ -203,7 +202,7 @@ export default class TodoStore extends FeatureStore {
   };
 
   @action _toggleTodosFeatureVisibility = () => {
-    console.log('_toggleTodosFeatureVisibility');
+    debug('_toggleTodosFeatureVisibility');
 
     this._updateSettings({
       isFeatureEnabledByUser: !this.settings.isFeatureEnabledByUser,
@@ -211,14 +210,14 @@ export default class TodoStore extends FeatureStore {
   };
 
   _openDevTools = () => {
-    console.log('_openDevTools');
+    debug('_openDevTools');
 
     const webview = document.querySelector('#todos-panel webview');
     if (webview) webview.openDevTools();
   };
 
   _reload = () => {
-    console.log('_reload');
+    debug('_reload');
 
     const webview = document.querySelector('#todos-panel webview');
     if (webview) webview.reload();
@@ -286,7 +285,7 @@ export default class TodoStore extends FeatureStore {
     const { pathname } = this.stores.router.location;
 
     if (pathname === TODOS_ROUTES.TARGET) {
-      console.log('Router is on todos route, show todos panel');
+      debug('Router is on todos route, show todos panel');
       // todosStore.start(stores, actions);
       this.stores.router.push('/');
 
diff --git a/src/features/workspaces/api.ts b/src/features/workspaces/api.ts
index 582433527..fb752c565 100644
--- a/src/features/workspaces/api.ts
+++ b/src/features/workspaces/api.ts
@@ -4,15 +4,14 @@ import Request from '../../stores/lib/Request';
 import Workspace from './models/Workspace';
 import apiBase from '../../api/apiBase';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:feature:workspaces:api');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:workspaces:api');
 
 export const workspaceApi = {
   getUserWorkspaces: async () => {
     const url = `${apiBase()}/workspace`;
-    console.log('getUserWorkspaces GET', url);
+    debug('getUserWorkspaces GET', url);
     const result = await sendAuthRequest(url, { method: 'GET' });
-    console.log('getUserWorkspaces RESULT', result);
+    debug('getUserWorkspaces RESULT', result);
     if (!result.ok) {
       throw new Error("Couldn't getUserWorkspaces");
     }
@@ -26,9 +25,9 @@ export const workspaceApi = {
       method: 'POST',
       body: JSON.stringify({ name }),
     };
-    console.log('createWorkspace POST', url, options);
+    debug('createWorkspace POST', url, options);
     const result = await sendAuthRequest(url, options);
-    console.log('createWorkspace RESULT', result);
+    debug('createWorkspace RESULT', result);
     if (!result.ok) {
       throw new Error("Couldn't createWorkspace");
     }
@@ -37,9 +36,9 @@ export const workspaceApi = {
 
   deleteWorkspace: async workspace => {
     const url = `${apiBase()}/workspace/${workspace.id}`;
-    console.log('deleteWorkspace DELETE', url);
+    debug('deleteWorkspace DELETE', url);
     const result = await sendAuthRequest(url, { method: 'DELETE' });
-    console.log('deleteWorkspace RESULT', result);
+    debug('deleteWorkspace RESULT', result);
     if (!result.ok) {
       throw new Error("Couldn't deleteWorkspace");
     }
@@ -52,9 +51,9 @@ export const workspaceApi = {
       method: 'PUT',
       body: JSON.stringify(pick(workspace, ['name', 'services'])),
     };
-    console.log('updateWorkspace UPDATE', url, options);
+    debug('updateWorkspace UPDATE', url, options);
     const result = await sendAuthRequest(url, options);
-    console.log('updateWorkspace RESULT', result);
+    debug('updateWorkspace RESULT', result);
     if (!result.ok) {
       throw new Error("Couldn't updateWorkspace");
     }
diff --git a/src/features/workspaces/store.js b/src/features/workspaces/store.js
index d2ccfeccf..20d32df67 100644
--- a/src/features/workspaces/store.js
+++ b/src/features/workspaces/store.js
@@ -15,8 +15,7 @@ import { createActionBindings } from '../utils/ActionBinding';
 
 import { KEEP_WS_LOADED_USID } from '../../config';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:feature:workspaces:store');
+const debug = require('../../preload-safe-debug')('Ferdium:feature:workspaces:store');
 
 export default class WorkspacesStore extends FeatureStore {
   @observable isFeatureActive = false;
@@ -70,7 +69,7 @@ export default class WorkspacesStore extends FeatureStore {
   // ========== PUBLIC API ========= //
 
   @action start(stores, actions) {
-    console.log('WorkspacesStore::start');
+    debug('WorkspacesStore::start');
     this.stores = stores;
     this.actions = actions;
 
@@ -116,7 +115,7 @@ export default class WorkspacesStore extends FeatureStore {
 
   @action stop() {
     super.stop();
-    console.log('WorkspacesStore::stop');
+    debug('WorkspacesStore::stop');
     this.reset();
     this.isFeatureActive = false;
   }
@@ -274,7 +273,7 @@ export default class WorkspacesStore extends FeatureStore {
   };
 
   _activateLastUsedWorkspaceReaction = () => {
-    console.log('_activateLastUsedWorkspaceReaction');
+    debug('_activateLastUsedWorkspaceReaction');
     if (!this.activeWorkspace && this.userHasWorkspaces) {
       const { lastActiveWorkspace } = this.settings;
       if (lastActiveWorkspace) {