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>

2 files changed, 13 insertions, 15 deletions

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) {