@chevre/domain 22.9.0-alpha.71 → 22.9.0-alpha.73

package/example/src/chevre/countPotentiallyExpired.ts

@@ -0,0 +1,28 @@
+// tslint:disable:no-console
+import * as moment from 'moment';
+import * as mongoose from 'mongoose';
+
+import { chevre } from '../../../lib/index';
+
+// const project = { id: String(process.env.PROJECT_ID) };
+
+// tslint:disable-next-line:max-func-body-length
+async function main() {
+    await mongoose.connect(<string>process.env.MONGOLAB_URI, { autoIndex: false });
+
+    const transactionRepo = await chevre.repository.Transaction.createInstance(mongoose.connection);
+    const result = await transactionRepo.countPotentiallyExpired({
+        expires: {
+            $lt: moment()
+                // tslint:disable-next-line:no-magic-numbers
+                .add(-60, 'seconds')
+                .toDate()
+        },
+        limit: 10
+    });
+    console.log('result', result);
+}
+
+main()
+    .then()
+    .catch(console.error);

package/example/src/chevre/notifyByEmail.ts

@@ -0,0 +1,56 @@
+// tslint:disable:no-console
+import * as moment from 'moment';
+import * as mongoose from 'mongoose';
+
+import { chevre } from '../../../lib/index';
+
+// const project = { id: String(process.env.PROJECT_ID) };
+
+async function main() {
+    await mongoose.connect(<string>process.env.MONGOLAB_URI, { autoIndex: false });
+
+    const taskRepo = await chevre.repository.Task.createInstance(mongoose.connection);
+    const sendGridCredentials = await chevre.credentials.SendGrid.createInstance({
+        apiKey: <string>process.env.SENDGRID_API_KEY,
+        alert: {
+            sender: {
+                name: 'xxx',
+                email: 'xxx'
+            },
+            toRecipient: [
+                { email: 'xxx' }
+            ]
+        }
+    });
+    const chevreSettings = new chevre.settings.Settings(<any>{
+        abortedTasksWithoutReport: [
+            chevre.factory.taskName.ImportEventCapacitiesFromCOA,
+            chevre.factory.taskName.ImportEventsFromCOA,
+            chevre.factory.taskName.ImportOffersFromCOA
+        ]
+    });
+
+    const result = await (await chevre.service.task.createService()).notifyAbortedTasksByEmail({
+        dateAbortedGte: moment()
+            // tslint:disable-next-line:no-magic-numbers
+            .add(-10, 'days')
+            .toDate()
+    })(
+        {
+            task: taskRepo
+        },
+        chevreSettings,
+        {
+            sendGrid: sendGridCredentials
+        }
+    );
+    // tslint:disable-next-line:no-null-keyword
+    console.dir(result, { depth: null });
+}
+
+main()
+    .then(console.log)
+    .catch((error) => {
+        // tslint:disable-next-line:no-null-keyword
+        console.dir(error, { depth: null });
+    });

package/lib/chevre/credentials/sendGrid.d.ts

@@ -1,11 +1,24 @@
+interface IAlert {
+    sender?: {
+        name: string;
+        email: string;
+    };
+    toRecipient?: [
+        {
+            email: string;
+        }
+    ];
+}
 interface IOptions {
     apiKey: string;
+    alert?: IAlert;
 }
 /**
  * SendGrid認証情報
  */
 declare class SendGridCredentials {
     readonly apiKey: string;
+    readonly alert?: IAlert;
     constructor(options: IOptions);
 }
 export { SendGridCredentials };

package/lib/chevre/credentials/sendGrid.js

@@ -6,8 +6,11 @@ exports.SendGridCredentials = void 0;
  */
 class SendGridCredentials {
     constructor(options) {
-        const { apiKey } = options;
+        const { apiKey, alert } = options;
         this.apiKey = apiKey;
+        if (alert !== undefined) {
+            this.alert = alert;
+        }
     }
 }
 exports.SendGridCredentials = SendGridCredentials;

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

@@ -168,6 +168,17 @@ export declare class TransactionRepo {
     setTasksExportedById(params: {
         id: string;
     }): Promise<void>;
+    /**
+     * add(2025-03-13~)
+     */
+    countPotentiallyExpired(params: {
+        expires: {
+            $lt: Date;
+        };
+        limit?: number;
+    }): Promise<{
+        count: number;
+    }>;
     /**
      * add(2025-03-03~)
      */

package/lib/chevre/repo/transaction.js

@@ -793,6 +793,24 @@ class TransactionRepo {
                 .exec();
         });
     }
