@webda/async 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/services/asyncevents.service.d.ts

@@ -0,0 +1,154 @@
+import { Queue, Service, ServiceParameters } from "@webda/core";
+import type { ModelClass } from "@webda/core";
+/**
+ * AsyncEvent representation
+ */
+export declare class AsyncEvent {
+    /**
+     * Service emitted the event
+     */
+    service: string;
+    /**
+     * Type of event
+     */
+    type: string;
+    /**
+     * Payload of the event
+     */
+    payload: any;
+    /**
+     * Time
+     */
+    time: Date;
+    /**
+     * Used when serializing a service
+     */
+    static ServiceTag: string;
+    /**
+     * @param service - the emitter: a service, a model class or its serialized name
+     * @param type - the event type
+     * @param payload - the event payload
+     */
+    constructor(service: string | Service | ModelClass, type: string, payload?: any);
+    /**
+     * Allow payload to contain Service but do not serialize them
+     * replacing them by a #Webda:Service:${service.getName()} so it
+     * can be revived
+     *
+     * @returns the serializable event
+     */
+    toJSON(): this & {
+        payload: string;
+    };
+    /**
+     * Deserialize from the queue, reviving any detected service
+     *
+     * @param data - the serialized event
+     * @returns the event
+     */
+    static fromQueue(data: any): AsyncEvent;
+    /**
+     * Mapper name
+     * @returns the mapper key
+     */
+    getMapper(): string;
+}
+/**
+ * Queues by name
+ */
+interface QueueMap {
+    [key: string]: Queue;
+}
+/**
+ * @inheritdoc
+ */
+export declare class EventServiceParameters extends ServiceParameters {
+    /**
+     * Queues to post async events to
+     */
+    queues?: {
+        [key: string]: string;
+    };
+    /**
+     * Make the event sending asynchronous
+     */
+    sync?: boolean;
+    /**
+     * @override
+     * @param params - the input parameters
+     * @returns this
+     */
+    load(params?: any): this;
+}
+/**
+ * @category CoreServices
+ * @WebdaModda AsyncEvents
+ */
+declare class EventService<T extends EventServiceParameters = EventServiceParameters> extends Service<T> {
+    _callbacks: any;
+    _queues: QueueMap;
+    _defaultQueue: string;
+    _async: boolean;
+    /**
+     * Resolve the queues
+     * @returns this
+     */
+    resolve(): this;
+    /**
+     * Bind a asynchronous event
+     *
+     * ```mermaid
+     * sequenceDiagram
+     *  participant S as Service
+     *  participant As as AsyncEventService
+     *  participant Q as Queue
+     *  participant Aw as AsyncEventService Worker
+     *
+     *  As->>S: Bind event to a sendQueue listener
+     *  activate As
+     *  S->>As: Emit event
+     *  As->>Q: Push the event to the queue
+     *  deactivate As
+     *  Aw->>Q: Consume queue
+     *  Aw->>Aw: Call the original listener
+     * ```
+     *
+     * @param service - the service or model class emitting the event
+     * @param event - the event name
+     * @param callback - the listener
+     * @param queue - the queue to use, default queue if not specified
+     */
+    bindAsyncListener(service: Service | ModelClass, event: string, callback: any, queue?: string): void;
+    /**
+     * Synchronous Listener to proxy to async
+     *
+     * @param service - the emitter
+     * @param type - the event type
+     * @param queue - the queue to use
+     * @param payload - the event payload
+     * @returns the send or handle promise
+     */
+    pushEvent(service: Service | ModelClass, type: string, queue: string, payload: any): Promise<void>;
+    /**
+     * Process one event
+     *
+     * @param event - the event
+     * @returns a promise resolved once all listeners are done
+     */
+    protected handleEvent(event: AsyncEvent): Promise<void>;
+    /**
+     * Process a serialized event
+     * @param event serialized event
+     * @returns the handle promise
+     */
+    protected handleRawEvent(event: AsyncEvent): Promise<void>;
+    /**
+     * Process asynchronous event on queue
+     * @param queue - the queue to consume
+     * @returns the consumer promise
+     */
+    worker(queue?: string): Promise<void>;
+}
+export { EventService };
+export type { QueueMap };
+//# sourceMappingURL=asyncevents.service.d.ts.map

