@nest-boot/schedule 7.0.3 → 7.2.0

package/dist/schedule.registry.spec.js

@@ -0,0 +1,233 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 });
+require("reflect-metadata");
+jest.mock("@nest-boot/bullmq", () => ({
+    InjectQueue: jest.fn(() => jest.fn()),
+}));
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const testing_1 = require("@nestjs/testing");
+const bullmq_1 = require("bullmq");
+const schedule_decorator_1 = require("./schedule.decorator");
+const schedule_module_definition_1 = require("./schedule.module-definition");
+const schedule_registry_1 = require("./schedule.registry");
+describe("ScheduleRegistry", () => {
+    class ControllerSchedules {
+        constructor() {
+            this.calls = [];
+        }
+        async syncUsers() {
+            await Promise.resolve();
+            this.calls.push("syncUsers");
+        }
+        undecorated() {
+            return undefined;
+        }
+    }
+    __decorate([
+        (0, schedule_decorator_1.Cron)("*/5 * * * *", {
+            attempts: 2,
+            timezone: "Asia/Shanghai",
+        }),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", []),
+        __metadata("design:returntype", Promise)
+    ], ControllerSchedules.prototype, "syncUsers", null);
+    class ProviderSchedules {
+        constructor() {
+            this.calls = [];
+        }
+        async refreshCache() {
+            await Promise.resolve();
+            this.calls.push("refreshCache");
+        }
+    }
+    __decorate([
+        (0, schedule_decorator_1.Interval)("1000", {
+            removeOnComplete: true,
+        }),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", []),
+        __metadata("design:returntype", Promise)
+    ], ProviderSchedules.prototype, "refreshCache", null);
+    const createRegistry = async (controller = new ControllerSchedules(), provider = new ProviderSchedules(), schedulers = []) => {
+        const queue = {
+            getJobSchedulers: jest.fn().mockResolvedValue(schedulers),
+            removeJobScheduler: jest.fn().mockResolvedValue(undefined),
+            upsertJobScheduler: jest.fn().mockResolvedValue(undefined),
+        };
+        const reflector = {
+            get: jest.fn((key, handler) => Reflect.getMetadata(key, handler)),
+        };
+        const discoveryService = {
+            getControllers: jest.fn(() => [
+                {
+                    instance: controller,
+                },
+                {
+                    instance: null,
+                },
+            ]),
+            getProviders: jest.fn(() => [
+                {
+                    instance: provider,
+                },
+                {
+                    instance: undefined,
+                },
+            ]),
+        };
+        const metadataScanner = {
+            getAllMethodNames: jest.fn((prototype) => Object.getOwnPropertyNames(prototype).filter((key) => key !== "constructor")),
+        };
+        const moduleRef = await testing_1.Test.createTestingModule({
+            providers: [
+                schedule_registry_1.ScheduleRegistry,
+                {
+                    provide: bullmq_1.Queue,
+                    useValue: queue,
+                },
+                {
+                    provide: core_1.Reflector,
+                    useValue: reflector,
+                },
+                {
+                    provide: core_1.DiscoveryService,
+                    useValue: discoveryService,
+                },
+                {
+                    provide: core_1.MetadataScanner,
+                    useValue: metadataScanner,
+                },
+            ],
+        }).compile();
+        const registry = moduleRef.get(schedule_registry_1.ScheduleRegistry);
+        jest.spyOn(registry.logger, "log").mockImplementation(jest.fn());
+        return {
+            controller,
+            discoveryService,
+            metadataScanner,
+            provider,
+            queue,
+            reflector,
+            registry,
+        };
+    };
+    beforeEach(() => {
+        jest.spyOn(common_1.Logger.prototype, "log").mockImplementation(jest.fn());
+    });
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+    it("should discover decorated methods, clean stale schedulers, and register schedules", async () => {
+        const { controller, queue, registry } = await createRegistry(undefined, undefined, [
+            {
+                name: "Old.cron",
+                pattern: "0 0 * * *",
+            },
+            {
+                name: "Old.interval",
+                every: 5000,
+            },
+            {
+                name: "ControllerSchedules.syncUsers",
+                pattern: "*/5 * * * *",
+            },
+        ]);
+        await registry.onApplicationBootstrap();
+        await registry.get("ControllerSchedules.syncUsers")?.handler();
+        expect(controller.calls).toEqual(["syncUsers"]);
+        expect(queue.removeJobScheduler).toHaveBeenCalledTimes(2);
+        expect(queue.removeJobScheduler).toHaveBeenCalledWith("Old.cron");
+        expect(queue.removeJobScheduler).toHaveBeenCalledWith("Old.interval");
+        expect(queue.upsertJobScheduler).toHaveBeenCalledWith("ControllerSchedules.syncUsers", {
+            pattern: "*/5 * * * *",
+            tz: "Asia/Shanghai",
+        }, {
+            name: "ControllerSchedules.syncUsers",
+            opts: {
+                attempts: 2,
+            },
+        });
+        expect(queue.upsertJobScheduler).toHaveBeenCalledWith("ProviderSchedules.refreshCache", {
+            every: 1000,
+            tz: "UTC",
+        }, {
+            name: "ProviderSchedules.refreshCache",
+            opts: {
+                removeOnComplete: true,
+            },
+        });
+    });
+    it("should ignore non-object wrappers and methods without schedule metadata", async () => {
+        const { discoveryService, metadataScanner, queue, reflector, registry } = await createRegistry();
+        await registry.onApplicationBootstrap();
+        expect(discoveryService.getControllers).toHaveBeenCalledTimes(1);
+        expect(discoveryService.getProviders).toHaveBeenCalledTimes(1);
+        expect(metadataScanner.getAllMethodNames).toHaveBeenCalledTimes(2);
+        expect(reflector.get).toHaveBeenCalledWith(schedule_module_definition_1.SCHEDULE_METADATA_KEY, Object.getOwnPropertyDescriptor(ControllerSchedules.prototype, "undecorated")?.value);
+        expect(queue.removeJobScheduler).not.toHaveBeenCalled();
+        expect(queue.upsertJobScheduler).toHaveBeenCalledTimes(2);
+        expect(registry.get("ControllerSchedules.undecorated")).toBeUndefined();
+    });
+    it("should load decorator metadata fallback branches", async () => {
+        await jest.isolateModulesAsync(async () => {
+            jest.doMock("@nest-boot/bullmq", () => ({
+                InjectQueue: jest.fn(() => jest.fn()),
+            }));
+            jest.doMock("bullmq", () => ({
+                Queue: undefined,
+            }));
+            jest.doMock("@nestjs/core", () => ({
+                DiscoveryService: undefined,
+                MetadataScanner: undefined,
+                Reflector: undefined,
+            }));
+            const module = await Promise.resolve().then(() => __importStar(require("./schedule.registry")));
+            expect(module.ScheduleRegistry).toBeDefined();
+        });
+    });
+});
+//# sourceMappingURL=schedule.registry.spec.js.map