+    /**
+     * add(2025-03-13~)
+     */
+    countPotentiallyExpired(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { expires, limit } = params;
+            const query = this.transactionModel.countDocuments({
+                status: { $eq: factory.transactionStatusType.InProgress },
+                expires: { $lt: expires.$lt }
+            });
+            if (typeof limit === 'number' && limit >= 0) {
+                query.limit(limit);
+            }
+            const count = yield query.setOptions({ maxTimeMS: settings_1.MONGO_MAX_TIME_MS })
+                .exec();
+            return { count };
+        });
+    }
     /**
      * add(2025-03-03~)
      */

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

@@ -24,6 +24,15 @@ declare function sendEmailMessage(params: factory.task.sendEmailMessage.IActionA
 }, credentials: {
     sendGrid: SendGridCredentials;
 }) => Promise<void>;
+declare function notifyByEmail(params: {
+    subject: string;
+    content: string;
+    logLevel: LineNotifyLogLevel;
+}): (__: {}, credentials: {
+    sendGrid: SendGridCredentials;
+}) => Promise<{
+    result: import("@chevre/factory/lib/action/transfer/send/message/email").IResult;
+}>;
 type LineNotifyLogLevel = 'log' | 'error' | 'info';
 declare function lineNotify({ subject, content, imageThumbnail, imageFullsize, logLevel }: {
     subject: string;
@@ -41,4 +50,4 @@ declare function triggerWebhook(params: factory.task.IData<factory.taskName.Trig
     potentialAction: PotentialActionRepo;
     setting: SettingRepo;
 }) => Promise<void>;
-export { lineNotify, sendEmailMessage, triggerWebhook };
+export { lineNotify, notifyByEmail, sendEmailMessage, triggerWebhook };

package/lib/chevre/service/notification.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lineNotify = lineNotify;
+exports.notifyByEmail = notifyByEmail;
 exports.sendEmailMessage = sendEmailMessage;
 exports.triggerWebhook = triggerWebhook;
 const sgMail = require("@sendgrid/mail");
@@ -133,6 +134,114 @@ function sendEmailMessage(params) {
         yield repos.action.completeWithVoid({ typeOf: action.typeOf, id: action.id, result: result, recipe });
     });
 }
