@delight-rpc/long-running-procedure 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 BlackGlory <woshenmedoubuzhidao@blackglory.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,141 @@
+# long-running-procedure
+## Install
+```sh
+npm install --save @delight-rpc/long-running-procedure
+# or
+yarn add @delight-rpc/long-running-procedure
+```
+
+## API
+```ts
+enum CallState {
+  Pending
+, Settled
+}
+
+interface ILongRunningProcedure<Args extends any[], Result> {
+  /**
+   * 调用此过程.
+   * 
+   * @returns 该调用的id.
+   */
+  call(args: Args): Awaitable<string>
+
+  /**
+   * 中断一个还未完成的调用.
+   * 如果该调用已经完成或调用不存在, 该函数会静默失败.
+   */
+  abort(id: string): Awaitable<Nullish>
+
+  /**
+   * 返回调用的状态.
+   * 
+   * @throws {CallNotFound}
+   */
+  getState(id: string): Awaitable<CallState>
+
+  /**
+   * 获取调用的结果, 如果调用尚未完成, 则会阻塞直到完成.
+   * 
+   * @throws {CallNotFound}
+   */
+  getResult(id: string): Awaitable<Result>
+
+  /**
+   * 删除一个已经完成的调用, 这会导致与该调用相关的信息被删除.
+   * 如果该调用还未完成, 则该操作会抛出错误.
+   * 如果该调用已经删除, 则该操作会静默失败.
+   */
+  remove(id: string): Awaitable<Nullish>
+}
+
+class CallNotFound extends CustomError {}
+```
+
+### LongRunningProcedure
+```ts
+class LongRunningProcedure<Args extends unknown[], Result, Error>
+implements ILongRunningProcedure<Args, Result> {
+  /**
+   * 超时和TTL的存在是为了减缓错误的实现耗尽存储空间的速度.
+   * 
+   * @param timeout 调用的超时时间(毫秒), 超时的调用会被自动中断.
+   * @param timeToLive 调用从完成开始计算的存活时间(毫秒), 超出存活时间的调用会被删除.
+   */
+  constructor(
+    procedure: (...args: [...Args, AbortSignal]) => PromiseLike<Result>
+  , options?: {
+      store?: Store<Result, Error>
+      timeout?: number
+      timeToLive?: number
+    }
+  )
+}
+```
+
+### Caller
+```ts
+interface ILongRunningProcedureCaller<Args extends unknown[], Result> {
+  call(...args: [...args: Args, signal: AbortSignal]): Promise<Result>
+}
+```
+
+#### LongRunningProcedureCaller
+```ts
+/**
+ * 以长连接方式接收长时运行过程的结果, 结果会尽快返回.
+ * 请注意, 在一些信道上维持长连接需要付出成本.
+ */
+class LongRunningProcedureCaller<Args extends unknown[], Result>
+implements ILongRunningProcedureCaller<Args, Result> {
+  constructor(procedure: ILongRunningProcedure<Args, Result>)
+}
+```
+
+#### LongRunningProcedurePollingCaller
+```ts
+/**
+ * 以轮询方式接收长时运行过程的结果, 这无法尽快返回结果.
+ * 请注意, 视轮询间隔, 可能会造成很多被浪费的请求.
+ */
+class LongRunningProcedurePollingCaller<Args extends unknown[], Result>
+implements ILongRunningProcedureCaller<Args, Result> {
+  constructor(
+    procedure: ILongRunningProcedure<Args, Result>
+  , pollingInterval: number
+  )
+}
+```
+
+### Store
+```ts
+enum StoreItemState {
+  Pending
+, Resolved
+, Rejected
+}
+
+interface Store<Result, Error> {
+  set(
+    id: string
+  , value:
+    | [StoreItemState.Pending]
+    | [StoreItemState.Resolved, Result]
+    | [StoreItemState.Rejected, Error]
+  , timeToLive?: number
+  ): Awaitable<Nullish>
+
+  get(id: string): Awaitable<Nullable<
+  | [StoreItemState.Pending]
+  | [StoreItemState.Resolved, Result]
+  | [StoreItemState.Rejected, Error]
+  >>
+
+  delete(id: string): Awaitable<Nullish>
+}
+```
+
+#### MemoryStore
+```ts
+class MemoryStore<Result, Error> implements Store<Result, Error> {}
+```