package/lib/services/asyncevents.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncevents.service.d.ts","sourceRoot":"","sources":["../../src/services/asyncevents.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAoC,MAAM,aAAa,CAAC;AAClG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C;;GAEG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,MAAM,CAAC,UAAU,SAAqB;IAEtC;;;;OAIG;IACH,YAAY,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,GAAQ,EAWlF;IAED;;;;;;OAMG;IACH,MAAM;;MAYL;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,cAazB;IAED;;;OAGG;IACH,SAAS,WAER;CACF;AAED;;GAEG;AACH,UAAU,QAAQ;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,iBAAiB;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAK3B;CACF;AAED;;;GAGG;AACH,cAAM,YAAY,CAAC,CAAC,SAAS,sBAAsB,GAAG,sBAAsB,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IAC9F,UAAU,EAAE,GAAG,CAAM;IACrB,OAAO,EAAE,QAAQ,CAAM;IACvB,aAAa,EAAE,MAAM,CAAM;IAC3B,MAAM,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,OAAO,IAAI,IAAI,CAiBd;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,KAAA,EAAE,KAAK,CAAC,EAAE,MAAM,QAiBvF;IAED;;;;;;;;OAQG;IACG,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,iBAOvF;IAED;;;;;OAKG;IACH,UAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAY5D;IAED;;;;OAIG;IACH,UAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,iBAE/C;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,GAAE,MAA2B,GAAG,OAAO,CAAC,IAAI,CAAC,CAIxD;CACF;AAED,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,YAAY,EAAE,QAAQ,EAAE,CAAC"}

package/lib/services/asyncevents.service.js

