feat: add timeout option

Author: iceprosurface

readme.md

@@ -218,6 +218,10 @@ socket.on('connection', (socket) => {
 
 ## Api Reference
 
+### constructor(setting: { timeout: number })
+
+`timeout` default timeout setting
+
 ### Server.receiveData(data: RemoteData)
 
 Receive a remote data from another server.
@@ -231,7 +235,7 @@ Add a listener on `target` path, which will call `callback` when `receiveData` w
 
 Remove listener on target. This will remove all callbacks when callback params was not set.
 
-### Server.registerPromise(target: string, data: any)
+### Server.registerPromise(target: string, data: any, option: { timeout: number })
 
 Register a promise and pass to anther server which listen `target` path.
 

src/Server.ts

@@ -13,7 +13,9 @@ export type RemoteCallBack = (
   reject?: (ret: any) => void,
   remoteData?: RemoteData,
 ) => any;
+export const NO_TIMEOUT = -1;
 export class Server {
+  constructor(private readonly setting: { timeout: number } = { timeout: NO_TIMEOUT }) {}
   protected promiseMap: {
     [key: string]: RemoteAsyncObject<any>;
   } = {};
@@ -99,10 +101,10 @@ export class Server {
   /**
    * Register a promise and pass to anther server which listen `target` path.
    */
-  registerPromise<T = any, Payload = any>(target: string, data?: Payload): Promise<T> {
+  registerPromise<T = any, Payload = any>(target: string, data?: Payload, option?: { timeout: number }): Promise<T> {
     const uuid = uuidv4();
     let resolver: (value: T | PromiseLike<T>) => void = () => {};
-    let ejector = () => {};
+    let ejector = (params: any) => {};
     const promise = new Promise<T>((resolve, reject) => {
       resolver = resolve;
       ejector = reject;
@@ -114,6 +116,10 @@ export class Server {
       data: this.dataStringify(typeof data === 'undefined' || data === null ? {} : data),
       target,
     });
+    const timeout = option?.timeout ?? this.setting.timeout ?? NO_TIMEOUT;
+    if (timeout !== NO_TIMEOUT && timeout >= 0) {
+      setTimeout(() => ejector(new Error('ErrorTimeout')), timeout);
+    }
     return promise;
   }
 }

tests/inner.spec.ts

@@ -34,6 +34,16 @@ describe('remoteAsync:inner test', () => {
     expect(returnedValue).toEqual(retObject);
   });
 
+  test('timeout', async () => {
+    const defer = (time: number) => new Promise((resolve) => setTimeout(resolve, time));
+    const listener = new Server({ timeout: 5 });
+    listener.registerSender(() => {});
+    await expect(() => listener.registerPromise('dataSend', { a: 1 })).rejects.toThrowError('ErrorTimeout');
+    await expect(
+      Promise.race([listener.registerPromise('dataSend', { a: 2 }, { timeout: 20 }), defer(30)]),
+    ).rejects.toThrowError('ErrorTimeout');
+  });
+
   test('reject data', async () => {
     const listener = new Server();
     const object = { a: 1 };