@cse-public/webex-node-bot-framework/storage/memory.js

Webex Teams Bot Framework for Node JS

'use strict';

const when = require('when');
const _ = require('lodash');

module.exports = exports = function () {
  // define memstore object
  let memStore = {};
  const name = "memory";

  return {
    /**
     * Init the global memory storage
     *
     * @function
     * @returns {(Promise.<Boolean>)} - True if setup
     */
    initialize: function () {
      return when(true);
    },

    /**
     * Get the storage adaptor's name
     *
     * @function
     * @returns {string} - storage adaptor name
     */
    getName: function () {
      return name;
    },

    /**
     * Called when a bot is spawned, this function reads in the exisitng
     * bot configuration from the DB or creates the default one
     *
     *
     * @function
     * @param {String} id - Room/Conversation/Context ID
     * @param {object} initBotData - object that contains the key/value pairs that should be set for new bots
     * @returns {(Promise.<Object>)} - bot's initial config data
     */
    initStorage: function (id, initBotData) {
      if (typeof id === 'string') {
        // if id does not exist, create
        if (!memStore[id]) {
          // create id object in memStore
          memStore[id] = {};
        }

        // Storage adaptors with persistent memory will add the initial 
        // data only for "new" bots which are created after the framewor
        // is initialized.   The memory adapter loads the default data
        // for all bots, since persistent storage is not available
        if ((initBotData) && (typeof initBotData === 'object')) {
          for (let key of Object.keys(initBotData)) {
            memStore[id][key] = initBotData[key];
          }
        } else {
          return when.reject('Initial bot storage data must be an object');
        }
      }
      return when(initBotData);
    },

    /**
     * Store key/value data.
     *
     * This method is exposed as bot.store(key, value);
     *
     * @function
     * @param {String} id - Room/Conversation/Context ID
     * @param {String} key - Key under id object
     * @param {(String|Number|Boolean|Array|Object)} value - Value of key
     * @returns {(Promise.<String>|Promise.<Number>|Promise.<Boolean>|Promise.<Array>|Promise.<Object>)} -- stored value
     */
    store: function (id, key, value) {
      if (typeof id === 'string') {
        // if id does not exist, create
        if (!memStore[id]) {
          // create id object in memStore
          memStore[id] = {};
        }

        if (typeof key === 'string' && typeof value !== 'undefined') {
          memStore[id][key] = value;
          return when(memStore[id][key]);
        } else {
          return when.reject(new Error('bot.store() must include a "key" argument of type "string"'));
        }

      } else {
        return when.reject(new Error('bot.store() Storage module must include a "id" argument of type "string"'));
      }
    },

    /**
     * Recall value of data stored by 'key'.
     *
     * This method is exposed as bot.recall(key);
     *
     * @function
     * @param {String} id - Room/Conversation/Context ID
     * @param {String} [key] - Key under id object (optional). If key is not passed, all keys for id are returned as an object.
     * @returns {(Promise.<String>|Promise.<Number>|Promise.<Boolean>|Promise.<Array>|Promise.<Object>)}
     */
    recall: function (id, key) {
      if (typeof id === 'string') {
        // if key is defined and of type string....
        if (typeof key === 'string') {
          // if id/key exists...
          if (memStore[id] && (typeof memStore[id][key] !== 'undefined')) {
            return when(memStore[id][key]);
          } else {
            return when.reject(new Error('bot.recall() could not find the value referenced by id/key'));
          }
        }

        // else if key is not defined
        else if (typeof key === 'undefined') {
          // if id exists...
          if (memStore[id]) {
            return when(memStore[id]);
          } else {
            return when.reject(new Error('bot.recall() has no key/values defined'));
          }
        }

        // else key is defined, but of wrong type
        else {
          return when.reject(new Error('bot.recall() key must be of type "string"'));
        }
      } else {
        return when.reject(new Error('bot.recall() Storage module must include a "id" argument of type "string"'));
      }
    },

    /**
     * Forget a key or entire store.
     *
     * This method is exposed as bot.forget(key);
     *
     * @function
     * @param {String} id - Room/Conversation/Context ID
     * @param {String} [key] - Key under id object (optional). If key is not passed, id and all children are removed.
     * @returns {(Promise.<String>|Promise.<Number>|Promise.<Boolean>|Promise.<Array>|Promise.<Object>)}
     */
    forget: function (id, key) {
      if (typeof id === 'string') {
        // if key is defined and of type string....
        if (typeof key === 'string') {
          // if id/key exists...
          if (memStore[id] && memStore[id][key]) {
            let deletedKey = _.cloneDeep(memStore[id][key]);
            delete memStore[id][key];
            return when(deletedKey);
          } else {
            return when.reject(new Error('bot.forget() could not find the value referenced by id/key'));
          }
        }

        // else if key is not defined
        else if (typeof key === 'undefined') {
          // if id exists...
          if (memStore[id]) {
            let deletedId = _.cloneDeep(memStore[id]);
            delete memStore[id];
            return when(deletedId);
          } else {
            return when.reject(new Error('bot.forget() has no key/values defined'));
          }
        }

        // else key is defined, but of wrong type
        else {
          return when.reject(new Error('bot.forget() key must be of type "string"'));
        }
      } else {
        return when.reject(new Error('bot.forget() Storage module must include a "id" argument of type "string"'));
      }
    }
  };

};