@@ -0,0 +1,219 @@
+import { Service, ServiceParameters, useDynamicService, useRepository } from "@webda/core";
+/**
+ * AsyncEvent representation
+ */
+export class AsyncEvent {
+    /**
+     * @param service - the emitter: a service, a model class or its serialized name
+     * @param type - the event type
+     * @param payload - the event payload
+     */
+    constructor(service, type, payload = {}) {
+        if (service instanceof Service) {
+            this.service = `service:${service.getName()}`;
+        }
+        else if (typeof service === "string") {
+            this.service = service;
+        }
+        else {
+            this.service = `model:${service.name}`;
+        }
+        this.type = type;
+        this.payload = payload;
+        this.time = new Date();
+    }
+    /**
+     * Allow payload to contain Service but do not serialize them
+     * replacing them by a #Webda:Service:${service.getName()} so it
+     * can be revived
+     *
+     * @returns the serializable event
+     */
+    toJSON() {
+        return {
+            ...this,
+            payload: JSON.stringify(this.payload, function serviceReplacer(key, value) {
+                // Service.toJSON is applied before the replacer, check the raw value
+                const raw = key === "" ? value : this[key];
+                if (raw instanceof Service) {
+                    return `${AsyncEvent.ServiceTag}${raw.getName()}`;
+                }
+                return value;
+            })
+        };
+    }
+    /**
+     * Deserialize from the queue, reviving any detected service
+     *
+     * @param data - the serialized event
+     * @returns the event
+     */
+    static fromQueue(data) {
+        const evt = new AsyncEvent(data.service, data.type, JSON.parse(data.payload, (_key, value) => {
+            if (typeof value === "string" && value.startsWith(AsyncEvent.ServiceTag)) {
+                return useDynamicService(value.substring(AsyncEvent.ServiceTag.length));
+            }
+            return value;
+        }));
+        evt.time = data.time;
+        return evt;
+    }
+    /**
+     * Mapper name
+     * @returns the mapper key
+     */
+    getMapper() {
+        return this.service + "_" + this.type;
+    }
+}
+/**
+ * Used when serializing a service
+ */
+AsyncEvent.ServiceTag = "#Webda:Service:";
+/**
+ * @inheritdoc
+ */
+export class EventServiceParameters extends ServiceParameters {
+    /**
+     * @override
+     * @param params - the input parameters
+     * @returns this
+     */
+    load(params = {}) {
+        super.load(params);
+        this.queues ?? (this.queues = {});
+        this.sync ?? (this.sync = false);
+        return this;
+    }
+}
+/**
+ * @category CoreServices
+ * @WebdaModda AsyncEvents
+ */
+class EventService extends Service {
+    constructor() {
+        super(...arguments);
+        this._callbacks = {};
+        this._queues = {};
+        this._defaultQueue = "";
+    }
+    /**
+     * Resolve the queues
+     * @returns this
+     */
+    resolve() {
+        super.resolve();
+        Object.keys(this.parameters.queues).forEach(key => {
+            // Define default as first queue
+            if (!this._defaultQueue) {
+                this._defaultQueue = key;
+            }
+            this._queues[key] = useDynamicService(this.parameters.queues[key]);
+        });
+        this._async = !this.parameters.sync;
+        // Check we have at least one queue to handle asynchronous
+        if (this._async && Object.keys(this._queues).length < 1) {
+            this.log("ERROR", "Need at least one queue for async to be ready", this.parameters);
+            throw Error("Need at least one queue for async to be ready");
+        }
+        return this;
+    }
+    /**
+     * Bind a asynchronous event
+     *
+     * ```mermaid
+     * sequenceDiagram
+     *  participant S as Service
+     *  participant As as AsyncEventService
+     *  participant Q as Queue
+     *  participant Aw as AsyncEventService Worker
+     *
+     *  As->>S: Bind event to a sendQueue listener
+     *  activate As
+     *  S->>As: Emit event
+     *  As->>Q: Push the event to the queue
+     *  deactivate As
+     *  Aw->>Q: Consume queue
+     *  Aw->>Aw: Call the original listener
+     * ```
+     *
+     * @param service - the service or model class emitting the event
+     * @param event - the event name
+     * @param callback - the listener
+     * @param queue - the queue to use, default queue if not specified
+     */
+    bindAsyncListener(service, event, callback, queue) {
+        if (!this._async) {
+            throw Error("EventService is not configured for asynchronous");
+        }
+        if (!queue) {
+            queue = this._defaultQueue;
+        }
+        const mapper = new AsyncEvent(service, event).getMapper();
+        if (!this._callbacks[mapper]) {
+            if (service instanceof Service) {
+                service.on(event, data => this.pushEvent(service, event, queue, data));
+            }
+            else {
+                useRepository(service).on(event, data => this.pushEvent(service, event, queue, data));
+            }
+            this._callbacks[mapper] = [];
+        }
+        this._callbacks[mapper].push(callback);
+    }
+    /**
+     * Synchronous Listener to proxy to async
+     *
+     * @param service - the emitter
+     * @param type - the event type
+     * @param queue - the queue to use
+     * @param payload - the event payload
+     * @returns the send or handle promise
+     */
+    async pushEvent(service, type, queue, payload) {
+        const event = new AsyncEvent(service, type, payload);
+        if (this._async) {
+            return this._queues[queue].sendMessage(event);
+        }
+        else {
+            return this.handleEvent(event);
+        }
+    }
+    /**
+     * Process one event
+     *
+     * @param event - the event
+     * @returns a promise resolved once all listeners are done
+     */
+    async handleEvent(event) {
+        if (!this._callbacks[event.getMapper()]) {
+            return Promise.reject("Callbacks should not be empty, possible application version mismatch between emitter and worker");
+        }
+        const promises = [];
+        this._callbacks[event.getMapper()].map(executor => {
+            promises.push(executor(event.payload, event));
+        });
+        // Need to handle the failure
+        await Promise.all(promises);
+    }
+    /**
+     * Process a serialized event
+     * @param event serialized event
+     * @returns the handle promise
+     */
+    async handleRawEvent(event) {
+        return this.handleEvent(AsyncEvent.fromQueue(event));
+    }
+    /**
+     * Process asynchronous event on queue
+     * @param queue - the queue to consume
+     * @returns the consumer promise
+     */
+    worker(queue = this._defaultQueue) {
+        // Avoid loops
+        this._async = false;
+        return this._queues[queue].consume(this.handleRawEvent.bind(this));
+    }
+}
+export { EventService };
+//# sourceMappingURL=asyncevents.service.js.map