+// tslint:disable-next-line:max-func-body-length
+function notifyByEmail(params
+// options: {
+//     timeout: number;
+//     useFetchAPI: boolean;
+// }
+) {
+    // tslint:disable-next-line:cyclomatic-complexity max-func-body-length
+    return (__, credentials) => __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const shortSubject = params.subject;
+        const message = util.format('\n%s\n%s\n%s\n%s\n%s\n\n%s', `[${params.logLevel}] ${shortSubject}`, `now:${(new Date()).toISOString()}`, `pid:${process.pid}`, `GAE_APPLICATION:${process.env.GAE_APPLICATION}`, 
+        // `GAE_INSTANCE:${process.env.GAE_INSTANCE}`,
+        `GAE_SERVICE:${process.env.GAE_SERVICE}`, params.content);
+        let msg;
+        let result = {};
+        try {
+            const apiKey = credentials.sendGrid.apiKey;
+            if (typeof apiKey !== 'string') {
+                throw new factory.errors.Internal('API Key not found');
+            }
+            sgMail.setApiKey(apiKey);
+            const senderName = (_b = (_a = credentials.sendGrid.alert) === null || _a === void 0 ? void 0 : _a.sender) === null || _b === void 0 ? void 0 : _b.name;
+            const senderEmail = (_d = (_c = credentials.sendGrid.alert) === null || _c === void 0 ? void 0 : _c.sender) === null || _d === void 0 ? void 0 : _d.email;
+            const toRecipientEmail = (Array.isArray((_e = credentials.sendGrid.alert) === null || _e === void 0 ? void 0 : _e.toRecipient))
+                ? (_g = (_f = credentials.sendGrid.alert) === null || _f === void 0 ? void 0 : _f.toRecipient.at(0)) === null || _g === void 0 ? void 0 : _g.email
+                : undefined;
+            if (typeof senderName !== 'string') {
+                throw new factory.errors.Internal('senderName not found');
+            }
+            if (typeof senderEmail !== 'string') {
+                throw new factory.errors.Internal('senderEmail not found');
+            }
+            if (typeof toRecipientEmail !== 'string') {
+                throw new factory.errors.Internal('toRecipientEmail not found');
+            }
+            const emailMessage = {
+                about: {
+                    typeOf: 'Thing',
+                    identifier: 'TaskAborted',
+                    name: shortSubject
+                },
+                identifier: 'taskAborted',
+                sender: {
+                    name: senderName,
+                    email: senderEmail
+                },
+                text: message,
+                toRecipient: [{
+                        name: 'developers',
+                        email: toRecipientEmail
+                    }],
+                typeOf: factory.creativeWorkType.EmailMessage
+            };
+            const emailMessageFrom = {
+                name: emailMessage.sender.name,
+                email: emailMessage.sender.email
+            };
+            let subject;
+            // 互換性維持対応として、String型に対応
+            if (typeof emailMessage.about === 'string') {
+                if (String(emailMessage.about).length > 0) {
+                    subject = String(emailMessage.about);
+                }
+            }
+            else if (typeof ((_h = emailMessage.about) === null || _h === void 0 ? void 0 : _h.name) === 'string') {
+                if (emailMessage.about.name.length > 0) {
+                    subject = emailMessage.about.name;
+                }
+            }
+            const emailDatas = (Array.isArray(emailMessage.toRecipient))
+                ? emailMessage.toRecipient.map((toRecipient) => {
+                    return {
+                        name: toRecipient.name,
+                        email: toRecipient.email
+                    };
+                })
+                // Arrayでない時期への互換性維持対応
+                : [{
+                        name: emailMessage.toRecipient.name,
+                        email: emailMessage.toRecipient.email
+                    }];
+            msg = Object.assign(Object.assign(Object.assign({ to: emailDatas, from: emailMessageFrom }, (typeof subject === 'string') ? { subject } : undefined), (String(emailMessage.text).length > 0) ? { text: String(emailMessage.text) } : undefined), { 
+                // html: '<strong>and easy to do anywhere, even with Node.js</strong>',
+                // categories: ['Transactional', 'My category'],
+                // 送信予定を追加することもできるが、タスクの実行予定日時でコントロールする想定
+                // sendAt: moment(email.send_at).unix(),
+                // 追跡用に通知IDをカスタムフィールドとしてセットする
+                customArgs: {
+                    emailMessage: emailMessage.identifier
+                    // actionId: action.id,
+                    // projectId: project.id
+                } });
+            // mlutiple recipients対応(2023-03-06~)
+            const response = yield sgMail.sendMultiple(msg);
+            // check the response.
+            if (response[0].statusCode !== http_status_1.ACCEPTED) {
+                throw new factory.errors.Internal(`sendgrid request not accepted. response is ${util.inspect(response)}`);
+            }
+            const { statusCode, statusMessage } = response[0];
+            result = { statusCode, statusMessage };
+        }
+        catch (error) {
+            throw error;
+        }
+        return { result };
+    });
+}
 const MAX_LINE_NOTIFY_SUBJECT_LENGTH = 100;
 function lineNotify({ subject, content, imageThumbnail, imageFullsize, logLevel }
 // options: {

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

@@ -72,14 +72,17 @@ declare function execute(task: IExecutableTask<factory.taskName>): IOperationExe
 /**
  * トライ可能回数が0に達したタスクを実行中止する
  */
-declare function abort(params: {
-    /**
-     * 最終トライ日時から何分経過したタスクを中止するか
-     */
-    intervalInMinutes: number;
-    notify: boolean;
-}): TaskOperation<void>;
 declare function notifyAbortedTasks(params: {
     dateAbortedGte: Date;
 }): TaskOperation<void>;
-export { ICallResult, IExecutableTaskKeys, IOperationExecute, executeById, executeOneIfExists, execute, abort, notifyAbortedTasks };
+/**
+ * add(2025-03-13~)
+ */
+declare function notifyAbortedTasksByEmail(params: {
+    dateAbortedGte: Date;
+}): (repos: {
+    task: TaskRepo;
+}, settings: Pick<Settings, "abortedTasksWithoutReport">, credentials: {
+    sendGrid: SendGridCredentials;
+}) => Promise<void>;
+export { ICallResult, IExecutableTaskKeys, IOperationExecute, executeById, executeOneIfExists, execute, notifyAbortedTasks, notifyAbortedTasksByEmail };

package/lib/chevre/service/task.js

@@ -12,8 +12,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeById = executeById;
 exports.executeOneIfExists = executeOneIfExists;
 exports.execute = execute;
-exports.abort = abort;
 exports.notifyAbortedTasks = notifyAbortedTasks;
+exports.notifyAbortedTasksByEmail = notifyAbortedTasksByEmail;
 /**
  * タスクサービス
  */
@@ -154,25 +154,62 @@ let notification;
 /**
  * トライ可能回数が0に達したタスクを実行中止する
  */
-function abort(params) {
+// function abort(params: {
+//     /**
+//      * 最終トライ日時から何分経過したタスクを中止するか
+//      */
+//     intervalInMinutes: number;
+//     notify: boolean;
+// }): TaskOperation<void> {
+//     return async (
+//         repos: {
+//             setting: SettingRepo;
+//             task: TaskRepo;
+//         },
+//         settings: Pick<Settings, 'abortedTasksWithoutReport'>,
+//         credentials: {
+//             lineNotify: LINENotifyCredentials;
+//         }
+//     ) => {
+//         const { abortedTasksWithoutReport } = settings;
+//         const abortedTask = await repos.task.abortOne(params);
+//         // tslint:disable-next-line:no-single-line-block-comment
+//         /* istanbul ignore if */
+//         if (abortedTask === null) {
+//             return;
+//         }
+//         if (params.notify === true) {
+//             // 中止を報告しないタスクであれば終了
+//             if (abortedTasksWithoutReport.includes(abortedTask.name)) {
+//                 return;
+//             }
+//             if (notification === undefined) {
+//                 notification = await import('./notification');
+//             }
+//             // 開発者へ報告
+//             const message = task2lineNotify({ task: abortedTask });
+//             await notification.lineNotify(
+//                 {
+//                     subject: message.subject, content: message.content,
+//                     logLevel: 'error'
+//                 }
+//                 // { timeout, useFetchAPI }
+//             )(undefined, credentials);
+//         }
+//     };
+// }
+function notifyAbortedTasks(params) {
     return (repos, settings, credentials) => __awaiter(this, void 0, void 0, function* () {
         const { abortedTasksWithoutReport } = settings;
-        const abortedTask = yield repos.task.abortOne(params);
-        // tslint:disable-next-line:no-single-line-block-comment
-        /* istanbul ignore if */
-        if (abortedTask === null) {
-            return;
-        }
-        if (params.notify === true) {
-            // 中止を報告しないタスクであれば終了
-            if (abortedTasksWithoutReport.includes(abortedTask.name)) {
-                return;
-            }
+        const abortedTasks = yield repos.task.projectFields(Object.assign({ statuses: [factory.taskStatus.Aborted], dateAborted: { $gte: params.dateAbortedGte } }, (abortedTasksWithoutReport.length > 0)
+            ? { name: { $nin: abortedTasksWithoutReport } }
+            : undefined), []);
+        if (abortedTasks.length > 0) {
             if (notification === undefined) {
                 notification = yield Promise.resolve().then(() => require('./notification'));
             }
             // 開発者へ報告
-            const message = (0, factory_1.task2lineNotify)({ task: abortedTask });
+            const message = (0, factory_1.tasks2lineNotify)({ tasks: abortedTasks });
             yield notification.lineNotify({
                 subject: message.subject, content: message.content,
                 logLevel: 'error'
@@ -182,7 +219,10 @@ function abort(params) {
         }
     });
 }
-function notifyAbortedTasks(params) {
+/**
+ * add(2025-03-13~)
+ */
+function notifyAbortedTasksByEmail(params) {
     return (repos, settings, credentials) => __awaiter(this, void 0, void 0, function* () {
         const { abortedTasksWithoutReport } = settings;
         const abortedTasks = yield repos.task.projectFields(Object.assign({ statuses: [factory.taskStatus.Aborted], dateAborted: { $gte: params.dateAbortedGte } }, (abortedTasksWithoutReport.length > 0)
@@ -194,12 +234,11 @@ function notifyAbortedTasks(params) {
             }
             // 開発者へ報告
             const message = (0, factory_1.tasks2lineNotify)({ tasks: abortedTasks });
-            yield notification.lineNotify({
+            const notifyResult = yield notification.notifyByEmail({
                 subject: message.subject, content: message.content,
                 logLevel: 'error'
-            }
-            // { timeout, useFetchAPI }
-            )(undefined, credentials);
+            })({}, credentials);
+            debug('notifyResult:', notifyResult);
         }
     });
 }

package/package.json

@@ -112,5 +112,5 @@
     "postversion": "git push origin --tags",
     "prepublishOnly": "npm run clean && npm run build && npm test && npm run doc"
   },
-  "version": "22.9.0-alpha.71"
+  "version": "22.9.0-alpha.73"
 }