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 callbacksRegistry = new CallbacksRegistry()
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.
const wrapArgs = function (args, visited) {
if (visited == null) {
visited = new Set()
}
function wrapArgs (args, visited) {
if (visited) visited = new Set()
const valueToMeta = function (value) {
// Check for circular reference.
@ -45,7 +61,7 @@ const wrapArgs = function (args, visited) {
type: 'date',
value: value.getTime()
}
} else if ((value != null) && typeof value === 'object') {
} else if (value && typeof value === 'object') {
if (isPromise(value)) {
return {
type: 'promise',
@ -62,7 +78,7 @@ const wrapArgs = function (args, visited) {
let meta = {
type: 'object',
name: value.constructor != null ? value.constructor.name : '',
name: (value.constructor) ? value.constructor.name : '',
members: []
}
visited.add(value)
@ -99,7 +115,7 @@ const wrapArgs = function (args, visited) {
// Populate object's members from descriptors.
// The |ref| will be kept referenced by |members|.
// This matches |getObjectMemebers| in rpc-server.
const setObjectMembers = function (ref, object, metaId, members) {
function setObjectMembers (ref, object, metaId, members) {
if (!Array.isArray(members)) return
for (let member of members) {
@ -110,11 +126,11 @@ const setObjectMembers = function (ref, object, metaId, members) {
const remoteMemberFunction = function (...args) {
if (this && this.constructor === remoteMemberFunction) {
// 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)
} else {
// 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)
}
}
@ -133,19 +149,17 @@ const setObjectMembers = function (ref, object, metaId, members) {
descriptor.configurable = true
} else if (member.type === 'get') {
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.
if (member.writable) {
descriptor.set = function (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
// to a value so it gets re-thrown.
if (meta != null) {
metaToValue(meta)
}
if (meta) metaToValue(meta)
return value
}
}
@ -157,8 +171,8 @@ const setObjectMembers = function (ref, object, metaId, members) {
// Populate object's prototype from descriptor.
// This matches |getObjectPrototype| in rpc-server.
const setObjectPrototype = function (ref, object, metaId, descriptor) {
if (descriptor === null) return
function setObjectPrototype (ref, object, metaId, descriptor) {
if (!descriptor) return
let proto = {}
setObjectMembers(ref, proto, metaId, descriptor.members)
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
const proxyFunctionProperties = function (remoteMemberFunction, metaId, name) {
function proxyFunctionProperties (remoteMemberFunction, metaId, name) {
let loaded = false
// Lazily load function properties
const loadRemoteProperties = () => {
if (loaded) return
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)
}
@ -201,7 +215,7 @@ const proxyFunctionProperties = function (remoteMemberFunction, metaId, name) {
},
getOwnPropertyDescriptor: (target, property) => {
let descriptor = Object.getOwnPropertyDescriptor(target, property)
if (descriptor != null) return descriptor
if (descriptor) return descriptor
loadRemoteProperties()
return Object.getOwnPropertyDescriptor(target, property)
}
@ -209,128 +223,106 @@ const proxyFunctionProperties = function (remoteMemberFunction, metaId, name) {
}
// Convert meta data from browser into real value.
const metaToValue = function (meta) {
var el, i, len, ref1, results, ret
switch (meta.type) {
case 'value':
return meta.value
case 'array':
ref1 = meta.members
results = []
for (i = 0, len = ref1.length; i < len; i++) {
el = ref1[i]
results.push(metaToValue(el))
}
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)
function metaToValue (meta) {
const types = {
'value': () => meta.value,
'array': () => {
const members = meta.members
return members.map((member) => metaToValue(member))
},
'buffer': () => Buffer.from(meta.value),
'promise': () => resolvePromise({then: metaToValue(meta.then)})
'error': () => metaToPlainObject(meta),
'date': () => new Date(meta.value),
'exception': () => new Error(`${meta.message}\n${meta.stack}`)
}
if (meta.type === 'function') {
// A shadow class to represent the remote function object.
let remoteFunction = function (...args) {
if (this && this.constructor === remoteFunction) {
// Constructor call.
let obj = ipcRenderer.sendSync('ELECTRON_BROWSER_CONSTRUCTOR', meta.id, wrapArgs(args))
// Returning object in constructor will replace constructed object
// with the returned object.
// http://stackoverflow.com/questions/1978049/what-values-can-a-constructor-return-to-avoid-returning-this
return metaToValue(obj)
} else {
// Function call.
let obj = ipcRenderer.sendSync('ELECTRON_BROWSER_FUNCTION_CALL', meta.id, wrapArgs(args))
return metaToValue(obj)
}
if (meta.type in types) {
types[meta.type]()
} else {
let ret
if (remoteObjectCache.has(meta.id)) return remoteObjectCache.get(meta.id)
// A shadow class to represent the remote function object.
if (meta.type === 'function') {
let remoteFunction = function (...args) {
if (this && this.constructor === remoteFunction) {
return metaToValue(ipcRenderer.sendSync(
ipcs['b_con'], meta.id, wrapArgs(args)
)
} 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)
// Populate delegate prototype.
setObjectPrototype(ret, ret, meta.id, meta.proto)
setObjectMembers(ret, ret, meta.id, meta.members)
setObjectPrototype(ret, ret, meta.id, meta.proto)
// Set constructor.name to object's name.
Object.defineProperty(ret.constructor, 'name', { value: meta.name })
// Set constructor.name to object's name.
Object.defineProperty(ret.constructor, 'name', { value: meta.name })
// Track delegate object's life time, and tell the browser to clean up
// when the object is GCed.
v8Util.setRemoteObjectFreer(ret, meta.id)
// Remember object's id.
v8Util.setHiddenValue(ret, 'atomId', meta.id)
remoteObjectCache.set(meta.id, ret)
return ret
// Track delegate obj's lifetime & tell browser to clean up when object is GCed.
v8Util.setRemoteObjectFreer(ret, meta.id)
v8Util.setHiddenValue(ret, 'atomId', meta.id)
remoteObjectCache.set(meta.id, ret)
return ret
}
}
// Construct a plain object from the meta.
const metaToPlainObject = function (meta) {
var i, len, obj, ref1
obj = (function () {
switch (meta.type) {
case 'error':
return new Error()
default:
return {}
}
})()
ref1 = meta.members
for (i = 0, len = ref1.length; i < len; i++) {
let {name, value} = ref1[i]
obj[name] = value
}
function metaToPlainObject (meta) {
if (meta.type === 'error') return new Error()
const obj = {}
const members = meta.members
members.forEach((key, val) => { obj[key] = val })
return obj
}
// 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))
})
// 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)
})
process.on('exit', () => {
ipcRenderer.sendSync('ELECTRON_BROWSER_CONTEXT_RELEASE')
ipcRenderer.sendSync(ipcs['b_con_rel'])
})
// Get remote 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.
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.
exports.getCurrentWindow = function () {
return metaToValue(ipcRenderer.sendSync('ELECTRON_BROWSER_CURRENT_WINDOW'))
return metaToValue(ipcRenderer.sendSync(ipcs['b_curr_win']))
}
// Get current WebContents object.
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.
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.
@ -340,16 +332,14 @@ exports.__defineGetter__('process', function () {
// Create a funtion that will return the specifed value when called in browser.
exports.createFunctionWithReturnValue = function (returnValue) {
const func = function () {
return returnValue
}
const func = () => returnValue
v8Util.setHiddenValue(func, 'returnValue', true)
return func
}
// Get the guest WebContents from 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)
}