Preserve errors (#22)

Co-authored-by: Sindre Sorhus <[email protected]>

Author: jackple

package.json

@@ -11,7 +11,7 @@
 	},
 	"scripts": {
 		"test": "xo && tsd",
-		"// disabled until spectron is updated // test": "xo && (cd test/fixture && ava) && tsd"
+		"test-with-spectron": "xo && (cd test/fixture && ava) && tsd"
 	},
 	"files": [
 		"index.js",
@@ -34,6 +34,9 @@
 		"async",
 		"await"
 	],
+	"dependencies": {
+		"serialize-error": "^5.0.0"
+	},
 	"devDependencies": {
 		"ava": "^2.2.0",
 		"electron": "^6.0.2",

source/main.js

@@ -1,5 +1,6 @@
 'use strict';
 const electron = require('electron');
+const {serializeError, deserializeError} = require('serialize-error');
 const util = require('./util');
 
 const {ipcMain, BrowserWindow} = electron;
@@ -28,7 +29,7 @@ ipc.callRenderer = (browserWindow, channel, data) => new Promise((resolve, rejec
 	});
 
 	ipc.once(errorChannel, (event, error) => {
-		onError(event, error);
+		onError(event, deserializeError(error));
 	});
 
 	const completeData = {
@@ -59,7 +60,7 @@ ipc.answerRenderer = (channel, callback) => {
 		try {
 			send(dataChannel, await callback(userData, browserWindow));
 		} catch (error) {
-			send(errorChannel, error);
+			send(errorChannel, serializeError(error));
 		}
 	};
 

source/renderer.js

@@ -1,5 +1,6 @@
 'use strict';
 const electron = require('electron');
+const {serializeError, deserializeError} = require('serialize-error');
 const util = require('./util');
 
 const {ipcRenderer} = electron;
@@ -28,7 +29,7 @@ ipc.callMain = (channel, data) => new Promise((resolve, reject) => {
 	});
 
 	ipc.once(errorChannel, (event, error) => {
-		onError(event, error);
+		onError(event, deserializeError(error));
 	});
 
 	const completeData = {
@@ -50,7 +51,7 @@ ipc.answerMain = (channel, callback) => {
 		try {
 			ipc.send(dataChannel, await callback(userData));
 		} catch (error) {
-			ipc.send(errorChannel, error);
+			ipc.send(errorChannel, serializeError(error));
 		}
 	};
 

test/fixture/index.js

@@ -10,14 +10,24 @@ ipc.answerRenderer('test', async data => {
 	return 'test:main:answer';
 });
 
+ipc.answerRenderer('test-error', async () => {
+	throw new Error('test-error:main:answer');
+});
+
 let mainWindow;
 
 (async () => {
 	await app.whenReady();
 
-	mainWindow = new BrowserWindow();
+	mainWindow = new BrowserWindow({
+		// Why? See below:
+		// https://github.com/electron-userland/spectron/issues/174#issuecomment-525540776
+		webPreferences: {
+			nodeIntegration: true
+		}
+	});
 	await mainWindow.loadFile(path.join(__dirname, 'index.html'));
 
-	const answer = await ipc.callRenderer(win, 'test', 'optional-data');
+	const answer = await ipc.callRenderer(mainWindow, 'test', 'optional-data');
 	console.log('test:main:answer-from-renderer:', answer);
 })();

test/fixture/renderer.js

@@ -9,3 +9,8 @@ ipc.answerMain('test', data => {
 	console.log('test:renderer:data-from-main:', data);
 	return 'test:renderer:answer-data';
 });
+
+ipc.callMain('test-error').catch(error => {
+	console.log('test-error:renderer:from-main:is-error', error instanceof Error);
+	console.log('test-error:renderer:from-main:error-message', error.message);
+});

test/fixture/test.js

@@ -9,8 +9,8 @@ test.beforeEach(async t => {
 	});
 });
 
-test.afterEach.always(async t => {
-	await t.context.app.stop();
+test.afterEach(t => {
+	return t.context.app.stop();
 });
 
 test('main', async t => {
@@ -33,15 +33,22 @@ test('main', async t => {
 	// More useless cleanup because Spectron sucks
 	logs = logs.filter(x =>
 		!x.startsWith('DevTools listening') &&
-		!/^\[.*:CONSOLE\(\d\)\]/.test(x) &&
-		x !== ''
+		!x.includes(':CONSOLE(') &&
+		// Cannot match like this one: [79915:0924/100744.171411:INFO:CONSOLE(14)]
+		// !/^\[.*:CONSOLE\(\d\)\]/.test(x) &&
+		x !== '' &&
+		x !== 'Please protect ports used by ChromeDriver and related test frameworks to prevent access by malicious code.'
 	);
 
+	console.log(logs);
+
 	t.deepEqual(logs, [
 		// TODO: The value is missing as Spectron only captures the first argument to `console.log`:
 		// https://github.com/electron/spectron/issues/282
-		'"test:renderer:answer-from-main:"',
-		'"test:renderer:data-from-main:"',
+		'"test-error:renderer:from-main:error-message" "test-error:main:answer"',
+		'"test-error:renderer:from-main:is-error" true',
+		'"test:renderer:answer-from-main:" "test:main:answer"',
+		'"test:renderer:data-from-main:" "optional-data"',
 		'test:main:answer-from-renderer: test:renderer:answer-data',
 		'test:main:data-from-renderer: optional-data'
 	]);