@vendure/core 1.4.7 → 1.5.0

package/cli/job-queue/job-buffer/job-buffer.service.js

@@ -0,0 +1,76 @@
+"use strict";
+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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobBufferService = void 0;
+const common_1 = require("@nestjs/common");
+const errors_1 = require("../../common/error/errors");
+const config_service_1 = require("../../config/config.service");
+const vendure_logger_1 = require("../../config/logger/vendure-logger");
+let JobBufferService = class JobBufferService {
+    constructor(configService) {
+        this.configService = configService;
+        this.buffers = new Set();
+        this.storageStrategy = configService.jobQueueOptions.jobBufferStorageStrategy;
+    }
+    addBuffer(buffer) {
+        const idAlreadyExists = Array.from(this.buffers).find(p => p.id === buffer.id);
+        if (idAlreadyExists) {
+            throw new errors_1.InternalServerError(`There is already a JobBufferProcessor with the id "${buffer.id}". Ids must be unique`);
+        }
+        this.buffers.add(buffer);
+    }
+    removeBuffer(buffer) {
+        this.buffers.delete(buffer);
+    }
+    async add(job) {
+        let collected = false;
+        for (const buffer of this.buffers) {
+            const shouldCollect = await buffer.collect(job);
+            if (shouldCollect) {
+                collected = true;
+                await this.storageStrategy.add(buffer.id, job);
+            }
+        }
+        return collected;
+    }
+    bufferSize(forBuffers) {
+        const buffer = forBuffers !== null && forBuffers !== void 0 ? forBuffers : Array.from(this.buffers);
+        return this.storageStrategy.bufferSize(buffer.map(p => (typeof p === 'string' ? p : p.id)));
+    }
+    async flush(forBuffers) {
+        const { jobQueueStrategy } = this.configService.jobQueueOptions;
+        const buffers = forBuffers !== null && forBuffers !== void 0 ? forBuffers : Array.from(this.buffers);
+        const flushResult = await this.storageStrategy.flush(buffers.map(p => (typeof p === 'string' ? p : p.id)));
+        const result = [];
+        for (const buffer of this.buffers) {
+            const jobsForBuffer = flushResult[buffer.id];
+            if (jobsForBuffer === null || jobsForBuffer === void 0 ? void 0 : jobsForBuffer.length) {
+                let jobsToAdd = jobsForBuffer;
+                try {
+                    jobsToAdd = await buffer.reduce(jobsForBuffer);
+                }
+                catch (e) {
+                    vendure_logger_1.Logger.error(`Error encountered processing jobs in JobBuffer "${buffer.id}":\n${e.message}`, undefined, e.stack);
+                }
+                for (const job of jobsToAdd) {
+                    result.push(await jobQueueStrategy.add(job));
+                }
+            }
+        }
+        return result;
+    }
+};
+JobBufferService = __decorate([
+    common_1.Injectable(),
+    __metadata("design:paramtypes", [config_service_1.ConfigService])
+], JobBufferService);
+exports.JobBufferService = JobBufferService;
+//# sourceMappingURL=job-buffer.service.js.map

package/cli/job-queue/job-buffer/job-buffer.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-buffer.service.js","sourceRoot":"","sources":["../../../src/job-queue/job-buffer/job-buffer.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,sDAAgE;AAChE,gEAA4D;AAC5D,uEAA4D;AAY5D,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAIzB,YAAoB,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;QAHxC,YAAO,GAAG,IAAI,GAAG,EAAa,CAAC;QAInC,IAAI,CAAC,eAAe,GAAG,aAAa,CAAC,eAAe,CAAC,wBAAwB,CAAC;IAClF,CAAC;IAED,SAAS,CAAC,MAAsB;QAC5B,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/E,IAAI,eAAe,EAAE;YACjB,MAAM,IAAI,4BAAmB,CACzB,sDAAsD,MAAM,CAAC,EAAE,uBAAuB,CACzF,CAAC;SACL;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,YAAY,CAAC,MAAsB;QAC/B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAQ;QACd,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YAC/B,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAChD,IAAI,aAAa,EAAE;gBACf,SAAS,GAAG,IAAI,CAAC;gBACjB,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;aAClD;SACJ;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,UAAU,CAAC,UAAsC;QAC7C,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,UAAsC;QAC9C,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC;QAChE,MAAM,OAAO,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAChD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CACvD,CAAC;QACF,MAAM,MAAM,GAAU,EAAE,CAAC;QACzB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YAC/B,MAAM,aAAa,GAAG,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,EAAE;gBACvB,IAAI,SAAS,GAAG,aAAa,CAAC;gBAC9B,IAAI;oBACA,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;iBAClD;gBAAC,OAAO,CAAC,EAAE;oBACR,uBAAM,CAAC,KAAK,CACR,mDAAmD,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAC9E,SAAS,EACT,CAAC,CAAC,KAAK,CACV,CAAC;iBACL;gBACD,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE;oBACzB,MAAM,CAAC,IAAI,CAAC,MAAM,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;iBAChD;aACJ;SACJ;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ,CAAA;AAlEY,gBAAgB;IAD5B,mBAAU,EAAE;qCAK0B,8BAAa;GAJvC,gBAAgB,CAkE5B;AAlEY,4CAAgB"}