package/lib/contract.d.ts

@@ -0,0 +1,15 @@
+import { CustomError } from '@blackglory/errors';
+import { Awaitable, Nullish } from '@blackglory/prelude';
+export declare enum CallState {
+    Pending = 0,
+    Settled = 1
+}
+export interface ILongRunningProcedure<Args extends any[], Result> {
+    call(args: Args): Awaitable<string>;
+    abort(id: string): Awaitable<Nullish>;
+    getState(id: string): Awaitable<CallState>;
+    getResult(id: string): Awaitable<Result>;
+    remove(id: string): Awaitable<Nullish>;
+}
+export declare class CallNotFound extends CustomError {
+}

package/lib/contract.js

@@ -0,0 +1,9 @@
+import { CustomError } from '@blackglory/errors';
+export var CallState;
+(function (CallState) {
+    CallState[CallState["Pending"] = 0] = "Pending";
+    CallState[CallState["Settled"] = 1] = "Settled";
+})(CallState = CallState || (CallState = {}));
+export class CallNotFound extends CustomError {
+}
+//# sourceMappingURL=contract.js.map

package/lib/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAGhD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,+CAAO,CAAA;IACP,+CAAO,CAAA;AACT,CAAC,EAHW,SAAS,GAAT,SAAS,KAAT,SAAS,QAGpB;AAsCD,MAAM,OAAO,YAAa,SAAQ,WAAW;CAAG"}

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+export * from './contract.js';
+export * from './types.js';
+export * from './long-running-procedure-caller.js';
+export * from './long-running-procedure-polling-caller.js';
+export * from './long-running-procedure/index.js';
+export * from './memory-store.js';

package/lib/index.js

@@ -0,0 +1,7 @@
+export * from './contract.js';
+export * from './types.js';
+export * from './long-running-procedure-caller.js';
+export * from './long-running-procedure-polling-caller.js';
+export * from './long-running-procedure/index.js';
+export * from './memory-store.js';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA;AAC1B,cAAc,oCAAoC,CAAA;AAClD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,mCAAmC,CAAA;AACjD,cAAc,mBAAmB,CAAA"}

package/lib/long-running-procedure/event-hub.d.ts

@@ -0,0 +1,17 @@
+export declare enum Event {
+    Settled = 0,
+    Removed = 1
+}
+type EventToArgs = {
+    [Event.Settled]: [];
+    [Event.Removed]: [];
+};
+export declare class EventHub {
+    private idToEmitter;
+    waitFor(id: string, event: keyof EventToArgs, abortSignal?: AbortSignal): Promise<void>;
+    on<T extends Event>(id: string, event: T, listener: (...args: EventToArgs[T]) => void): () => void;
+    once<T extends Event>(id: string, event: T, listener: (...args: EventToArgs[T]) => void): () => void;
+    emit<T extends Event>(id: string, event: T, ...args: EventToArgs[T]): void;
+    removeAllListeners(id: string): void;
+}
+export {};

package/lib/long-running-procedure/event-hub.js

@@ -0,0 +1,44 @@
+import { Emitter } from '@blackglory/structures';
+import { waitForEmitter } from '@blackglory/wait-for';
+export var Event;
+(function (Event) {
+    Event[Event["Settled"] = 0] = "Settled";
+    Event[Event["Removed"] = 1] = "Removed";
+})(Event = Event || (Event = {}));
+export class EventHub {
+    constructor() {
+        this.idToEmitter = new Map();
+    }
+    async waitFor(id, event, abortSignal) {
+        if (!this.idToEmitter.has(id)) {
+            this.idToEmitter.set(id, new Emitter());
+        }
+        const emitter = this.idToEmitter.get(id);
+        await waitForEmitter(emitter, event, abortSignal);
+    }
+    on(id, event, listener) {
+        if (!this.idToEmitter.has(id)) {
+            this.idToEmitter.set(id, new Emitter());
+        }
+        const emitter = this.idToEmitter.get(id);
+        return emitter.on(event, listener);
+    }
+    once(id, event, listener) {
+        if (!this.idToEmitter.has(id)) {
+            this.idToEmitter.set(id, new Emitter());
+        }
+        const emitter = this.idToEmitter.get(id);
+        return emitter.once(event, listener);
+    }
+    emit(id, event, ...args) {
+        var _a;
+        (_a = this.idToEmitter.get(id)) === null || _a === void 0 ? void 0 : _a.emit(event, ...args);
+    }
+    removeAllListeners(id) {
+        const emitter = this.idToEmitter.get(id);
+        if (emitter) {
+            emitter.removeAllListeners(Event.Settled);
+        }
+    }
+}
+//# sourceMappingURL=event-hub.js.map

