@chevre/domain 22.11.0-alpha.9 → 22.11.0

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

@@ -23,7 +23,9 @@ interface IOptionOnCreate {
     emitImmediately: boolean;
 }
 export type IExecutableTaskKeys = 'data' | 'id' | 'name' | 'status' | 'numberOfTried' | 'project' | 'remainingNumberOfTries' | 'runsAt' | 'expires';
-export type IExecutableTask<T extends factory.taskName> = Pick<factory.task.ITask<T>, IExecutableTaskKeys>;
+export type IExecutableTask<T extends factory.taskName> = Pick<factory.task.ITask<T>, IExecutableTaskKeys> & {
+    status: factory.taskStatus.Running;
+};
 type IKeyOfProjection = keyof factory.task.ITask<factory.taskName>;
 type ICreatingTask = Pick<factory.task.IAttributes<factory.taskName>, 'data' | 'executionResults' | 'name' | 'numberOfTried' | 'project' | 'remainingNumberOfTries' | 'runsAt' | 'status' | 'identifier' | 'description'>;
 /**
@@ -68,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;
@@ -77,12 +83,11 @@ export declare class TaskRepo {
         expires?: Date;
     }): Promise<IExecutableTask<factory.taskName> | null>;
     /**
-     * support no name(2025-03-04~)
+     * Readyのタスクをname指定でひとつRunningに変更する
      */
     executeOneIfExists(params: {
-        name?: {
-            $eq?: factory.taskName;
-            $nin?: factory.taskName[];
+        name: {
+            $eq: factory.taskName;
         };
         executor: {
             name: string;
@@ -90,6 +95,10 @@ export declare class TaskRepo {
         runsAt: {
             $lt: Date;
         };
+        sort: {
+            numberOfTried?: factory.sortType;
+            runsAt?: factory.sortType;
+        };
     }): Promise<IExecutableTask<factory.taskName> | null>;
     /**
      * add(2025-03-16~)
@@ -97,7 +106,7 @@ export declare class TaskRepo {
     countPotentiallyRunning(params: {
         name?: {
             $eq?: factory.taskName;
-            $nin?: factory.taskName[];
+            $in?: factory.taskName[];
         };
         runsAt: {
             $lt: Date;
@@ -106,45 +115,54 @@ export declare class TaskRepo {
     }): Promise<{
         count: number;
     }>;
+    /**
+     * 実行日時を一定期間過ぎたReadyタスクについて、Runningスタータスに変更した上で、Runningイベントを発生させる
+     */
     emitRunningIfExists(params: {
-        name?: {
-            $eq?: factory.taskName;
-            $nin?: factory.taskName[];
-        };
-        executor: {
-            name: string;
+        /**
+         * 必ずタスク名指定で実行する
+         */
+        name: {
+            $eq: factory.taskName;
+            $in?: never;
+        } | {
+            $eq?: never;
+            $in: factory.taskName[];
         };
         runsAt: {
             $lt: Date;
         };
         sort: {
             numberOfTried?: factory.sortType;
-            runsAt: factory.sortType;
+            runsAt?: factory.sortType;
         };
-    }): Promise<Pick<factory.task.ITask<factory.taskName>, 'id' | 'name'> | null>;
-    findExecutableOne(params: {
-        name?: {
-            $eq?: factory.taskName;
-            $nin?: factory.taskName[];
-        };
-        runsAt: {
-            $lt: Date;
+        executor: {
+            name: string;
         };
-    }): Promise<IExecutableTask<factory.taskName> | null>;
-    /**
-     * emit OnTaskStatusChanged on delayed tasks
-     */
+        nameFilterBeforeRunsAt: boolean;
+    }, next?: INextFunction): Promise<Pick<factory.task.ITask<factory.taskName>, 'id' | 'name'> | null>;
     /**
-     * make tasks expired
+     * Readyのままで期限切れのタスクをExpiredに変更する
      */
     makeExpiredMany(params: {
         expiresLt: Date;
     }): Promise<UpdateWriteOpResult>;
     /**
-     * 実行中ステータスのままになっているタスクをリトライする
+     * Runningのまま一定期間超過し、かつ、remainingNumberOfTries>0のタスクをReadyに変更する
      */
-    retry(params: {
+    retryMany(params: {
         intervalInMinutes: number;
+        /**
+         * リトライ条件に残り試行回数条件を追加する
+         * 十分に小さい数値を指定すれば、実質残り試行回数に関係なくRunningがReadyに変更されることになる
+         */
+        remainingNumberOfTries: {
+            $gte?: number;
+            $lte?: number;
+        };
+        name: {
+            $in?: factory.taskName[];
+        };
     }): Promise<UpdateWriteOpResult>;
     /**
      * 実行中止済タスクを強制的にリトライ
@@ -154,25 +172,27 @@ export declare class TaskRepo {
         id: string;
         remainingNumberOfTries: number;
     }): Promise<UpdateWriteOpResult>;
-    abortOne(params: {
-        intervalInMinutes: number;
-    }): Promise<factory.task.ITask<factory.taskName> | null>;
     abortMany(params: {
         intervalInMinutes: number;
+        name: {
+            $in?: factory.taskName[];
+        };
     }): Promise<UpdateWriteOpResult>;
     /**
-     * 実行結果を保管する
+     * タスクIDから実行結果とステータスを保管する
+     * Abortedの場合、dateAbortedもセットする
      */
-    pushExecutionResultById(params: {
+    setExecutionResultAndStatus(params: {
         /**
          * タスクID
          */
         id: string;
-        status: factory.taskStatus;
-    }, executionResult: factory.task.IExecutionResult, next?: INextFunction): Promise<void>;
-    /**
-     * 特定タスク検索
-     */
+        remainingNumberOfTries: number;
+        name: factory.taskName;
+    }, 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;
     }>;