@chevre/domain 22.11.0-alpha.19 → 22.11.0-alpha.20

package/example/src/chevre/settings/addSettings.ts

@@ -24,7 +24,9 @@ async function main() {
                         url: INFORM_TASK_AGG_URL
                     }
                 }],
-                informTaskNames: []
+                informTaskNames: [
+                    chevre.factory.taskName.Pay
+                ]
             }
         }
     );

package/lib/chevre/eventEmitter/task.d.ts

@@ -33,7 +33,7 @@ interface IRunningTask {
  */
 interface IExecutedTask {
     id: string;
-    status: factory.taskStatus.Executed | factory.taskStatus.Running;
+    status: factory.taskStatus.Executed | factory.taskStatus.Running | factory.taskStatus.Aborted;
     executionResult: factory.task.IExecutionResult;
     /**
      * 実行されたタスクの残り試行回数

package/lib/chevre/repo/task.d.ts

@@ -70,6 +70,10 @@ export declare class TaskRepo {
      */
     createDeleteTransactionTaskIfNotExist(params: Pick<factory.task.IAttributes<factory.taskName.DeleteTransaction>, 'data' | 'executionResults' | 'name' | 'numberOfTried' | 'project' | 'remainingNumberOfTries' | 'runsAt' | 'status'>, options: IOptionOnCreate): Promise<void>;
     createOnAssetTransactionStatusChangedTaskIfNotExist(params: Pick<factory.task.IAttributes<factory.taskName.OnAssetTransactionStatusChanged>, 'data' | 'executionResults' | 'name' | 'numberOfTried' | 'project' | 'remainingNumberOfTries' | 'runsAt' | 'status'>, options: IOptionOnCreate): Promise<void>;
+    /**
+     * Ready -> remainingNumberOfTriesが1減る
+     * Running -> findOneするだけ
+     */
     executeOneById(params: {
         id: string;
         status: factory.taskStatus.Ready | factory.taskStatus.Running;
@@ -79,7 +83,7 @@ export declare class TaskRepo {
         expires?: Date;
     }): Promise<IExecutableTask<factory.taskName> | null>;
     /**
-     * support no name(2025-03-04~)
+     * Readyのタスクをname指定でひとつRunningに変更する
      */
     executeOneIfExists(params: {
         name?: {
@@ -126,21 +130,28 @@ export declare class TaskRepo {
             numberOfTried?: factory.sortType;
             runsAt: factory.sortType;
         };
-    }, next: INextFunction): Promise<Pick<factory.task.ITask<factory.taskName>, 'id' | 'name'> | null>;
+    }, next?: INextFunction): Promise<Pick<factory.task.ITask<factory.taskName>, 'id' | 'name'> | null>;
     /**
      * emit OnTaskStatusChanged on delayed tasks
      */
     /**
-     * make tasks expired
+     * Readyのままで期限切れのタスクをExpiredに変更する
      */
     makeExpiredMany(params: {
         expiresLt: Date;
     }): Promise<UpdateWriteOpResult>;
     /**
-     * 実行中ステータスのままになっているタスクをリトライする
+     * Runningのまま一定期間超過し、かつ、remainingNumberOfTries>0のタスクをReadyに変更する
      */
-    retry(params: {
+    retryMany(params: {
         intervalInMinutes: number;
+        /**
+         * リトライ条件に残り試行回数条件を追加する
+         * 十分に小さい数値を指定すれば、実質残り試行回数に関係なくRunningがReadyに変更されることになる
+         */
+        remainingNumberOfTries: {
+            $gt: number;
+        };
     }): Promise<UpdateWriteOpResult>;
     /**
      * 実行中止済タスクを強制的にリトライ
@@ -154,17 +165,20 @@ export declare class TaskRepo {
         intervalInMinutes: number;
     }): Promise<UpdateWriteOpResult>;
     /**
-     * 実行結果を保管する
+     * タスクIDから実行結果とステータスを保管する
+     * Abortedの場合、dateAbortedもセットする
      */
-    pushExecutionResultById(params: {
+    setExecutionResultAndStatus(params: {
         /**
          * タスクID
          */
         id: string;
-        status: factory.taskStatus.Executed | factory.taskStatus.Running;
         remainingNumberOfTries: number;
         name: factory.taskName;
-    }, executionResult: factory.task.IExecutionResult, next?: INextFunction): Promise<void>;
+    }, update: {
+        status: factory.taskStatus.Executed | factory.taskStatus.Running | factory.taskStatus.Aborted;
+        executionResult: factory.task.IExecutionResult;
+    }, next?: INextFunction): Promise<void>;
     count(params: factory.task.ISearchConditions): Promise<{
         count: number;
     }>;

package/lib/chevre/repo/task.js

@@ -352,6 +352,10 @@ class TaskRepo {
             }
         });
     }
+    /**
+     * Ready -> remainingNumberOfTriesが1減る
+     * Running -> findOneするだけ
+     */
     executeOneById(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const now = new Date();
@@ -386,7 +390,7 @@ class TaskRepo {
         });
     }
     /**
-     * support no name(2025-03-04~)
+     * Readyのタスクをname指定でひとつRunningに変更する
      */
     executeOneIfExists(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -489,7 +493,7 @@ class TaskRepo {
             task_1.taskEventEmitter.emitTaskStatusChanged({
                 id: doc.id,
                 status: factory.taskStatus.Running
-            }, next);
+            }, (typeof next === 'function') ? next : undefined);
             return doc;
         });
     }
