@webda/async 3.9.3 → 4.0.0-beta.10

package/lib/models.d.ts

@@ -1,169 +0,0 @@
-import { CoreModel, OperationContext, WebContext } from "@webda/core";
-import { WorkerLogLevel } from "@webda/workout";
-/**
- * Represent an item for processing queue
- */
-export interface AsyncActionQueueItem {
-    /**
-     * Item to launch
-     */
-    uuid: string;
-    /**
-     * Secret key for status hook
-     */
-    __secretKey: string;
-    /**
-     * Type of action
-     */
-    type: string;
-}
-/**
- * Job information
- */
-export interface Job {
-}
-/**
- * Define here a model that can be used along with Store service
- * @WebdaModel
- */
-export default class AsyncAction extends CoreModel {
-    /**
-     * Set type
-     */
-    constructor();
-    /**
-     * By default AsyncAction are not considered internal
-     *
-     * Internal: That execute a method or operation of Webda application framework
-     * @returns
-     */
-    isInternal(): boolean;
-    /**
-     * Action uuid
-     */
-    uuid: string;
-    /**
-     * Current status
-     */
-    status: "RUNNING" | "SUCCESS" | "ERROR" | "QUEUED" | "STARTING" | "TIMEOUT" | "SCHEDULED" | "CANCELLED";
-    /**
-     * Timestamp when the action was scheduled
-     */
-    scheduled?: number;
-    /**
-     * If an error occured it should contain the message
-     */
-    errorMessage?: string;
-    /**
-     * Job information
-     */
-    job: Job;
-    /**
-     * Last time the job was updated
-     */
-    _lastJobUpdate: number;
-    /**
-     * Results from the job
-     */
-    results: any;
-    /**
-     * Job current status
-     */
-    statusDetails: any;
-    /**
-     *
-     */
-    type: string;
-    /**
-     *
-     */
-    arguments?: any[];
-    /**
-     * Current logs
-     */
-    logs: string[];
-    /**
-     * Secret key to post feedback
-     */
-    __secretKey: string;
-    /**
-     * Expected action for the job
-     *
-     * It should be a verb
-     */
-    action?: "STOP" | string;
-    getLogsLimit(): number;
-    /**
-     * Allow to report status for a job
-     * @param context
-     */
-    statusAction(context: WebContext): Promise<void>;
-    /**
-     * Return the hook url if empty fallback to the service url
-     * @returns
-     */
-    getHookUrl(): string;
-    /**
-     *
-     * @param body
-     */
-    update(body: any, time?: string): Promise<this>;
-    /**
-     *
-     * @param context
-     * @param action
-     */
-    protected verifyJobRequest<K extends AsyncAction = AsyncAction>(context: WebContext): Promise<void>;
-    /**
-     * Get the hmac for the job
-     * @param jobTime
-     * @returns
-     */
-    getHmac(jobTime: string): string;
-    /**
-     * Ensure action hook is ok
-     * @param context
-     * @param _action
-     * @returns
-     */
-    checkAct(context: OperationContext<any, any>, action: string): Promise<void>;
-}
-/**
- * Define a Webda Async Action
- *
- * @WebdaModel
- */
-export declare class AsyncWebdaAction extends AsyncAction {
-    serviceName?: string;
-    method?: string;
-    logLevel: WorkerLogLevel;
-    /**
-     *
-     * @param serviceName service to call
-     * @param method method to call
-     * @param arguments to call with the method
-     */
-    constructor(serviceName?: string, method?: string, ...args: any[]);
-    /**
-     * Execute a serviceName.method(...args) so this is internal
-     * @returns
-     */
-    isInternal(): boolean;
-}
-/**
- * Operation called asynchronously
- *
- * @WebdaModel
- */
-export declare class AsyncOperationAction extends AsyncAction {
-    operationId: string;
-    context: OperationContext;
-    logLevel: WorkerLogLevel;
-    constructor(operationId: string, context: OperationContext, logLevel?: WorkerLogLevel);
-    /**
-     * Execute a webda.callOperation(context ,id) so this is internal
-     * @returns
-     */
-    isInternal(): boolean;
-}
-export { AsyncAction };

package/lib/models.js