package/cli/job-queue/job-queue.d.ts

@@ -0,0 +1,16 @@
+import { JobQueueStrategy } from '../config';
+import { JobBufferService } from './job-buffer/job-buffer.service';
+import { SubscribableJob } from './subscribable-job';
+import { CreateQueueOptions, JobConfig, JobData } from './types';
+export declare class JobQueue<Data extends JobData<Data> = {}> {
+    private options;
+    private jobQueueStrategy;
+    private jobBufferService;
+    private running;
+    get name(): string;
+    get started(): boolean;
+    constructor(options: CreateQueueOptions<Data>, jobQueueStrategy: JobQueueStrategy, jobBufferService: JobBufferService);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    add(data: Data, options?: Pick<JobConfig<Data>, 'retries'>): Promise<SubscribableJob<Data>>;
+}

package/cli/job-queue/job-queue.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobQueue = void 0;
+const vendure_logger_1 = require("../config/logger/vendure-logger");
+const job_1 = require("./job");
+const subscribable_job_1 = require("./subscribable-job");
+class JobQueue {
+    constructor(options, jobQueueStrategy, jobBufferService) {
+        this.options = options;
+        this.jobQueueStrategy = jobQueueStrategy;
+        this.jobBufferService = jobBufferService;
+        this.running = false;
+    }
+    get name() {
+        return this.options.name;
+    }
+    get started() {
+        return this.running;
+    }
+    async start() {
+        if (this.running) {
+            return;
+        }
+        this.running = true;
+        await this.jobQueueStrategy.start(this.options.name, this.options.process);
+    }
+    async stop() {
+        if (!this.running) {
+            return;
+        }
+        this.running = false;
+        return this.jobQueueStrategy.stop(this.options.name, this.options.process);
+    }
+    async add(data, options) {
+        var _a;
+        const job = new job_1.Job({
+            data,
+            queueName: this.options.name,
+            retries: (_a = options === null || options === void 0 ? void 0 : options.retries) !== null && _a !== void 0 ? _a : 0,
+        });
+        const isBuffered = await this.jobBufferService.add(job);
+        if (!isBuffered) {
+            try {
+                const addedJob = await this.jobQueueStrategy.add(job);
+                return new subscribable_job_1.SubscribableJob(addedJob, this.jobQueueStrategy);
+            }
+            catch (err) {
+                vendure_logger_1.Logger.error(`Could not add Job to "${this.name}" queue`, undefined, err.stack);
+                return new subscribable_job_1.SubscribableJob(job, this.jobQueueStrategy);
+            }
+        }
+        else {
+            const bufferedJob = new job_1.Job(Object.assign(Object.assign({}, job), { data: job.data, id: 'buffered' }));
+            return new subscribable_job_1.SubscribableJob(bufferedJob, this.jobQueueStrategy);
+        }
+    }
+}
+exports.JobQueue = JobQueue;
+//# sourceMappingURL=job-queue.js.map