package/lib/services/asyncevents.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncevents.service.js","sourceRoot":"","sources":["../../src/services/asyncevents.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGlG;;GAEG;AACH,MAAM,OAAO,UAAU;IAuBrB;;;;OAIG;IACH,YAAY,OAAsC,EAAE,IAAY,EAAE,OAAO,GAAQ,EAAE;QACjF,IAAI,OAAO,YAAY,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG,WAAW,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QAChD,CAAC;aAAM,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,SAAS,OAAO,CAAC,IAAI,EAAE,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,MAAM;QACJ,OAAO;YACL,GAAG,IAAI;YACP,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,eAAe,CAAY,GAAW,EAAE,KAAU;gBAC/F,qEAAqE;gBACrE,MAAM,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3C,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;oBAC3B,OAAO,GAAG,UAAU,CAAC,UAAU,GAAG,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;gBACpD,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,IAAS;QACxB,MAAM,GAAG,GAAG,IAAI,UAAU,CACxB,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAY,EAAE,KAAU,EAAE,EAAE;YACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzE,OAAO,iBAAiB,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAC1E,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CACH,CAAC;QACF,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;IACxC,CAAC;CACF;AAxEC;;GAEG;AACI,qBAAU,GAAG,iBAAiB,CAAC;AA8ExC;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,iBAAiB;IAU3D;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAQ,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,EAAE,EAAC;QACnB,IAAI,CAAC,IAAI,KAAT,IAAI,CAAC,IAAI,GAAK,KAAK,EAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,YAAwE,SAAQ,OAAU;IAAhG;;QACE,eAAU,GAAQ,EAAE,CAAC;QACrB,YAAO,GAAa,EAAE,CAAC;QACvB,kBAAa,GAAW,EAAE,CAAC;IA8H7B,CAAC;IA3HC;;;OAGG;IACH,OAAO;QACL,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAChD,gCAAgC;YAChC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACxB,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;YAC3B,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAQ,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QACpC,0DAA0D;QAC1D,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACpF,MAAM,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAAiB,CAAC,OAA6B,EAAE,KAAa,EAAE,QAAQ,EAAE,KAAc;QACtF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC;QAC7B,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAI,OAAO,YAAY,OAAO,EAAE,CAAC;gBAC/B,OAAO,CAAC,EAAE,CAAQ,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;YAChF,CAAC;iBAAM,CAAC;gBACA,aAAa,CAAC,OAAO,CAAE,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;YAC/F,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAC/B,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CAAC,OAA6B,EAAE,IAAY,EAAE,KAAa,EAAE,OAAY;QACtF,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,WAAW,CAAC,KAAiB;QAC3C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;YACxC,OAAO,OAAO,CAAC,MAAM,CACnB,iGAAiG,CAClG,CAAC;QACJ,CAAC;QACD,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YAChD,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QACH,6BAA6B;QAC7B,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,cAAc,CAAC,KAAiB;QAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,GAAW,IAAI,CAAC,aAAa;QACvC,cAAc;QACd,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;CACF;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/lib/services/{asyncjobservice.d.ts → asyncjobservice.service.d.ts}

@@ -1,9 +1,11 @@
-import { CancelableLoopPromise, CancelablePromise, CloudBinary, Constructor, CoreModelDefinition, CronDefinition, OperationContext, Queue, RequestFilter, Service, ServiceParameters, Store, WebContext } from "@webda/core";
+import { CronDefinition, OperationContext, Queue, RequestFilter, Service, ServiceParameters, WebContext } from "@webda/core";
+import type { ModelClass } from "@webda/core";
 import * as WebdaQL from "@webda/ql";
+import { CancelableLoopPromise, CancelablePromise } from "@webda/utils";
 import { WorkerLogLevel } from "@webda/workout";
 import { JSONSchema7 } from "json-schema";