@@ -1,177 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { Action, Core, CoreModel, WebContext, WebdaError } from "@webda/core";
-import * as crypto from "crypto";
-/**
- * Define here a model that can be used along with Store service
- * @WebdaModel
- */
-export default class AsyncAction extends CoreModel {
-    /**
-     * Set type
-     */
-    constructor() {
-        super();
-        this.type = this.constructor.name;
-    }
-    /**
-     * By default AsyncAction are not considered internal
-     *
-     * Internal: That execute a method or operation of Webda application framework
-     * @returns
-     */
-    isInternal() {
-        return false;
-    }
-    getLogsLimit() {
-        return 1000;
-    }
-    /**
-     * Allow to report status for a job
-     * @param context
-     */
-    async statusAction(context) {
-        await this.update(await context.getRequestBody(), context.getHttpContext().getUniqueHeader("X-Job-Time"));
-        context.write({ ...this, logs: undefined, statusDetails: undefined });
-    }
-    /**
-     * Return the hook url if empty fallback to the service url
-     * @returns
-     */
-    getHookUrl() {
-        return Core.get().getApiUrl(`${Core.get().getRouter().getModelUrl(this)}/${this.uuid}`);
-    }
-    /**
-     *
-     * @param body
-     */
-    async update(body, time = undefined) {
-        if (body.logs && Array.isArray(body.logs)) {
-            this.logs ?? (this.logs = []);
-            this.logs.push(...body.logs);
-            // Prevent having too much logs
-            if (this.logs.length > this.getLogsLimit()) {
-                this.logs = this.logs.slice(-1 * this.getLogsLimit());
-            }
-        }
-        this._lastJobUpdate = Number.parseInt(time || "0") || 0;
-        if (Date.now() - this._lastJobUpdate > 60) {
-            this._lastJobUpdate = Date.now();
-        }
-        await this.patch({
-            _lastJobUpdate: this._lastJobUpdate,
-            logs: this.logs,
-            status: body.status || this.status,
-            errorMessage: body.errorMessage || this.errorMessage,
-            statusDetails: body.statusDetails || this.statusDetails,
-            results: body.results || this.results
-        });
-        return this;
-    }
-    /**
-     *
-     * @param context
-     * @param action
-     */
-    async verifyJobRequest(context) {
-        const jobTime = context.getHttpContext().getUniqueHeader("X-Job-Time");
-        const jobHash = context.getHttpContext().getUniqueHeader("X-Job-Hash");
-        // Ensure hash mac is correct
-        if (jobHash !== this.getHmac(jobTime)) {
-            context.log("TRACE", "Invalid Job HMAC");
-            throw new WebdaError.Forbidden("Invalid Job HMAC");
-        }
-        // Set the context extension
-        context.setExtension("asyncJob", this);
-    }
-    /**
-     * Get the hmac for the job
-     * @param jobTime
-     * @returns
-     */
-    getHmac(jobTime) {
-        return crypto.createHmac("sha256", this.__secretKey).update(jobTime).digest("hex");
-    }
-    /**
-     * Ensure action hook is ok
-     * @param context
-     * @param _action
-     * @returns
-     */
-    async checkAct(context, action) {
-        // Only action runner can call status action
-        if ("status" === action) {
-            if (context instanceof WebContext) {
-                if (context.getHttpContext().getUniqueHeader("X-Job-Hash") &&
-                    context.getHttpContext().getUniqueHeader("X-Job-Time")) {
-                    return await this.verifyJobRequest(context);
-                }
-            }
-            throw new WebdaError.Forbidden("Only Job runner can call this action");
-        }
-        // Allow to retrieve/update binaries by action runner
-        if (["get_binary", "attach_binary", "update_binary_metadata"].includes(action) &&
-            context.getHttpContext()?.getUniqueHeader("X-Job-Hash") &&
-            context.getHttpContext()?.getUniqueHeader("X-Job-Time")) {
-            console.log(action, context.getHttpContext()?.getUniqueHeader("X-Job-Hash"), context.getHttpContext()?.getUniqueHeader("X-Job-Time"));
-            return await this.verifyJobRequest(context);
-        }
-        return super.checkAct(context, action);
-    }
-}
-__decorate([
-    Action({ name: "status", openapi: { hidden: true } })
-], AsyncAction.prototype, "statusAction", null);
-/**
- * Define a Webda Async Action
- *
- * @WebdaModel
- */
-export class AsyncWebdaAction extends AsyncAction {
-    /**
-     *
-     * @param serviceName service to call
-     * @param method method to call
-     * @param arguments to call with the method
-     */
-    constructor(serviceName, method, ...args) {
-        super();
-        this.serviceName = serviceName;
-        this.method = method;
-        this.logLevel = "INFO";
-        this.arguments = args;
-    }
-    /**
-     * Execute a serviceName.method(...args) so this is internal
-     * @returns
-     */
-    isInternal() {
-        return true;
-    }
-}
-/**
- * Operation called asynchronously
- *
- * @WebdaModel
- */
-export class AsyncOperationAction extends AsyncAction {
-    constructor(operationId, context, logLevel = "INFO") {
-        super();
-        this.operationId = operationId;
-        this.context = context;
-        this.logLevel = logLevel;
-    }
-    /**
-     * Execute a webda.callOperation(context ,id) so this is internal
-     * @returns
-     */
-    isInternal() {
-        return true;
-    }
-}
-export { AsyncAction };
-//# sourceMappingURL=models.js.map

