botbuilder-mongo-storage

Bot Framework MongoDB Storage + Cache (Redis)

Table of Contents

• Quick start
  • Installation
  • Usage
  • Options
  • Advanced Usages
• FAQ
  • Why ?

Installation:

npm install botbuilder-mongo-storage

Usage

Normal

// Options
const options = {
  database: 'foobar',
  collection: 'conversations',
};

(async () => {
  // storage
  const storage = new MongoStore('mongodb://localhost:27017/', options);
  await storage.connect();
  const conversationState = new ConversationState(storage);
})();

Redis Cache (redis options)

// Options
const options = {
  database: 'foobar',
  collection: 'conversations',
  redis: {
    url: 'redis://localhost:6380', // "rediss://..." - for TLS
    password: 'foobared'
  },
};

(async () => {
  // storage
  const storage = new MongoStore('mongodb://localhost:27017/', options);
  await storage.connect();
  const conversationState = new ConversationState(storage);
})();

Options

Parameter	Type	Defaut value	Description
database	String	bot-storage	database name in mongodb
collection	String	conversations	collection name to store states
mongo	MongoOptions	-	optional mongo connection options
redis	RedisOptions	-	optional cache redis options
cacheExpiration	Number	1209600 - 14 days	optional TTL in seconds for redis cached state (14 days is default Microsoft directline conversation inactivity expiration time)
disableWriteConcern	Boolean	false(w/ redis) true (w/o redis)	optional only when using redis, mongodb queries will be executed with writeConcern: { w: 0 } for better perfomance. more details

Advanced Usages

1. Health Check

// Options
const storageOptions = {
  database: 'bot',
  collection: 'conversations',
  redis: {
    url: 'redis://localhost:6380', // "rediss://..." - for TLS
    password: 'foobared'
  },
  mongo: {
    tls: true,
  },
  cacheExpiration: 604800, // 7 days
};

(async () => {
  // storage
  const storage = new MongoStore('mongodb://localhost:27017/', storageOptions);
  await storage.connect();
  const conversationState = new ConversationState(storage);

  server.get('/health', (req, res) => {
    const storageHealth = await storage.health(); // always resolves promise - no need to catch error
    // const storageHealth = {
    //   ok: 1,
    //   mongo: 1,
    //   redis: 1, // only if redis is enabled
    // };
    res.status(200);
    res.send({
      ok: 1,
      storage: storageHealth,
    });
  });
})();

2. TTL Document Mongo

// Options
const storageOptions = {
  database: 'bot',
  collection: 'conversations',
};

(async () => {
  // storage
  const storage = new MongoStore('mongodb://localhost:27017/', storageOptions);
  await storage.connect();
  await storage.storage.createIndex(
    { date: 1 },
    { expireAfterSeconds: 14 * 24 * 60 * 60, background: true }
  ); // TTL - Auto deletes document after 14 days
  const conversationState = new ConversationState(storage);
})();

FAQ

Why ?

• Supports latest botbuilder framework
• Built-in cache layer
• Uses latest drivers for database and cache
• Provides more flixble options for custom usage
• Typescript support