-import { AsyncAction, AsyncActionQueueItem, AsyncOperationAction, AsyncWebdaAction } from "../models.js";
-import { Runner } from "./runner.js";
+import { AsyncAction, AsyncActionQueueItem, AsyncOperationAction, AsyncWebdaAction } from "../asyncaction.model.js";
+import { Runner } from "./runner.service.js";
 /**
  * Represent a Job information as you will find in env
  */
@@ -17,14 +19,6 @@ export interface JobInfo {
  * @inheritdoc
  */
 export declare class AsyncJobServiceParameters extends ServiceParameters {
-    /**
-     * If we want to expose a way to upload/download binary for the job
-     *
-     * It will expose a /download and /upload additional url
-     *
-     * @deprecated will be removed in 4.0 to only use object AsyncAction
-     */
-    binaryStore?: string;
     /**
      * If set runner will be called without queue
      *
@@ -39,8 +33,7 @@ export declare class AsyncJobServiceParameters extends ServiceParameters {
     /**
      * URL to expose job status report hook
      *
-     * @default /async/jobs
-     * @deprecated will be removed in 4.0 to only use object AsyncAction
+     * @default /async
      */
     url: string;
     /**
@@ -107,22 +100,23 @@ export declare class AsyncJobServiceParameters extends ServiceParameters {
      * Generated with `webda operations operations.json`
      */
     asyncOperationDefinition?: string;
-    constructor(params: any);
+    /**
+     * @override
+     * @param params - the input parameters
+     * @returns this
+     */
+    load(params?: any): this;
 }
 /**
  * AsyncService allows you to launch jobs and report status
  *
  * @WebdaModda
  */
-export default class AsyncJobService<T extends AsyncJobServiceParameters = AsyncJobServiceParameters> extends Service<T> implements RequestFilter {
+export default class AsyncJobService<T extends AsyncJobServiceParameters = AsyncJobServiceParameters> extends Service<T> implements RequestFilter<WebContext> {
     /**
      * Queue for execution
      */
     protected queue: Queue<AsyncActionQueueItem>;
-    /**
-     * Store for async actions
-     */
-    protected store: Store<AsyncAction>;
     /**
      * Runner to use
      */
@@ -131,18 +125,14 @@ export default class AsyncJobService<T extends AsyncJobServiceParameters = Async
      * HMAC Algorithm used for simple auth
      */
     static HMAC_ALGO: string;
-    /**
-     * If we want job to be able to upload/download
-     */
-    protected binaryStore: CloudBinary;
     /**
      * Model to use when launching action
      */
-    model: Constructor<AsyncWebdaAction, [string, string, ...any[]]> & CoreModelDefinition<AsyncAction>;
+    model: (new (serviceName?: string, method?: string, ...args: any[]) => AsyncWebdaAction) & ModelClass<AsyncWebdaAction>;
     /**
-     * Model to use when launching action
+     * Model to use when launching operation
      */
-    operationModel: Constructor<AsyncOperationAction, [string, OperationContext, WorkerLogLevel?]>;
+    operationModel: new (operationId: string, context: OperationContext, logLevel?: WorkerLogLevel) => AsyncOperationAction;
     /**
      * Operations definition
      */
@@ -171,133 +161,148 @@ export default class AsyncJobService<T extends AsyncJobServiceParameters = Async
     };
     /**
      * @inheritdoc
-     */
-    loadParameters(params: any): ServiceParameters;
-    /**
-     * @inheritdoc
+     * @returns this
      */
     resolve(): this;
     /**
      * Register new operations
-     * @param operations
+     * @param operations - the operations definition
      */
     registerOperations(operations: typeof this.operations): void;
     /**
      * Allow job status report url
+     * @param context - the web context
+     * @returns true if the request is a job status report
      */
     checkRequest(context: WebContext): Promise<boolean>;
     /**
      * Status hook for job report
      *
      * Only updates specific fields: status, errorMessage, statusDetails, results, logs (appending)
+     * @param context - the web context
      */
     protected statusHook(context: WebContext): Promise<void>;
     /**
      * Worker
      *
      * This will launch actions based on defined runners
+     * @returns a cancelable promise
      */
     worker(): CancelablePromise<void>;
     /**
      * Handle one event from the queue and launch the job
-     * @param event
+     * @param event - the queue item
+     * @returns the job promise if any
      */
     protected handleEvent(event: AsyncActionQueueItem): Promise<void>;
+    /**
+     * Absolute url of the status hook remote runners POST their reports to
+     *
+     * It is this service status route: its request filter lets the job headers through
+     * and the HMAC is then verified by the action
+     * @returns the hook url
+     */
+    getHookUrl(): string;
     /**
      * Get the job info
-     * @param action
-     * @returns
+     * @param action - the action
+     * @returns the job information
      */
     getJobInfo(action: AsyncAction): JobInfo;
     /**
      * List available operations through this service
-     * @param context
+     * @param context - the web context
      */
     listOperations(context: WebContext<void, {
-        application: {
-            name: string;
-            version: string;
-        };
-        operations: {
-            [key: string]: {
-                id: string;
-                input?: string;
-                output?: string;
-            };
-        };
-        schemas: {
-            [key: string]: JSONSchema7;
-        };
-    } | string[]>): Promise<void>;
+        full?: boolean;
+    }>): Promise<void>;
     /**
      * Call an operation for an external system
-     * @param context
-     * @returns
+     * @param context - the operation context
+     * @returns the launched action
      */