package/cli/job-queue/job-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-queue.js","sourceRoot":"","sources":["../../src/job-queue/job-queue.ts"],"names":[],"mappings":";;;AAKA,oEAAyD;AAEzD,+BAA4B;AAE5B,yDAAqD;AAerD,MAAa,QAAQ;IAWjB,YACY,OAAiC,EACjC,gBAAkC,EAClC,gBAAkC;QAFlC,YAAO,GAAP,OAAO,CAA0B;QACjC,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,qBAAgB,GAAhB,gBAAgB,CAAkB;QAbtC,YAAO,GAAG,KAAK,CAAC;IAcrB,CAAC;IAZJ,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IASD,KAAK,CAAC,KAAK;QACP,IAAI,IAAI,CAAC,OAAO,EAAE;YACd,OAAO;SACV;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACrF,CAAC;IAGD,KAAK,CAAC,IAAI;QACN,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,OAAO;SACV;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;IAmCD,KAAK,CAAC,GAAG,CAAC,IAAU,EAAE,OAA0C;;QAC5D,MAAM,GAAG,GAAG,IAAI,SAAG,CAAM;YACrB,IAAI;YACJ,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YAC5B,OAAO,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,CAAC;SACjC,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxD,IAAI,CAAC,UAAU,EAAE;YACb,IAAI;gBACA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACtD,OAAO,IAAI,kCAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC/D;YAAC,OAAO,GAAG,EAAE;gBACV,uBAAM,CAAC,KAAK,CAAC,yBAAyB,IAAI,CAAC,IAAI,SAAS,EAAE,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;gBAChF,OAAO,IAAI,kCAAe,CAAC,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC1D;SACJ;aAAM;YACH,MAAM,WAAW,GAAG,IAAI,SAAG,iCACpB,GAAG,KACN,IAAI,EAAE,GAAG,CAAC,IAAI,EACd,EAAE,EAAE,UAAU,IAChB,CAAC;YACH,OAAO,IAAI,kCAAe,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;SAClE;IACL,CAAC;CACJ;AA7FD,4BA6FC"}

package/cli/job-queue/job-queue.service.d.ts

@@ -0,0 +1,27 @@
+import { OnModuleDestroy } from '@nestjs/common';
+import { JobQueue as GraphQlJobQueue } from '@vendure/common/lib/generated-types';
+import { ConfigService } from '../config';
+import { Job } from './job';
+import { JobBuffer } from './job-buffer/job-buffer';
+import { JobBufferService } from './job-buffer/job-buffer.service';
+import { JobQueue } from './job-queue';
+import { CreateQueueOptions, JobData } from './types';
+export declare class JobQueueService implements OnModuleDestroy {
+    private configService;
+    private jobBufferService;
+    private queues;
+    private hasStarted;
+    private get jobQueueStrategy();
+    constructor(configService: ConfigService, jobBufferService: JobBufferService);
+    onModuleDestroy(): Promise<void[]>;
+    createQueue<Data extends JobData<Data>>(options: CreateQueueOptions<Data>): Promise<JobQueue<Data>>;
+    start(): Promise<void>;
+    addBuffer(buffer: JobBuffer<any>): void;
+    removeBuffer(buffer: JobBuffer<any>): void;
+    bufferSize(...forBuffers: Array<JobBuffer<any> | string>): Promise<{
+        [bufferId: string]: number;
+    }>;
+    flush(...forBuffers: Array<JobBuffer<any> | string>): Promise<Job[]>;
+    getJobQueues(): GraphQlJobQueue[];
+    private shouldStartQueue;
+}

package/cli/job-queue/job-queue.service.js