package/lib/long-running-procedure/event-hub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-hub.js","sourceRoot":"","sources":["../../src/long-running-procedure/event-hub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAErD,MAAM,CAAN,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,uCAAO,CAAA;IACP,uCAAO,CAAA;AACT,CAAC,EAHW,KAAK,GAAL,KAAK,KAAL,KAAK,QAGhB;AAOD,MAAM,OAAO,QAAQ;IAArB;QACU,gBAAW,GAAsC,IAAI,GAAG,EAAE,CAAA;IAuDpE,CAAC;IArDC,KAAK,CAAC,OAAO,CACX,EAAU,EACV,KAAwB,EACxB,WAAyB;QAEzB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC7B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,OAAO,EAAE,CAAC,CAAA;SACxC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAE,CAAA;QACzC,MAAM,cAAc,CAAC,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;IACnD,CAAC;IAED,EAAE,CACA,EAAU,EACV,KAAQ,EACR,QAA2C;QAE3C,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC7B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,OAAO,EAAE,CAAC,CAAA;SACxC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAE,CAAA;QACzC,OAAO,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;IACpC,CAAC;IAED,IAAI,CACF,EAAU,EACV,KAAQ,EACR,QAA2C;QAE3C,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC7B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,OAAO,EAAE,CAAC,CAAA;SACxC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAE,CAAA;QACzC,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,CACF,EAAU,EACV,KAAQ,EACR,GAAG,IAAoB;;QAEvB,MAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,0CAAE,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAA;IAChD,CAAC;IAED,kBAAkB,CAAC,EAAU;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACxC,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SAC1C;IACH,CAAC;CACF"}

package/lib/long-running-procedure/index.d.ts

@@ -0,0 +1,21 @@
+import { ILongRunningProcedure, CallState } from '@src/contract.js';
+import { Store } from '@src/types.js';
+export declare class LongRunningProcedure<Args extends unknown[], Result, Error> implements ILongRunningProcedure<Args, Result> {
+    private procedure;
+    private eventHub;
+    private idToAbortController;
+    private store;
+    private timeout?;
+    private timeToLive?;
+    constructor(procedure: (...args: [...Args, AbortSignal]) => PromiseLike<Result>, { store, timeToLive, timeout }?: {
+        store?: Store<Result, Error>;
+        timeout?: number;
+        timeToLive?: number;
+    });
+    call(args: Args): Promise<string>;
+    abort(id: string): null;
+    getState(id: string): Promise<CallState>;
+    getResult(id: string): Promise<Result>;
+    remove(id: string): Promise<null>;
+    private createId;
+}

package/lib/long-running-procedure/index.js

