-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Tests are now in typescript * Fix various types * Get NYC coverage working with typescript * Properly configure the linter
- Loading branch information
Showing
14 changed files
with
546 additions
and
226 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,105 +1,129 @@ | ||
| import uuid from 'uuid/v4'; | ||
| import serializeError from 'serialize-error'; | ||
| import Map from 'es6-map'; | ||
| import { IpcMain, IpcRenderer, WebContents, IpcMessageEvent } from 'electron'; | ||
| import uuid from 'uuid/v4'; | ||
| import serializeError from 'serialize-error'; | ||
| import Map from 'es6-map'; | ||
| import { IpcMain, IpcRenderer, WebContents, IpcMessageEvent } from 'electron'; | ||
|
|
||
| export type Listener = (event?: IpcMessageEvent, ...dataArgs: any) => void | ||
| export type Options = { maxTimeoutMs?: number } | ||
| /** | ||
| * For backwards compatibility, event is the (optional) LAST argument to a listener function. | ||
| * This leads to the following verbose overload type for a listener function. | ||
| */ | ||
| export type Listener = | ||
| | { (event?: IpcMessageEvent): void } | ||
| | { (arg1?: unknown, event?: IpcMessageEvent): void } | ||
| | { (arg1?: unknown, arg2?: unknown, event?: IpcMessageEvent): void } | ||
| | { (arg1?: unknown, arg2?: unknown, arg3?: unknown, event?: IpcMessageEvent): void } | ||
| | { | ||
| ( | ||
| arg1?: unknown, | ||
| arg2?: unknown, | ||
| arg3?: unknown, | ||
| arg4?: unknown, | ||
| event?: IpcMessageEvent, | ||
| ): void; | ||
| } | ||
| | { | ||
| ( | ||
| arg1?: unknown, | ||
| arg2?: unknown, | ||
| arg3?: unknown, | ||
| arg4?: unknown, | ||
| arg5?: unknown, | ||
| event?: IpcMessageEvent, | ||
| ): void; | ||
| }; | ||
| export type Options = { maxTimeoutMs?: number }; | ||
|
|
||
| export default class PromiseIpcBase { | ||
| private eventEmitter: IpcMain | IpcRenderer; | ||
| private maxTimeoutMs: number; | ||
| private routeListenerMap: Map; | ||
| private listenerMap: Map; | ||
| export default class PromiseIpcBase { | ||
| private eventEmitter: IpcMain | IpcRenderer; | ||
|
|
||
| constructor(opts: { maxTimeoutMs?: number} | undefined, eventEmitter: IpcMain | IpcRenderer) { | ||
| private maxTimeoutMs: number; | ||
|
|
||
| if (opts && opts.maxTimeoutMs) { | ||
| this.maxTimeoutMs = opts.maxTimeoutMs; | ||
| } | ||
| private routeListenerMap: Map; | ||
|
|
||
| // either ipcRenderer or ipcMain | ||
| this.eventEmitter = eventEmitter; | ||
| this.routeListenerMap = new Map(); | ||
| this.listenerMap = new Map(); | ||
| } | ||
| private listenerMap: Map; | ||
|
|
||
| public send(route: string, sender: WebContents | IpcRenderer, ...dataArgs: any): Promise<unknown> { | ||
| return new Promise((resolve, reject) => { | ||
| const replyChannel: string = `${route}#${uuid()}`; | ||
| let timeout: any; | ||
| let didTimeOut: boolean = false; | ||
| constructor(opts: { maxTimeoutMs?: number } | undefined, eventEmitter: IpcMain | IpcRenderer) { | ||
| if (opts && opts.maxTimeoutMs) { | ||
| this.maxTimeoutMs = opts.maxTimeoutMs; | ||
| } // either ipcRenderer or ipcMain | ||
|
|
||
| // ipcRenderer will send a message back to replyChannel when it finishes calculating | ||
| this.eventEmitter.once(replyChannel, (event, status, returnData) => { | ||
| clearTimeout(timeout); | ||
| if (didTimeOut) { | ||
| return null; | ||
| } | ||
| switch (status) { | ||
| case 'success': | ||
| return resolve(returnData); | ||
| case 'failure': | ||
| return reject(returnData); | ||
| default: | ||
| return reject(new Error(`Unexpected IPC call status "${status}" in ${route}`)); | ||
| } | ||
| }); | ||
| sender.send(route, replyChannel, ...dataArgs); | ||
| if (this.maxTimeoutMs) { | ||
| timeout = setTimeout(() => { | ||
| didTimeOut = true; | ||
| reject(new Error(`${route} timed out.`)); | ||
| }, this.maxTimeoutMs); | ||
| } | ||
| }); | ||
| } | ||
| this.eventEmitter = eventEmitter; | ||
| this.routeListenerMap = new Map(); | ||
| this.listenerMap = new Map(); | ||
| } | ||
|
|
||
| public on(route: string, listener: Listener): WebContents | PromiseIpcBase { | ||
| const prevListener = this.routeListenerMap.get(route); | ||
| // If listener has already been added for this route, don't add it again. | ||
| if (prevListener === listener) { | ||
| return this; | ||
| } | ||
| // Only one listener may be active for a given route. | ||
| // If two are active promises it won't work correctly - that's a race condition. | ||
| if (this.routeListenerMap.has(route)) { | ||
| this.off(route, prevListener); | ||
| } | ||
| // This function _wraps_ the listener argument. We maintain a map of | ||
| // listener -> wrapped listener in order to implement #off(). | ||
| const wrappedListener = (event, replyChannel, ...dataArgs) => { | ||
| // Chaining off of Promise.resolve() means that listener can return a promise, or return | ||
| // synchronously -- it can even throw. The end result will still be handled promise-like. | ||
| Promise.resolve() | ||
| .then(() => listener(...dataArgs, event)) | ||
| .then((results) => { | ||
| event.sender.send(replyChannel, 'success', results); | ||
| }) | ||
| .catch((e) => { | ||
|
|
||
| event.sender.send(replyChannel, 'failure', serializeError(e)); | ||
| }); | ||
| }; | ||
| this.routeListenerMap.set(route, listener); | ||
| this.listenerMap.set(listener, wrappedListener); | ||
| this.eventEmitter.on(route, wrappedListener); | ||
| return this; | ||
| } | ||
| public send( | ||
| route: string, | ||
| sender: WebContents | IpcRenderer, | ||
| ...dataArgs: [unknown] | ||
| ): Promise<unknown> { | ||
| return new Promise((resolve, reject) => { | ||
| const replyChannel = `${route}#${uuid()}`; | ||
| let timeout: NodeJS.Timeout; | ||
| let didTimeOut = false; // ipcRenderer will send a message back to replyChannel when it finishes calculating | ||
|
|
||
| public off(route: string, listener: Listener): void { | ||
| const registeredListener = this.routeListenerMap.get(route); | ||
| if (listener && listener !== registeredListener) { | ||
| return; // trying to remove the wrong listener, so do nothing. | ||
| } | ||
| const wrappedListener = this.listenerMap.get(registeredListener); | ||
| this.eventEmitter.removeListener(route, wrappedListener); | ||
| this.listenerMap.delete(registeredListener); | ||
| this.routeListenerMap.delete(route); | ||
| } | ||
| this.eventEmitter.once(replyChannel, (event, status, returnData) => { | ||
| clearTimeout(timeout); | ||
| if (didTimeOut) { | ||
| return null; | ||
| } | ||
| switch (status) { | ||
| case 'success': | ||
| return resolve(returnData); | ||
| case 'failure': | ||
| return reject(returnData); | ||
| default: | ||
| return reject(new Error(`Unexpected IPC call status "${status}" in ${route}`)); | ||
| } | ||
| }); | ||
| sender.send(route, replyChannel, ...dataArgs); | ||
| if (this.maxTimeoutMs) { | ||
| timeout = setTimeout(() => { | ||
| didTimeOut = true; | ||
| reject(new Error(`${route} timed out.`)); | ||
| }, this.maxTimeoutMs); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| public removeListener(route: string, listener: Listener): void { | ||
| this.off(route, listener); | ||
| } | ||
| public on(route: string, listener: Listener): WebContents | PromiseIpcBase { | ||
| const prevListener = this.routeListenerMap.get(route); // If listener has already been added for this route, don't add it again. | ||
| if (prevListener === listener) { | ||
| return this; | ||
| } // Only one listener may be active for a given route. // If two are active promises it won't work correctly - that's a race condition. | ||
| if (this.routeListenerMap.has(route)) { | ||
| this.off(route, prevListener); | ||
| } // This function _wraps_ the listener argument. We maintain a map of // listener -> wrapped listener in order to implement #off(). | ||
| const wrappedListener = (event, replyChannel, ...dataArgs): void => { | ||
| // Chaining off of Promise.resolve() means that listener can return a promise, or return | ||
| // synchronously -- it can even throw. The end result will still be handled promise-like. | ||
| Promise.resolve() | ||
| .then(() => listener(...dataArgs, event)) | ||
| .then((results) => { | ||
| event.sender.send(replyChannel, 'success', results); | ||
| }) | ||
| .catch((e) => { | ||
| event.sender.send(replyChannel, 'failure', serializeError(e)); | ||
| }); | ||
| }; | ||
| this.routeListenerMap.set(route, listener); | ||
| this.listenerMap.set(listener, wrappedListener); | ||
| this.eventEmitter.on(route, wrappedListener); | ||
| return this; | ||
| } | ||
|
|
||
| } | ||
| public off(route: string, listener: Listener): void { | ||
| const registeredListener = this.routeListenerMap.get(route); | ||
| if (listener && listener !== registeredListener) { | ||
| return; // trying to remove the wrong listener, so do nothing. | ||
| } | ||
| const wrappedListener = this.listenerMap.get(registeredListener); | ||
| this.eventEmitter.removeListener(route, wrappedListener); | ||
| this.listenerMap.delete(registeredListener); | ||
| this.routeListenerMap.delete(route); | ||
| } | ||
|
|
||
| public removeListener(route: string, listener: Listener): void { | ||
| this.off(route, listener); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,11 @@ | ||
| import isRenderer from 'is-electron-renderer'; | ||
| import renderer from "./renderer"; | ||
| import mainProcess from "./mainProcess"; | ||
| import renderer, { RendererProcessType } from './renderer'; | ||
| import mainProcess, { MainProcessType } from './mainProcess'; | ||
|
|
||
| if (isRenderer) { | ||
| module.exports = renderer; | ||
| } else { | ||
| module.exports = mainProcess; | ||
| } | ||
| const exportedModule: RendererProcessType | MainProcessType = isRenderer ? renderer : mainProcess; | ||
| export default exportedModule; | ||
| module.exports = exportedModule; | ||
|
|
||
| // Re-export the renderer and main process types for consumer modules to access | ||
| export { RendererProcessType } from './renderer'; | ||
| export { MainProcessType } from './mainProcess'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.