refactor: use v8 serialization for ipc (#20214)

* refactor: use v8 serialization for ipc

* cloning process.env doesn't work

* serialize host objects by enumerating key/values

* new serialization can handle NaN, Infinity, and undefined correctly

* can't allocate v8 objects during GC

* backport microtasks fix

* fix compile

* fix node_stream_loader reentrancy

* update subframe spec to expect undefined instead of null

* write undefined instead of crashing when serializing host objects

* fix webview spec

* fix download spec

* buffers are transformed into uint8arrays

* can't serialize promises

* fix chrome.i18n.getMessage

* fix devtools tests

* fix zoom test

* fix debug build

* fix lint

* update ipcRenderer tests

* fix printToPDF test

* update patch

* remove accidentally re-added remote-side spec

* wip

* don't attempt to serialize host objects

* jump through different hoops to set options.webContents sometimes

* whoops

* fix lint

* clean up error-handling logic

* fix memory leak

* fix lint

* convert host objects using old base::Value serialization

* fix lint more

* fall back to base::Value-based serialization

* remove commented-out code

* add docs to breaking-changes.md

* Update breaking-changes.md

* update ipcRenderer and WebContents docs

* lint

* use named values for format tag

* save a memcpy for ~30% speedup

* get rid of calls to ShallowClone

* extra debugging for paranoia

* d'oh, use the correct named tags

* apparently msstl doesn't like this DCHECK

* funny story about that DCHECK

* disable remote-related functions when enable_remote_module = false

* nits

* use EnableIf to disable remote methods in mojom

* fix include

* review comments
This commit is contained in:
Jeremy Apthorp 2019-10-09 10:59:08 -07:00 committed by John Kleinschmidt
parent c250cd6e7c
commit 2fad53e66b
38 changed files with 623 additions and 169 deletions

View file

@ -31,14 +31,14 @@ describe('ipcRenderer module', () => {
expect(received).to.deep.equal(obj)
})
it('can send instances of Date as ISO strings', async () => {
it('can send instances of Date as Dates', async () => {
const isoDate = new Date().toISOString()
w.webContents.executeJavaScript(`{
const { ipcRenderer } = require('electron')
ipcRenderer.send('message', new Date(${JSON.stringify(isoDate)}))
}`)
const [, received] = await emittedOnce(ipcMain, 'message')
expect(received).to.equal(isoDate)
expect(received.toISOString()).to.equal(isoDate)
})
it('can send instances of Buffer', async () => {
@ -48,10 +48,12 @@ describe('ipcRenderer module', () => {
ipcRenderer.send('message', Buffer.from(${JSON.stringify(data)}))
}`)
const [, received] = await emittedOnce(ipcMain, 'message')
expect(received).to.be.an.instanceOf(Buffer)
expect(received).to.be.an.instanceOf(Uint8Array)
expect(Buffer.from(data).equals(received)).to.be.true()
})
// TODO(nornagon): Change this test to expect an exception to be thrown in
// Electron 9.
it('can send objects with DOM class prototypes', async () => {
w.webContents.executeJavaScript(`{
const { ipcRenderer } = require('electron')
@ -62,21 +64,20 @@ describe('ipcRenderer module', () => {
expect(value.hostname).to.equal('')
})
it('does not crash on external objects (regression)', async () => {
// TODO(nornagon): Change this test to expect an exception to be thrown in
// Electron 9.
it('does not crash when sending external objects', async () => {
w.webContents.executeJavaScript(`{
const { ipcRenderer } = require('electron')
const http = require('http')
const request = http.request({ port: 5000, hostname: '127.0.0.1', method: 'GET', path: '/' })
const stream = request.agent.sockets['127.0.0.1:5000:'][0]._handle._externalStream
request.on('error', () => {})
ipcRenderer.send('message', request, stream)
ipcRenderer.send('message', stream)
}`)
const [, requestValue, externalStreamValue] = await emittedOnce(ipcMain, 'message')
const [, externalStreamValue] = await emittedOnce(ipcMain, 'message')
expect(requestValue.method).to.equal('GET')
expect(requestValue.path).to.equal('/')
expect(externalStreamValue).to.be.null()
})
@ -104,7 +105,7 @@ describe('ipcRenderer module', () => {
expect(childValue).to.deep.equal(child)
})
it('inserts null for cyclic references', async () => {
it('can handle cyclic references', async () => {
w.webContents.executeJavaScript(`{
const { ipcRenderer } = require('electron')
const array = [5]
@ -117,10 +118,10 @@ describe('ipcRenderer module', () => {
const [, arrayValue, childValue] = await emittedOnce(ipcMain, 'message')
expect(arrayValue[0]).to.equal(5)
expect(arrayValue[1]).to.be.null()
expect(arrayValue[1]).to.equal(arrayValue)
expect(childValue.hello).to.equal('world')
expect(childValue.child).to.be.null()
expect(childValue.child).to.equal(childValue)
})
})
@ -182,9 +183,6 @@ describe('ipcRenderer module', () => {
generateSpecs('with contextIsolation', { contextIsolation: true })
generateSpecs('with contextIsolation + sandbox', { contextIsolation: true, sandbox: true })
})
/*
*/
describe('ipcRenderer.on', () => {
it('is not used for internals', async () => {