@@ -0,0 +1,84 @@
+"use strict";
+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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobQueueService = void 0;
+const common_1 = require("@nestjs/common");
+const config_1 = require("../config");
+const constants_1 = require("./constants");
+const job_buffer_service_1 = require("./job-buffer/job-buffer.service");
+const job_queue_1 = require("./job-queue");
+let JobQueueService = class JobQueueService {
+    constructor(configService, jobBufferService) {
+        this.configService = configService;
+        this.jobBufferService = jobBufferService;
+        this.queues = [];
+        this.hasStarted = false;
+    }
+    get jobQueueStrategy() {
+        return this.configService.jobQueueOptions.jobQueueStrategy;
+    }
+    onModuleDestroy() {
+        this.hasStarted = false;
+        return Promise.all(this.queues.map(q => q.stop()));
+    }
+    async createQueue(options) {
+        if (this.configService.jobQueueOptions.prefix) {
+            options = Object.assign(Object.assign({}, options), { name: `${this.configService.jobQueueOptions.prefix}${options.name}` });
+        }
+        const queue = new job_queue_1.JobQueue(options, this.jobQueueStrategy, this.jobBufferService);
+        if (this.hasStarted && this.shouldStartQueue(queue.name)) {
+            await queue.start();
+        }
+        this.queues.push(queue);
+        return queue;
+    }
+    async start() {
+        this.hasStarted = true;
+        for (const queue of this.queues) {
+            if (!queue.started && this.shouldStartQueue(queue.name)) {
+                config_1.Logger.info(`Starting queue: ${queue.name}`, constants_1.loggerCtx);
+                await queue.start();
+            }
+        }
+    }
+    addBuffer(buffer) {
+        this.jobBufferService.addBuffer(buffer);
+    }
+    removeBuffer(buffer) {
+        this.jobBufferService.removeBuffer(buffer);
+    }
+    bufferSize(...forBuffers) {
+        return this.jobBufferService.bufferSize(forBuffers);
+    }
+    flush(...forBuffers) {
+        return this.jobBufferService.flush(forBuffers);
+    }
+    getJobQueues() {
+        return this.queues.map(queue => ({
+            name: queue.name,
+            running: queue.started,
+        }));
+    }
+    shouldStartQueue(queueName) {
+        if (this.configService.jobQueueOptions.activeQueues.length > 0) {
+            if (!this.configService.jobQueueOptions.activeQueues.includes(queueName)) {
+                return false;
+            }
+        }
+        return true;
+    }
+};
+JobQueueService = __decorate([
+    common_1.Injectable(),
+    __metadata("design:paramtypes", [config_1.ConfigService, job_buffer_service_1.JobBufferService])
+], JobQueueService);
+exports.JobQueueService = JobQueueService;
+//# sourceMappingURL=job-queue.service.js.map

package/cli/job-queue/job-queue.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-queue.service.js","sourceRoot":"","sources":["../../src/job-queue/job-queue.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA6D;AAG7D,sCAAoE;AAEpE,2CAAwC;AAGxC,wEAAmE;AACnE,2CAAuC;AAuCvC,IAAa,eAAe,GAA5B,MAAa,eAAe;IAQxB,YAAoB,aAA4B,EAAU,gBAAkC;QAAxE,kBAAa,GAAb,aAAa,CAAe;QAAU,qBAAgB,GAAhB,gBAAgB,CAAkB;QAPpF,WAAM,GAAyB,EAAE,CAAC;QAClC,eAAU,GAAG,KAAK,CAAC;IAMoE,CAAC;IAJhG,IAAY,gBAAgB;QACxB,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,gBAAgB,CAAC;IAC/D,CAAC;IAKD,eAAe;QACX,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;IAMD,KAAK,CAAC,WAAW,CACb,OAAiC;QAEjC,IAAI,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,EAAE;YAC3C,OAAO,mCAAQ,OAAO,KAAE,IAAI,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,GAAE,CAAC;SACjG;QACD,MAAM,KAAK,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAClF,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACtD,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;SACvB;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACrD,eAAM,CAAC,IAAI,CAAC,mBAAmB,KAAK,CAAC,IAAI,EAAE,EAAE,qBAAS,CAAC,CAAC;gBACxD,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;aACvB;SACJ;IACL,CAAC;IASD,SAAS,CAAC,MAAsB;QAC5B,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IASD,YAAY,CAAC,MAAsB;QAC/B,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAmBD,UAAU,CAAC,GAAG,UAA0C;QACpD,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACxD,CAAC;IAiBD,KAAK,CAAC,GAAG,UAA0C;QAC/C,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACnD,CAAC;IAOD,YAAY;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC7B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;SACzB,CAAC,CAAC,CAAC;IACR,CAAC;IAEO,gBAAgB,CAAC,SAAiB;QACtC,IAAI,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5D,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBACtE,OAAO,KAAK,CAAC;aAChB;SACJ;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ,CAAA;AA/HY,eAAe;IAD3B,mBAAU,EAAE;qCAS0B,sBAAa,EAA4B,qCAAgB;GARnF,eAAe,CA+H3B;AA/HY,0CAAe"}

package/cli/job-queue/job.d.ts

