wingbot-mongodb 4.1.2 → 4.2.0

package/.nyc_output/processinfo/dcd83c20-b25a-4e44-9809-1951738231ac.json

@@ -0,0 +1 @@
+{"parent":null,"pid":92445,"argv":["/Users/david/.nvm/versions/node/v22.3.0/bin/node","/Users/david/Development/wingbot-mongodb/node_modules/.bin/mocha","./test"],"execArgv":[],"cwd":"/Users/david/Development/wingbot-mongodb","time":1728402100297,"ppid":92444,"coverageFilename":"/Users/david/Development/wingbot-mongodb/.nyc_output/dcd83c20-b25a-4e44-9809-1951738231ac.json","externalId":"","uuid":"dcd83c20-b25a-4e44-9809-1951738231ac","files":["/Users/david/Development/wingbot-mongodb/src/BaseStorage.js","/Users/david/Development/wingbot-mongodb/src/defaultLogger.js","/Users/david/Development/wingbot-mongodb/src/getNestedObjects.js","/Users/david/Development/wingbot-mongodb/src/AttachmentCache.js","/Users/david/Development/wingbot-mongodb/src/AuditLogStorage.js","/Users/david/Development/wingbot-mongodb/src/BotConfigStorage.js","/Users/david/Development/wingbot-mongodb/src/BotTokenStorage.js","/Users/david/Development/wingbot-mongodb/src/tokenFactory.js","/Users/david/Development/wingbot-mongodb/src/ChatLogStorage.js","/Users/david/Development/wingbot-mongodb/src/NotificationsStorage.js","/Users/david/Development/wingbot-mongodb/src/StateStorage.js"]}

package/.nyc_output/processinfo/index.json

