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, 3 insertions, 4 deletions

diff --git a/src/helpers/url-helpers.ts b/src/helpers/url-helpers.ts
index abe123577..ddbf4b4f7 100644
--- a/src/helpers/url-helpers.ts
+++ b/src/helpers/url-helpers.ts
@@ -6,8 +6,7 @@ import { shell } from 'electron';
 
 import { ALLOWED_PROTOCOLS } 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:Helpers:url');
+const debug = require('../preload-safe-debug')('Ferdium:Helpers:url');
 
 export function isValidExternalURL(url: string | URL) {
   let parsedUrl: URL;
@@ -19,7 +18,7 @@ export function isValidExternalURL(url: string | URL) {
 
   const isAllowed = ALLOWED_PROTOCOLS.includes(parsedUrl.protocol);
 
-  console.log('protocol check is', isAllowed, 'for:', url);
+  debug('protocol check is', isAllowed, 'for:', url);
 
   return isAllowed;
 }
@@ -38,7 +37,7 @@ export function openExternalUrl(
   url: string | URL,
   skipValidityCheck: boolean = false,
 ) {
-  console.log('Open url:', url, 'with skipValidityCheck:', skipValidityCheck);
+  debug('Open url:', url, 'with skipValidityCheck:', skipValidityCheck);
   if (skipValidityCheck || isValidExternalURL(url)) {
     shell.openExternal(url.toString());
   }