@@ -0,0 +1,41 @@
+import { JobState } from '@vendure/common/lib/generated-types';
+import { JobConfig, JobData } from './types';
+export declare type JobEventType = 'progress';
+export declare type JobEventListener<T extends JobData<T>> = (job: Job<T>) => void;
+export declare class Job<T extends JobData<T> = any> {
+    readonly id: number | string | null;
+    readonly queueName: string;
+    readonly retries: number;
+    readonly createdAt: Date;
+    private readonly _data;
+    private _state;
+    private _progress;
+    private _result?;
+    private _error?;
+    private _attempts;
+    private _startedAt?;
+    private _settledAt?;
+    private readonly eventListeners;
+    get name(): string;
+    get data(): T;
+    get state(): JobState;
+    get progress(): number;
+    get result(): any;
+    get error(): any;
+    get isSettled(): boolean;
+    get startedAt(): Date | undefined;
+    get settledAt(): Date | undefined;
+    get duration(): number;
+    get attempts(): number;
+    constructor(config: JobConfig<T>);
+    start(): void;
+    setProgress(percent: number): void;
+    complete(result?: any): void;
+    fail(err?: any): void;
+    cancel(): void;
+    defer(): void;
+    on(eventType: JobEventType, listener: JobEventListener<T>): void;
+    off(eventType: JobEventType, listener: JobEventListener<T>): void;
+    private fireEvent;
+    private ensureDataIsSerializable;
+}

package/cli/job-queue/job.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Job = void 0;
+const generated_types_1 = require("@vendure/common/lib/generated-types");
+const shared_utils_1 = require("@vendure/common/lib/shared-utils");
+const vendure_logger_1 = require("../config/logger/vendure-logger");
+class Job {
+    constructor(config) {
+        this.eventListeners = {
+            progress: [],
+        };
+        this.queueName = config.queueName;
+        this._data = this.ensureDataIsSerializable(config.data);
+        this.id = config.id || null;
+        this._state = config.state || generated_types_1.JobState.PENDING;
+        this.retries = config.retries || 0;
+        this._attempts = config.attempts || 0;
+        this._progress = config.progress || 0;
+        this.createdAt = config.createdAt || new Date();
+        this._result = config.result;
+        this._error = config.error;
+        this._startedAt = config.startedAt;
+        this._settledAt = config.settledAt;
+    }
+    get name() {
+        return this.queueName;
+    }
+    get data() {
+        return this._data;
+    }
+    get state() {
+        return this._state;
+    }
+    get progress() {
+        return this._progress;
+    }
+    get result() {
+        return this._result;
+    }
+    get error() {
+        return this._error;
+    }
+    get isSettled() {
+        return (!!this._settledAt &&
+            (this._state === generated_types_1.JobState.COMPLETED ||
+                this._state === generated_types_1.JobState.FAILED ||
+                this._state === generated_types_1.JobState.CANCELLED));
+    }
+    get startedAt() {
+        return this._startedAt;
+    }
+    get settledAt() {
+        return this._settledAt;
+    }
+    get duration() {
+        if (this.state === generated_types_1.JobState.PENDING || this.state === generated_types_1.JobState.RETRYING) {
+            return 0;
+        }
+        const end = this._settledAt || new Date();
+        return +end - +(this._startedAt || end);
+    }
+    get attempts() {
+        return this._attempts;
+    }
+    start() {
+        if (this._state === generated_types_1.JobState.PENDING || this._state === generated_types_1.JobState.RETRYING) {
+            this._state = generated_types_1.JobState.RUNNING;
+            this._startedAt = new Date();
+            this._attempts++;
+            vendure_logger_1.Logger.debug(`Job ${this.id} [${this.queueName}] starting (attempt ${this._attempts} of ${this.retries + 1})`);
+        }
+    }
+    setProgress(percent) {
+        this._progress = Math.min(percent || 0, 100);
+        this.fireEvent('progress');
+    }
+    complete(result) {
+        this._result = result;
+        this._progress = 100;
+        this._state = generated_types_1.JobState.COMPLETED;
+        this._settledAt = new Date();
+        vendure_logger_1.Logger.debug(`Job ${this.id} [${this.queueName}] completed`);
+    }
+    fail(err) {
+        this._error = (err === null || err === void 0 ? void 0 : err.message) ? err.message : String(err);
+        this._progress = 0;
+        if (this.retries >= this._attempts) {
+            this._state = generated_types_1.JobState.RETRYING;
+            vendure_logger_1.Logger.warn(`Job ${this.id} [${this.queueName}] failed (attempt ${this._attempts} of ${this.retries + 1})`);
+        }
+        else {
+            if (this._state !== generated_types_1.JobState.CANCELLED) {
+                this._state = generated_types_1.JobState.FAILED;
+                vendure_logger_1.Logger.warn(`Job ${this.id} [${this.queueName}] failed and will not retry.`);
+            }
+            this._settledAt = new Date();
+        }
+    }
+    cancel() {
+        this._settledAt = new Date();
+        this._state = generated_types_1.JobState.CANCELLED;
+    }
+    defer() {
+        if (this._state === generated_types_1.JobState.RUNNING) {
+            this._state = generated_types_1.JobState.PENDING;
+            this._attempts = 0;
+            vendure_logger_1.Logger.debug(`Job ${this.id} [${this.queueName}] deferred back to PENDING state`);
+        }
+    }
+    on(eventType, listener) {
+        this.eventListeners[eventType].push(listener);
+    }
+    off(eventType, listener) {
+        const idx = this.eventListeners[eventType].indexOf(listener);
+        if (idx !== -1) {
+            this.eventListeners[eventType].splice(idx, 1);
+        }
+    }
+    fireEvent(eventType) {
+        for (const listener of this.eventListeners[eventType]) {
+            listener(this);
+        }
+    }
+    ensureDataIsSerializable(data, output) {
+        if (data instanceof Date) {
+            return data.toISOString();
+        }
+        else if (shared_utils_1.isObject(data)) {
+            if (!output) {
+                output = {};
+            }
+            for (const key of Object.keys(data)) {
+                output[key] = this.ensureDataIsSerializable(data[key]);
+            }
+            if (shared_utils_1.isClassInstance(data)) {
+                const descriptors = Object.getOwnPropertyDescriptors(Object.getPrototypeOf(data));
+                for (const name of Object.keys(descriptors)) {
+                    const descriptor = descriptors[name];
+                    if (typeof descriptor.get === 'function') {
+                        output[name] = data[name];
+                    }
+                }
+            }
+        }
+        else if (Array.isArray(data)) {
+            if (!output) {
+                output = [];
+            }
+            data.forEach((item, i) => {
+                output[i] = this.ensureDataIsSerializable(item);
+            });
+        }
+        else {
+            return data;
+        }
+        return output;
+    }
+}
+exports.Job = Job;
+//# sourceMappingURL=job.js.map