@@ -0,0 +1,103 @@
+import { nanoid } from 'nanoid';
+import { CallState, CallNotFound } from '@src/contract.js';
+import { toResultPromise } from 'return-style';
+import { AbortController } from 'extra-abort';
+import { EventHub, Event } from './event-hub.js';
+import { setTimeout } from 'extra-timers';
+import { StoreItemState } from '@src/types.js';
+import { MemoryStore } from '@src/memory-store.js';
+export class LongRunningProcedure {
+    constructor(procedure, { store = new MemoryStore(), timeToLive, timeout } = {}) {
+        this.procedure = procedure;
+        this.eventHub = new EventHub();
+        this.idToAbortController = new Map();
+        this.store = store;
+        this.timeToLive = timeToLive;
+        this.timeout = timeout;
+    }
+    async call(args) {
+        const id = this.createId();
+        const controller = new AbortController();
+        this.idToAbortController.set(id, controller);
+        await this.store.set(id, [StoreItemState.Pending], this.timeout);
+        queueMicrotask(async () => {
+            const result = await toResultPromise(this.procedure(...args, controller.signal));
+            const item = await this.store.get(id);
+            if (item) {
+                if (result.isOk()) {
+                    await this.store.set(id, [StoreItemState.Resolved, result.unwrap()], this.timeToLive);
+                }
+                else {
+                    await this.store.set(id, [StoreItemState.Rejected, result.unwrapErr()], this.timeToLive);
+                }
+                if (this.timeToLive) {
+                    const cancelTimeout = setTimeout(this.timeToLive, () => this.remove(id));
+                    this.eventHub.once(id, Event.Removed, cancelTimeout);
+                }
+                this.eventHub.emit(id, Event.Settled);
+            }
+        });
+        return id;
+    }
+    abort(id) {
+        var _a;
+        (_a = this.idToAbortController.get(id)) === null || _a === void 0 ? void 0 : _a.abort();
+        return null;
+    }
+    async getState(id) {
+        const item = await this.store.get(id);
+        if (item) {
+            const [state] = item;
+            switch (state) {
+                case StoreItemState.Pending: return CallState.Pending;
+                case StoreItemState.Resolved:
+                case StoreItemState.Rejected:
+                    return CallState.Settled;
+                default:
+                    throw new Error(`Unknown store state ${state}`);
+            }
+        }
+        else {
+            throw new CallNotFound();
+        }
+    }
+    async getResult(id) {
+        const item = await this.store.get(id);
+        if (item) {
+            const [state, value] = item;
+            switch (state) {
+                case StoreItemState.Pending: {
+                    const controller = this.idToAbortController.get(id);
+                    await this.eventHub.waitFor(id, Event.Settled, controller.signal);
+                    return await this.getResult(id);
+                }
+                case StoreItemState.Resolved: return value;
+                case StoreItemState.Rejected: throw value;
+            }
+        }
+        else {
+            throw new CallNotFound();
+        }
+    }
+    async remove(id) {
+        const item = await this.store.get(id);
+        if (item) {
+            const [state] = item;
+            switch (state) {
+                case StoreItemState.Pending: throw new Error('The call is still pending');
+                case StoreItemState.Resolved:
+                case StoreItemState.Rejected: {
+                    this.eventHub.emit(id, Event.Removed);
+                    this.eventHub.removeAllListeners(id);
+                    this.idToAbortController.delete(id);
+                    await this.store.delete(id);
+                }
+            }
+        }
+        return null;
+    }
+    createId() {
+        return nanoid();
+    }
+}
+//# sourceMappingURL=index.js.map

package/lib/long-running-procedure/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/long-running-procedure/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/B,OAAO,EAAyB,SAAS,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACjF,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAS,cAAc,EAAE,MAAM,eAAe,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAElD,MAAM,OAAO,oBAAoB;IAc/B,YACU,SAAmE,EAC3E,EACE,KAAK,GAAG,IAAI,WAAW,EAAiB,EACxC,UAAU,EACV,OAAO,KAKL,EAAE;QATE,cAAS,GAAT,SAAS,CAA0D;QAbrE,aAAQ,GAAG,IAAI,QAAQ,EAAE,CAAA;QACzB,wBAAmB,GAAiC,IAAI,GAAG,EAAE,CAAA;QAuBnE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAU;QACnB,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAA;QAC1B,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;QACxC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;QAC5C,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QAEhE,cAAc,CAAC,KAAK,IAAI,EAAE;YACxB,MAAM,MAAM,GAAG,MAAM,eAAe,CAClC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,CAC3C,CAAA;YAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACrC,IAAI,IAAI,EAAE;gBACR,IAAI,MAAM,CAAC,IAAI,EAAE,EAAE;oBACjB,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAClB,EAAE,EACF,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAC1C,IAAI,CAAC,UAAU,CAChB,CAAA;iBACF;qBAAM;oBACL,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAClB,EAAE,EACF,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,EAC7C,IAAI,CAAC,UAAU,CAChB,CAAA;iBACF;gBAED,IAAI,IAAI,CAAC,UAAU,EAAE;oBACnB,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;oBACxE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;iBACrD;gBAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;aACtC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,EAAE,CAAA;IACX,CAAC;IAED,KAAK,CAAC,EAAU;;QACd,MAAA,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,0CAAE,KAAK,EAAE,CAAA;QAEzC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU;QACvB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACrC,IAAI,IAAI,EAAE;YACR,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;YACpB,QAAQ,KAAK,EAAE;gBACb,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC,OAAO,CAAA;gBACrD,KAAK,cAAc,CAAC,QAAQ,CAAC;gBAC7B,KAAK,cAAc,CAAC,QAAQ;oBAC1B,OAAO,SAAS,CAAC,OAAO,CAAA;gBAC1B;oBACE,MAAM,IAAI,KAAK,CAAC,uBAAuB,KAAK,EAAE,CAAC,CAAA;aAClD;SACF;aAAM;YACL,MAAM,IAAI,YAAY,EAAE,CAAA;SACzB;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,EAAU;QACxB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACrC,IAAI,IAAI,EAAE;YACR,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,IAAI,CAAA;YAC3B,QAAQ,KAAK,EAAE;gBACb,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC;oBAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAE,CAAA;oBACpD,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;oBACjE,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;iBAChC;gBACD,KAAK,cAAc,CAAC,QAAQ,CAAC,CAAC,OAAO,KAAK,CAAA;gBAC1C,KAAK,cAAc,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAA;aAC1C;SACF;aAAM;YACL,MAAM,IAAI,YAAY,EAAE,CAAA;SACzB;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAErC,IAAI,IAAI,EAAE;YACR,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;YACpB,QAAQ,KAAK,EAAE;gBACb,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;gBACzE,KAAK,cAAc,CAAC,QAAQ,CAAC;gBAC7B,KAAK,cAAc,CAAC,QAAQ,CAAC,CAAC;oBAC5B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;oBACrC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;oBACpC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;oBACnC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;iBAC5B;aACF;SACF;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,QAAQ;QACd,OAAO,MAAM,EAAE,CAAA;IACjB,CAAC;CACF"}

