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>

7 files changed, 20 insertions, 23 deletions

diff --git a/src/electron/Settings.ts b/src/electron/Settings.ts
index 0956ea486..de010b9a3 100644
--- a/src/electron/Settings.ts
+++ b/src/electron/Settings.ts
@@ -2,7 +2,7 @@ import { observable, toJS } from 'mobx';
 import { pathExistsSync, outputJsonSync, readJsonSync } from 'fs-extra';
 import { userDataPath } from '../environment-remote';
 
-const debug = require('debug')('Ferdium:Settings');
+const debug = require('../preload-safe-debug')('Ferdium:Settings');
 
 export default class Settings {
   type = '';
diff --git a/src/electron/ipc-api/autoUpdate.ts b/src/electron/ipc-api/autoUpdate.ts
index 930644816..839f1f117 100644
--- a/src/electron/ipc-api/autoUpdate.ts
+++ b/src/electron/ipc-api/autoUpdate.ts
@@ -2,7 +2,7 @@ import { app, ipcMain, BrowserWindow } from 'electron';
 import { autoUpdater } from 'electron-updater';
 import { isMac, isWindows } from '../../environment';
 
-const debug = require('debug')('Ferdium:ipcApi:autoUpdate');
+const debug = require('../../preload-safe-debug')('Ferdium:ipcApi:autoUpdate');
 
 export default (params: { mainWindow: BrowserWindow; settings: any }) => {
   const enableUpdate = Boolean(params.settings.app.get('automaticUpdates'));
diff --git a/src/electron/ipc-api/cld.ts b/src/electron/ipc-api/cld.ts
index 8918b016f..a6332e22d 100644
--- a/src/electron/ipc-api/cld.ts
+++ b/src/electron/ipc-api/cld.ts
@@ -2,7 +2,7 @@ import { ipcMain } from 'electron';
 // @ts-ignore
 import cld from 'cld';
 
-const debug = require('debug')('Ferdium:ipcApi:cld');
+const debug = require('../../preload-safe-debug')('Ferdium:ipcApi:cld');
 
 export default async () => {
   ipcMain.handle('detect-language', async (_event, { sample }) => {
diff --git a/src/electron/ipc-api/dnd.ts b/src/electron/ipc-api/dnd.ts
index 54a325db2..6b1777367 100644
--- a/src/electron/ipc-api/dnd.ts
+++ b/src/electron/ipc-api/dnd.ts
@@ -3,7 +3,7 @@ import { isMac } from '../../environment';
 
 const { getDoNotDisturb } = require('macos-notification-state');
 
-const debug = require('debug')('Ferdium:ipcApi:dnd');
+const debug = require('../../preload-safe-debug')('Ferdium:ipcApi:dnd');
 
 export default async () => {
   ipcMain.handle('get-dnd', async () => {
diff --git a/src/electron/ipc-api/download.ts b/src/electron/ipc-api/download.ts
index 3631e8fee..21af0d045 100644
--- a/src/electron/ipc-api/download.ts
+++ b/src/electron/ipc-api/download.ts
@@ -4,8 +4,7 @@ import mime from 'mime-types';
 import { writeFileSync } from 'fs-extra';
 import { PathLike } from 'fs';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:ipcApi:download');
+const debug = require('../../preload-safe-debug')('Ferdium:ipcApi:download');
 
 function decodeBase64Image(dataString: string) {
   const matches = dataString.match(/^data:([+/A-Za-z-]+);base64,(.+)$/);
@@ -28,7 +27,7 @@ export default (params: { mainWindow: BrowserWindow }) => {
           const dl = await download(win!, url, {
             saveAs: true,
           });
-          console.log('File saved to', dl.savePath);
+          debug('File saved to', dl.savePath);
         } else {
           const extension = mime.extension(fileOptions.mime);
           const filename = `${fileOptions.name}.${extension}`;
@@ -47,7 +46,7 @@ export default (params: { mainWindow: BrowserWindow }) => {
               'binary',
             );
 
-            console.log('File blob saved to', saveDialog.filePath);
+            debug('File blob saved to', saveDialog.filePath);
           } catch (error) {
             console.error(error);
           }
diff --git a/src/electron/ipc-api/sessionStorage.ts b/src/electron/ipc-api/sessionStorage.ts
index 96acacd12..2a9f4b4d1 100644
--- a/src/electron/ipc-api/sessionStorage.ts
+++ b/src/electron/ipc-api/sessionStorage.ts
@@ -2,8 +2,7 @@ import { ipcMain, Session, session } from 'electron';
 
 import { TODOS_PARTITION_ID } 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:ipcApi:sessionStorage');
+const debug = require('../../preload-safe-debug')('Ferdium:ipcApi:sessionStorage');
 
 function deduceSession(serviceId: string | undefined | null): Session {
   if (serviceId) {
@@ -22,14 +21,14 @@ export default async () => {
       const serviceSession = deduceSession(serviceId);
       serviceSession.flushStorageData();
       if (targetsToClear) {
-        console.log('Clearing targets:', targetsToClear);
+        debug('Clearing targets:', targetsToClear);
         serviceSession.clearStorageData(targetsToClear);
       } else {
-        console.log('Clearing all targets');
+        debug('Clearing all targets');
         serviceSession.clearStorageData();
       }
     } catch (error) {
-      console.log(error);
+      debug(error);
     }
   });
 
diff --git a/src/electron/macOSPermissions.ts b/src/electron/macOSPermissions.ts
index 07caaaada..2415534e5 100644
--- a/src/electron/macOSPermissions.ts
+++ b/src/electron/macOSPermissions.ts
@@ -6,12 +6,11 @@ import { dirname } from 'path';
 import { askForScreenCaptureAccess } from 'node-mac-permissions';
 import { userDataPath } from '../environment-remote';
 
-// TODO: Go back to 'debug' from 'console.log' when https://github.com/electron/electron/issues/31689 is fixed
-// const debug = require('debug')('Ferdium:macOSPermissions');
+const debug = require('../preload-safe-debug')('Ferdium:macOSPermissions');
 
 const isExplicitScreenCapturePermissionReqd =
   macosVersion.isGreaterThanOrEqualTo('10.15');
-console.log(
+debug(
   `Should check explicitly for screen-capture permissions: ${isExplicitScreenCapturePermissionReqd}`,
 );
 
@@ -22,7 +21,7 @@ function hasPromptedForScreenCapturePermission(): string | boolean {
     return false;
   }
 
-  console.log('Checking if status file exists');
+  debug('Checking if status file exists');
   return filePath && pathExistsSync(filePath);
 }
 
@@ -32,7 +31,7 @@ function hasScreenCapturePermissionAlreadyBeenGranted(): boolean {
   }
 
   const screenCaptureStatus = systemPreferences.getMediaAccessStatus('screen');
-  console.log(`screen-capture permissions status: ${screenCaptureStatus}`);
+  debug(`screen-capture permissions status: ${screenCaptureStatus}`);
   return screenCaptureStatus === 'granted';
 }
 
@@ -50,18 +49,18 @@ function createStatusFile() {
 }
 
 export const askFormacOSPermissions = async (mainWindow: BrowserWindow) => {
-  console.log('Checking camera & microphone permissions');
+  debug('Checking camera & microphone permissions');
   systemPreferences.askForMediaAccess('camera');
   systemPreferences.askForMediaAccess('microphone');
 
   if (hasScreenCapturePermissionAlreadyBeenGranted()) {
-    console.log('Already obtained screen-capture permissions - writing status file');
+    debug('Already obtained screen-capture permissions - writing status file');
     createStatusFile();
     return;
   }
 
   if (!hasPromptedForScreenCapturePermission()) {
-    console.log('Checking screen capture permissions');
+    debug('Checking screen capture permissions');
 
     const { response } = await dialog.showMessageBox(mainWindow, {
       type: 'info',
@@ -74,11 +73,11 @@ export const askFormacOSPermissions = async (mainWindow: BrowserWindow) => {
     });
 
     if (response === 0) {
-      console.log('Asking for access');
+      debug('Asking for access');
       askForScreenCaptureAccess();
       createStatusFile();
     } else if (response === 1) {
-      console.log("Don't ask again");
+      debug("Don't ask again");
       createStatusFile();
     }
   }