package/cli/job-queue/job.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job.js","sourceRoot":"","sources":["../../src/job-queue/job.ts"],"names":[],"mappings":";;;AAAA,yEAA+D;AAC/D,mEAA6E;AAE7E,oEAAyD;AAiCzD,MAAa,GAAG;IAsEZ,YAAY,MAAoB;QAzDf,mBAAc,GAA2D;YACtF,QAAQ,EAAE,EAAE;SACf,CAAC;QAwDE,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,IAAI,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,0BAAQ,CAAC,OAAO,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;IACvC,CAAC;IAlED,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAI,SAAS;QACT,OAAO,CACH,CAAC,CAAC,IAAI,CAAC,UAAU;YACjB,CAAC,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,SAAS;gBAC/B,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,MAAM;gBAC/B,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,SAAS,CAAC,CAC1C,CAAC;IACN,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,IAAI,QAAQ;QACR,IAAI,IAAI,CAAC,KAAK,KAAK,0BAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,KAAK,0BAAQ,CAAC,QAAQ,EAAE;YACrE,OAAO,CAAC,CAAC;SACZ;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC;QAC1C,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAsBD,KAAK;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,QAAQ,EAAE;YACvE,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,OAAO,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,uBAAM,CAAC,KAAK,CACR,OAAO,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,SAAS,uBAAuB,IAAI,CAAC,SAAS,OAClE,IAAI,CAAC,OAAO,GAAG,CACnB,GAAG,CACN,CAAC;SACL;IACL,CAAC;IAMD,WAAW,CAAC,OAAe;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;IAOD,QAAQ,CAAC,MAAY;QACjB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QAC7B,uBAAM,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,SAAS,aAAa,CAAC,CAAC;IACjE,CAAC;IAMD,IAAI,CAAC,GAAS;QACV,IAAI,CAAC,MAAM,GAAG,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,EAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,QAAQ,CAAC;YAChC,uBAAM,CAAC,IAAI,CACP,OAAO,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,SAAS,qBAAqB,IAAI,CAAC,SAAS,OAChE,IAAI,CAAC,OAAO,GAAG,CACnB,GAAG,CACN,CAAC;SACL;aAAM;YACH,IAAI,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,SAAS,EAAE;gBACpC,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,MAAM,CAAC;gBAC9B,uBAAM,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,SAAS,8BAA8B,CAAC,CAAC;aAChF;YACD,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;SAChC;IACL,CAAC;IAED,MAAM;QACF,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,SAAS,CAAC;IACrC,CAAC;IAOD,KAAK;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,OAAO,EAAE;YAClC,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,OAAO,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;YACnB,uBAAM,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,SAAS,kCAAkC,CAAC,CAAC;SACrF;IACL,CAAC;IAMD,EAAE,CAAC,SAAuB,EAAE,QAA6B;QACrD,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,GAAG,CAAC,SAAuB,EAAE,QAA6B;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7D,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE;YACZ,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;SACjD;IACL,CAAC;IAEO,SAAS,CAAC,SAAuB;QACrC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;YACnD,QAAQ,CAAC,IAAI,CAAC,CAAC;SAClB;IACL,CAAC;IAQO,wBAAwB,CAAC,IAAS,EAAE,MAAY;QACpD,IAAI,IAAI,YAAY,IAAI,EAAE;YACtB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;SAC7B;aAAM,IAAI,uBAAQ,CAAC,IAAI,CAAC,EAAE;YACvB,IAAI,CAAC,MAAM,EAAE;gBACT,MAAM,GAAG,EAAE,CAAC;aACf;YACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACjC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAE,IAAY,CAAC,GAAG,CAAC,CAAC,CAAC;aACnE;YACD,IAAI,8BAAe,CAAC,IAAI,CAAC,EAAE;gBACvB,MAAM,WAAW,GAAG,MAAM,CAAC,yBAAyB,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;gBAClF,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;oBACzC,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;oBACrC,IAAI,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU,EAAE;wBACtC,MAAM,CAAC,IAAI,CAAC,GAAI,IAAY,CAAC,IAAI,CAAC,CAAC;qBACtC;iBACJ;aACJ;SACJ;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC5B,IAAI,CAAC,MAAM,EAAE;gBACT,MAAM,GAAG,EAAE,CAAC;aACf;YACD,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;gBACrB,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;SACN;aAAM;YACH,OAAO,IAAI,CAAC;SACf;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAhOD,kBAgOC"}