package/lib/long-running-procedure-caller.d.ts

@@ -0,0 +1,7 @@
+import { ILongRunningProcedure } from './contract.js';
+import { ILongRunningProcedureCaller } from './types.js';
+export declare class LongRunningProcedureCaller<Args extends unknown[], Result> implements ILongRunningProcedureCaller<Args, Result> {
+    private procedure;
+    constructor(procedure: ILongRunningProcedure<Args, Result>);
+    call(...args: [...args: Args, signal: AbortSignal]): Promise<Result>;
+}

package/lib/long-running-procedure-caller.js

@@ -0,0 +1,26 @@
+export class LongRunningProcedureCaller {
+    constructor(procedure) {
+        this.procedure = procedure;
+    }
+    async call(...args) {
+        const realArgs = args.slice(0, args.length - 1);
+        const signal = args[args.length - 1];
+        signal.throwIfAborted();
+        const id = await this.procedure.call(realArgs);
+        try {
+            if (signal.aborted) {
+                await this.procedure.abort(id);
+            }
+            else {
+                signal.addEventListener('abort', async () => {
+                    await this.procedure.abort(id);
+                });
+            }
+            return await this.procedure.getResult(id);
+        }
+        finally {
+            await this.procedure.remove(id);
+        }
+    }
+}
+//# sourceMappingURL=long-running-procedure-caller.js.map

package/lib/long-running-procedure-caller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"long-running-procedure-caller.js","sourceRoot":"","sources":["../src/long-running-procedure-caller.ts"],"names":[],"mappings":"AAOA,MAAM,OAAO,0BAA0B;IAErC,YAAoB,SAA8C;QAA9C,cAAS,GAAT,SAAS,CAAqC;IAAG,CAAC;IAEtE,KAAK,CAAC,IAAI,CAAC,GAAG,IAA0C;QACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAS,CAAA;QACvD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAgB,CAAA;QACnD,MAAM,CAAC,cAAc,EAAE,CAAA;QAEvB,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC9C,IAAI;YACF,IAAI,MAAM,CAAC,OAAO,EAAE;gBAClB,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;aAC/B;iBAAM;gBACL,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;oBAC1C,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBAChC,CAAC,CAAC,CAAA;aACH;YAED,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;SAC1C;gBAAS;YACR,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;SAChC;IACH,CAAC;CACF"}

package/lib/long-running-procedure-polling-caller.d.ts

