-
Notifications
You must be signed in to change notification settings - Fork 335
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into hotfix/3.18.6
- Loading branch information
Showing
13 changed files
with
404 additions
and
196 deletions.
There are no files selected for viewing
Submodule memex-common
updated
from 158e60 to a22d8b
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| import createResolvable, { Resolvable } from '@josephg/resolvable' | ||
| import type { RPCManager, RPCManagerDependencies, RPCRequest } from './types' | ||
| import type { Runtime } from 'webextension-polyfill' | ||
| import { createRPCRequestObject, createRPCResponseObject } from './utils' | ||
| import { RpcError } from '../webextensionRPC' | ||
| import { resolveTabUrl } from '../uri-utils' | ||
|
|
||
| export class EventBasedRPCManager implements RPCManager { | ||
| private paused?: Resolvable<void> | ||
|
|
||
| constructor(private deps: RPCManagerDependencies) { | ||
| if (deps.initPaused) { | ||
| this.paused = createResolvable() | ||
| } | ||
| } | ||
|
|
||
| private log = (msg: string, obj?: any) => { | ||
| if (this.deps.debug === true || globalThis['memex-rpc-debug']) { | ||
| msg = `RPC::side=${this.deps.sideName}::` + msg | ||
| console['log'](msg, obj ?? {}) | ||
| } | ||
| } | ||
|
|
||
| private async postMessageRequestToRPC<T, O>( | ||
| request: RPCRequest<T>, | ||
| ): Promise<O> { | ||
| this.log(`messageRequester:: Requested for [${request.headers.name}]`, { | ||
| request, | ||
| }) | ||
|
|
||
| let ret: RPCRequest<O> | ||
| try { | ||
| if (this.deps.sideName === 'background') { | ||
| ret = await this.deps.browserAPIs.tabs.sendMessage( | ||
| request.headers.tabId, | ||
| request, | ||
| ) | ||
| } else { | ||
| ret = await this.deps.browserAPIs.runtime.sendMessage(request) | ||
| } | ||
| } catch (err) { | ||
| throw new RpcError(err.message) | ||
| } | ||
| this.log( | ||
| `messageRequester:: Got response for [${request.headers.name}]`, | ||
| ret.payload, | ||
| ) | ||
| return ret.payload | ||
| } | ||
|
|
||
| postMessageRequestToBackground: RPCManager['postMessageRequestToBackground'] = async ( | ||
| name, | ||
| payload, | ||
| ) => { | ||
| const request = createRPCRequestObject( | ||
| { name, originSide: this.deps.sideName }, | ||
| payload, | ||
| ) | ||
| return this.postMessageRequestToRPC(request) | ||
| } | ||
|
|
||
| postMessageRequestToTab: RPCManager['postMessageRequestToTab'] = async ( | ||
| tabId, | ||
| name, | ||
| payload, | ||
| ) => { | ||
| const request = createRPCRequestObject( | ||
| { name, tabId, originSide: this.deps.sideName }, | ||
| payload, | ||
| ) | ||
| return this.postMessageRequestToRPC(request) | ||
| } | ||
|
|
||
| postMessageRequestToTabViaBackground: RPCManager['postMessageRequestToTabViaBackground'] = async ( | ||
| tabId, | ||
| name, | ||
| payload, | ||
| ) => { | ||
| const request = createRPCRequestObject( | ||
| { | ||
| tabId, | ||
| proxy: 'background', | ||
| name, | ||
| originSide: this.deps.sideName, | ||
| }, | ||
| payload, | ||
| ) | ||
| return this.postMessageRequestToRPC(request) | ||
| } | ||
|
|
||
| private messageResponder = async ( | ||
| request: RPCRequest, | ||
| sender: Runtime.MessageSender, | ||
| ) => { | ||
| const { headers, payload, error, serializedError } = request | ||
| const { id, name, type } = headers | ||
|
|
||
| // Forward the request to the BG if it was received on the options page via content script | ||
| if ( | ||
| this.deps.sideName === 'extension-page-options' && | ||
| request.headers.proxy == null && | ||
| request.headers.tabId == null | ||
| ) { | ||
| return this.postMessageRequestToBackground(name, payload) | ||
| } | ||
|
|
||
| await this.paused | ||
|
|
||
| if (type === 'RPC_REQUEST') { | ||
| this.log( | ||
| `messageResponder:: REQUEST received for [${name}]:`, | ||
| request, | ||
| ) | ||
|
|
||
| // If the Request type was a proxy, the background shouldn't fullill this request itself | ||
| // but pass it on to the specific tab to fullfill | ||
| if (headers.proxy === 'background') { | ||
| await this.postMessageRequestToTab(headers.tabId, name, payload) | ||
| } else { | ||
| const f = this.deps.getRegisteredRemoteFunction(name) | ||
|
|
||
| if (!f) { | ||
| console.error({ side: this.deps.sideName, packet: request }) | ||
| throw Error(`No registered remote function called ${name}`) | ||
| } | ||
| Object.defineProperty(f, 'name', { value: name }) | ||
|
|
||
| this.log(`messageResponder:: RUNNING Function [${name}]`) | ||
|
|
||
| let tab = | ||
| sender.tab ?? | ||
| (request.headers.tabId != null | ||
| ? await this.deps.browserAPIs.tabs?.get( | ||
| request.headers.tabId, | ||
| ) // Tabs API only available in non-CS | ||
| : undefined) | ||
| tab = resolveTabUrl(tab) | ||
|
|
||
| try { | ||
| const functionReturn = await f({ tab }, ...payload) | ||
| this.log( | ||
| `messageResponder:: FINISHED Function [${name}]`, | ||
| functionReturn, | ||
| ) | ||
| return createRPCResponseObject({ | ||
| request, | ||
| payload: functionReturn, | ||
| originSide: this.deps.sideName, | ||
| }) | ||
| } catch (err) { | ||
| this.log(`messageResponder:: ERRORED Function [${name}]`) | ||
| throw new RpcError(err.message) | ||
| } | ||
| } | ||
| } else if (type === 'RPC_RESPONSE') { | ||
| this.log(`messageResponder:: RESPONSE received for [${name}]`) | ||
| // We don't need to do anything with the response - it's available directly from the `sendMessage` calls | ||
| } | ||
| } | ||
|
|
||
| setup: RPCManager['setup'] = () => { | ||
| this.deps.browserAPIs.runtime.onMessage.addListener( | ||
| this.messageResponder, | ||
| ) | ||
| } | ||
|
|
||
| unpause: RPCManager['unpause'] = () => { | ||
| const paused = this.paused | ||
| delete this.paused | ||
| paused?.resolve() | ||
| } | ||
| } |
Oops, something went wrong.