@@ -595,7 +599,7 @@ class TaskRepo {
     //     return delayedTasks;
     // }
     /**
-     * make tasks expired
+     * Readyのままで期限切れのタスクをExpiredに変更する
      */
     makeExpiredMany(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -615,20 +619,24 @@ class TaskRepo {
         });
     }
     /**
-     * 実行中ステータスのままになっているタスクをリトライする
+     * Runningのまま一定期間超過し、かつ、remainingNumberOfTries>0のタスクをReadyに変更する
      */
-    retry(params) {
+    retryMany(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const lastTriedAtShoudBeLessThan = moment()
                 .add(-params.intervalInMinutes, 'minutes')
                 .toDate();
-            return this.taskModel.updateMany({
+            const remainingNumberOfTriesGt = params.remainingNumberOfTries.$gt;
+            return this.taskModel.updateMany(
+            // name: 'retry'のindexと連動しているので、条件の順序などには注意すること
+            // @see schemas/task
+            {
                 status: { $eq: factory.taskStatus.Running },
                 lastTriedAt: {
                     $type: 'date',
                     $lt: lastTriedAtShoudBeLessThan
                 },
-                remainingNumberOfTries: { $gt: 0 }
+                remainingNumberOfTries: { $gt: remainingNumberOfTriesGt }
             }, {
                 $set: {
                     status: factory.taskStatus.Ready // 実行前に変更
@@ -715,15 +723,18 @@ class TaskRepo {
         });
     }
     /**
-     * 実行結果を保管する
+     * タスクIDから実行結果とステータスを保管する
+     * Abortedの場合、dateAbortedもセットする
      */
-    pushExecutionResultById(params, executionResult, 
+    setExecutionResultAndStatus(params, update, 
     // support customr function(2025-05-25~)
     next) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { id, status, remainingNumberOfTries, name } = params;
+            const { id, remainingNumberOfTries, name } = params;
+            const { status, executionResult } = update;
             yield this.taskModel.updateOne({ _id: { $eq: id } }, {
-                $set: { status },
+                $set: Object.assign({ status }, (status === factory.taskStatus.Aborted) ? { dateAborted: executionResult.endDate } : undefined // 2025-08-04~
+                ),
                 $push: { executionResults: executionResult }
             })
                 .exec();

package/lib/chevre/service/taskHandler.js

@@ -14,6 +14,51 @@ const createDebug = require("debug");
 const moment = require("moment");
 const factory = require("../factory");
 const debug = createDebug('chevre-domain:service:task');
+/**
+ * タスク実行失敗時処理
+ */
+function onOperationFailed(params) {
+    return (repos) => __awaiter(this, void 0, void 0, function* () {
+        let error = params.error;
+        const { task, now, next } = params;
+        if (typeof error !== 'object') {
+            error = { message: String(error) };
+        }
+        // remainingNumberOfTries<=0ならAborted(2025-08-04~)
+        const isRetryable = task.remainingNumberOfTries > 0;
+        if (isRetryable) {
+            const result = {
+                executedAt: now,
+                endDate: new Date(),
+                error: Object.assign(Object.assign({}, error), { code: error.code, message: error.message, name: error.name, stack: error.stack })
+            };
+            // 失敗してもここではステータスを戻さない(Runningのまま待機)
+            yield repos.task.setExecutionResultAndStatus({
+                id: task.id,
+                remainingNumberOfTries: task.remainingNumberOfTries,
+                name: task.name
+            }, {
+                status: task.status,
+                executionResult: result
+            }, (typeof next === 'function') ? next : undefined);
+        }
+        else {
+            const result = {
+                executedAt: now,
+                endDate: new Date(),
+                error: Object.assign(Object.assign({}, error), { code: error.code, message: error.message, name: error.name, stack: error.stack })
+            };
+            yield repos.task.setExecutionResultAndStatus({
+                id: task.id,
+                remainingNumberOfTries: task.remainingNumberOfTries,
+                name: task.name
+            }, {
+                status: factory.taskStatus.Aborted,
+                executionResult: result
+            }, (typeof next === 'function') ? next : undefined);
+        }
+    });
+}
 /**
  * タスクを実行する
  */
@@ -32,6 +77,13 @@ function executeTask(task, next) {
                     throw new factory.errors.Internal(`task expired [expires:${task.expires}]`);
                 }
             }
+            // remainingNumberOfTries<0ならcallを実行しない(2025-08-04~)
+            // リトライを繰り返した後、不明の原因でRunningのまま残ってしまったタスクがリトライされたケース
+            const { remainingNumberOfTries } = task;
+            const isCallable = remainingNumberOfTries >= 0;
+            if (!isCallable) {
+                throw new factory.errors.Internal(`task remainingNumberOfTries < 0 [remainingNumberOfTries:${remainingNumberOfTries}]`);
+            }
             // タスク名の関数が定義されていなければ、TypeErrorとなる
             let callResult;
             const { call } = yield Promise.resolve(`${`./task/${task.name}`}`).then(s => require(s));
@@ -70,31 +122,18 @@ function executeTask(task, next) {
                 error: ((callResult === null || callResult === void 0 ? void 0 : callResult.error) instanceof Error)
                     ? Object.assign(Object.assign({}, callResult.error), { message: callResult.error.message }) : ''
             };
-            yield taskRepo.pushExecutionResultById({
+            yield taskRepo.setExecutionResultAndStatus({
                 id: task.id,
-                status: factory.taskStatus.Executed,
-                remainingNumberOfTries: task.remainingNumberOfTries,
+                remainingNumberOfTries,
                 name: task.name
-            }, result, (typeof next === 'function') ? next : undefined);
+            }, {
+                status: factory.taskStatus.Executed,
+                executionResult: result
+            }, (typeof next === 'function') ? next : undefined);
         }
         catch (error) {
             debug('service.task.execute throwed an error. task:', task.name, task.id, 'error:', error === null || error === void 0 ? void 0 : error.name, error === null || error === void 0 ? void 0 : error.message);
-            if (typeof error !== 'object') {
-                error = { message: String(error) };
-            }
-            // 実行結果追加
-            const result = {
-                executedAt: now,
-                endDate: new Date(),
-                error: Object.assign(Object.assign({}, error), { code: error.code, message: error.message, name: error.name, stack: error.stack })
-            };
-            // 失敗してもここではステータスを戻さない(Runningのまま待機)
-            yield taskRepo.pushExecutionResultById({
-                id: task.id,
-                status: task.status,
-                remainingNumberOfTries: task.remainingNumberOfTries,
-                name: task.name
-            }, result, (typeof next === 'function') ? next : undefined);
+            yield onOperationFailed(Object.assign({ task, now, error }, (typeof next === 'function') ? { next } : undefined))({ task: taskRepo });
         }
     });
 }

package/package.json

@@ -115,5 +115,5 @@
     "postversion": "git push origin --tags",
     "prepublishOnly": "npm run clean && npm run build && npm test && npm run doc"
   },
-  "version": "22.11.0-alpha.19"
+  "version": "22.11.0-alpha.20"
 }