@@ -0,0 +1,8 @@
+import { ILongRunningProcedure } from './contract.js';
+import { ILongRunningProcedureCaller } from './types.js';
+export declare class LongRunningProcedurePollingCaller<Args extends unknown[], Result> implements ILongRunningProcedureCaller<Args, Result> {
+    private procedure;
+    private pollingInterval;
+    constructor(procedure: ILongRunningProcedure<Args, Result>, pollingInterval: number);
+    call(...args: [...args: Args, signal: AbortSignal]): Promise<Result>;
+}

package/lib/long-running-procedure-polling-caller.js

@@ -0,0 +1,40 @@
+import { delay } from 'extra-promise';
+import { CallState } from './contract.js';
+export class LongRunningProcedurePollingCaller {
+    constructor(procedure, pollingInterval) {
+        this.procedure = procedure;
+        this.pollingInterval = pollingInterval;
+    }
+    async call(...args) {
+        const realArgs = args.slice(0, args.length - 1);
+        const signal = args[args.length - 1];
+        signal.throwIfAborted();
+        const id = await this.procedure.call(realArgs);
+        try {
+            if (signal.aborted) {
+                await this.procedure.abort(id);
+            }
+            else {
+                signal.addEventListener('abort', async () => {
+                    await this.procedure.abort(id);
+                });
+            }
+            while (true) {
+                const state = await this.procedure.getState(id);
+                switch (state) {
+                    case CallState.Pending: {
+                        await delay(this.pollingInterval);
+                        break;
+                    }
+                    case CallState.Settled: {
+                        return await this.procedure.getResult(id);
+                    }
+                }
+            }
+        }
+        finally {
+            await this.procedure.remove(id);
+        }
+    }
+}
+//# sourceMappingURL=long-running-procedure-polling-caller.js.map

package/lib/long-running-procedure-polling-caller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"long-running-procedure-polling-caller.js","sourceRoot":"","sources":["../src/long-running-procedure-polling-caller.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AACrC,OAAO,EAAyB,SAAS,EAAE,MAAM,eAAe,CAAA;AAOhE,MAAM,OAAO,iCAAiC;IAE5C,YACU,SAA8C,EAC9C,eAAuB;QADvB,cAAS,GAAT,SAAS,CAAqC;QAC9C,oBAAe,GAAf,eAAe,CAAQ;IAC9B,CAAC;IAEJ,KAAK,CAAC,IAAI,CAAC,GAAG,IAA0C;QACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAS,CAAA;QACvD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAgB,CAAA;QACnD,MAAM,CAAC,cAAc,EAAE,CAAA;QAEvB,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC9C,IAAI;YACF,IAAI,MAAM,CAAC,OAAO,EAAE;gBAClB,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;aAC/B;iBAAM;gBACL,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;oBAC1C,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBAChC,CAAC,CAAC,CAAA;aACH;YAED,OAAO,IAAI,EAAE;gBACX,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;gBAE/C,QAAQ,KAAK,EAAE;oBACb,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC;wBACtB,MAAM,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;wBACjC,MAAK;qBACN;oBACD,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC;wBACtB,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;qBAC1C;iBACF;aACF;SACF;gBAAS;YACR,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;SAChC;IACH,CAAC;CACF"}

package/lib/memory-store.d.ts

@@ -0,0 +1,8 @@
+import { Awaitable, Nullish, Nullable } from '@blackglory/prelude';
+import { Store, StoreItemState } from './types.js';
+export declare class MemoryStore<Result, Error> implements Store<Result, Error> {
+    private map;
+    set(id: string, value: [StoreItemState.Pending] | [StoreItemState.Resolved, Result] | [StoreItemState.Rejected, Error], timeToLive?: number): null;
+    get(id: string): Awaitable<Nullable<[StoreItemState.Pending] | [StoreItemState.Resolved, Result] | [StoreItemState.Rejected, Error]>>;
+    delete(id: string): Awaitable<Nullish>;
+}

package/lib/memory-store.js

@@ -0,0 +1,18 @@
+import { ExpirableMap } from '@blackglory/structures';
+export class MemoryStore {
+    constructor() {
+        this.map = new ExpirableMap();
+    }
+    set(id, value, timeToLive) {
+        this.map.set(id, value, timeToLive);
+        return null;
+    }
+    get(id) {
+        return this.map.get(id);
+    }
+    delete(id) {
+        this.map.delete(id);
+        return null;
+    }
+}
+//# sourceMappingURL=memory-store.js.map

