electron/lib/renderer/api/remote.ts

393 lines
14 KiB
TypeScript
Raw Normal View History

2020-06-11 18:36:03 +00:00
import { CallbacksRegistry } from '../remote/callbacks-registry';
import { isPromise, isSerializableObject, serialize, deserialize } from '../../common/type-utils';
import { MetaTypeFromRenderer, ObjectMember, ObjProtoDescriptor, MetaType } from '../../common/remote/types';
import { ipcRendererInternal } from '../ipc-renderer-internal';
import type { BrowserWindow, WebContents } from 'electron/main';
2020-09-10 16:17:17 +00:00
import deprecate from '@electron/internal/common/api/deprecate';
2020-06-11 18:36:03 +00:00
import { browserModuleNames } from '@electron/internal/browser/api/module-names';
import { commonModuleList } from '@electron/internal/common/api/module-list';
import { IPC_MESSAGES } from '@electron/internal/common/remote/ipc-messages';
2020-09-10 16:17:17 +00:00
deprecate.log('The remote module is deprecated. Use https://github.com/electron/remote instead.');
const v8Util = process._linkedBinding('electron_common_v8_util');
const { hasSwitch } = process._linkedBinding('electron_common_command_line');
2016-01-12 02:40:23 +00:00
2020-03-20 20:28:31 +00:00
const callbacksRegistry = new CallbacksRegistry();
const remoteObjectCache = new Map();
const finalizationRegistry = new (window as any).FinalizationRegistry((id: number) => {
const ref = remoteObjectCache.get(id);
if (ref !== undefined && ref.deref() === undefined) {
remoteObjectCache.delete(id);
ipcRendererInternal.send(IPC_MESSAGES.BROWSER_DEREFERENCE, contextId, id, 0);
}
});
function getCachedRemoteObject (id: number) {
const ref = remoteObjectCache.get(id);
if (ref !== undefined) {
const deref = ref.deref();
if (deref !== undefined) return deref;
}
}
function setCachedRemoteObject (id: number, value: any) {
const wr = new (window as any).WeakRef(value);
remoteObjectCache.set(id, wr);
finalizationRegistry.register(value, id);
return value;
}
// An unique ID that can represent current context.
2020-06-11 18:36:03 +00:00
const contextId = v8Util.getHiddenValue<string>(global, 'contextId');
// Notify the main process when current context is going to be released.
// Note that when the renderer process is destroyed, the message may not be
// sent, we also listen to the "render-view-deleted" event in the main process
// to guard that situation.
process.on('exit', () => {
const command = IPC_MESSAGES.BROWSER_CONTEXT_RELEASE;
2020-03-20 20:28:31 +00:00
ipcRendererInternal.send(command, contextId);
});
const IS_REMOTE_PROXY = Symbol('is-remote-proxy');
2016-01-14 18:35:29 +00:00
// Convert the arguments object into an array of meta data.
2020-06-11 18:36:03 +00:00
function wrapArgs (args: any[], visited = new Set()): any {
const valueToMeta = (value: any): any => {
// Check for circular reference.
if (visited.has(value)) {
2016-01-12 02:40:23 +00:00
return {
type: 'value',
value: null
2020-03-20 20:28:31 +00:00
};
}
2020-07-13 21:44:12 +00:00
if (value && value.constructor && value.constructor.name === 'NativeImage') {
return { type: 'nativeimage', value: serialize(value) };
} else if (Array.isArray(value)) {
2020-03-20 20:28:31 +00:00
visited.add(value);
const meta = {
2016-01-12 02:40:23 +00:00
type: 'array',
value: wrapArgs(value, visited)
2020-03-20 20:28:31 +00:00
};
visited.delete(value);
return meta;
} else if (value instanceof Buffer) {
2016-01-12 02:40:23 +00:00
return {
type: 'buffer',
value
2020-03-20 20:28:31 +00:00
};
} else if (isSerializableObject(value)) {
2016-01-12 02:40:23 +00:00
return {
type: 'value',
value
2020-03-20 20:28:31 +00:00
};
} else if (typeof value === 'object') {
2016-05-25 05:38:35 +00:00
if (isPromise(value)) {
return {
type: 'promise',
2020-06-11 18:36:03 +00:00
then: valueToMeta(function (onFulfilled: Function, onRejected: Function) {
2020-03-20 20:28:31 +00:00
value.then(onFulfilled, onRejected);
2016-05-23 22:07:01 +00:00
})
2020-03-20 20:28:31 +00:00
};
} else if (v8Util.getHiddenValue(value, 'electronId')) {
return {
type: 'remote-object',
id: v8Util.getHiddenValue(value, 'electronId')
2020-03-20 20:28:31 +00:00
};
}
2020-06-11 18:36:03 +00:00
const meta: MetaTypeFromRenderer = {
2016-01-12 02:40:23 +00:00
type: 'object',
2017-10-26 03:41:11 +00:00
name: value.constructor ? value.constructor.name : '',
2016-01-12 02:40:23 +00:00
members: []
2020-03-20 20:28:31 +00:00
};
visited.add(value);
for (const prop in value) { // eslint-disable-line guard-for-in
meta.members.push({
2016-01-12 02:40:23 +00:00
name: prop,
value: valueToMeta(value[prop])
2020-03-20 20:28:31 +00:00
});
2016-01-12 02:40:23 +00:00
}
2020-03-20 20:28:31 +00:00
visited.delete(value);
return meta;
2016-01-12 02:40:23 +00:00
} else if (typeof value === 'function' && v8Util.getHiddenValue(value, 'returnValue')) {
return {
type: 'function-with-return-value',
value: valueToMeta(value())
2020-03-20 20:28:31 +00:00
};
2016-01-12 02:40:23 +00:00
} else if (typeof value === 'function') {
return {
type: 'function',
id: callbacksRegistry.add(value),
location: v8Util.getHiddenValue(value, 'location'),
length: value.length
2020-03-20 20:28:31 +00:00
};
2016-01-12 02:40:23 +00:00
} else {
return {
type: 'value',
value
2020-03-20 20:28:31 +00:00
};
2016-01-12 02:40:23 +00:00
}
2020-03-20 20:28:31 +00:00
};
return args.map(valueToMeta);
2016-03-25 19:57:17 +00:00
}
2016-01-12 02:40:23 +00:00
// Populate object's members from descriptors.
// The |ref| will be kept referenced by |members|.
// This matches |getObjectMembers| in rpc-server.
2020-06-11 18:36:03 +00:00
function setObjectMembers (ref: any, object: any, metaId: number, members: ObjectMember[]) {
2020-03-20 20:28:31 +00:00
if (!Array.isArray(members)) return;
for (const member of members) {
2020-03-20 20:28:31 +00:00
if (Object.prototype.hasOwnProperty.call(object, member.name)) continue;
2020-06-11 18:36:03 +00:00
const descriptor: PropertyDescriptor = { enumerable: member.enumerable };
if (member.type === 'method') {
2020-06-11 18:36:03 +00:00
const remoteMemberFunction = function (this: any, ...args: any[]) {
2020-03-20 20:28:31 +00:00
let command;
if (this && this.constructor === remoteMemberFunction) {
command = IPC_MESSAGES.BROWSER_MEMBER_CONSTRUCTOR;
} else {
command = IPC_MESSAGES.BROWSER_MEMBER_CALL;
}
2020-03-20 20:28:31 +00:00
const ret = ipcRendererInternal.sendSync(command, contextId, metaId, member.name, wrapArgs(args));
return metaToValue(ret);
};
2020-03-20 20:28:31 +00:00
let descriptorFunction = proxyFunctionProperties(remoteMemberFunction, metaId, member.name);
2017-11-03 01:07:40 +00:00
descriptor.get = () => {
2020-03-20 20:28:31 +00:00
descriptorFunction.ref = ref; // The member should reference its object.
return descriptorFunction;
};
// Enable monkey-patch the method
2017-11-03 01:07:40 +00:00
descriptor.set = (value) => {
2020-03-20 20:28:31 +00:00
descriptorFunction = value;
return value;
};
descriptor.configurable = true;
} else if (member.type === 'get') {
2017-11-03 01:07:40 +00:00
descriptor.get = () => {
const command = IPC_MESSAGES.BROWSER_MEMBER_GET;
2020-03-20 20:28:31 +00:00
const meta = ipcRendererInternal.sendSync(command, contextId, metaId, member.name);
return metaToValue(meta);
};
if (member.writable) {
2017-11-03 01:07:40 +00:00
descriptor.set = (value) => {
2020-03-20 20:28:31 +00:00
const args = wrapArgs([value]);
const command = IPC_MESSAGES.BROWSER_MEMBER_SET;
2020-03-20 20:28:31 +00:00
const meta = ipcRendererInternal.sendSync(command, contextId, metaId, member.name, args);
if (meta != null) metaToValue(meta);
return value;
};
}
}
2020-03-20 20:28:31 +00:00
Object.defineProperty(object, member.name, descriptor);
}
2016-03-25 19:57:17 +00:00
}
// Populate object's prototype from descriptor.
// This matches |getObjectPrototype| in rpc-server.
2020-06-11 18:36:03 +00:00
function setObjectPrototype (ref: any, object: any, metaId: number, descriptor: ObjProtoDescriptor) {
2020-03-20 20:28:31 +00:00
if (descriptor === null) return;
const proto = {};
setObjectMembers(ref, proto, metaId, descriptor.members);
setObjectPrototype(ref, proto, metaId, descriptor.proto);
Object.setPrototypeOf(object, proto);
2016-03-25 19:57:17 +00:00
}
// Wrap function in Proxy for accessing remote properties
2020-06-11 18:36:03 +00:00
function proxyFunctionProperties (remoteMemberFunction: Function, metaId: number, name: string) {
2020-03-20 20:28:31 +00:00
let loaded = false;
// Lazily load function properties
const loadRemoteProperties = () => {
2020-03-20 20:28:31 +00:00
if (loaded) return;
loaded = true;
const command = IPC_MESSAGES.BROWSER_MEMBER_GET;
2020-03-20 20:28:31 +00:00
const meta = ipcRendererInternal.sendSync(command, contextId, metaId, name);
setObjectMembers(remoteMemberFunction, remoteMemberFunction, meta.id, meta.members);
};
2020-06-11 18:36:03 +00:00
return new Proxy(remoteMemberFunction as any, {
set: (target, property, value) => {
2020-03-20 20:28:31 +00:00
if (property !== 'ref') loadRemoteProperties();
target[property] = value;
return true;
},
2020-06-11 18:36:03 +00:00
get: (target, property) => {
if (property === IS_REMOTE_PROXY) return true;
2020-03-20 20:28:31 +00:00
if (!Object.prototype.hasOwnProperty.call(target, property)) loadRemoteProperties();
const value = target[property];
if (property === 'toString' && typeof value === 'function') {
2020-03-20 20:28:31 +00:00
return value.bind(target);
}
2020-03-20 20:28:31 +00:00
return value;
},
ownKeys: (target) => {
2020-03-20 20:28:31 +00:00
loadRemoteProperties();
return Object.getOwnPropertyNames(target);
},
getOwnPropertyDescriptor: (target, property) => {
2020-03-20 20:28:31 +00:00
const descriptor = Object.getOwnPropertyDescriptor(target, property);
if (descriptor) return descriptor;
loadRemoteProperties();
return Object.getOwnPropertyDescriptor(target, property);
}
2020-03-20 20:28:31 +00:00
});
}
2016-01-14 18:35:29 +00:00
// Convert meta data from browser into real value.
2020-06-11 18:36:03 +00:00
function metaToValue (meta: MetaType): any {
if (meta.type === 'value') {
return meta.value;
} else if (meta.type === 'array') {
return meta.members.map((member) => metaToValue(member));
} else if (meta.type === 'nativeimage') {
return deserialize(meta.value);
} else if (meta.type === 'buffer') {
return Buffer.from(meta.value.buffer, meta.value.byteOffset, meta.value.byteLength);
} else if (meta.type === 'promise') {
return Promise.resolve({ then: metaToValue(meta.then) });
} else if (meta.type === 'error') {
return metaToError(meta);
} else if (meta.type === 'exception') {
if (meta.value.type === 'error') { throw metaToError(meta.value); } else { throw new Error(`Unexpected value type in exception: ${meta.value.type}`); }
2017-10-25 13:51:21 +00:00
} else {
2020-03-20 20:28:31 +00:00
let ret;
if ('id' in meta) {
const cached = getCachedRemoteObject(meta.id);
if (cached !== undefined) { return cached; }
2017-11-03 01:07:40 +00:00
}
2017-10-25 13:51:21 +00:00
// A shadow class to represent the remote function object.
if (meta.type === 'function') {
2020-06-11 18:36:03 +00:00
const remoteFunction = function (this: any, ...args: any[]) {
2020-03-20 20:28:31 +00:00
let command;
2017-10-25 13:51:21 +00:00
if (this && this.constructor === remoteFunction) {
command = IPC_MESSAGES.BROWSER_CONSTRUCTOR;
2017-10-25 13:51:21 +00:00
} else {
command = IPC_MESSAGES.BROWSER_FUNCTION_CALL;
2016-03-25 19:57:17 +00:00
}
2020-03-20 20:28:31 +00:00
const obj = ipcRendererInternal.sendSync(command, contextId, meta.id, wrapArgs(args));
return metaToValue(obj);
};
ret = remoteFunction;
2017-10-25 13:51:21 +00:00
} else {
2020-03-20 20:28:31 +00:00
ret = {};
2017-10-25 13:51:21 +00:00
}
2016-01-12 02:40:23 +00:00
2020-03-20 20:28:31 +00:00
setObjectMembers(ret, ret, meta.id, meta.members);
setObjectPrototype(ret, ret, meta.id, meta.proto);
2020-06-11 18:36:03 +00:00
if (ret.constructor && (ret.constructor as any)[IS_REMOTE_PROXY]) {
Object.defineProperty(ret.constructor, 'name', { value: meta.name });
}
2016-01-12 02:40:23 +00:00
2017-10-25 13:51:21 +00:00
// Track delegate obj's lifetime & tell browser to clean up when object is GCed.
v8Util.setHiddenValue(ret, 'electronId', meta.id);
setCachedRemoteObject(meta.id, ret);
2020-03-20 20:28:31 +00:00
return ret;
2016-01-12 02:40:23 +00:00
}
2016-03-25 19:57:17 +00:00
}
2016-01-12 02:40:23 +00:00
2020-06-11 18:36:03 +00:00
function metaToError (meta: { type: 'error', value: any, members: ObjectMember[] }) {
2020-03-20 20:28:31 +00:00
const obj = meta.value;
for (const { name, value } of meta.members) {
2020-03-20 20:28:31 +00:00
obj[name] = metaToValue(value);
2017-11-03 01:29:17 +00:00
}
2020-03-20 20:28:31 +00:00
return obj;
2016-03-25 19:57:17 +00:00
}
2016-01-12 02:40:23 +00:00
2020-06-11 18:36:03 +00:00
function handleMessage (channel: string, handler: Function) {
ipcRendererInternal.onMessageFromMain(channel, (event, passedContextId, id, ...args) => {
if (passedContextId === contextId) {
2020-03-20 20:28:31 +00:00
handler(id, ...args);
} else {
// Message sent to an un-exist context, notify the error to main process.
ipcRendererInternal.send(IPC_MESSAGES.BROWSER_WRONG_CONTEXT_ERROR, contextId, passedContextId, id);
}
2020-03-20 20:28:31 +00:00
});
}
2020-03-20 20:28:31 +00:00
const enableStacks = hasSwitch('enable-api-filtering-logging');
2020-06-11 18:36:03 +00:00
function getCurrentStack (): string | undefined {
const target = { stack: undefined as string | undefined };
if (enableStacks) {
2020-03-20 20:28:31 +00:00
Error.captureStackTrace(target, getCurrentStack);
}
2020-03-20 20:28:31 +00:00
return target.stack;
}
2016-01-14 18:35:29 +00:00
// Browser calls a callback in renderer.
handleMessage(IPC_MESSAGES.RENDERER_CALLBACK, (id: number, args: any) => {
2020-03-20 20:28:31 +00:00
callbacksRegistry.apply(id, metaToValue(args));
});
2016-01-12 02:40:23 +00:00
2016-01-14 18:35:29 +00:00
// A callback in browser is released.
handleMessage(IPC_MESSAGES.RENDERER_RELEASE_CALLBACK, (id: number) => {
2020-03-20 20:28:31 +00:00
callbacksRegistry.remove(id);
});
2016-01-12 02:40:23 +00:00
2020-06-11 18:36:03 +00:00
exports.require = (module: string) => {
const command = IPC_MESSAGES.BROWSER_REQUIRE;
2020-03-20 20:28:31 +00:00
const meta = ipcRendererInternal.sendSync(command, contextId, module, getCurrentStack());
return metaToValue(meta);
};
2016-01-12 02:40:23 +00:00
2016-01-14 18:35:29 +00:00
// Alias to remote.require('electron').xxx.
2020-06-11 18:36:03 +00:00
export function getBuiltin (module: string) {
const command = IPC_MESSAGES.BROWSER_GET_BUILTIN;
2020-03-20 20:28:31 +00:00
const meta = ipcRendererInternal.sendSync(command, contextId, module, getCurrentStack());
return metaToValue(meta);
2020-06-11 18:36:03 +00:00
}
2016-01-12 02:40:23 +00:00
2020-06-11 18:36:03 +00:00
export function getCurrentWindow (): BrowserWindow {
const command = IPC_MESSAGES.BROWSER_GET_CURRENT_WINDOW;
2020-03-20 20:28:31 +00:00
const meta = ipcRendererInternal.sendSync(command, contextId, getCurrentStack());
return metaToValue(meta);
2020-06-11 18:36:03 +00:00
}
2016-01-12 02:40:23 +00:00
2016-01-14 18:35:29 +00:00
// Get current WebContents object.
2020-06-11 18:36:03 +00:00
export function getCurrentWebContents (): WebContents {
const command = IPC_MESSAGES.BROWSER_GET_CURRENT_WEB_CONTENTS;
2020-03-20 20:28:31 +00:00
const meta = ipcRendererInternal.sendSync(command, contextId, getCurrentStack());
return metaToValue(meta);
2020-06-11 18:36:03 +00:00
}
2016-01-14 18:35:29 +00:00
// Get a global object in browser.
2020-06-11 18:36:03 +00:00
export function getGlobal<T = any> (name: string): T {
const command = IPC_MESSAGES.BROWSER_GET_GLOBAL;
2020-03-20 20:28:31 +00:00
const meta = ipcRendererInternal.sendSync(command, contextId, name, getCurrentStack());
return metaToValue(meta);
2020-06-11 18:36:03 +00:00
}
2016-01-12 02:40:23 +00:00
2016-01-14 18:35:29 +00:00
// Get the process object in browser.
Object.defineProperty(exports, 'process', {
get: () => exports.getGlobal('process')
2020-03-20 20:28:31 +00:00
});
2016-01-12 02:40:23 +00:00
2017-10-26 03:41:11 +00:00
// Create a function that will return the specified value when called in browser.
2020-06-11 18:36:03 +00:00
export function createFunctionWithReturnValue<T> (returnValue: T): () => T {
2020-03-20 20:28:31 +00:00
const func = () => returnValue;
v8Util.setHiddenValue(func, 'returnValue', true);
return func;
2020-06-11 18:36:03 +00:00
}
2016-01-12 02:40:23 +00:00
2020-06-11 18:36:03 +00:00
const addBuiltinProperty = (name: string) => {
Object.defineProperty(exports, name, {
2017-11-03 01:07:40 +00:00
get: () => exports.getBuiltin(name)
2020-03-20 20:28:31 +00:00
});
};
2020-06-11 18:36:03 +00:00
const browserModules = commonModuleList.concat(browserModuleNames.map(name => ({ name, loader: () => {} })));
// And add a helper receiver for each one.
browserModules
.filter((m) => !m.private)
.map((m) => m.name)
2020-03-20 20:28:31 +00:00
.forEach(addBuiltinProperty);