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

package/example/src/chevre/reIndex.ts

@@ -11,7 +11,7 @@ mongoose.Model.on('index', (...args) => {
 async function main() {
     await mongoose.connect(<string>process.env.MONGOLAB_URI, { autoIndex: false });
 
-    await chevre.repository.Member.createInstance(mongoose.connection);
+    await chevre.repository.Task.createInstance(mongoose.connection);
     console.log('success!');
 }
 

package/example/src/chevre/task/countTasks.ts

@@ -0,0 +1,50 @@
+// tslint:disable:no-console
+import * as mongoose from 'mongoose';
+
+import { chevre } from '../../../../lib/index';
+
+// const project = { id: String(process.env.PROJECT_ID) };
+
+mongoose.Model.on('index', (...args) => {
+    console.error('******** index event emitted. ********\n', args);
+});
+
+async function main() {
+    await mongoose.connect(<string>process.env.MONGOLAB_URI, { autoIndex: false });
+
+    const taskRepo = await chevre.repository.Task.createInstance(mongoose.connection);
+
+    setInterval(
+        async () => {
+            const readyTasksCountResult = await taskRepo.count({
+                limit: 100,
+                status: { $eq: chevre.factory.taskStatus.Ready },
+                runsThrough: new Date()
+            });
+            console.log('readyTasksCountResult:', readyTasksCountResult);
+
+            const readyTasks = await taskRepo.projectFields(
+                {
+                    limit: 10,
+                    status: { $eq: chevre.factory.taskStatus.Ready },
+                    runsThrough: new Date(),
+                    name: { $nin: [chevre.factory.taskName.DeleteTransaction] }
+                },
+                ['name']
+            );
+            console.log('readyTasks:', readyTasks);
+
+            const runningTasksCountResult = await taskRepo.count({
+                limit: 100,
+                status: { $eq: chevre.factory.taskStatus.Running }
+            });
+            console.log('runningTasksCountResult:', runningTasksCountResult);
+        },
+        // tslint:disable-next-line:no-magic-numbers
+        10000
+    );
+}
+
+main()
+    .then()
+    .catch(console.error);

package/lib/chevre/repo/mongoose/schemas/task.js

@@ -186,6 +186,15 @@ const indexes = [
             }
         }
     ],
