wingbot-mongodb 2.16.3 → 2.19.0

package/src/ChatLogStorage.js

@@ -3,12 +3,13 @@
 */
 'use strict';
 
-const mongodb = require('mongodb'); // eslint-disable-line no-unused-vars
 const BaseStorage = require('./BaseStorage');
 
 const PAGE_SENDER_TIMESTAMP = 'pageId_1_senderId_1_timestamp_-1';
 const TIMESTAMP = 'timestamp_1';
 
+/** @typedef {import('mongodb/lib/db')} Db */
+
 /**
  * Storage for conversation logs
  *
@@ -18,12 +19,13 @@ class ChatLogStorage extends BaseStorage {
 
     /**
      *
-     * @param {mongodb.Db|{():Promise<mongodb.Db>}} mongoDb
+     * @param {Db|{():Promise<Db>}} mongoDb
      * @param {string} collectionName
      * @param {{error:Function,log:Function}} [log] - console like logger
-     * @param {boolean} isCosmo
+     * @param {boolean} [isCosmo]
+     * @param {string|Promise<string>} [secret]
      */
-    constructor (mongoDb, collectionName = 'chatlogs', log = console, isCosmo = false) {
+    constructor (mongoDb, collectionName = 'chatlogs', log = console, isCosmo = false, secret = null) {
         super(mongoDb, collectionName, log, isCosmo);
 
         this.addIndex({
@@ -43,6 +45,7 @@ class ChatLogStorage extends BaseStorage {
         }
 
         this.muteErrors = true;
+        this._secret = secret;
     }
 
     /**
@@ -54,6 +57,7 @@ class ChatLogStorage extends BaseStorage {
      * @param {number} [limit]
      * @param {number} [endAt] - iterate backwards to history
      * @param {number} [startAt] - iterate forward to last interaction
+     * @returns {Promise<object[]>}
      */
     async getInteractions (senderId, pageId, limit = 10, endAt = null, startAt = null) {
         const c = await this._getCollection();
@@ -80,44 +84,79 @@ class ChatLogStorage extends BaseStorage {
         const res = await c.find(q)
             .limit(limit)
             .sort({ timestamp: orderBackwards ? 1 : -1 })
-            .project({ _id: 0, time: 0 })
+            .project({ _id: 0 })
             .toArray();
 
         if (!orderBackwards) {
             res.reverse();
         }
 
-        return res;
+        if (!this._secret) {
+            return res.map((r) => Object.assign(r, { ok: null }));
+        }
+
+        const secret = await Promise.resolve(this._secret);
+
+        return res.map((r) => {
+            const {
+                sign,
+                ...log
+            } = r;
+            const objToSign = this._objectToSign(log);
+            const compare = this._signWithSecret(objToSign, secret);
+            const ok = compare === sign;
+            if (!ok) {
+                this._log.error(`ChatLog: found wrong signature at pageId: "${r.pageId}", senderId: "${r.senderId}", at: ${r.timestamp}`, r);
+            }
+
+            return Object.assign(log, { ok });
+        });
     }
 
     /**
      * Log single event
      *
      * @param {string} senderId
-     * @param {Object[]} responses - list of sent responses
-     * @param {Object} request - event request
-     * @param {Object} [metadata] - request metadata
+     * @param {object[]} responses - list of sent responses
+     * @param {object} request - event request
+     * @param {object} [metadata] - request metadata
      * @returns {Promise}
      */
     log (senderId, responses = [], request = {}, metadata = {}) {
         const log = {
             senderId,
-            time: new Date(request.timestamp || Date.now()),
             request,
-            responses
+            responses,
+            ...metadata
         };
 
-        Object.assign(log, metadata);
-
-        return this._getCollection()
-            .then(c => c.insertOne(log))
-            .catch((err) => {
-                this._log.error('Failed to store chat log', err, log);
+        return this._storeLog(log);
+    }
 
-                if (!this.muteErrors) {
-                    throw err;
-                }
+    async _storeLog (event) {
+        let log = event;
+        if (!event.timestamp) {
+            Object.assign(event, {
+                timestamp: event.request.timestamp || Date.now()
+            });
+        }
+        if (typeof event.pageId === 'undefined') {
+            Object.assign(event, {
+                pageId: null
             });
+        }
+        try {
+            const c = await this._getCollection();
+            log = await this._sign(log);
+            // @ts-ignore
+            await c.insertOne(log);
+        } catch (e) {
+            this._log.error('Failed to store chat log', e, log);
+
+            if (!this.muteErrors) {
+                throw e;
+            }
+        }
     }
 
     /**
@@ -127,31 +166,23 @@ class ChatLogStorage extends BaseStorage {
      * @name ChatLog#error
      * @param {any} err - error
      * @param {string} senderId
-     * @param {Object[]} [responses] - list of sent responses
-     * @param {Object} [request] - event request
-     * @param {Object} [metadata] - request metadata
+     * @param {object[]} [responses] - list of sent responses
+     * @param {object} [request] - event request
+     * @param {object} [metadata] - request metadata
      * @returns {Promise}
      */
     error (err, senderId, responses = [], request = {}, metadata = {}) {
         const log = {
             senderId,
-            time: new Date(request.timestamp || Date.now()),
             request,
             responses,
-            err: `${err}`
+            err: `${err}`,
+            ...metadata
         };
 
         Object.assign(log, metadata);
 
-        return this._getCollection()
-            .then(c => c.insertOne(log))
-            .catch((storeError) => {
-                this._log.error('Failed to store chat log', storeError, log);
-
-                if (!this.muteErrors) {
-                    throw storeError;
-                }
-            });
+        return this._storeLog(log);
     }
 
 }

package/src/NotificationsStorage.js

@@ -21,7 +21,7 @@ const { ObjectID } = mongodb;
  */
 
 /**
- * @typedef Campaign {Object}
+ * @typedef Campaign {object}
  * @prop {string} id
  * @prop {string} name
  *
@@ -45,7 +45,7 @@ const { ObjectID } = mongodb;
  * Interaction
  *
  * @prop {string} action
- * @prop {Object} [data]
+ * @prop {object} [data]
  *
  * Setup
  *
@@ -72,7 +72,6 @@ const { ObjectID } = mongodb;
  * @prop {number} [leaved] - time the event was not sent because user left
  */
 
-
 const MAX_TS = 9999999999999;
 const COSMO_LIMIT = 999;
 
@@ -114,7 +113,7 @@ class NotificationsStorage {
             const collections = await db.collections();
 
             collection = collections
-                .find(c => c.collectionName === name);
+                .find((c) => c.collectionName === name);
 
             if (!collection) {
                 try {
@@ -223,7 +222,7 @@ class NotificationsStorage {
         }
 
         await Promise.all(existing
-            .filter(e => !['_id_', '_id'].includes(e.name) && !indexes.some(i => e.name === i.options.name))
+            .filter((e) => !['_id_', '_id'].includes(e.name) && !indexes.some((i) => e.name === i.options.name))
             .map((e) => {
                 // eslint-disable-next-line no-console
                 this._log.log(`dropping index ${e.name}`);
@@ -235,8 +234,8 @@ class NotificationsStorage {
             }));
 
         await Promise.all(indexes
-            .filter(i => !existing.some(e => e.name === i.options.name))
-            .map(i => collection
+            .filter((i) => !existing.some((e) => e.name === i.options.name))
+            .map((i) => collection
                 .createIndex(i.index, i.options)
                 // @ts-ignore
                 .catch((e) => {
@@ -251,7 +250,7 @@ class NotificationsStorage {
 
     /**
      *
-     * @param {Object} tasks
+     * @param {object} tasks
      * @returns {Promise<Task[]>}
      */
     async pushTasks (tasks) {
@@ -267,7 +266,7 @@ class NotificationsStorage {
                 campaignId, senderId, pageId, sent
             } = task;
 
-            const $set = Object.assign({}, task);
+            const $set = { ...task };
 
             const filter = {
                 campaignId, senderId, pageId, sent
@@ -338,7 +337,7 @@ class NotificationsStorage {
             } else {
                 override = missingIds.get(i);
             }
-            return Object.assign({}, task, override);
+            return { ...task, ...override };
         });
     }
 
@@ -382,7 +381,7 @@ class NotificationsStorage {
                 }
             }, {
                 sort: { enqueue: 1 },
-                returnOriginal: false
+                returnDocument: 'after'
             });
             if (found.value) {
                 pop.push(this._mapGenericObject(found.value));
@@ -464,7 +463,7 @@ class NotificationsStorage {
     /**
      *
      * @param {string} taskId
-     * @param {Object} data
+     * @param {object} data
      */
     async updateTask (taskId, data) {
         const c = await this._getCollection(this.taksCollection);
@@ -476,7 +475,7 @@ class NotificationsStorage {
         }, {
             $set: data
         }, {
-            returnOriginal: false
+            returnDocument: 'after'
         });
 
         return this._mapGenericObject(res.value);
@@ -530,7 +529,7 @@ class NotificationsStorage {
                 .project({ campaignId: 1, _id: 0 })
                 .toArray();
 
-            return data.map(d => d.campaignId);
+            return data.map((d) => d.campaignId);
         }
     }
 
@@ -558,7 +557,7 @@ class NotificationsStorage {
         }
 
         const result = await Promise.all(
-            tasks.map(task => c.findOneAndUpdate({
+            tasks.map((task) => c.findOneAndUpdate({
                 _id: task._id,
                 [eventType]: null
             }, {
@@ -566,19 +565,19 @@ class NotificationsStorage {
                     [eventType]: ts
                 }
             }, {
-                returnOriginal: false
+                returnDocument: 'after'
             }))
         );
 
         return result
-            .map(res => (res.value ? this._mapGenericObject(res.value) : null))
-            .filter(r => r !== null);
+            .map((res) => (res.value ? this._mapGenericObject(res.value) : null))
+            .filter((r) => r !== null);
     }
 
     /**
      *
-     * @param {Object} campaign
-     * @param {Object} [updateCampaign]
+     * @param {object} campaign
+     * @param {object} [updateCampaign]
      * @returns {Promise<Campaign>}
      */
     async upsertCampaign (campaign, updateCampaign = null) {
@@ -586,7 +585,7 @@ class NotificationsStorage {
 
         let ret;
         if (campaign.id) {
-            const $setOnInsert = Object.assign({}, campaign);
+            const $setOnInsert = { ...campaign };
             delete $setOnInsert.id;
             const update = {};
             if (Object.keys($setOnInsert).length !== 0) {
@@ -603,12 +602,12 @@ class NotificationsStorage {
                 id: campaign.id
             }, update, {
                 upsert: true,
-                returnOriginal: false
+                returnDocument: 'after'
             });
             ret = this._mapCampaign(res.value);
         } else {
             const id = new ObjectID();
-            ret = Object.assign({ id: id.toHexString(), _id: id }, campaign);
+            ret = { id: id.toHexString(), _id: id, ...campaign };
             if (updateCampaign) {
                 Object.assign(ret, updateCampaign);
             }
@@ -635,7 +634,7 @@ class NotificationsStorage {
     /**
      *
      * @param {string} campaignId
-     * @param {Object} increment
+     * @param {object} increment
      * @returns {Promise}
      */
     async incrementCampaign (campaignId, increment = {}) {
@@ -651,7 +650,7 @@ class NotificationsStorage {
     /**
      *
      * @param {string} campaignId
-     * @param {Object} data
+     * @param {object} data
      * @returns {Promise<Campaign|null>}
      */
     async updateCampaign (campaignId, data) {
@@ -662,7 +661,7 @@ class NotificationsStorage {
         }, {
             $set: data
         }, {
-            returnOriginal: false
+            returnDocument: 'after'
         });
 
         return this._mapCampaign(res.value);
@@ -682,7 +681,7 @@ class NotificationsStorage {
         }, {
             $set: { startAt: null }
         }, {
-            returnOriginal: true
+            returnDocument: 'before'
         });
 
         return this._mapCampaign(res.value);
@@ -717,16 +716,16 @@ class NotificationsStorage {
             }
         })
             .limit(campaignIds.length)
-            .map(camp => this._mapCampaign(camp));
+            .map((camp) => this._mapCampaign(camp));
 
         return cursor.toArray();
     }
 
     /**
      *
-     * @param {Object} condition
+     * @param {object} condition
      * @param {number} [limit]
-     * @param {Object} [lastKey]
+     * @param {object} [lastKey]
      * @returns {Promise<{data:Campaign[],lastKey:string}>}
      */
     async getCampaigns (condition, limit = null, lastKey = null) {
@@ -737,11 +736,12 @@ class NotificationsStorage {
         if (lastKey !== null) {
             const key = JSON.parse(Buffer.from(lastKey, 'base64').toString('utf8'));
 
-            useCondition = Object.assign({}, useCondition, {
+            useCondition = {
+                ...useCondition,
                 _id: {
                     $lt: ObjectID.createFromHexString(key._id)
                 }
-            });
+            };
         }
 
         const cursor = c.find(useCondition)
@@ -764,7 +764,7 @@ class NotificationsStorage {
         }
 
         return {
-            data: data.map(camp => this._mapCampaign(camp)),
+            data: data.map((camp) => this._mapCampaign(camp)),
             lastKey: nextLastKey
         };
     }
@@ -807,7 +807,7 @@ class NotificationsStorage {
             }, {
                 $pull: { subs: tag }
             }, {
-                returnOriginal: false
+                returnDocument: 'after'
             });
 
             if (res.value) {
@@ -880,11 +880,12 @@ class NotificationsStorage {
         if (lastKey !== null) {
             const key = JSON.parse(Buffer.from(lastKey, 'base64').toString('utf8'));
 
-            condition = Object.assign({}, condition, {
+            condition = {
+                ...condition,
                 _id: {
                     $gt: ObjectID.createFromHexString(key._id)
                 }
-            });
+            };
         }
 
         let data = [];
@@ -972,7 +973,6 @@ class NotificationsStorage {
 
         const res = await c.aggregate(pipeline);
 
-
         const arr = await res.toArray();
 
         return arr.map(({ _id: tag, subscribtions }) => ({ tag, subscribtions }));