mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

clean up remote

Browse source
This commit is contained in:
Shelley Vohr 2017-10-25 09:51:21 -04:00
parent 36a51bbf4d
commit f129622446
No known key found for this signature in database
GPG key ID: F13993A75599653C
1 changed files with 94 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

198
lib/renderer/api/remote.js
View file

@ -9,14 +9,30 @@ const {ipcRenderer, isPromise, CallbacksRegistry} = require('electron')
const resolvePromise = Promise.resolve.bind(Promise) const resolvePromise = Promise.resolve.bind(Promise)
const callbacksRegistry = new CallbacksRegistry() const callbacksRegistry = new CallbacksRegistry()
const remoteObjectCache = v8Util.createIDWeakMap() const remoteObjectCache = v8Util.createIDWeakMap()
// lookup for ipc renderer send calls
const ipcs = {
'b_mem_con': 'ELECTRON_BROWSER_MEMBER_CONSTRUCTOR',
'b_mem_call': 'ELECTRON_BROWSER_MEMBER_CALL',
'b_mem_get': 'ELECTRON_BROWSER_MEMBER_GET',
'b_mem_set': 'ELECTRON_BROWSER_MEMBER_SET',
'b_con': 'ELECTRON_BROWSER_CONSTRUCTOR',
'b_func_call': 'ELECTRON_BROWSER_FUNCTION_CALL',
'rend_call': 'ELECTRON_RENDERER_CALLBACK',
'rend_rel_call': 'ELECTRON_RENDERER_RELEASE_CALLBACK',
'b_con_rel': 'ELECTRON_BROWSER_CONTEXT_RELEASE'
'b_req': 'ELECTRON_BROWSER_REQUIRE',
'b_get_built': 'ELECTRON_BROWSER_GET_BUILTIN',
'b_curr_win': 'ELECTRON_BROWSER_CURRENT_WINDOW',
'b_curr_web_con': 'ELECTRON_BROWSER_CURRENT_WEB_CONTENTS',
'b_glob': 'ELECTRON_BROWSER_GLOBAL',
'b_guest_web_con': 'ELECTRON_BROWSER_GUEST_WEB_CONTENTS'
}
// Convert the arguments object into an array of meta data. // Convert the arguments object into an array of meta data.
const wrapArgs = function (args, visited) { function wrapArgs (args, visited) {
if (visited == null) { if (visited) visited = new Set()
visited = new Set()
}
const valueToMeta = function (value) { const valueToMeta = function (value) {
// Check for circular reference. // Check for circular reference.
@ -45,7 +61,7 @@ const wrapArgs = function (args, visited) {
type: 'date', type: 'date',
value: value.getTime() value: value.getTime()
} }
} else if ((value != null) && typeof value === 'object') { } else if (value && typeof value === 'object') {
if (isPromise(value)) { if (isPromise(value)) {
return { return {
type: 'promise', type: 'promise',
@ -62,7 +78,7 @@ const wrapArgs = function (args, visited) {
let meta = { let meta = {
type: 'object', type: 'object',
name: value.constructor != null ? value.constructor.name : '', name: (value.constructor) ? value.constructor.name : '',
members: [] members: []
} }
visited.add(value) visited.add(value)
@ -99,7 +115,7 @@ const wrapArgs = function (args, visited) {
// Populate object's members from descriptors. // Populate object's members from descriptors.
// The |ref| will be kept referenced by |members|. // The |ref| will be kept referenced by |members|.
// This matches |getObjectMemebers| in rpc-server. // This matches |getObjectMemebers| in rpc-server.
const setObjectMembers = function (ref, object, metaId, members) { function setObjectMembers (ref, object, metaId, members) {
if (!Array.isArray(members)) return if (!Array.isArray(members)) return
for (let member of members) { for (let member of members) {
@ -110,11 +126,11 @@ const setObjectMembers = function (ref, object, metaId, members) {
const remoteMemberFunction = function (...args) { const remoteMemberFunction = function (...args) {
if (this && this.constructor === remoteMemberFunction) { if (this && this.constructor === remoteMemberFunction) {
// Constructor call. // Constructor call.
let ret = ipcRenderer.sendSync('ELECTRON_BROWSER_MEMBER_CONSTRUCTOR', metaId, member.name, wrapArgs(args)) const ret = ipcRenderer.sendSync(ipcs['b_mem_con'], metaId, member.name, wrapArgs(args))
return metaToValue(ret) return metaToValue(ret)
} else { } else {
// Call member function. // Call member function.
let ret = ipcRenderer.sendSync('ELECTRON_BROWSER_MEMBER_CALL', metaId, member.name, wrapArgs(args)) const ret = ipcRenderer.sendSync(ipcs['b_mem_call'], metaId, member.name, wrapArgs(args))
return metaToValue(ret) return metaToValue(ret)
} }
} }
@ -133,19 +149,17 @@ const setObjectMembers = function (ref, object, metaId, members) {
descriptor.configurable = true descriptor.configurable = true
} else if (member.type === 'get') { } else if (member.type === 'get') {
descriptor.get = function () { descriptor.get = function () {
return metaToValue(ipcRenderer.sendSync('ELECTRON_BROWSER_MEMBER_GET', metaId, member.name)) return metaToValue(ipcRenderer.sendSync(ipcs['b_mem_get'], metaId, member.name))
} }
// Only set setter when it is writable. // Only set setter when it is writable.
if (member.writable) { if (member.writable) {
descriptor.set = function (value) { descriptor.set = function (value) {
const args = wrapArgs([value]) const args = wrapArgs([value])
const meta = ipcRenderer.sendSync('ELECTRON_BROWSER_MEMBER_SET', metaId, member.name, args) const meta = ipcRenderer.sendSync(ipcs['b_mem_set'], metaId, member.name, args)
// Meta will be non-null when a setter error occurred so parse it // Meta will be non-null when a setter error occurred so parse it
// to a value so it gets re-thrown. // to a value so it gets re-thrown.
if (meta != null) { if (meta) metaToValue(meta)
metaToValue(meta)
}
return value return value
} }
} }
@ -157,8 +171,8 @@ const setObjectMembers = function (ref, object, metaId, members) {
// Populate object's prototype from descriptor. // Populate object's prototype from descriptor.
// This matches |getObjectPrototype| in rpc-server. // This matches |getObjectPrototype| in rpc-server.
const setObjectPrototype = function (ref, object, metaId, descriptor) { function setObjectPrototype (ref, object, metaId, descriptor) {
if (descriptor === null) return if (!descriptor) return
let proto = {} let proto = {}
setObjectMembers(ref, proto, metaId, descriptor.members) setObjectMembers(ref, proto, metaId, descriptor.members)
setObjectPrototype(ref, proto, metaId, descriptor.proto) setObjectPrototype(ref, proto, metaId, descriptor.proto)
@ -166,14 +180,14 @@ const setObjectPrototype = function (ref, object, metaId, descriptor) {
} }
// Wrap function in Proxy for accessing remote properties // Wrap function in Proxy for accessing remote properties
const proxyFunctionProperties = function (remoteMemberFunction, metaId, name) { function proxyFunctionProperties (remoteMemberFunction, metaId, name) {
let loaded = false let loaded = false
// Lazily load function properties // Lazily load function properties
const loadRemoteProperties = () => { const loadRemoteProperties = () => {
if (loaded) return if (loaded) return
loaded = true loaded = true
const meta = ipcRenderer.sendSync('ELECTRON_BROWSER_MEMBER_GET', metaId, name) const meta = ipcRenderer.sendSync(ipcs['b_mem_get'], metaId, name)
setObjectMembers(remoteMemberFunction, remoteMemberFunction, meta.id, meta.members) setObjectMembers(remoteMemberFunction, remoteMemberFunction, meta.id, meta.members)
} }
@ -201,7 +215,7 @@ const proxyFunctionProperties = function (remoteMemberFunction, metaId, name) {
}, },
getOwnPropertyDescriptor: (target, property) => { getOwnPropertyDescriptor: (target, property) => {
let descriptor = Object.getOwnPropertyDescriptor(target, property) let descriptor = Object.getOwnPropertyDescriptor(target, property)
if (descriptor != null) return descriptor if (descriptor) return descriptor
loadRemoteProperties() loadRemoteProperties()
return Object.getOwnPropertyDescriptor(target, property) return Object.getOwnPropertyDescriptor(target, property)
} }
@ -209,128 +223,106 @@ const proxyFunctionProperties = function (remoteMemberFunction, metaId, name) {
} }
// Convert meta data from browser into real value. // Convert meta data from browser into real value.
const metaToValue = function (meta) { function metaToValue (meta) {
var el, i, len, ref1, results, ret const types = {
switch (meta.type) { 'value': () => meta.value,
case 'value': 'array': () => {
return meta.value const members = meta.members
case 'array': return members.map((member) => metaToValue(member))
ref1 = meta.members },
results = [] 'buffer': () => Buffer.from(meta.value),
for (i = 0, len = ref1.length; i < len; i++) { 'promise': () => resolvePromise({then: metaToValue(meta.then)})
el = ref1[i] 'error': () => metaToPlainObject(meta),
results.push(metaToValue(el)) 'date': () => new Date(meta.value),
} 'exception': () => new Error(`${meta.message}\n${meta.stack}`)
return results }
case 'buffer':
return Buffer.from(meta.value)
case 'promise':
return resolvePromise({then: metaToValue(meta.then)})
case 'error':
return metaToPlainObject(meta)
case 'date':
return new Date(meta.value)
case 'exception':
throw new Error(meta.message + '\n' + meta.stack)
default:
if (remoteObjectCache.has(meta.id)) return remoteObjectCache.get(meta.id)
if (meta.type === 'function') { if (meta.type in types) {
// A shadow class to represent the remote function object. types[meta.type]()
let remoteFunction = function (...args) { } else {
if (this && this.constructor === remoteFunction) { let ret
// Constructor call. if (remoteObjectCache.has(meta.id)) return remoteObjectCache.get(meta.id)
let obj = ipcRenderer.sendSync('ELECTRON_BROWSER_CONSTRUCTOR', meta.id, wrapArgs(args))
// Returning object in constructor will replace constructed object // A shadow class to represent the remote function object.
// with the returned object. if (meta.type === 'function') {
// http://stackoverflow.com/questions/1978049/what-values-can-a-constructor-return-to-avoid-returning-this let remoteFunction = function (...args) {
return metaToValue(obj) if (this && this.constructor === remoteFunction) {
} else { return metaToValue(ipcRenderer.sendSync(
// Function call. ipcs['b_con'], meta.id, wrapArgs(args)
let obj = ipcRenderer.sendSync('ELECTRON_BROWSER_FUNCTION_CALL', meta.id, wrapArgs(args)) )
return metaToValue(obj) } else {
} return metaToValue(ipcRenderer.sendSync(
ipcs['b_func_call'], meta.id, wrapArgs(args)
)
} }
ret = remoteFunction
} else {
ret = {}
} }
ret = remoteFunction
} else {
ret = {}
}
// Populate delegate members. setObjectMembers(ret, ret, meta.id, meta.members)
setObjectMembers(ret, ret, meta.id, meta.members) setObjectPrototype(ret, ret, meta.id, meta.proto)
// Populate delegate prototype.
setObjectPrototype(ret, ret, meta.id, meta.proto)
// Set constructor.name to object's name. // Set constructor.name to object's name.
Object.defineProperty(ret.constructor, 'name', { value: meta.name }) Object.defineProperty(ret.constructor, 'name', { value: meta.name })
// Track delegate object's life time, and tell the browser to clean up // Track delegate obj's lifetime & tell browser to clean up when object is GCed.
// when the object is GCed. v8Util.setRemoteObjectFreer(ret, meta.id)
v8Util.setRemoteObjectFreer(ret, meta.id) v8Util.setHiddenValue(ret, 'atomId', meta.id)
remoteObjectCache.set(meta.id, ret)
// Remember object's id. return ret
v8Util.setHiddenValue(ret, 'atomId', meta.id)
remoteObjectCache.set(meta.id, ret)
return ret
} }
} }
// Construct a plain object from the meta. // Construct a plain object from the meta.
const metaToPlainObject = function (meta) { function metaToPlainObject (meta) {
var i, len, obj, ref1 if (meta.type === 'error') return new Error()
obj = (function () {
switch (meta.type) { const obj = {}
case 'error': const members = meta.members
return new Error()
default: members.forEach((key, val) => { obj[key] = val })
return {}
}
})()
ref1 = meta.members
for (i = 0, len = ref1.length; i < len; i++) {
let {name, value} = ref1[i]
obj[name] = value
}
return obj return obj
} }
// Browser calls a callback in renderer. // Browser calls a callback in renderer.
ipcRenderer.on('ELECTRON_RENDERER_CALLBACK', function (event, id, args) { ipcRenderer.on(ipcs['rend_call'], (event, id, args) => {
callbacksRegistry.apply(id, metaToValue(args)) callbacksRegistry.apply(id, metaToValue(args))
}) })
// A callback in browser is released. // A callback in browser is released.
ipcRenderer.on('ELECTRON_RENDERER_RELEASE_CALLBACK', function (event, id) { ipcRenderer.on(ipcs['rend_rel_call'], (event, id) => {
callbacksRegistry.remove(id) callbacksRegistry.remove(id)
}) })
process.on('exit', () => { process.on('exit', () => {
ipcRenderer.sendSync('ELECTRON_BROWSER_CONTEXT_RELEASE') ipcRenderer.sendSync(ipcs['b_con_rel'])
}) })
// Get remote module. // Get remote module.
exports.require = function (module) { exports.require = function (module) {
return metaToValue(ipcRenderer.sendSync('ELECTRON_BROWSER_REQUIRE', module)) return metaToValue(ipcRenderer.sendSync(ipcs['b_req'], module))
} }
// Alias to remote.require('electron').xxx. // Alias to remote.require('electron').xxx.
exports.getBuiltin = function (module) { exports.getBuiltin = function (module) {
return metaToValue(ipcRenderer.sendSync('ELECTRON_BROWSER_GET_BUILTIN', module)) return metaToValue(ipcRenderer.sendSync(ipcs['b_get_built'], module))
} }
// Get current BrowserWindow. // Get current BrowserWindow.
exports.getCurrentWindow = function () { exports.getCurrentWindow = function () {
return metaToValue(ipcRenderer.sendSync('ELECTRON_BROWSER_CURRENT_WINDOW')) return metaToValue(ipcRenderer.sendSync(ipcs['b_curr_win']))
} }
// Get current WebContents object. // Get current WebContents object.
exports.getCurrentWebContents = function () { exports.getCurrentWebContents = function () {
return metaToValue(ipcRenderer.sendSync('ELECTRON_BROWSER_CURRENT_WEB_CONTENTS')) return metaToValue(ipcRenderer.sendSync(ipcs['b_curr_web_cont']))
} }
// Get a global object in browser. // Get a global object in browser.
exports.getGlobal = function (name) { exports.getGlobal = function (name) {
return metaToValue(ipcRenderer.sendSync('ELECTRON_BROWSER_GLOBAL', name)) return metaToValue(ipcRenderer.sendSync(ipcs['b_glob'], name))
} }
// Get the process object in browser. // Get the process object in browser.
@ -340,16 +332,14 @@ exports.__defineGetter__('process', function () {
// Create a funtion that will return the specifed value when called in browser. // Create a funtion that will return the specifed value when called in browser.
exports.createFunctionWithReturnValue = function (returnValue) { exports.createFunctionWithReturnValue = function (returnValue) {
const func = function () { const func = () => returnValue
return returnValue
}
v8Util.setHiddenValue(func, 'returnValue', true) v8Util.setHiddenValue(func, 'returnValue', true)
return func return func
} }
// Get the guest WebContents from guestInstanceId. // Get the guest WebContents from guestInstanceId.
exports.getGuestWebContents = function (guestInstanceId) { exports.getGuestWebContents = function (guestInstanceId) {
const meta = ipcRenderer.sendSync('ELECTRON_BROWSER_GUEST_WEB_CONTENTS', guestInstanceId) const meta = ipcRenderer.sendSync(ipcs['b_guest_web_con'], guestInstanceId)
return metaToValue(meta) return metaToValue(meta)
} }