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>

1 files changed, 5 insertions, 6 deletions

diff --git a/src/webview/lib/RecipeWebview.ts b/src/webview/lib/RecipeWebview.ts
index cf70164ef..e7a39579b 100644
--- a/src/webview/lib/RecipeWebview.ts
+++ b/src/webview/lib/RecipeWebview.ts
@@ -2,8 +2,7 @@ import { ipcRenderer } from 'electron';
 import { BrowserWindow } from '@electron/remote';
 import { pathExistsSync, readFileSync, existsSync } from 'fs-extra';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:Plugin:RecipeWebview');
+const debug = require('../../preload-safe-debug')('Ferdium:Plugin:RecipeWebview');
 
 class RecipeWebview {
   badgeHandler: any;
@@ -28,7 +27,7 @@ class RecipeWebview {
     ipcRenderer.on('poll', () => {
       this.loopFunc();
 
-      console.log('Poll event');
+      debug('Poll event');
 
       // This event is for checking if the service recipe is still actively
       // communicating with the client
@@ -110,7 +109,7 @@ class RecipeWebview {
 
         if (head) {
           head.append(styles);
-          console.log('Append styles', styles);
+          debug('Append styles', styles);
         }
       }
     });
@@ -122,13 +121,13 @@ class RecipeWebview {
         if (existsSync(file)) {
           return readFileSync(file, 'utf8');
         }
-        console.log('Script not found', file);
+        debug('Script not found', file);
         return null;
       }),
     ).then(scripts => {
       const scriptsFound = scripts.filter(script => script !== null);
       if (scriptsFound.length > 0) {
-        console.log('Inject scripts to main world', scriptsFound);
+        debug('Inject scripts to main world', scriptsFound);
         ipcRenderer.sendToHost('inject-js-unsafe', ...scriptsFound);
       }
     });