-    callOperation(context: OperationContext): Promise<AsyncAction>;
+    callOperation(context: OperationContext): Promise<AsyncOperationAction>;
+    /**
+     * Check the operation exists, is allowed and its input is valid
+     * @param context - the operation context
+     * @param operationId - the operation id
+     */
+    checkOperation(context: OperationContext, operationId: string): Promise<void>;
     /**
      * Launch an operation through this service
+     * @param context - the web context
      */
     launchOperation(context: WebContext): Promise<void>;
     /**
      * Launch the action asynchronously
-     * @param action
-     * @returns
+     * @param action - the action
+     * @returns the action
      */
-    launchAction(action: AsyncAction): Promise<AsyncAction>;
+    launchAction<A extends AsyncAction>(action: A): Promise<A>;
     /**
      * Schedule action for later execution
      *
-     * @param action
-     * @param timestamp
+     * @param action - the action
+     * @param timestamp - when to launch it
+     * @returns the action
      */
-    scheduleAction(action: AsyncAction, timestamp: number): Promise<AsyncAction>;
+    scheduleAction<A extends AsyncAction>(action: A, timestamp: number): Promise<A>;
     /**
      * Return headers to request status hook
      *
-     * @param jobInfo
-     * @returns
+     * @param jobInfo - the job information
+     * @returns the headers
      */
     getHeaders(jobInfo: JobInfo): {
         [key: string]: string;
     };
     /**
      * Post hook to a remote url or use local store to update status
-     * @param jobInfo
-     * @param message
-     * @returns
+     * @param jobInfo - the job information
+     * @param message - the status report
+     * @returns the updated action
      */
     postHook(jobInfo: JobInfo, message: any): Promise<AsyncWebdaAction>;
     /**
      * Launch a service.method as an AsyncAction
-     * @param serviceName
-     * @param method
-     * @param args
+     * @param serviceName - the service
+     * @param method - the method
+     * @param args - the arguments
+     * @returns the action
      */
-    launchAsAsyncAction(serviceName: string, method: string, ...args: any[]): Promise<AsyncAction>;
+    launchAsAsyncAction(serviceName: string, method: string, ...args: any[]): Promise<AsyncWebdaAction>;
     /**
      * Execute a service.method as an AsyncAction
      *
      * Useful for crontab execution
-     * @param serviceName
-     * @param method
-     * @param args
+     * @param serviceName - the service
+     * @param method - the method
+     * @param args - the arguments
+     * @returns the execution promise
      */
     executeAsAsyncAction(serviceName: string, method: string, ...args: any[]): Promise<void>;