package/lib/memory-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-store.js","sourceRoot":"","sources":["../src/memory-store.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAGrD,MAAM,OAAO,WAAW;IAAxB;QACU,QAAG,GAAG,IAAI,YAAY,EAK3B,CAAA;IA4BL,CAAC;IA1BC,GAAG,CACD,EAAU,EACV,KAGkC,EAClC,UAAmB;QAEnB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,CAAA;QAEnC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,GAAG,CAAC,EAAU;QAKZ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IACzB,CAAC;IAED,MAAM,CAAC,EAAU;QACf,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAEnB,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}

package/lib/types.d.ts

@@ -0,0 +1,14 @@
+import { Awaitable, Nullable, Nullish } from '@blackglory/prelude';
+export declare enum StoreItemState {
+    Pending = 0,
+    Resolved = 1,
+    Rejected = 2
+}
+export interface Store<Result, Error> {
+    set(id: string, value: [StoreItemState.Pending] | [StoreItemState.Resolved, Result] | [StoreItemState.Rejected, Error], timeToLive?: number): Awaitable<Nullish>;
+    get(id: string): Awaitable<Nullable<[StoreItemState.Pending] | [StoreItemState.Resolved, Result] | [StoreItemState.Rejected, Error]>>;
+    delete(id: string): Awaitable<Nullish>;
+}
+export interface ILongRunningProcedureCaller<Args extends unknown[], Result> {
+    call(...args: [...args: Args, signal: AbortSignal]): Promise<Result>;
+}

package/lib/types.js

@@ -0,0 +1,7 @@
+export var StoreItemState;
+(function (StoreItemState) {
+    StoreItemState[StoreItemState["Pending"] = 0] = "Pending";
+    StoreItemState[StoreItemState["Resolved"] = 1] = "Resolved";
+    StoreItemState[StoreItemState["Rejected"] = 2] = "Rejected";
+})(StoreItemState = StoreItemState || (StoreItemState = {}));
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,yDAAO,CAAA;IACP,2DAAQ,CAAA;IACR,2DAAQ,CAAA;AACV,CAAC,EAJW,cAAc,GAAd,cAAc,KAAd,cAAc,QAIzB"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@delight-rpc/long-running-procedure",
+  "version": "0.5.0",
+  "description": "",
+  "files": [
+    "lib"
+  ],
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "sideEffects": false,
+  "repository": "git@github.com:delight-rpc/long-running-procedure.git",
+  "author": "BlackGlory <woshenmedoubuzhidao@blackglory.me>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "prepare": "ts-patch install -s",
+    "lint": "eslint --ext .js,.jsx,.ts,.tsx --quiet src __tests__",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --runInBand --no-cache --config jest.config.cjs",
+    "test:debug": "cross-env NODE_OPTIONS=--experimental-vm-modules node --inspect-brk node_modules/.bin/jest --runInBand --config jest.config.cjs",
+    "test:coverage": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --runInBand --coverage --config jest.config.cjs",
+    "prepublishOnly": "run-s prepare clean build",
+    "clean": "rimraf lib",
+    "build": "tsc --project tsconfig.build.json",
+    "release": "standard-version"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "run-s prepare lint build test",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "devDependencies": {
+    "@blackglory/jest-resolver": "^0.3.0",
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@types/jest": "^29.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@typescript-eslint/parser": "^5.55.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.36.0",
+    "husky": "4",
+    "jest": "^29.5.0",
+    "jest-resolve": "^29.5.0",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^3.0.2",
+    "standard-version": "^9.3.2",
+    "ts-jest": "^29.0.5",
+    "ts-patch": "^2.1.0",
+    "tslib": "^2.5.0",
+    "typescript": "5.0.2",
+    "typescript-transform-paths": "^3.4.6"
+  },
+  "dependencies": {
+    "@blackglory/errors": "^3.0.0",
+    "@blackglory/prelude": "^0.3.1",
+    "@blackglory/structures": "^0.13.3",
+    "@blackglory/wait-for": "^0.7.3",
+    "extra-abort": "^0.3.2",
+    "extra-promise": "^6.0.5",
+    "extra-timers": "^0.2.5",
+    "nanoid": "4.0.1",
+    "return-style": "^3.0.0"
+  }
+}