entityseven/rage-framework-rpc
Archived
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add options including timeout option

Browse Source
This commit is contained in:
micah 2019-06-02 12:08:28 -04:00
parent 57c234c6e9
commit 18deb4d908
3 changed files with 75 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/defs.d.ts vendored
View File

@ -22,6 +22,10 @@ declare interface ProcedureListenerInfo {
browser?: Browser; browser?: Browser;
} }
declare interface CallOptions {
timeout?: number;
}
declare interface Event { declare interface Event {
req?: number; req?: number;
ret?: number; ret?: number;

88
src/index.ts
View File

@ -153,11 +153,12 @@ export function unregister(name: string): void {
* *
* @param name - The name of the locally registered procedure. * @param name - The name of the locally registered procedure.
* @param args - Any parameters for the procedure. * @param args - Any parameters for the procedure.
* @param options - Any options.
* @returns The result from the procedure. * @returns The result from the procedure.
*/ */
export function call(name: string, args?: any): Promise<any> { export function call(name: string, args?: any, options: CallOptions = {}): Promise<any> {
if(arguments.length !== 1 && arguments.length !== 2) return util.promiseReject('call expects 1 or 2 arguments: "name" and optional "args"'); if(arguments.length < 1 || arguments.length > 3) return util.promiseReject('call expects 1 to 3 arguments: "name", optional "args", and optional "options"');
return callProcedure(name, args, { environment }); return util.promiseTimeout(callProcedure(name, args, { environment }), options.timeout);
} }
function _callServer(name: string, args?: any, extraData = {}): Promise<any> { function _callServer(name: string, args?: any, extraData = {}): Promise<any> {
@ -195,11 +196,12 @@ function _callServer(name: string, args?: any, extraData = {}): Promise<any> {
* *
* @param name - The name of the registered procedure. * @param name - The name of the registered procedure.
* @param args - Any parameters for the procedure. * @param args - Any parameters for the procedure.
* @param options - Any options.
* @returns The result from the procedure. * @returns The result from the procedure.
*/ */
export function callServer(name: string, args?: any): Promise<any> { export function callServer(name: string, args?: any, options: CallOptions = {}): Promise<any> {
if(arguments.length !== 1 && arguments.length !== 2) return util.promiseReject('callServer expects 1 or 2 arguments: "name" and optional "args"'); if(arguments.length < 1 || arguments.length > 3) return util.promiseReject('callServer expects 1 to 3 arguments: "name", optional "args", and optional "options"');
return _callServer(name, args, {}); return util.promiseTimeout(_callServer(name, args, {}), options.timeout);
} }
/** /**
@ -210,20 +212,25 @@ export function callServer(name: string, args?: any): Promise<any> {
* @param player - The player to call the procedure on. * @param player - The player to call the procedure on.
* @param name - The name of the registered procedure. * @param name - The name of the registered procedure.
* @param args - Any parameters for the procedure. * @param args - Any parameters for the procedure.
* @param options - Any options.
* @returns The result from the procedure. * @returns The result from the procedure.
*/ */
export function callClient(player: Player | string, name?: string | any, args?: any): Promise<any> { export function callClient(player: Player | string, name?: string | any, args?: any, options: CallOptions = {}): Promise<any> {
let promise;
switch(environment){ switch(environment){
case "client": { case 'client': {
options = args || {};
args = name; args = name;
name = player; name = player;
if((arguments.length !== 1 && arguments.length !== 2) || typeof name !== "string") return util.promiseReject('callClient from the client expects 1 or 2 arguments: "name" and optional "args"'); if((arguments.length < 1 || arguments.length > 3) || typeof name !== 'string') return util.promiseReject('callClient from the client expects 1 to 3 arguments: "name", optional "args", and optional "options"');
return call(name, args); promise = call(name, args);
break;
} }
case "server": { case 'server': {
if((arguments.length !== 2 && arguments.length !== 3) || typeof player !== "object") return util.promiseReject('callClient from the server expects 2 or 3 arguments: "player", "name", and optional "args"'); if((arguments.length < 2 || arguments.length > 4) || typeof player !== 'object') return util.promiseReject('callClient from the server expects 2 to 4 arguments: "player", "name", optional "args", and optional "options"');
const id = util.uid(); const id = util.uid();
return new Promise(resolve => { promise = new Promise(resolve => {
glob.__rpcPending[id] = { glob.__rpcPending[id] = {
resolve, resolve,
player player
@ -237,13 +244,15 @@ export function callClient(player: Player | string, name?: string | any, args?:
}; };
player.call(PROCESS_EVENT, [util.stringifyData(event)]); player.call(PROCESS_EVENT, [util.stringifyData(event)]);
}); });
break;
} }
case "cef": { case 'cef': {
options = args || {};
args = name; args = name;
name = player; name = player;
if((arguments.length !== 1 && arguments.length !== 2) || typeof name !== "string") return util.promiseReject('callClient from the browser expects 1 or 2 arguments: "name" and optional "args"'); if((arguments.length < 1 || arguments.length > 3) || typeof name !== 'string') return util.promiseReject('callClient from the browser expects 1 to 3 arguments: "name", optional "args", and optional "options"');
const id = util.uid(); const id = util.uid();
return glob[IDENTIFIER].then((browserId: string) => { promise = glob[IDENTIFIER].then((browserId: string) => {
return new Promise(resolve => { return new Promise(resolve => {
glob.__rpcPending[id] = { glob.__rpcPending[id] = {
resolve resolve
@ -259,8 +268,13 @@ export function callClient(player: Player | string, name?: string | any, args?:
mp.trigger(PROCESS_EVENT, util.stringifyData(event)); mp.trigger(PROCESS_EVENT, util.stringifyData(event));
}); });
}); });
break;
} }
} }
if(promise){
return util.promiseTimeout(promise, options.timeout);
}
} }
function _callBrowser(id: string, browser: Browser, name: string, args?: any, extraData = {}): Promise<any> { function _callBrowser(id: string, browser: Browser, name: string, args?: any, extraData = {}): Promise<any> {
@ -281,16 +295,16 @@ function _callBrowser(id: string, browser: Browser, name: string, args?: any, ex
function _callBrowsers(player: Player, name: string, args?: any, extraData = {}): Promise<any> { function _callBrowsers(player: Player, name: string, args?: any, extraData = {}): Promise<any> {
switch(environment){ switch(environment){
case "client": case 'client':
const id = util.uid(); const id = util.uid();
const browserId = glob.__rpcBrowserProcedures[name]; const browserId = glob.__rpcBrowserProcedures[name];
if(!browserId) return util.promiseReject(ERR_NOT_FOUND); if(!browserId) return util.promiseReject(ERR_NOT_FOUND);
const browser = glob.__rpcBrowsers[browserId]; const browser = glob.__rpcBrowsers[browserId];
if(!browser || !util.isBrowserValid(browser)) return util.promiseReject(ERR_NOT_FOUND); if(!browser || !util.isBrowserValid(browser)) return util.promiseReject(ERR_NOT_FOUND);
return _callBrowser(id, browser, name, args, extraData); return _callBrowser(id, browser, name, args, extraData);
case "server": case 'server':
return callClient(player, '__rpc:callBrowsers', [name, args]); return callClient(player, '__rpc:callBrowsers', [name, args]);
case "cef": case 'cef':
return callClient('__rpc:callBrowsers', [name, args]); return callClient('__rpc:callBrowsers', [name, args]);
} }
} }
@ -303,17 +317,29 @@ function _callBrowsers(player: Player, name: string, args?: any, extraData = {})
* @param player - The player to call the procedure on. * @param player - The player to call the procedure on.
* @param name - The name of the registered procedure. * @param name - The name of the registered procedure.
* @param args - Any parameters for the procedure. * @param args - Any parameters for the procedure.
* @param options - Any options.
* @returns The result from the procedure. * @returns The result from the procedure.
*/ */
export function callBrowsers(player: Player | string, name?: string | any, args?: any): Promise<any> { export function callBrowsers(player: Player | string, name?: string | any, args?: any, options: CallOptions = {}): Promise<any> {
let promise;
switch(environment){ switch(environment){
case "client": case 'client':
case "cef": case 'cef':
if(arguments.length !== 1 && arguments.length !== 2) return util.promiseReject('callBrowsers from the client or browser expects 1 or 2 arguments: "name" and optional "args"'); options = args || {};
return _callBrowsers(null, player as string, name, {}); args = name;
case "server": name = player;
if(arguments.length !== 2 && arguments.length !== 3) return util.promiseReject('callBrowsers from the server expects 2 or 3 arguments: "player", "name", and optional "args"'); if(arguments.length < 1 || arguments.length > 3) return util.promiseReject('callBrowsers from the client or browser expects 1 to 3 arguments: "name", optional "args", and optional "options"');
return _callBrowsers(player as Player, name, args, {}); promise = _callBrowsers(null, name, args, {});
break;
case 'server':
if(arguments.length < 2 || arguments.length > 4) return util.promiseReject('callBrowsers from the server expects 2 to 4 arguments: "player", "name", optional "args", and optional "options"');
promise = _callBrowsers(player as Player, name, args, {});
break;
}
if(promise){
return util.promiseTimeout(promise, options.timeout);
} }
} }
@ -325,13 +351,15 @@ export function callBrowsers(player: Player | string, name?: string | any, args?
* @param browser - The browser instance. * @param browser - The browser instance.
* @param name - The name of the registered procedure. * @param name - The name of the registered procedure.
* @param args - Any parameters for the procedure. * @param args - Any parameters for the procedure.
* @param options - Any options.
* @returns The result from the procedure. * @returns The result from the procedure.
*/ */
export function callBrowser(browser: Browser, name: string, args?: any): Promise<any> { export function callBrowser(browser: Browser, name: string, args?: any, options: CallOptions = {}): Promise<any> {
if(environment !== 'client') return util.promiseReject('callBrowser can only be used in the client environment'); if(environment !== 'client') return util.promiseReject('callBrowser can only be used in the client environment');
if(arguments.length !== 2 && arguments.length !== 3) return util.promiseReject('callBrowser expects 2 or 3 arguments: "browser", "name", and optional "args"'); if(arguments.length < 2 || arguments.length > 4) return util.promiseReject('callBrowser expects 2 to 4 arguments: "browser", "name", optional "args", and optional "options"');
const id = util.uid(); const id = util.uid();
return _callBrowser(id, browser, name, args, {});
return util.promiseTimeout(_callBrowser(id, browser, name, args, {}), options.timeout);
} }
export default { export default {

11
src/util.ts
View File

@ -103,6 +103,17 @@ export function promiseReject(error: any): Promise<any> {
return new Promise((_, reject) => setTimeout(() => reject(error), 0)); return new Promise((_, reject) => setTimeout(() => reject(error), 0));
} }
export function promiseTimeout(promise: Promise<any>, timeout?: number){
if(typeof timeout === 'number'){
return Promise.race([
new Promise((_, reject) => {
setTimeout(() => reject('TIMEOUT'), timeout);
}),
promise
]);
}else return promise;
}
export function isBrowserValid(browser: Browser): boolean { export function isBrowserValid(browser: Browser): boolean {
try { try {
browser.url; browser.url;