+    [
+        { status: 1, lastTriedAt: 1, remainingNumberOfTries: 1, name: 1 },
+        {
+            name: 'abortMany',
+            partialFilterExpression: {
+                lastTriedAt: { $type: 'date' }
+            }
+        }
+    ],
     [
         { status: 1, expires: 1 },
         {

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

@@ -150,7 +150,11 @@ export declare class TaskRepo {
          * 十分に小さい数値を指定すれば、実質残り試行回数に関係なくRunningがReadyに変更されることになる
          */
         remainingNumberOfTries: {
-            $gt: number;
+            $gte?: number;
+            $lte?: number;
+        };
+        name: {
+            $in?: factory.taskName[];
         };
     }): Promise<UpdateWriteOpResult>;
     /**
@@ -163,6 +167,9 @@ export declare class TaskRepo {
     }): Promise<UpdateWriteOpResult>;
     abortMany(params: {
         intervalInMinutes: number;
+        name: {
+            $in?: factory.taskName[];
+        };
     }): Promise<UpdateWriteOpResult>;
     /**
      * タスクIDから実行結果とステータスを保管する

package/lib/chevre/repo/task.js

@@ -626,18 +626,16 @@ class TaskRepo {
             const lastTriedAtShoudBeLessThan = moment()
                 .add(-params.intervalInMinutes, 'minutes')
                 .toDate();
-            const remainingNumberOfTriesGt = params.remainingNumberOfTries.$gt;
-            return this.taskModel.updateMany(
-            // name: 'retry'のindexと連動しているので、条件の順序などには注意すること
-            // @see schemas/task
-            {
-                status: { $eq: factory.taskStatus.Running },
-                lastTriedAt: {
+            const remainingNumberOfTriesGte = params.remainingNumberOfTries.$gte;
+            const remainingNumberOfTriesLte = params.remainingNumberOfTries.$lte;
+            return this.taskModel.updateMany(Object.assign(Object.assign(Object.assign({ status: { $eq: factory.taskStatus.Running }, lastTriedAt: {
                     $type: 'date',
                     $lt: lastTriedAtShoudBeLessThan
-                },
-                remainingNumberOfTries: { $gt: remainingNumberOfTriesGt }
-            }, {
+                } }, (typeof remainingNumberOfTriesGte === 'number')
+                ? { remainingNumberOfTries: { $gte: remainingNumberOfTriesGte } }
+                : undefined), (typeof remainingNumberOfTriesLte === 'number')
+                ? { remainingNumberOfTries: { $lte: remainingNumberOfTriesLte } }
+                : undefined), (Array.isArray(params.name.$in)) ? { name: { $in: params.name.$in } } : undefined), {
                 $set: {
                     status: factory.taskStatus.Ready // 実行前に変更
                 }
@@ -706,14 +704,10 @@ class TaskRepo {
             const lastTriedAtShoudBeLessThan = moment()
                 .add(-params.intervalInMinutes, 'minutes')
                 .toDate();
-            return this.taskModel.updateMany({
-                status: { $eq: factory.taskStatus.Running },
-                lastTriedAt: {
+            return this.taskModel.updateMany(Object.assign({ status: { $eq: factory.taskStatus.Running }, lastTriedAt: {
                     $type: 'date',
                     $lt: lastTriedAtShoudBeLessThan
-                },
-                remainingNumberOfTries: { $eq: 0 }
-            }, {
+                }, remainingNumberOfTries: { $eq: 0 } }, (Array.isArray(params.name.$in)) ? { name: { $in: params.name.$in } } : undefined), {
                 $set: {
                     status: factory.taskStatus.Aborted,
                     dateAborted: new Date()

package/lib/chevre/service/taskHandler/onOperationFailed/informTaskIfNeeded.d.ts

@@ -0,0 +1,8 @@
+import * as factory from '../../../factory';
+import type { SettingRepo } from '../../../repo/setting';
+import type { IExecutableTask, TaskRepo } from '../../../repo/task';
+declare function informTaskIfNeeded(task: IExecutableTask<factory.taskName>): (repos: {
+    setting: SettingRepo;
+    task: TaskRepo;
+}) => Promise<void>;
+export { informTaskIfNeeded };

package/lib/chevre/service/taskHandler/onOperationFailed/informTaskIfNeeded.js

@@ -0,0 +1,82 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.informTaskIfNeeded = informTaskIfNeeded;
+const createDebug = require("debug");
+const factory = require("../../../factory");
+const debug = createDebug('chevre-domain:service:taskHandler:onOperationFailed');
+function createInformTasks(task, setting) {
+    var _a, _b;
+    const taskRunsAt = new Date();
+    const informTask = (_a = setting === null || setting === void 0 ? void 0 : setting.onTaskStatusChanged) === null || _a === void 0 ? void 0 : _a.informTask;
+    const informTaskNames = (_b = setting === null || setting === void 0 ? void 0 : setting.onTaskStatusChanged) === null || _b === void 0 ? void 0 : _b.informTaskNames;
+    const informTasks = [];
+    if (Array.isArray(informTaskNames) && informTaskNames.includes(task.name)) {
+        const { id, name, data, project, runsAt } = task;
+        const task4inform = {
+            id, name, data, project, runsAt,
+            status: factory.taskStatus.Aborted,
+            typeOf: 'Task'
+        };
+        const informIdentifier = `Task:${name}:${id}:${task4inform.status}`;
+        if (Array.isArray(informTask) && informTask.length > 0) {
+            informTask.forEach((informTaskParams) => {
+                var _a, _b;
+                if (typeof ((_a = informTaskParams.recipient) === null || _a === void 0 ? void 0 : _a.url) === 'string') {
+                    const informActionAttributes = {
+                        object: task4inform,
+                        recipient: {
+                            id: '',
+                            name: String((_b = informTaskParams.recipient) === null || _b === void 0 ? void 0 : _b.name),
+                            typeOf: factory.creativeWorkType.WebApplication
+                        },
+                        target: {
+                            httpMethod: 'POST',
+                            encodingType: factory.encodingFormat.Application.json,
+                            typeOf: 'EntryPoint',
+                            urlTemplate: informTaskParams.recipient.url
+                        },
+                        identifier: informIdentifier
+                    };
+                    const description = `inform aborting tasks to agg service: ${name} ${id}`;
+                    informTasks.push({
+                        project,
+                        name: factory.taskName.TriggerWebhook,
+                        status: factory.taskStatus.Ready,
+                        runsAt: taskRunsAt,
+                        remainingNumberOfTries: 10,
+                        numberOfTried: 0,
+                        executionResults: [],
+                        data: informActionAttributes,
+                        description
+                    });
+                }
+            });
+        }
+    }
+    return informTasks;
+}
+function informTaskIfNeeded(task) {
+    return (repos) => __awaiter(this, void 0, void 0, function* () {
+        const isAborting = task.status === factory.taskStatus.Running && task.remainingNumberOfTries <= 0;
+        const useInform = isAborting
+            && task.name !== factory.taskName.HandleNotification // nameで絞る
+            && task.name !== factory.taskName.TriggerWebhook;
+        if (useInform) {
+            const setting = yield repos.setting.findOne({ project: { id: { $eq: '*' } } }, ['onTaskStatusChanged']);
+            const informTasks = createInformTasks(task, setting);
+            debug('informTaskIfNeeded: creating inform tasks...', JSON.stringify(informTasks));
+            if (informTasks.length > 0) {
+                yield repos.task.saveMany(informTasks, { emitImmediately: true });
+            }
+        }
+    });
+}

package/lib/chevre/service/taskHandler/onOperationFailed.d.ts

@@ -0,0 +1,17 @@
+import type { INextFunction } from '../../eventEmitter/task';
+import * as factory from '../../factory';
+import type { SettingRepo } from '../../repo/setting';
+import type { IExecutableTask, TaskRepo } from '../../repo/task';
+/**
+ * タスク実行失敗時処理
+ */
+declare function onOperationFailed(params: {
+    task: IExecutableTask<factory.taskName>;
+    now: Date;
+    error: any;
+    next?: INextFunction;
+}): (repos: {
+    setting: SettingRepo;
+    task: TaskRepo;
+}) => Promise<void>;
+export { onOperationFailed };

package/lib/chevre/service/taskHandler/onOperationFailed.js

@@ -0,0 +1,64 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onOperationFailed = onOperationFailed;
+const factory = require("../../factory");
+const informTaskIfNeeded_1 = require("./onOperationFailed/informTaskIfNeeded");
+/**
+ * タスク実行失敗時処理
+ */
+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 {
+            // 分析連携(2025-08-05~)
+            // 設定されたnameの場合連携する
+            // もしここで連携タスク作成に失敗したとしても、再度Readyタスクとなりリトライされて、処理は冪等となる想定
+            // 最終的に、連携タスクが作成され、実行中タスクがAbortedとなればよい
+            yield (0, informTaskIfNeeded_1.informTaskIfNeeded)(task)(repos);
+            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);
+        }
+    });
+}