@@ -1 +1 @@
-{"processes":{"596e9b84-51c8-44b2-b5a0-e9ba553853e7":{"parent":null,"children":[]}},"files":{"/Users/david/Development/wingbot-mongodb/src/BaseStorage.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/defaultLogger.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/AttachmentCache.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/AuditLogStorage.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/BotConfigStorage.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/BotTokenStorage.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/tokenFactory.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/ChatLogStorage.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/NotificationsStorage.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"],"/Users/david/Development/wingbot-mongodb/src/StateStorage.js":["596e9b84-51c8-44b2-b5a0-e9ba553853e7"]},"externalIds":{}}
+{"processes":{"dcd83c20-b25a-4e44-9809-1951738231ac":{"parent":null,"children":[]}},"files":{"/Users/david/Development/wingbot-mongodb/src/BaseStorage.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/defaultLogger.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/getNestedObjects.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/AttachmentCache.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/AuditLogStorage.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/BotConfigStorage.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/BotTokenStorage.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/tokenFactory.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/ChatLogStorage.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/NotificationsStorage.js":["dcd83c20-b25a-4e44-9809-1951738231ac"],"/Users/david/Development/wingbot-mongodb/src/StateStorage.js":["dcd83c20-b25a-4e44-9809-1951738231ac"]},"externalIds":{}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot-mongodb",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "description": "MongoDB storage for wingbot.ai",
   "main": "src/main.js",
   "scripts": {

package/src/BaseStorage.js

@@ -7,31 +7,12 @@ const { ObjectId } = require('mongodb');
 const { strict: assert } = require('assert');
 const crypto = require('crypto');
 const defaultLogger = require('./defaultLogger');
+const getNestedObjects = require('./getNestedObjects');
 
 /** @typedef {import('mongodb').Db} Db */
 /** @typedef {import('mongodb').Document} Document */
 /** @typedef {import('mongodb').CreateIndexesOptions} CreateIndexesOptions */
 
-/**
- *
- * @param {any} obj
- * @param {boolean} nested
- * @param {string} [attr]
- * @param {object} [ret]
- * @returns {object}
- */
-function getNestedObjects (obj, nested, attr = null, ret = {}) {
-    if (typeof obj !== 'object' || !obj || nested === null || Array.isArray(obj)) {
-        Object.assign(ret, { [attr]: obj === undefined ? null : obj });
-    } else {
-        Object.entries(obj)
-            .forEach(([key, val]) => {
-                getNestedObjects(val, nested || null, attr ? `${attr}.${key}` : key, ret);
-            });
-    }
-    return ret;
-}
-
 /**
  *
  * @template T

package/src/NotificationsStorage.js

@@ -9,20 +9,21 @@ const defaultLogger = require('./defaultLogger');
 const { ObjectId } = mongodb;
 
 /**
- * @typedef Target {Object}
+ * @typedef {object} Target
  * @prop {string} senderId
  * @prop {string} pageId
+ * @prop {{ [key: string]: object }} [meta]
  */
 
 /**
- * @typedef Subscribtion {Object}
+ * @typedef {object} Subscribtion
  * @prop {string} senderId
  * @prop {string} pageId
  * @prop {string[]} subs
  */
 
 /**
- * @typedef Campaign {object}
+ * @typedef {object}  Campaign
  * @prop {string} id
  * @prop {string} name
  *
@@ -59,7 +60,7 @@ const { ObjectId } = mongodb;
  */
 
 /**
- * @typedef Task {Object}
+ * @typedef {object} Task
  * @prop {string} id
  * @prop {string} pageId
  * @prop {string} senderId
@@ -73,6 +74,21 @@ const { ObjectId } = mongodb;
  * @prop {number} [leaved] - time the event was not sent because user left
  */
 
+/**
+ * @typedef {object} Subscription
+ * @prop {string} tag
+ * @prop {object} meta
+ */
+
+/**
+ * @typedef {object} SubscriptionData
+ * @prop {string} pageId
+ * @prop {string} senderId
+ * @prop {string[]} tags
+ * @prop {boolean} [remove]
+ * @prop {{ [key: string]: object }} [meta]
+ */
+
 const MAX_TS = 9999999999999;
 const COSMO_LIMIT = 999;
 
@@ -472,6 +488,7 @@ class NotificationsStorage {
         const c = await this._getCollection(this.taksCollection);
 
         const res = await c.findOne({
+            // @ts-ignore
             _id: ObjectId.isValid(taskId)
                 ? ObjectId.createFromHexString(taskId)
                 : taskId
@@ -489,6 +506,7 @@ class NotificationsStorage {
         const c = await this._getCollection(this.taksCollection);
 
         const res = await c.findOneAndUpdate({
+            // @ts-ignore
             _id: ObjectId.isValid(taskId)
                 ? ObjectId.createFromHexString(taskId)
                 : taskId
@@ -789,6 +807,66 @@ class NotificationsStorage {
         };
     }
 
+    /**
+     *
+     * @param {SubscriptionData[]} subscriptionData
+     * @param {boolean} [onlyToKnown=false]
+     * @returns {Promise}
+     */
+    async batchSubscribe (subscriptionData, onlyToKnown = false) {
+        const c = await this._getCollection(this.subscribtionsCollection);
+
+        const toSend = subscriptionData.filter((t) => t.tags.length !== 0);
+
+        while (toSend.length) {
+            const up = toSend.splice(0, 999);
+
+            await c.bulkWrite(
+                // @ts-ignore
+                up.map(({
+                    pageId, senderId, tags, meta = {}, remove
+                }) => {
+                    const set = Object.entries(meta);
+
+                    let addSet = {};
+
+                    if (remove) {
+                        addSet = {
+                            $set: Object.fromEntries(
+                                tags.map((t) => [`meta.${t}`, {}])
+                            )
+                        };
+                    } else if (set.length) {
+                        addSet = {
+                            $set: Object.fromEntries(
+                                set.map(([k, v]) => [`meta.${k}`, v])
+                            )
+                        };
+                    }
+
+                    return {
+                        updateOne: {
+                            filter: { senderId, pageId },
+                            update: {
+                                ...(remove
+                                    ? { $pullAll: { subs: tags } }
+                                    : { $addToSet: { subs: { $each: tags } } }),
+                                ...addSet
+                            },
+                            upsert: !remove && !onlyToKnown
+                        }
+                    };
+                }),
+                {
+                    ordered: false,
+                    writeConcern: {
+                        w: onlyToKnown ? 0 : 1
+                    }
+                }
+            );
+        }
+    }
+
     /**
      *
      * @param {string|string[]} senderId
@@ -801,25 +879,13 @@ class NotificationsStorage {
         // !IMPORTANT: do not add a default value to the fourth parameter!
         const senderIds = Array.isArray(senderId) ? senderId : [senderId];
 
-        if (senderIds.length === 0) {
-            return;
-        }
-        const c = await this._getCollection(this.subscribtionsCollection);
-
-        await c.bulkWrite(
+        return this.batchSubscribe(
             senderIds.map((sid) => ({
-                updateOne: {
-                    filter: { senderId: sid, pageId },
-                    update: { $addToSet: { subs: tag } },
-                    upsert: !onlyToKnown
-                }
+                senderId: sid,
+                pageId,
+                tags: [tag]
             })),
-            {
-                ordered: false,
-                writeConcern: {
-                    w: onlyToKnown ? 0 : 1
-                }
-            }
+            onlyToKnown
         );
     }
 
@@ -840,6 +906,7 @@ class NotificationsStorage {
             const res = await c.findOneAndUpdate({
                 pageId, senderId, subs: tag
             }, {
+                // @ts-ignore
                 $pull: { subs: tag }
             }, {
                 returnDocument: 'after'
@@ -933,7 +1000,17 @@ class NotificationsStorage {
         while (hasNext) {
 
             const cursor = c.find(condition)
-                .project({ _id: 1, pageId: 1, senderId: 1 })
+                .project({
+                    _id: 1,
+                    pageId: 1,
+                    senderId: 1,
+                    ...(include.length === 0
+                        ? { meta: 1 }
+                        : Object.fromEntries(
+                            include.map((k) => [`meta.${k}`, 1])
+                        )
+                    )
+                })
                 .sort({ _id: 1 })
                 .skip(skip)
                 .limit(useLimit);
@@ -959,29 +1036,48 @@ class NotificationsStorage {
         }
 
         return Promise.resolve({
-            data: data.map(({ senderId, pageId: p }) => ({ senderId, pageId: p })),
+            data: data.map(({
+                senderId, pageId: p, meta
+            }) => ({
+                senderId, pageId: p, ...(meta ? { meta } : {})
+            })),
             lastKey: nextLastKey
         });
     }
 
     /**
-     *
      * @param {string} senderId
      * @param {string} pageId
-     * @returns {Promise<string[]>}
+     * @returns {Promise<Subscription[]>}
      */
-    async getSenderSubscribtions (senderId, pageId) {
+    async getSenderSubscriptions (senderId, pageId) {
         const c = await this._getCollection(this.subscribtionsCollection);
 
-        const sub = await c.findOne({ senderId, pageId }, { projection: { _id: 0, subs: 1 } });
+        const sub = await c.findOne({
+            senderId, pageId
+        }, { projection: { _id: 0, subs: 1, meta: 1 } });
 
         if (sub) {
-            return sub.subs;
+            return sub.subs.map((tag) => ({
+                tag,
+                meta: (sub.meta && sub.meta[tag]) || {}
+            }));
         }
 
         return [];
     }
 
+    /**
+     *
+     * @param {string} senderId
+     * @param {string} pageId
+     * @returns {Promise<string[]>}
+     */
+    async getSenderSubscribtions (senderId, pageId) {
+        const subs = await this.getSenderSubscriptions(senderId, pageId);
+        return subs.map((s) => s.tag);
+    }
+
     async getTags (pageId = null) {
         const c = await this._getCollection(this.subscribtionsCollection);
 

package/src/getNestedObjects.js

@@ -0,0 +1,26 @@
+/**
+ * @author David Menger
+ */
+'use strict';
+
+/**
+ *
+ * @param {any} obj
+ * @param {boolean} nested
+ * @param {string} [attr]
+ * @param {object} [ret]
+ * @returns {object}
+ */
+function getNestedObjects (obj, nested, attr = null, ret = {}) {
+    if (typeof obj !== 'object' || !obj || nested === null || Array.isArray(obj)) {
+        Object.assign(ret, { [attr]: obj === undefined ? null : obj });
+    } else {
+        Object.entries(obj)
+            .forEach(([key, val]) => {
+                getNestedObjects(val, nested || null, attr ? `${attr}.${key}` : key, ret);
+            });
+    }
+    return ret;
+}
+
+module.exports = getNestedObjects;