package/cli/job-queue/polling-job-queue-strategy.d.ts

@@ -0,0 +1,26 @@
+import { ID } from '@vendure/common/lib/shared-types';
+import { InjectableJobQueueStrategy } from './injectable-job-queue-strategy';
+import { Job } from './job';
+import { JobData } from './types';
+export declare type BackoffStrategy = (queueName: string, attemptsMade: number, job: Job) => number;
+export interface PollingJobQueueStrategyConfig {
+    concurrency?: number;
+    pollInterval?: number | ((queueName: string) => number);
+    setRetries?: (queueName: string, job: Job) => number;
+    backoffStrategy?: BackoffStrategy;
+}
+export declare abstract class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
+    concurrency: number;
+    pollInterval: number | ((queueName: string) => number);
+    setRetries: (queueName: string, job: Job) => number;
+    backOffStrategy?: BackoffStrategy;
+    private activeQueues;
+    constructor(config?: PollingJobQueueStrategyConfig);
+    constructor(concurrency?: number, pollInterval?: number);
+    start<Data extends JobData<Data> = {}>(queueName: string, process: (job: Job<Data>) => Promise<any>): Promise<void>;
+    stop<Data extends JobData<Data> = {}>(queueName: string, process: (job: Job<Data>) => Promise<any>): Promise<void>;
+    cancelJob(jobId: ID): Promise<Job | undefined>;
+    abstract next(queueName: string): Promise<Job | undefined>;
+    abstract update(job: Job): Promise<void>;
+    abstract findOne(id: ID): Promise<Job | undefined>;
+}