package/lib/chevre/service/taskHandler.d.ts

@@ -1,9 +1,9 @@
-import { SendGridCredentials } from '../credentials/sendGrid';
+import type { SendGridCredentials } from '../credentials/sendGrid';
 import type { IExecuteSettings as IMinimumExecuteSettings, INextFunction } from '../eventEmitter/task';
 import * as factory from '../factory';
 import type { IExecutableTask, IExecutableTaskKeys } from '../repo/task';
-import { Settings } from '../settings';
-import { AggregationSettings } from '../settings/aggregation';
+import type { Settings } from '../settings';
+import type { AggregationSettings } from '../settings/aggregation';
 interface ICredentialSettings {
     sendGrid: SendGridCredentials;
 }

package/lib/chevre/service/taskHandler.js

@@ -13,52 +13,8 @@ exports.executeTask = executeTask;
 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);
-        }
-    });
-}
+const onOperationFailed_1 = require("./taskHandler/onOperationFailed");
+const debug = createDebug('chevre-domain:service:taskHandler');
 /**
  * タスクを実行する
  */
@@ -67,6 +23,7 @@ function executeTask(task, next) {
     const now = new Date();
     debug('executing an executableTask...', task, now);
     return (settings, options) => __awaiter(this, void 0, void 0, function* () {
+        const settingRepo = new (yield Promise.resolve().then(() => require('../repo/setting'))).SettingRepo(settings.connection);
         const taskRepo = new (yield Promise.resolve().then(() => require('../repo/task'))).TaskRepo(settings.connection);
         try {
             // 期限検証(2024-04-23~)
@@ -133,7 +90,7 @@ function executeTask(task, next) {
         }
         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);
-            yield onOperationFailed(Object.assign({ task, now, error }, (typeof next === 'function') ? { next } : undefined))({ task: taskRepo });
+            yield (0, onOperationFailed_1.onOperationFailed)(Object.assign({ task, now, error }, (typeof next === 'function') ? { next } : undefined))({ setting: settingRepo, 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.20"
+  "version": "22.11.0-alpha.23"
 }