+    /**
+     * Run the AsyncAction described by the JOB_* environment variables
+     * @returns the execution promise
+     */
+    runAction(): Promise<void>;
     /**
      * Wrap async job and call the job status hook
+     * @param jobInfo - the job information, from environment if not provided
+     * @returns a promise resolved once the job is reported
      */
     runAsyncOperationAction(jobInfo?: JobInfo): Promise<void>;
     /**
      * Get the cron callback function
-     * @param cron
-     * @returns
+     * @param cron - the cron definition
+     * @returns the cron callback
      */
     getCronExecutor(cron: CronDefinition): () => Promise<void>;
     /**
      * Manage scheduled actions and crontab actions
-     * @returns
+     * @returns a cancelable loop promise
      */
     scheduler(): CancelableLoopPromise;
 }
 export { AsyncJobService };
+//# sourceMappingURL=asyncjobservice.service.d.ts.map

package/lib/services/asyncjobservice.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncjobservice.service.d.ts","sourceRoot":"","sources":["../../src/services/asyncjobservice.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,cAAc,EAGd,gBAAgB,EAChB,KAAK,EAGL,aAAa,EACb,OAAO,EACP,iBAAiB,EASjB,UAAU,EAEX,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAwC,MAAM,cAAc,CAAC;AAC9G,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpH,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAG7C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,iBAAiB;IAC9D;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAY3B;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe,CAAC,CAAC,SAAS,yBAAyB,GAAG,yBAAyB,CAClG,SAAQ,OAAO,CAAC,CAAC,CACjB,YAAW,aAAa,CAAC,UAAU,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,CAAY;IACpC;;OAEG;IACH,KAAK,EAAE,CAAC,KAAK,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,gBAAgB,CAAC,GACtF,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAC/B;;OAEG;IACH,cAAc,EAAE,KACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,cAAc,KACtB,oBAAoB,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE;QACpB,WAAW,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC;QAC/C,UAAU,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAC;gBAAC,MAAM,CAAC,EAAE,MAAM,CAAC;gBAAC,UAAU,CAAC,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC;QACnG,OAAO,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;SAAE,CAAC;KACzC,CAAC;IACF;;OAEG;IACH,SAAS,CAAC,iBAAiB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAA;KAAE,CAAM;IAE5E;;;OAGG;IACH,OAAO,IAAI,IAAI,CAgCd;IAED;;;OAGG;IACH,kBAAkB,CAAC,UAAU,EAAE,OAAO,IAAI,CAAC,UAAU,QAwBpD;IAED;;;;OAIG;IACG,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CASxD;IAED;;;;;OAKG;IACH,UAAgB,UAAU,CAAC,OAAO,EAAE,UAAU,iBAU7C;IAED;;;;;OAKG;IAEH,MAAM,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAkBhC;IAED;;;;OAIG;IACH,UAAgB,WAAW,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CA6BtE;IAED;;;;;;OAMG;IACH,UAAU,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAOvC;IAED;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CA+BjF;IAED;;;;OAIG;IACG,aAAa,CAAC,OAAO,EAAE,gBAAgB,iCAE5C;IAED;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBlF;IAED;;;OAGG;IACG,eAAe,CAAC,OAAO,EAAE,UAAU,iBAexC;IAED;;;;OAIG;IACG,YAAY,CAAC,CAAC,SAAS,WAAW,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAa/D;IAED;;;;;;OAMG;IACG,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAOpF;IAED;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO;;MAU1B;IAED;;;;;OAKG;IACG,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAYxE;IAED;;;;;;OAMG;IACG,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,6BAE5E;IAED;;;;;;;;OAQG;IACG,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,OAAA,GAAG,OAAO,CAAC,IAAI,CAAC,CAatF;IAED;;;OAGG;IAEG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAE/B;IAED;;;;OAIG;IACG,uBAAuB,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CA6D9D;IAED;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,cAAc,uBAenC;IAED;;;OAGG;IAEH,SAAS,IAAI,qBAAqB,CA0BjC;CACF;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}