koatty_schedule 3.0.0 → 3.2.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.2.0](https://github.com/thinkkoa/koatty_schedule/compare/v3.1.0...v3.2.0) (2025-06-22)
+
+
+### Features
+
+* introduce component-specific metadata keys for scheduled and redlock decorators ([803b350](https://github.com/thinkkoa/koatty_schedule/commit/803b3503489c02ab138b3f9f14cb520dd6c7fec4))
+
+
+### Bug Fixes
+
+* 修复IOC容器元数据键格式不匹配问题 ([065d456](https://github.com/thinkkoa/koatty_schedule/commit/065d456fc65004e25eb19838da96bf0a52cb2af1))
+
+## [3.1.0](https://github.com/thinkkoa/koatty_schedule/compare/v3.0.0...v3.1.0) (2025-06-21)
+
+
+### Features
+
+* update decorator types to support symbol property keys and improve IOC container integration ([a60ef3e](https://github.com/thinkkoa/koatty_schedule/commit/a60ef3e361b245f97ba0d6ee51d42efd437a1252))
+
 ## [3.0.0](https://github.com/thinkkoa/koatty_schedule/compare/v2.1.0...v3.0.0) (2025-06-21)
 
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2025-06-21 14:10:01
+* @Date: 2025-06-22 20:33:52
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2025-06-21 14:09:54
+* @Date: 2025-06-22 20:33:45
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -23,6 +23,8 @@ var cron = require('cron');
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
+const COMPONENT_SCHEDULED = 'COMPONENT_SCHEDULED';
+const COMPONENT_REDLOCK = 'COMPONENT_REDLOCK';
 /**
  * Decorator types supported by the system
  */
@@ -184,9 +186,9 @@ function getEffectiveRedLockOptions(methodOptions) {
 function RedLock(lockName, options) {
     return (target, propertyKey, descriptor) => {
         const methodName = propertyKey.toString();
-        // 验证装饰器使用的类型
-        const targetObj = target;
-        const componentType = koatty_container.IOCContainer.getType(targetObj);
+        // 验证装饰器使用的类型（从原型对象获取类构造函数）
+        const targetClass = target.constructor;
+        const componentType = koatty_container.IOCContainer.getType(targetClass);
         if (componentType !== "SERVICE" && componentType !== "COMPONENT") {
             throw Error("@RedLock decorator can only be used on SERVICE or COMPONENT classes.");
         }
@@ -208,12 +210,14 @@ function RedLock(lockName, options) {
         if (options) {
             validateRedLockMethodOptions(options);
         }
+        // 保存类到IOC容器
+        koatty_container.IOCContainer.saveClass(COMPONENT_REDLOCK, targetClass, targetClass.name);
         // 保存RedLock元数据到 IOC 容器（lockName已确定）
-        koatty_container.IOCContainer.attachClassMetadata('COMPONENT', DecoratorType.REDLOCK, {
+        koatty_container.IOCContainer.attachClassMetadata(COMPONENT_REDLOCK, DecoratorType.REDLOCK, {
             method: methodName,
             name: lockName, // 确定的锁名称，不会为undefined
             options
-        }, targetObj, methodName);
+        }, target, methodName);
     };
 }
 
@@ -261,26 +265,29 @@ function Scheduled(cron, timezone) {
         throw Error("Timezone must be a string");
     }
     return (target, propertyKey, descriptor) => {
-        // 验证装饰器使用的类型
-        const targetObj = target;
-        const componentType = koatty_container.IOCContainer.getType(targetObj);
+        // 验证装饰器使用的类型（从原型对象获取类构造函数）
+        const targetClass = target.constructor;
+        const componentType = koatty_container.IOCContainer.getType(targetClass);
         if (componentType !== "SERVICE" && componentType !== "COMPONENT") {
             throw Error("@Scheduled decorator can only be used on SERVICE or COMPONENT classes.");
         }
         // 验证方法名
-        if (!propertyKey || typeof propertyKey !== 'string') {
+        const methodName = propertyKey.toString();
+        if (!methodName || typeof methodName !== 'string') {
             throw Error("Method name is required for @Scheduled decorator");
         }
         // 验证方法描述符
         if (!descriptor || typeof descriptor.value !== 'function') {
             throw Error("@Scheduled decorator can only be applied to methods");
         }
-        // 保存调度元数据到 IOC 容器（timezone如果用户未指定则保存为undefined，在injectSchedule中处理）
-        koatty_container.IOCContainer.attachClassMetadata('COMPONENT', DecoratorType.SCHEDULED, {
-            method: propertyKey,
+        // 保存类到IOC容器
+        koatty_container.IOCContainer.saveClass(COMPONENT_SCHEDULED, targetClass, targetClass.name);
+        // 保存调度元数据到 IOC 容器
+        koatty_container.IOCContainer.attachClassMetadata(COMPONENT_SCHEDULED, DecoratorType.SCHEDULED, {
+            method: methodName,
             cron,
             timezone // 保存用户指定的值，可能为undefined
-        }, targetObj, propertyKey);
+        }, target, methodName);
     };
 }
 
@@ -709,12 +716,12 @@ async function initRedLock(options, app) {
  * @param {RedLockOptions} options - RedLock 配置选项
  * @param {Koatty} app - Koatty 应用实例
  */
-async function injectRedLock(options, app) {
+async function injectRedLock(_options, _app) {
     try {
         koatty_logger.DefaultLogger.Debug('Starting batch RedLock injection...');
-        const componentList = koatty_container.IOCContainer.listClass("COMPONENT");
+        const componentList = koatty_container.IOCContainer.listClass(COMPONENT_REDLOCK);
         for (const component of componentList) {
-            const classMetadata = koatty_container.IOCContainer.getClassMetadata('COMPONENT', DecoratorType.REDLOCK, component);
+            const classMetadata = koatty_container.IOCContainer.getClassMetadata(COMPONENT_REDLOCK, DecoratorType.REDLOCK, component.target);
             if (!classMetadata) {
                 continue;
             }
@@ -727,7 +734,7 @@ async function injectRedLock(options, app) {
                     }
                     // 查找所有RedLock方法的元数据
                     for (const [key, value] of Object.entries(metadata)) {
-                        if (key.startsWith('REDLOCK:')) {
+                        if (key.startsWith('REDLOCK')) {
                             const redlockData = value;
                             const targetMethod = instance[redlockData.method];
                             if (!koatty_lib.Helper.isFunction(targetMethod)) {
@@ -895,12 +902,12 @@ function redLockerDescriptor(descriptor, name, method, methodOptions) {
  * @param {RedLockOptions} options - RedLock 配置选项
  * @param {Koatty} app - Koatty 应用实例
  */
-async function injectSchedule(options, app) {
+async function injectSchedule(_options, _app) {
     try {
         koatty_logger.DefaultLogger.Debug('Starting batch schedule injection...');
-        const componentList = koatty_container.IOCContainer.listClass("COMPONENT");
+        const componentList = koatty_container.IOCContainer.listClass(COMPONENT_SCHEDULED);
         for (const component of componentList) {
-            const classMetadata = koatty_container.IOCContainer.getClassMetadata('COMPONENT', DecoratorType.SCHEDULED, component);
+            const classMetadata = koatty_container.IOCContainer.getClassMetadata(COMPONENT_SCHEDULED, DecoratorType.SCHEDULED, component.target);
             if (!classMetadata) {
                 continue;
             }
@@ -913,7 +920,7 @@ async function injectSchedule(options, app) {
                     }
                     // 查找所有调度方法的元数据
                     for (const [key, value] of Object.entries(metadata)) {
-                        if (key.startsWith('SCHEDULED:')) {
+                        if (key.startsWith('SCHEDULED')) {
                             const scheduleData = value;
                             const targetMethod = instance[scheduleData.method];
                             if (!koatty_lib.Helper.isFunction(targetMethod)) {
@@ -922,7 +929,7 @@ async function injectSchedule(options, app) {
                             }
                             const taskName = `${className}_${scheduleData.method}`;
                             const tz = getEffectiveTimezone(scheduleData.timezone);
-                            const cronJob = new cron.CronJob(scheduleData.cron, () => {
+                            new cron.CronJob(scheduleData.cron, () => {
                                 koatty_logger.DefaultLogger.Debug(`The schedule job ${taskName} started.`);
                                 Promise.resolve(targetMethod.call(instance))
                                     .then(() => {

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2025-06-21 14:09:54
+* @Date: 2025-06-22 20:33:45
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -21,6 +21,8 @@ import { CronJob } from 'cron';
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
+const COMPONENT_SCHEDULED = 'COMPONENT_SCHEDULED';
+const COMPONENT_REDLOCK = 'COMPONENT_REDLOCK';
 /**
  * Decorator types supported by the system
  */
@@ -182,9 +184,9 @@ function getEffectiveRedLockOptions(methodOptions) {
 function RedLock(lockName, options) {
     return (target, propertyKey, descriptor) => {
         const methodName = propertyKey.toString();
-        // 验证装饰器使用的类型
-        const targetObj = target;
-        const componentType = IOCContainer.getType(targetObj);
+        // 验证装饰器使用的类型（从原型对象获取类构造函数）
+        const targetClass = target.constructor;
+        const componentType = IOCContainer.getType(targetClass);
         if (componentType !== "SERVICE" && componentType !== "COMPONENT") {
             throw Error("@RedLock decorator can only be used on SERVICE or COMPONENT classes.");
         }
@@ -206,12 +208,14 @@ function RedLock(lockName, options) {
         if (options) {
             validateRedLockMethodOptions(options);
         }
+        // 保存类到IOC容器
+        IOCContainer.saveClass(COMPONENT_REDLOCK, targetClass, targetClass.name);
         // 保存RedLock元数据到 IOC 容器（lockName已确定）
-        IOCContainer.attachClassMetadata('COMPONENT', DecoratorType.REDLOCK, {
+        IOCContainer.attachClassMetadata(COMPONENT_REDLOCK, DecoratorType.REDLOCK, {
             method: methodName,
             name: lockName, // 确定的锁名称，不会为undefined
             options
-        }, targetObj, methodName);
+        }, target, methodName);
     };
 }
 
@@ -259,26 +263,29 @@ function Scheduled(cron, timezone) {
         throw Error("Timezone must be a string");
     }
     return (target, propertyKey, descriptor) => {
-        // 验证装饰器使用的类型
-        const targetObj = target;
-        const componentType = IOCContainer.getType(targetObj);
+        // 验证装饰器使用的类型（从原型对象获取类构造函数）
+        const targetClass = target.constructor;
+        const componentType = IOCContainer.getType(targetClass);
         if (componentType !== "SERVICE" && componentType !== "COMPONENT") {
             throw Error("@Scheduled decorator can only be used on SERVICE or COMPONENT classes.");
         }
         // 验证方法名
-        if (!propertyKey || typeof propertyKey !== 'string') {
+        const methodName = propertyKey.toString();
+        if (!methodName || typeof methodName !== 'string') {
             throw Error("Method name is required for @Scheduled decorator");
         }
         // 验证方法描述符
         if (!descriptor || typeof descriptor.value !== 'function') {
             throw Error("@Scheduled decorator can only be applied to methods");
         }
-        // 保存调度元数据到 IOC 容器（timezone如果用户未指定则保存为undefined，在injectSchedule中处理）
-        IOCContainer.attachClassMetadata('COMPONENT', DecoratorType.SCHEDULED, {
-            method: propertyKey,
+        // 保存类到IOC容器
+        IOCContainer.saveClass(COMPONENT_SCHEDULED, targetClass, targetClass.name);
+        // 保存调度元数据到 IOC 容器
+        IOCContainer.attachClassMetadata(COMPONENT_SCHEDULED, DecoratorType.SCHEDULED, {
+            method: methodName,
             cron,
             timezone // 保存用户指定的值，可能为undefined
-        }, targetObj, propertyKey);
+        }, target, methodName);
     };
 }
 
@@ -707,12 +714,12 @@ async function initRedLock(options, app) {
  * @param {RedLockOptions} options - RedLock 配置选项
  * @param {Koatty} app - Koatty 应用实例
  */
-async function injectRedLock(options, app) {
+async function injectRedLock(_options, _app) {
     try {
         DefaultLogger.Debug('Starting batch RedLock injection...');
-        const componentList = IOCContainer.listClass("COMPONENT");
+        const componentList = IOCContainer.listClass(COMPONENT_REDLOCK);
         for (const component of componentList) {
-            const classMetadata = IOCContainer.getClassMetadata('COMPONENT', DecoratorType.REDLOCK, component);
+            const classMetadata = IOCContainer.getClassMetadata(COMPONENT_REDLOCK, DecoratorType.REDLOCK, component.target);
             if (!classMetadata) {
                 continue;
             }
@@ -725,7 +732,7 @@ async function injectRedLock(options, app) {
                     }
                     // 查找所有RedLock方法的元数据
                     for (const [key, value] of Object.entries(metadata)) {
-                        if (key.startsWith('REDLOCK:')) {
+                        if (key.startsWith('REDLOCK')) {
                             const redlockData = value;
                             const targetMethod = instance[redlockData.method];
                             if (!Helper.isFunction(targetMethod)) {
@@ -893,12 +900,12 @@ function redLockerDescriptor(descriptor, name, method, methodOptions) {
  * @param {RedLockOptions} options - RedLock 配置选项
  * @param {Koatty} app - Koatty 应用实例
  */
-async function injectSchedule(options, app) {
+async function injectSchedule(_options, _app) {
     try {
         DefaultLogger.Debug('Starting batch schedule injection...');
-        const componentList = IOCContainer.listClass("COMPONENT");
+        const componentList = IOCContainer.listClass(COMPONENT_SCHEDULED);
         for (const component of componentList) {
-            const classMetadata = IOCContainer.getClassMetadata('COMPONENT', DecoratorType.SCHEDULED, component);
+            const classMetadata = IOCContainer.getClassMetadata(COMPONENT_SCHEDULED, DecoratorType.SCHEDULED, component.target);
             if (!classMetadata) {
                 continue;
             }
@@ -911,7 +918,7 @@ async function injectSchedule(options, app) {
                     }
                     // 查找所有调度方法的元数据
                     for (const [key, value] of Object.entries(metadata)) {
-                        if (key.startsWith('SCHEDULED:')) {
+                        if (key.startsWith('SCHEDULED')) {
                             const scheduleData = value;
                             const targetMethod = instance[scheduleData.method];
                             if (!Helper.isFunction(targetMethod)) {
@@ -920,7 +927,7 @@ async function injectSchedule(options, app) {
                             }
                             const taskName = `${className}_${scheduleData.method}`;
                             const tz = getEffectiveTimezone(scheduleData.timezone);
-                            const cronJob = new CronJob(scheduleData.cron, () => {
+                            new CronJob(scheduleData.cron, () => {
                                 DefaultLogger.Debug(`The schedule job ${taskName} started.`);
                                 Promise.resolve(targetMethod.call(instance))
                                     .then(() => {

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_schedule",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Schedule for koatty.",
   "scripts": {
     "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_schedule",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Schedule for koatty.",
   "scripts": {
     "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",