package/dist/schedule.registry.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schedule.registry.spec.js","sourceRoot":"","sources":["../src/schedule.registry.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4BAA0B;AAE1B,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC;IACpC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;CACtC,CAAC,CAAC,CAAC;AAEJ,2CAAwC;AACxC,uCAA4E;AAC5E,6CAAuC;AACvC,mCAA+B;AAE/B,6DAAsD;AACtD,6EAAqE;AACrE,2DAAuD;AAEvD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,mBAAmB;QAAzB;YACE,UAAK,GAAa,EAAE,CAAC;QAcvB,CAAC;QARO,AAAN,KAAK,CAAC,SAAS;YACb,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;QAED,WAAW;YACT,OAAO,SAAS,CAAC;QACnB,CAAC;KACF;IARO;QAJL,IAAA,yBAAI,EAAC,aAAa,EAAE;YACnB,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,eAAe;SAC1B,CAAC;;;;wDAID;IAOH,MAAM,iBAAiB;QAAvB;YACE,UAAK,GAAa,EAAE,CAAC;QASvB,CAAC;QAJO,AAAN,KAAK,CAAC,YAAY;YAChB,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;KACF;IAJO;QAHL,IAAA,6BAAQ,EAAC,MAAM,EAAE;YAChB,gBAAgB,EAAE,IAAI;SACvB,CAAC;;;;yDAID;IAGH,MAAM,cAAc,GAAG,KAAK,EAC1B,UAAU,GAAG,IAAI,mBAAmB,EAAE,EACtC,QAAQ,GAAG,IAAI,iBAAiB,EAAE,EAClC,aAIM,EAAE,EACR,EAAE;QACF,MAAM,KAAK,GAAG;YACZ,gBAAgB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC;YACzD,kBAAkB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;YAC1D,kBAAkB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;SAC3D,CAAC;QACF,MAAM,SAAS,GAAG;YAChB,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,GAAW,EAAE,OAAsC,EAAE,EAAE,CACnE,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAClC;SACF,CAAC;QACF,MAAM,gBAAgB,GAAG;YACvB,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;gBAC5B;oBACE,QAAQ,EAAE,UAAU;iBACrB;gBACD;oBACE,QAAQ,EAAE,IAAI;iBACf;aACF,CAAC;YACF,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;gBAC1B;oBACE,QAAQ,EAAE,QAAQ;iBACnB;gBACD;oBACE,QAAQ,EAAE,SAAS;iBACpB;aACF,CAAC;SACH,CAAC;QACF,MAAM,eAAe,GAAG;YACtB,iBAAiB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,SAAiB,EAAE,EAAE,CAC/C,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,MAAM,CAC1C,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,aAAa,CAC/B,CACF;SACF,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,SAAS,EAAE;gBACT,oCAAgB;gBAChB;oBACE,OAAO,EAAE,cAAK;oBACd,QAAQ,EAAE,KAAK;iBAChB;gBACD;oBACE,OAAO,EAAE,gBAAS;oBAClB,QAAQ,EAAE,SAAS;iBACpB;gBACD;oBACE,OAAO,EAAE,uBAAgB;oBACzB,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,eAAe;iBAC1B;aACF;SACF,CAAC,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,oCAAgB,CAAC,CAAC;QAEjD,IAAI,CAAC,KAAK,CAAE,QAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAE1E,OAAO;YACL,UAAU;YACV,gBAAgB;YAChB,eAAe;YACf,QAAQ;YACR,KAAK;YACL,SAAS;YACT,QAAQ;SACT,CAAC;IACJ,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,KAAK,CAAC,eAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mFAAmF,EAAE,KAAK,IAAI,EAAE;QACjG,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,cAAc,CAC1D,SAAS,EACT,SAAS,EACT;YACE;gBACE,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,WAAW;aACrB;YACD;gBACE,IAAI,EAAE,cAAc;gBACpB,KAAK,EAAE,IAAI;aACZ;YACD;gBACE,IAAI,EAAE,+BAA+B;gBACrC,OAAO,EAAE,aAAa;aACvB;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,CAAC,sBAAsB,EAAE,CAAC;QACxC,MAAM,QAAQ,CAAC,GAAG,CAAC,+BAA+B,CAAC,EAAE,OAAO,EAAE,CAAC;QAE/D,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAClE,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CACnD,+BAA+B,EAC/B;YACE,OAAO,EAAE,aAAa;YACtB,EAAE,EAAE,eAAe;SACpB,EACD;YACE,IAAI,EAAE,+BAA+B;YACrC,IAAI,EAAE;gBACJ,QAAQ,EAAE,CAAC;aACZ;SACF,CACF,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CACnD,gCAAgC,EAChC;YACE,KAAK,EAAE,IAAI;YACX,EAAE,EAAE,KAAK;SACV,EACD;YACE,IAAI,EAAE,gCAAgC;YACtC,IAAI,EAAE;gBACJ,gBAAgB,EAAE,IAAI;aACvB;SACF,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACvF,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,GACrE,MAAM,cAAc,EAAE,CAAC;QAEzB,MAAM,QAAQ,CAAC,sBAAsB,EAAE,CAAC;QAExC,MAAM,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACxC,kDAAqB,EACrB,MAAM,CAAC,wBAAwB,CAC7B,mBAAmB,CAAC,SAAS,EAC7B,aAAa,CACd,EAAE,KAAK,CACT,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,IAAI,EAAE;YACxC,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC;gBACtC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;aACtC,CAAC,CAAC,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;gBAC3B,KAAK,EAAE,SAAS;aACjB,CAAC,CAAC,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC;gBACjC,gBAAgB,EAAE,SAAS;gBAC3B,eAAe,EAAE,SAAS;gBAC1B,SAAS,EAAE,SAAS;aACrB,CAAC,CAAC,CAAC;YAEJ,MAAM,MAAM,GAAG,wDAAa,qBAAqB,GAAC,CAAC;YAEnD,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}