fix: crashReporter incompatible with sandbox on Linux (#23265)
This commit is contained in:
Jeremy Apthorp
GitHub
parent
fc434f136b
commit
06bf0d08dc
77 changed files with 2235 additions and 2404 deletions
|
|
@ -4,17 +4,16 @@ import * as http from 'http';
|
|||
import * as Busboy from 'busboy';
|
||||
import * as path from 'path';
|
||||
import { ifdescribe, ifit } from './spec-helpers';
|
||||
import * as temp from 'temp';
|
||||
import { app } from 'electron/main';
|
||||
import { crashReporter } from 'electron/common';
|
||||
import { AddressInfo } from 'net';
|
||||
import { EventEmitter } from 'events';
|
||||
import * as fs from 'fs';
|
||||
import * as v8 from 'v8';
|
||||
|
||||
temp.track();
|
||||
import * as uuid from 'uuid';
|
||||
|
||||
const isWindowsOnArm = process.platform === 'win32' && process.arch === 'arm64';
|
||||
const isLinuxOnArm = process.platform === 'linux' && process.arch.includes('arm');
|
||||
|
||||
const afterTest: ((() => void) | (() => Promise<void>))[] = [];
|
||||
async function cleanup () {
|
||||
|
|
@ -29,37 +28,41 @@ type CrashInfo = {
|
|||
prod: string
|
||||
ver: string
|
||||
process_type: string // eslint-disable-line camelcase
|
||||
ptype: string
|
||||
platform: string
|
||||
extra1: string
|
||||
extra2: string
|
||||
extra3: undefined
|
||||
_productName: string
|
||||
_companyName: string
|
||||
_version: string
|
||||
upload_file_minidump: Buffer // eslint-disable-line camelcase
|
||||
mainProcessSpecific: 'mps' | undefined
|
||||
rendererSpecific: 'rs' | undefined
|
||||
globalParam: 'globalValue' | undefined
|
||||
addedThenRemoved: 'to-be-removed' | undefined
|
||||
longParam: string | undefined
|
||||
}
|
||||
|
||||
function checkCrash (expectedProcessType: string, fields: CrashInfo) {
|
||||
expect(String(fields.prod)).to.equal('Electron');
|
||||
expect(String(fields.ver)).to.equal(process.versions.electron);
|
||||
expect(String(fields.process_type)).to.equal(expectedProcessType);
|
||||
expect(String(fields.platform)).to.equal(process.platform);
|
||||
expect(String(fields._productName)).to.equal('Zombies');
|
||||
expect(String(fields._companyName)).to.equal('Umbrella Corporation');
|
||||
expect(String(fields._version)).to.equal(app.getVersion());
|
||||
expect(String(fields.prod)).to.equal('Electron', 'prod');
|
||||
expect(String(fields.ver)).to.equal(process.versions.electron, 'ver');
|
||||
expect(String(fields.ptype)).to.equal(expectedProcessType, 'ptype');
|
||||
expect(String(fields.process_type)).to.equal(expectedProcessType, 'process_type');
|
||||
expect(String(fields.platform)).to.equal(process.platform, 'platform');
|
||||
expect(String(fields._productName)).to.equal('Zombies', '_productName');
|
||||
expect(String(fields._version)).to.equal(app.getVersion(), '_version');
|
||||
expect(fields.upload_file_minidump).to.be.an.instanceOf(Buffer);
|
||||
expect(fields.upload_file_minidump.length).to.be.greaterThan(0);
|
||||
}
|
||||
|
||||
function checkCrashExtra (fields: CrashInfo) {
|
||||
expect(String(fields.extra1)).to.equal('extra1');
|
||||
expect(String(fields.extra2)).to.equal('extra2');
|
||||
expect(fields.extra3).to.be.undefined();
|
||||
// TODO(nornagon): minidumps are sometimes (not always) turning up empty on
|
||||
// 32-bit Linux. Figure out why.
|
||||
if (!(process.platform === 'linux' && process.arch === 'ia32')) {
|
||||
expect(fields.upload_file_minidump.length).to.be.greaterThan(0);
|
||||
}
|
||||
}
|
||||
|
||||
const startRemoteControlApp = async () => {
|
||||
const appPath = path.join(__dirname, 'fixtures', 'apps', 'remote-control');
|
||||
const appProcess = childProcess.spawn(process.execPath, [appPath]);
|
||||
appProcess.stderr.on('data', d => {
|
||||
process.stderr.write(d);
|
||||
});
|
||||
const port = await new Promise<number>(resolve => {
|
||||
appProcess.stdout.on('data', d => {
|
||||
const m = /Listening: (\d+)/.exec(d.toString());
|
||||
|
|
@ -90,8 +93,11 @@ const startRemoteControlApp = async () => {
|
|||
req.end();
|
||||
});
|
||||
}
|
||||
function remotely (script: Function, ...args: any[]): Promise<any> {
|
||||
return remoteEval(`(${script})(...${JSON.stringify(args)})`);
|
||||
}
|
||||
afterTest.push(() => { appProcess.kill('SIGINT'); });
|
||||
return { remoteEval };
|
||||
return { remoteEval, remotely };
|
||||
};
|
||||
|
||||
const startServer = async () => {
|
||||
|
|
@ -123,7 +129,8 @@ const startServer = async () => {
|
|||
fields[fieldname] = val;
|
||||
});
|
||||
busboy.on('finish', () => {
|
||||
const reportId = 'abc-123-def-456-abc-789-abc-123-abcd';
|
||||
// breakpad id must be 16 hex digits.
|
||||
const reportId = Math.random().toString(16).split('.')[1].padStart(16, '0');
|
||||
res.end(reportId, async () => {
|
||||
req.socket.destroy();
|
||||
emitter.emit('crash', { ...fields, ...files });
|
||||
|
|
@ -179,189 +186,400 @@ function waitForNewFileInDir (dir: string): Promise<string[]> {
|
|||
});
|
||||
}
|
||||
|
||||
// TODO(alexeykuzmin): [Ch66] This test fails on Linux. Fix it and enable back.
|
||||
ifdescribe(!process.mas && !process.env.DISABLE_CRASH_REPORTER_TESTS && process.platform !== 'linux')('crashReporter module', function () {
|
||||
// TODO(nornagon): Fix tests on linux/arm.
|
||||
ifdescribe(!isLinuxOnArm && !process.mas && !process.env.DISABLE_CRASH_REPORTER_TESTS)('crashReporter module', function () {
|
||||
afterEach(cleanup);
|
||||
|
||||
it('should send minidump when renderer crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('renderer', port);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('renderer', crash);
|
||||
describe('should send minidump', () => {
|
||||
it('when renderer crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('renderer', port);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('renderer', crash);
|
||||
expect(crash.mainProcessSpecific).to.be.undefined();
|
||||
});
|
||||
|
||||
it('when sandboxed renderer crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('sandboxed-renderer', port);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('renderer', crash);
|
||||
expect(crash.mainProcessSpecific).to.be.undefined();
|
||||
});
|
||||
|
||||
// TODO(nornagon): Minidump generation in main/node process on Linux/Arm is
|
||||
// broken (//components/crash prints "Failed to generate minidump"). Figure
|
||||
// out why.
|
||||
ifit(!isLinuxOnArm)('when main process crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('main', port);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('browser', crash);
|
||||
expect(crash.mainProcessSpecific).to.equal('mps');
|
||||
});
|
||||
|
||||
ifit(!isLinuxOnArm)('when a node process crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('node', port);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('node', crash);
|
||||
expect(crash.mainProcessSpecific).to.be.undefined();
|
||||
expect(crash.rendererSpecific).to.be.undefined();
|
||||
});
|
||||
|
||||
describe('with extra parameters', () => {
|
||||
it('when renderer crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('renderer', port, ['--set-extra-parameters-in-renderer']);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('renderer', crash);
|
||||
expect(crash.mainProcessSpecific).to.be.undefined();
|
||||
expect(crash.rendererSpecific).to.equal('rs');
|
||||
expect(crash.addedThenRemoved).to.be.undefined();
|
||||
});
|
||||
|
||||
it('when sandboxed renderer crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('sandboxed-renderer', port, ['--set-extra-parameters-in-renderer']);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('renderer', crash);
|
||||
expect(crash.mainProcessSpecific).to.be.undefined();
|
||||
expect(crash.rendererSpecific).to.equal('rs');
|
||||
expect(crash.addedThenRemoved).to.be.undefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('should send minidump when sandboxed renderer crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('sandboxed-renderer', port);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('renderer', crash);
|
||||
checkCrashExtra(crash);
|
||||
ifdescribe(!isLinuxOnArm)('extra parameter limits', () => {
|
||||
it('should truncate extra values longer than 127 characters', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
remotely((port: number) => {
|
||||
require('electron').crashReporter.start({
|
||||
submitURL: `http://127.0.0.1:${port}`,
|
||||
ignoreSystemCrashHandler: true,
|
||||
extra: { 'longParam': 'a'.repeat(130) }
|
||||
});
|
||||
setTimeout(() => process.crash());
|
||||
}, port);
|
||||
const crash = await waitForCrash();
|
||||
expect(crash).to.have.property('longParam', 'a'.repeat(127));
|
||||
});
|
||||
|
||||
it('should omit extra keys with names longer than the maximum', async () => {
|
||||
const kKeyLengthMax = 39;
|
||||
const { port, waitForCrash } = await startServer();
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
remotely((port: number, kKeyLengthMax: number) => {
|
||||
require('electron').crashReporter.start({
|
||||
submitURL: `http://127.0.0.1:${port}`,
|
||||
ignoreSystemCrashHandler: true,
|
||||
extra: {
|
||||
['a'.repeat(kKeyLengthMax + 10)]: 'value',
|
||||
['b'.repeat(kKeyLengthMax)]: 'value',
|
||||
'not-long': 'not-long-value'
|
||||
}
|
||||
});
|
||||
require('electron').crashReporter.addExtraParameter('c'.repeat(kKeyLengthMax + 10), 'value');
|
||||
setTimeout(() => process.crash());
|
||||
}, port, kKeyLengthMax);
|
||||
const crash = await waitForCrash();
|
||||
expect(crash).not.to.have.property('a'.repeat(kKeyLengthMax + 10));
|
||||
expect(crash).not.to.have.property('a'.repeat(kKeyLengthMax));
|
||||
expect(crash).to.have.property('b'.repeat(kKeyLengthMax), 'value');
|
||||
expect(crash).to.have.property('not-long', 'not-long-value');
|
||||
expect(crash).not.to.have.property('c'.repeat(kKeyLengthMax + 10));
|
||||
expect(crash).not.to.have.property('c'.repeat(kKeyLengthMax));
|
||||
});
|
||||
});
|
||||
|
||||
it('should send minidump with updated parameters when renderer crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('renderer', port, ['--set-extra-parameters-in-renderer']);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('renderer', crash);
|
||||
expect(crash.extra1).to.be.undefined();
|
||||
expect(crash.extra2).to.equal('extra2');
|
||||
expect(crash.extra3).to.equal('added');
|
||||
describe('globalExtra', () => {
|
||||
ifit(!isLinuxOnArm)('should be sent with main process dumps', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('main', port, ['--add-global-param=globalParam:globalValue']);
|
||||
const crash = await waitForCrash();
|
||||
expect(crash.globalParam).to.equal('globalValue');
|
||||
});
|
||||
|
||||
it('should be sent with renderer process dumps', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('renderer', port, ['--add-global-param=globalParam:globalValue']);
|
||||
const crash = await waitForCrash();
|
||||
expect(crash.globalParam).to.equal('globalValue');
|
||||
});
|
||||
|
||||
it('should be sent with sandboxed renderer process dumps', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('sandboxed-renderer', port, ['--add-global-param=globalParam:globalValue']);
|
||||
const crash = await waitForCrash();
|
||||
expect(crash.globalParam).to.equal('globalValue');
|
||||
});
|
||||
|
||||
ifit(!isLinuxOnArm)('should not be overridden by extra in main process', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('main', port, ['--add-global-param=mainProcessSpecific:global']);
|
||||
const crash = await waitForCrash();
|
||||
expect(crash.mainProcessSpecific).to.equal('global');
|
||||
});
|
||||
|
||||
ifit(!isLinuxOnArm)('should not be overridden by extra in renderer process', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('main', port, ['--add-global-param=rendererSpecific:global']);
|
||||
const crash = await waitForCrash();
|
||||
expect(crash.rendererSpecific).to.equal('global');
|
||||
});
|
||||
});
|
||||
|
||||
it('should send minidump with updated parameters when sandboxed renderer crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('sandboxed-renderer', port, ['--set-extra-parameters-in-renderer']);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('renderer', crash);
|
||||
expect(crash.extra1).to.be.undefined();
|
||||
expect(crash.extra2).to.equal('extra2');
|
||||
expect(crash.extra3).to.equal('added');
|
||||
});
|
||||
|
||||
it('should send minidump when main process crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('main', port);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('browser', crash);
|
||||
checkCrashExtra(crash);
|
||||
});
|
||||
|
||||
it('should send minidump when a node process crashes', async () => {
|
||||
const { port, waitForCrash } = await startServer();
|
||||
runCrashApp('node', port);
|
||||
const crash = await waitForCrash();
|
||||
checkCrash('node', crash);
|
||||
checkCrashExtra(crash);
|
||||
});
|
||||
|
||||
// TODO(jeremy): re-enable on woa
|
||||
// TODO(nornagon): also test crashing main / sandboxed renderers.
|
||||
ifit(!isWindowsOnArm)('should not send a minidump when uploadToServer is false', async () => {
|
||||
const { port, getCrashes } = await startServer();
|
||||
const crashesDir = path.join(app.getPath('temp'), 'Zombies Crashes');
|
||||
const completedCrashesDir = path.join(crashesDir, 'completed');
|
||||
const crashAppeared = waitForNewFileInDir(completedCrashesDir);
|
||||
const { port, waitForCrash, getCrashes } = await startServer();
|
||||
waitForCrash().then(() => expect.fail('expected not to receive a dump'));
|
||||
await runCrashApp('renderer', port, ['--no-upload']);
|
||||
await crashAppeared;
|
||||
// wait a sec in case crashpad is about to upload a crash
|
||||
// wait a sec in case the crash reporter is about to upload a crash
|
||||
await new Promise(resolve => setTimeout(resolve, 1000));
|
||||
expect(getCrashes()).to.have.length(0);
|
||||
});
|
||||
|
||||
describe('start() option validation', () => {
|
||||
it('requires that the companyName option be specified', () => {
|
||||
it('requires that the submitURL option be specified', () => {
|
||||
expect(() => {
|
||||
crashReporter.start({ companyName: 'dummy' } as any);
|
||||
crashReporter.start({} as any);
|
||||
}).to.throw('submitURL is a required option to crashReporter.start');
|
||||
});
|
||||
|
||||
it('requires that the submitURL option be specified', () => {
|
||||
expect(() => {
|
||||
crashReporter.start({ submitURL: 'dummy' } as any);
|
||||
}).to.throw('companyName is a required option to crashReporter.start');
|
||||
});
|
||||
|
||||
it('can be called twice', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1"})`);
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1"})`);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getCrashesDirectory', () => {
|
||||
it('correctly returns the directory', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1"})`);
|
||||
const crashesDir = await remoteEval(`require('electron').crashReporter.getCrashesDirectory()`);
|
||||
const dir = path.join(app.getPath('temp'), 'remote-control Crashes');
|
||||
expect(crashesDir).to.equal(dir);
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
await expect(remotely(() => {
|
||||
const { crashReporter } = require('electron');
|
||||
crashReporter.start({ submitURL: 'http://127.0.0.1' });
|
||||
crashReporter.start({ submitURL: 'http://127.0.0.1' });
|
||||
})).to.be.fulfilled();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getUploadedReports', () => {
|
||||
it('returns an array of reports', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1"})`);
|
||||
const reports = await remoteEval(`require('electron').crashReporter.getUploadedReports()`);
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
await remotely(() => {
|
||||
require('electron').crashReporter.start({ submitURL: 'http://127.0.0.1' });
|
||||
});
|
||||
const reports = await remotely(() => require('electron').crashReporter.getUploadedReports());
|
||||
expect(reports).to.be.an('array');
|
||||
});
|
||||
});
|
||||
|
||||
// TODO(jeremy): re-enable on woa
|
||||
// TODO(nornagon): re-enable on woa
|
||||
ifdescribe(!isWindowsOnArm)('getLastCrashReport', () => {
|
||||
it('returns the last uploaded report', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
const { port, waitForCrash } = await startServer();
|
||||
|
||||
// 0. clear the crash reports directory.
|
||||
const dir = path.join(app.getPath('temp'), 'remote-control Crashes');
|
||||
const dir = await remotely(() => require('electron').app.getPath('crashDumps'));
|
||||
try {
|
||||
fs.rmdirSync(dir, { recursive: true });
|
||||
fs.mkdirSync(dir);
|
||||
} catch (e) { /* ignore */ }
|
||||
|
||||
// 1. start the crash reporter.
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1:${port}", ignoreSystemCrashHandler: true})`);
|
||||
// 2. generate a crash.
|
||||
remoteEval(`(function() { const {BrowserWindow} = require('electron'); const bw = new BrowserWindow({show: false, webPreferences: {nodeIntegration: true}}); bw.loadURL('about:blank'); bw.webContents.executeJavaScript('process.crash()') })()`);
|
||||
await remotely((port: number) => {
|
||||
require('electron').crashReporter.start({
|
||||
submitURL: `http://127.0.0.1:${port}`,
|
||||
ignoreSystemCrashHandler: true
|
||||
});
|
||||
}, [port]);
|
||||
// 2. generate a crash in the renderer.
|
||||
remotely(() => {
|
||||
const { BrowserWindow } = require('electron');
|
||||
const bw = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
|
||||
bw.loadURL('about:blank');
|
||||
bw.webContents.executeJavaScript('process.crash()');
|
||||
});
|
||||
await waitForCrash();
|
||||
// 3. get the crash from getLastCrashReport.
|
||||
const firstReport = await remoteEval(`require('electron').crashReporter.getLastCrashReport()`);
|
||||
const firstReport = await remotely(() => require('electron').crashReporter.getLastCrashReport());
|
||||
expect(firstReport).to.not.be.null();
|
||||
expect(firstReport.date).to.be.an.instanceOf(Date);
|
||||
expect((+new Date()) - (+firstReport.date)).to.be.lessThan(30000);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getUploadToServer()', () => {
|
||||
it('returns true when uploadToServer is set to true (by default)', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1"})`);
|
||||
const uploadToServer = await remoteEval(`require('electron').crashReporter.getUploadToServer()`);
|
||||
await remotely(() => { require('electron').crashReporter.start({ submitURL: 'http://127.0.0.1' }); });
|
||||
const uploadToServer = await remotely(() => require('electron').crashReporter.getUploadToServer());
|
||||
expect(uploadToServer).to.be.true();
|
||||
});
|
||||
|
||||
it('returns false when uploadToServer is set to false in init', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1", uploadToServer: false})`);
|
||||
const uploadToServer = await remoteEval(`require('electron').crashReporter.getUploadToServer()`);
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
await remotely(() => { require('electron').crashReporter.start({ submitURL: 'http://127.0.0.1', uploadToServer: false }); });
|
||||
const uploadToServer = await remotely(() => require('electron').crashReporter.getUploadToServer());
|
||||
expect(uploadToServer).to.be.false();
|
||||
});
|
||||
|
||||
it('is updated by setUploadToServer', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1"})`);
|
||||
await remoteEval(`require('electron').crashReporter.setUploadToServer(false)`);
|
||||
expect(await remoteEval(`require('electron').crashReporter.getUploadToServer()`)).to.be.false();
|
||||
await remoteEval(`require('electron').crashReporter.setUploadToServer(true)`);
|
||||
expect(await remoteEval(`require('electron').crashReporter.getUploadToServer()`)).to.be.true();
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
await remotely(() => { require('electron').crashReporter.start({ submitURL: 'http://127.0.0.1' }); });
|
||||
await remotely(() => { require('electron').crashReporter.setUploadToServer(false); });
|
||||
expect(await remotely(() => require('electron').crashReporter.getUploadToServer())).to.be.false();
|
||||
await remotely(() => { require('electron').crashReporter.setUploadToServer(true); });
|
||||
expect(await remotely(() => require('electron').crashReporter.getUploadToServer())).to.be.true();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Parameters', () => {
|
||||
describe('getParameters', () => {
|
||||
it('returns all of the current parameters', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1", extra: {"extra1": "hi"}})`);
|
||||
const parameters = await remoteEval(`require('electron').crashReporter.getParameters()`);
|
||||
expect(parameters).to.be.an('object');
|
||||
expect(parameters.extra1).to.equal('hi');
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
await remotely(() => {
|
||||
require('electron').crashReporter.start({
|
||||
submitURL: 'http://127.0.0.1',
|
||||
extra: { 'extra1': 'hi' }
|
||||
});
|
||||
});
|
||||
const parameters = await remotely(() => require('electron').crashReporter.getParameters());
|
||||
expect(parameters).to.have.property('extra1', 'hi');
|
||||
});
|
||||
|
||||
it('adds and removes parameters', async () => {
|
||||
const { remoteEval } = await startRemoteControlApp();
|
||||
await remoteEval(`require('electron').crashReporter.start({companyName: "Umbrella Corporation", submitURL: "http://127.0.0.1"})`);
|
||||
await remoteEval(`require('electron').crashReporter.addExtraParameter('hello', 'world')`);
|
||||
it('reflects added and removed parameters', async () => {
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
await remotely(() => {
|
||||
require('electron').crashReporter.start({ submitURL: 'http://127.0.0.1' });
|
||||
require('electron').crashReporter.addExtraParameter('hello', 'world');
|
||||
});
|
||||
{
|
||||
const parameters = await remoteEval(`require('electron').crashReporter.getParameters()`);
|
||||
expect(parameters).to.have.property('hello');
|
||||
expect(parameters.hello).to.equal('world');
|
||||
const parameters = await remotely(() => require('electron').crashReporter.getParameters());
|
||||
expect(parameters).to.have.property('hello', 'world');
|
||||
}
|
||||
|
||||
await remotely(() => { require('electron').crashReporter.removeExtraParameter('hello'); });
|
||||
|
||||
{
|
||||
await remoteEval(`require('electron').crashReporter.removeExtraParameter('hello')`);
|
||||
const parameters = await remoteEval(`require('electron').crashReporter.getParameters()`);
|
||||
const parameters = await remotely(() => require('electron').crashReporter.getParameters());
|
||||
expect(parameters).not.to.have.property('hello');
|
||||
}
|
||||
});
|
||||
|
||||
it('can be called in the renderer', async () => {
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
const rendererParameters = await remotely(async () => {
|
||||
const { crashReporter, BrowserWindow } = require('electron');
|
||||
crashReporter.start({ submitURL: 'http://' });
|
||||
const bw = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
|
||||
bw.loadURL('about:blank');
|
||||
await bw.webContents.executeJavaScript(`require('electron').crashReporter.addExtraParameter('hello', 'world')`);
|
||||
return bw.webContents.executeJavaScript(`require('electron').crashReporter.getParameters()`);
|
||||
});
|
||||
if (process.platform === 'linux') {
|
||||
// On Linux, 'getParameters' will also include the global parameters,
|
||||
// because breakpad doesn't support global parameters.
|
||||
expect(rendererParameters).to.have.property('hello', 'world');
|
||||
} else {
|
||||
expect(rendererParameters).to.deep.equal({ hello: 'world' });
|
||||
}
|
||||
});
|
||||
|
||||
it('can be called in a node child process', async () => {
|
||||
function slurp (stream: NodeJS.ReadableStream): Promise<string> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const chunks: Buffer[] = [];
|
||||
stream.on('data', chunk => { chunks.push(chunk); });
|
||||
stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
|
||||
stream.on('error', e => reject(e));
|
||||
});
|
||||
}
|
||||
const child = childProcess.fork(path.join(__dirname, 'fixtures', 'module', 'print-crash-parameters.js'), [], { silent: true });
|
||||
const output = await slurp(child.stdout!);
|
||||
expect(JSON.parse(output)).to.deep.equal({ hello: 'world' });
|
||||
});
|
||||
});
|
||||
|
||||
describe('crash dumps directory', () => {
|
||||
it('is set by default', () => {
|
||||
expect(app.getPath('crashDumps')).to.be.a('string');
|
||||
});
|
||||
|
||||
it('is inside the user data dir', () => {
|
||||
expect(app.getPath('crashDumps')).to.include(app.getPath('userData'));
|
||||
});
|
||||
|
||||
it('matches getCrashesDirectory', async () => {
|
||||
expect(app.getPath('crashDumps')).to.equal(require('electron').crashReporter.getCrashesDirectory());
|
||||
});
|
||||
|
||||
function crash (processType: string, remotely: Function) {
|
||||
if (processType === 'main') {
|
||||
return remotely(() => {
|
||||
setTimeout(() => { process.crash(); });
|
||||
});
|
||||
} else if (processType === 'renderer') {
|
||||
return remotely(() => {
|
||||
const { BrowserWindow } = require('electron');
|
||||
const bw = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
|
||||
bw.loadURL('about:blank');
|
||||
bw.webContents.executeJavaScript('process.crash()');
|
||||
});
|
||||
} else if (processType === 'sandboxed-renderer') {
|
||||
const preloadPath = path.join(__dirname, 'fixtures', 'apps', 'crash', 'sandbox-preload.js');
|
||||
return remotely((preload: string) => {
|
||||
const { BrowserWindow } = require('electron');
|
||||
const bw = new BrowserWindow({ show: false, webPreferences: { sandbox: true, preload } });
|
||||
bw.loadURL('about:blank');
|
||||
}, preloadPath);
|
||||
} else if (processType === 'node') {
|
||||
const crashScriptPath = path.join(__dirname, 'fixtures', 'apps', 'crash', 'node-crash.js');
|
||||
return remotely((crashScriptPath: string) => {
|
||||
const { app } = require('electron');
|
||||
const childProcess = require('child_process');
|
||||
const version = app.getVersion();
|
||||
const url = 'http://127.0.0.1';
|
||||
childProcess.fork(crashScriptPath, [url, version], { silent: true });
|
||||
}, crashScriptPath);
|
||||
}
|
||||
}
|
||||
|
||||
for (const crashingProcess of ['main', 'renderer', 'sandboxed-renderer', 'node']) {
|
||||
// TODO(nornagon): breakpad on linux disables itself when uploadToServer
|
||||
// is false, so we should figure out a different way to test the crash
|
||||
// dump dir on linux.
|
||||
ifdescribe(process.platform !== 'linux')(`when ${crashingProcess} crashes`, () => {
|
||||
it('stores crashes in the crash dump directory when uploadToServer: false', async () => {
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
const crashesDir = await remotely(() => {
|
||||
const { crashReporter } = require('electron');
|
||||
crashReporter.start({ submitURL: 'http://127.0.0.1', uploadToServer: false, ignoreSystemCrashHandler: true });
|
||||
return crashReporter.getCrashesDirectory();
|
||||
});
|
||||
const reportsDir = process.platform === 'darwin' ? path.join(crashesDir, 'completed') : path.join(crashesDir, 'reports');
|
||||
const newFileAppeared = waitForNewFileInDir(reportsDir);
|
||||
crash(crashingProcess, remotely);
|
||||
const newFiles = await newFileAppeared;
|
||||
expect(newFiles).to.have.length(1);
|
||||
expect(newFiles[0]).to.match(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.dmp$/);
|
||||
});
|
||||
|
||||
it('respects an overridden crash dump directory', async () => {
|
||||
const { remotely } = await startRemoteControlApp();
|
||||
const crashesDir = path.join(app.getPath('temp'), uuid.v4());
|
||||
const remoteCrashesDir = await remotely((crashesDir: string) => {
|
||||
const { crashReporter, app } = require('electron');
|
||||
app.setPath('crashDumps', crashesDir);
|
||||
crashReporter.start({ submitURL: 'http://127.0.0.1', uploadToServer: false, ignoreSystemCrashHandler: true });
|
||||
return crashReporter.getCrashesDirectory();
|
||||
}, crashesDir);
|
||||
expect(remoteCrashesDir).to.equal(crashesDir);
|
||||
|
||||
const reportsDir = process.platform === 'darwin' ? path.join(crashesDir, 'completed') : path.join(crashesDir, 'reports');
|
||||
const newFileAppeared = waitForNewFileInDir(reportsDir);
|
||||
crash(crashingProcess, remotely);
|
||||
const newFiles = await newFileAppeared;
|
||||
expect(newFiles).to.have.length(1, `Files that appeared: ${JSON.stringify(newFiles)}`);
|
||||
expect(newFiles[0]).to.match(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.dmp$/);
|
||||
});
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
describe('when not started', () => {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue