wingbot-mongodb 2.17.0 → 2.20.0

package/src/BaseStorage.js

@@ -4,17 +4,19 @@
 'use strict';
 
 const mongodb = require('mongodb'); // eslint-disable-line no-unused-vars
+const crypto = require('crypto');
 
-/** @typedef {import('mongodb').IndexOptions} IndexOptions */
+/** @typedef {import('mongodb/lib/db')} Db */
+/** @typedef {import('mongodb/lib/collection')} Collection */
 
 class 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]
      * @example
      *
      * const { BaseStorage } = require('winbot-mongodb');
@@ -47,18 +49,34 @@ class BaseStorage {
         this._log = log;
 
         /**
-         * @type {Promise<mongodb.Collection>}
+         * @type {Collection|Promise<Collection>}
          */
         this._collection = null;
 
         this._indexes = [];
+
+        this.ignoredSignatureKeys = ['_id', 'sign'];
+        this._secret = null;
+
+        this.systemIndexes = ['_id_', '_id'];
+
+        this._fixtures = [];
+    }
+
+    /**
+     * Insert defalt document to DB
+     *
+     * @param  {...any} objects
+     */
+    addFixtureDoc (...objects) {
+        this._fixtures.push(...objects);
     }
 
     /**
      * Add custom indexing rule
      *
      * @param {object} index
-     * @param {IndexOptions} options
+     * @param {mongodb.IndexOptions} options
      */
     addIndex (index, options) {
         if (!options.name) {
@@ -78,6 +96,7 @@ class BaseStorage {
         let collection;
 
         if (this._isCosmo) {
+            // @ts-ignore
             const collections = await db.collections();
 
             collection = collections
@@ -103,7 +122,7 @@ class BaseStorage {
     /**
      * Returns the collection to operate with
      *
-     * @returns {Promise<mongodb.Collection>}
+     * @returns {Promise<Collection>}
      */
     async _getCollection () {
         if (this._collection === null) {
@@ -128,29 +147,85 @@ class BaseStorage {
             existing = [];
         }
 
-        await Promise.all(existing
-            .filter((e) => !['_id_', '_id'].includes(e.name)
+        await existing
+            .filter((e) => !this.systemIndexes.includes(e.name)
                 && !indexes.some((i) => e.name === i.options.name))
-            .map((e) => {
+            .reduce((p, e) => {
                 // eslint-disable-next-line no-console
                 this._log.log(`dropping index ${e.name}`);
-                return collection.dropIndex(e.name)
+                return p
+                    .then(() => collection.dropIndex(e.name))
                     .catch((err) => {
                         // eslint-disable-next-line no-console
                         this._log.error(`dropping index ${e.name} FAILED`, err);
                     });
-            }));
+            }, Promise.resolve());
 
-        await Promise.all(indexes
+        const updated = await indexes
             .filter((i) => !existing.some((e) => e.name === i.options.name))
-            .map((i) => collection
-                .createIndex(i.index, i.options)
-                // @ts-ignore
+            .reduce((p, i) => {
+                this._log.log(`creating index ${i.name}`);
+                return p
+                    .then(() => collection.createIndex(i.index, i.options))
+                    .catch((e) => {
+                        this._log.error(`failed to create index ${i.options.name} on ${collection.collectionName}`, e);
+                    })
+                    .then(() => true);
+            }, Promise.resolve(false));
+
+        if (updated || existing.every((i) => this.systemIndexes.includes(i.name))) {
+            // upsert fixtures
+
+            await this._fixtures.reduce((p, o) => p
+                .then(() => collection.insertOne(o))
+                .then(() => this._log.log(`DB> Inserted fixture doc to "${this._collectionName}"`))
                 .catch((e) => {
-                    this._log.error(`failed to create index ${i.options.name} on ${collection.collectionName}`, e);
-                })));
+                    if (e.code !== 11000) {
+                        this._log.error(`DB> failed to insert fixture doc to "${this._collectionName}"`, e);
+                    }
+                }),
+            Promise.resolve());
+        }
     }
 
+    async _sign (object) {
+        if (!this._secret) {
+            return object;
+        }
+        const secret = await Promise.resolve(this._secret);
+        const objToSign = this._objectToSign(object);
+        const sign = this._signWithSecret(objToSign, secret);
+
+        return Object.assign(objToSign, {
+            sign
+        });
+    }
+
+    _objectToSign (object) {
+        const entries = Object.keys(object)
+            .filter((key) => !this.ignoredSignatureKeys.includes(key));
+
+        entries.sort();
+
+        return entries.reduce((o, key) => {
+            let val = object[key];
+            if (val instanceof Date) {
+                val = val.toISOString();
+            }
+            return Object.assign(o, { [key]: val });
+        }, {});
+    }
+
+    _signWithSecret (objToSign, secret, previous = null) {
+        const h = crypto.createHmac('sha3-224', secret)
+            .update(JSON.stringify(objToSign));
+
+        if (previous) {
+            h.update(previous);
+        }
+
+        return h.digest('base64');
+    }
 }
 
 module.exports = BaseStorage;

package/src/BotConfigStorage.js

@@ -3,8 +3,16 @@
  */
 'use strict';
 
-const mongodb = require('mongodb'); // eslint-disable-line no-unused-vars
-const { apiAuthorizer } = require('wingbot');
+let apiAuthorizer = () => false;
+try {
+    // @ts-ignore
+    ({ apiAuthorizer } = module.require('wingbot'));
+} catch (e) {
+    // noop
+}
+
+/** @typedef {import('mongodb/lib/db')} Db */
+/** @typedef {import('mongodb/lib/collection')} Collection */
 
 const CONFIG_ID = 'config';
 
@@ -17,7 +25,7 @@ class BotConfigStorage {
 
     /**
      *
-     * @param {mongodb.Db|{():Promise<mongodb.Db>}} mongoDb
+     * @param {Db|{():Promise<Db>}} mongoDb
      * @param {string} collectionName
      */
     constructor (mongoDb, collectionName = 'botconfig') {
@@ -25,13 +33,13 @@ class BotConfigStorage {
         this._collectionName = collectionName;
 
         /**
-         * @type {mongodb.Collection}
+         * @type {Collection}
          */
         this._collection = null;
     }
 
     /**
-     * @returns {Promise<mongodb.Collection>}
+     * @returns {Promise<Collection>}
      */
     async _getCollection () {
         if (this._collection === null) {
@@ -56,6 +64,7 @@ class BotConfigStorage {
         const storage = this;
         return {
             async updateBot (args, ctx) {
+                // @ts-ignore
                 if (!apiAuthorizer(args, ctx, acl)) {
                     return null;
                 }
@@ -74,6 +83,7 @@ class BotConfigStorage {
     async invalidateConfig () {
         const c = await this._getCollection();
 
+        // @ts-ignore
         return c.deleteOne({ _id: CONFIG_ID });
     }
 
@@ -95,25 +105,36 @@ class BotConfigStorage {
     /**
      * @template T
      * @param {T} newConfig
+     * @param {string} [id]
      * @returns {Promise<T>}
      */
-    async updateConfig (newConfig) {
+    async updateConfig (newConfig, id = CONFIG_ID) {
         Object.assign(newConfig, { timestamp: Date.now() });
 
-        const c = await this._getCollection();
-
-        await c.replaceOne({ _id: CONFIG_ID }, newConfig, { upsert: true });
+        await this.setConfig(id, newConfig);
 
         return newConfig;
     }
 
     /**
+     *
+     * @param {string} id
+     * @param {object} newConfig
+     */
+    async setConfig (id, newConfig) {
+        const c = await this._getCollection();
+
+        await c.replaceOne({ _id: id }, newConfig, { upsert: true });
+    }
+
+    /**
+     * @param {string} [id]
      * @returns {Promise<object | null>}
      */
-    async getConfig () {
+    async getConfig (id = CONFIG_ID) {
         const c = await this._getCollection();
 
-        return c.findOne({ _id: CONFIG_ID }, { projection: { _id: 0 } });
+        return c.findOne({ _id: id }, { projection: { _id: 0 } });
     }
 
 }

package/src/BotTokenStorage.js

@@ -131,7 +131,7 @@ class BotTokenStorage {
             }
         }, {
             upsert: true,
-            returnOriginal: false
+            returnDocument: 'after'
         });
 
         res = res.value;

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,14 +84,33 @@ 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 });
+        });
     }
 
     /**
@@ -102,22 +125,38 @@ class ChatLogStorage extends BaseStorage {
     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;
+            }
+        }
     }
 
     /**
@@ -135,23 +174,15 @@ class ChatLogStorage extends BaseStorage {
     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

@@ -381,7 +381,7 @@ class NotificationsStorage {
                 }
             }, {
                 sort: { enqueue: 1 },
-                returnOriginal: false
+                returnDocument: 'after'
             });
             if (found.value) {
                 pop.push(this._mapGenericObject(found.value));
@@ -475,7 +475,7 @@ class NotificationsStorage {
         }, {
             $set: data
         }, {
-            returnOriginal: false
+            returnDocument: 'after'
         });
 
         return this._mapGenericObject(res.value);
@@ -565,7 +565,7 @@ class NotificationsStorage {
                     [eventType]: ts
                 }
             }, {
-                returnOriginal: false
+                returnDocument: 'after'
             }))
         );
 
@@ -602,7 +602,7 @@ class NotificationsStorage {
                 id: campaign.id
             }, update, {
                 upsert: true,
-                returnOriginal: false
+                returnDocument: 'after'
             });
             ret = this._mapCampaign(res.value);
         } else {
@@ -661,7 +661,7 @@ class NotificationsStorage {
         }, {
             $set: data
         }, {
-            returnOriginal: false
+            returnDocument: 'after'
         });
 
         return this._mapCampaign(res.value);
@@ -681,7 +681,7 @@ class NotificationsStorage {
         }, {
             $set: { startAt: null }
         }, {
-            returnOriginal: true
+            returnDocument: 'before'
         });
 
         return this._mapCampaign(res.value);
@@ -807,7 +807,7 @@ class NotificationsStorage {
             }, {
                 $pull: { subs: tag }
             }, {
-                returnOriginal: false
+                returnDocument: 'after'
             });
 
             if (res.value) {

package/src/StateStorage.js

@@ -36,7 +36,7 @@ class StateStorage extends BaseStorage {
      * @param {{error:Function,log:Function}} [log] - console like logger
      * @param {boolean} isCosmo
      */
-    constructor (mongoDb, collectionName = 'chatlogs', log = console, isCosmo = false) {
+    constructor (mongoDb, collectionName = 'states', log = console, isCosmo = false) {
         super(mongoDb, collectionName, log, isCosmo);
 
         this.addIndex(
@@ -115,7 +115,7 @@ class StateStorage extends BaseStorage {
             $set
         }, {
             upsert: true,
-            returnOriginal: false,
+            returnDocument: 'after',
             projection: {
                 _id: 0
             }

package/src/main.js

@@ -9,6 +9,7 @@ const BotTokenStorage = require('./BotTokenStorage');
 const ChatLogStorage = require('./ChatLogStorage');
 const BotConfigStorage = require('./BotConfigStorage');
 const AttachmentCache = require('./AttachmentCache');
+const AuditLogStorage = require('./AuditLogStorage');
 const NotificationsStorage = require('./NotificationsStorage');
 
 module.exports = {
@@ -18,5 +19,6 @@ module.exports = {
     ChatLogStorage,
     BotConfigStorage,
     AttachmentCache,
-    NotificationsStorage
+    NotificationsStorage,
+    AuditLogStorage
 };