package/lib/models.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../src/models.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAoB,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEhG,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAyBjC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,SAAS;IAChD;;OAEG;IACH;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IAiED,YAAY;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IAEU,AAAN,KAAK,CAAC,YAAY,CAAC,OAAmB;QAC3C,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,OAAO,CAAC,cAAc,EAAE,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1G,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,IAAS,EAAE,OAAe,SAAS;QACrD,IAAI,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,KAAT,IAAI,CAAC,IAAI,GAAK,EAAE,EAAC;YACjB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,+BAA+B;YAC/B,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;gBAC3C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,GAAG,EAAE,EAAE,CAAC;YAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACnC,CAAC;QACD,MAAM,IAAI,CAAC,KAAK,CAAM;YACpB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;YAClC,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YACpD,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa;YACvD,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO;SACtC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,gBAAgB,CAAsC,OAAmB;QACvF,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACvE,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEvE,6BAA6B;QAC7B,IAAI,OAAO,KAAK,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACtC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;YACzC,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACrD,CAAC;QACD,4BAA4B;QAC5B,OAAO,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,OAAe;QACrB,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAmC,EAAE,MAAc;QACvE,4CAA4C;QAC5C,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YACxB,IAAI,OAAO,YAAY,UAAU,EAAE,CAAC;gBAClC,IACE,OAAO,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC;oBACtD,OAAO,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,EACtD,CAAC;oBACD,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;QACzE,CAAC;QACD,qDAAqD;QACrD,IACE,CAAC,YAAY,EAAE,eAAe,EAAE,wBAAwB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC1E,OAAO,CAAC,cAAc,EAAE,EAAE,eAAe,CAAC,YAAY,CAAC;YACvD,OAAO,CAAC,cAAc,EAAE,EAAE,eAAe,CAAC,YAAY,CAAC,EACvD,CAAC;YACD,OAAO,CAAC,GAAG,CACT,MAAM,EACN,OAAO,CAAC,cAAc,EAAE,EAAE,eAAe,CAAC,YAAY,CAAC,EACvD,OAAO,CAAC,cAAc,EAAE,EAAE,eAAe,CAAC,YAAY,CAAC,CACxD,CAAC;YACF,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAa,OAAO,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;CACF;AAtGc;IADZ,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC;+CAIrD;AAqGH;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAE/C;;;;;OAKG;IACH,YACS,WAAoB,EACpB,MAAe,EACtB,GAAG,IAAW;QAEd,KAAK,EAAE,CAAC;QAJD,gBAAW,GAAX,WAAW,CAAS;QACpB,WAAM,GAAN,MAAM,CAAS;QATjB,aAAQ,GAAmB,MAAM,CAAC;QAavC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD,YACS,WAAmB,EACnB,OAAyB,EACzB,WAA2B,MAAM;QAExC,KAAK,EAAE,CAAC;QAJD,gBAAW,GAAX,WAAW,CAAQ;QACnB,YAAO,GAAP,OAAO,CAAkB;QACzB,aAAQ,GAAR,QAAQ,CAAyB;IAG1C,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}