Merge pull request #124 from Botfuel/brainrefactoring

refactoring needed for the reference doc
Botfuel · Feb 28, 2018 · 19bed17 · 19bed17
2 parents bbdab82 + e6189f4
commit 19bed17
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 46 deletions.
diff --git a/packages/botfuel-dialog/src/adapters/adapter.js b/packages/botfuel-dialog/src/adapters/adapter.js
@@ -91,7 +91,7 @@ class Adapter {
    */
   async handleMessage(userMessage) {
     logger.debug('handleMessage', userMessage);
-    await this.initUserIfNecessary(userMessage.user);
+    await this.addUserIfNecessary(userMessage.user);
     const context = {
       user: userMessage.user,
       brain: this.bot.brain,
@@ -104,16 +104,16 @@ class Adapter {
   }
 
   /**
-   * Inits the user if necessary.
+   * Adds the user if necessary.
    * Calls the corresponding method of the brain.
    * Adapters can add specific behaviour.
    * @async
    * @param {int} userId - the user id
    * @returns {Promise.<void>}
    */
-  async initUserIfNecessary(userId) {
-    logger.debug('initUserIfNecessary', userId);
-    await this.bot.brain.initUserIfNecessary(userId);
+  async addUserIfNecessary(userId) {
+    logger.debug('addUserIfNecessary', userId);
+    await this.bot.brain.addUserIfNecessary(userId);
   }
 
   /**

diff --git a/packages/botfuel-dialog/src/adapters/messenger-adapter.js b/packages/botfuel-dialog/src/adapters/messenger-adapter.js
@@ -97,8 +97,8 @@ class MessengerAdapter extends WebAdapter {
   }
 
   /** @inheritDoc */
-  async initUserIfNecessary(userId) {
-    await super.initUserIfNecessary(userId);
+  async addUserIfNecessary(userId) {
+    await super.addUserIfNecessary(userId);
     await this.updateUserProfile(userId);
   }
 

diff --git a/packages/botfuel-dialog/src/brains/brain.js b/packages/botfuel-dialog/src/brains/brain.js
@@ -64,24 +64,13 @@ class Brain {
   }
 
   /**
-   * Gets the init value for creating a new conversation.
-   * @returns {Object}
-   */
-  getConversationInitValue() {
-    return {
-      _dialogs: { stack: [], previous: [] },
-      createdAt: Date.now(),
-    };
-  }
-
-  /**
-   * Inits a user if necessary (if he does not exist).
+   * Adds a user if necessary (if he does not exist).
    * @async
    * @param {String} userId - the user id
    * @returns {Promise.<void>}
    */
-  async initUserIfNecessary(userId) {
-    logger.debug('initUserIfNecessary', userId);
+  async addUserIfNecessary(userId) {
+    logger.debug('addUserIfNecessary', userId);
     const userExists = await this.hasUser(userId);
     if (!userExists) {
       await this.addUser(userId);
@@ -119,6 +108,17 @@ class Brain {
     throw new MissingImplementationError();
   }
 
+  /**
+   * Gets the init value for creating a new conversation.
+   * @returns {Object}
+   */
+  getConversationInitValue() {
+    return {
+      _dialogs: { stack: [], previous: [] },
+      createdAt: Date.now(),
+    };
+  }
+
   /**
    * Adds a conversation to a user.
    * @async
@@ -231,7 +231,7 @@ class Brain {
    * @param {String} key - the key
    * @returns {Promise.<*>} the value
    */
-  async getValue() {
+  async botGet() {
     throw new MissingImplementationError();
   }
 
@@ -243,7 +243,7 @@ class Brain {
    * @param {*} value - the value
    * @returns {Promise.<*>} the new value
    */
-  async setValue() {
+  async botSet() {
     throw new MissingImplementationError();
   }
 }

diff --git a/packages/botfuel-dialog/src/brains/memory-brain.js b/packages/botfuel-dialog/src/brains/memory-brain.js
@@ -100,12 +100,12 @@ class MemoryBrain extends Brain {
   }
 
   /** @inheritdoc */
-  async getValue(key) {
+  async botGet(key) {
     return this.bot[key];
   }
 
   /** @inheritdoc */
-  async setValue(key, value) {
+  async botSet(key, value) {
     this.bot[key] = value;
     return value;
   }

diff --git a/packages/botfuel-dialog/src/brains/mongo-brain.js b/packages/botfuel-dialog/src/brains/mongo-brain.js
@@ -27,15 +27,14 @@ class MongoBrain extends Brain {
   constructor(config) {
     logger.debug('constructor');
     super(config);
-    this.users = null;
   }
 
   /** @inheritdoc */
   async init() {
     logger.debug('init');
     this.db = await MongoClient.connect(this.getMongoDbUri());
     this.users = this.db.collection('users');
-    this.bots = this.db.collection('bots');
+    this.bots = this.db.collection('bots'); // TODO: is this what we need?
   }
 
   /**
@@ -49,20 +48,19 @@ class MongoBrain extends Brain {
     if (process.env.MONGODB_URI) {
       return process.env.MONGODB_URI;
     }
-
     if (!process.env.BOTFUEL_APP_TOKEN) {
       throw new MissingCredentialsError(
         'Either MONGODB_URI or BOTFUEL_APP_TOKEN is required to use the Brain with mongodb.',
       );
     }
-
     return `mongodb://localhost/botfuel-bot-${process.env.BOTFUEL_APP_TOKEN}`;
   }
 
   /** @inheritdoc */
   async clean() {
     logger.debug('clean');
-    return this.users.deleteMany();
+    await this.bots.deleteMany();
+    await this.users.deleteMany();
   }
 
   /** @inheritdoc */
@@ -82,13 +80,10 @@ class MongoBrain extends Brain {
   /** @inheritdoc */
   async getUser(userId, ...params) {
     logger.debug('getUser', userId);
-
     const user = await this.users.findOne({ userId }, ...params);
-
     if (!user) {
       throw new Error('User does not exist');
     }
-
     return user;
   }
 
@@ -101,11 +96,9 @@ class MongoBrain extends Brain {
    */
   async findUserAndUpdate(...params) {
     const user = await this.users.findOneAndUpdate(...params);
-
     if (!user) {
       throw new Error('User does not exist');
     }
-
     return user;
   }
 
@@ -117,15 +110,13 @@ class MongoBrain extends Brain {
       { $set: { [key]: value } },
       { returnOriginal: false },
     );
-
     return result.value;
   }
 
   /** @inheritdoc */
   async getLastConversation(userId) {
     logger.debug('getLastConversation', userId);
     const user = await this.getUser(userId, { conversations: { $slice: 1 } });
-
     const conversation = user.conversations[0];
     return this.isConversationValid(conversation) ? conversation : this.addConversation(userId);
   }
@@ -138,7 +129,6 @@ class MongoBrain extends Brain {
       { $push: { conversations: { $each: [this.getConversationInitValue()], $position: 0 } } },
       { returnOriginal: false },
     );
-
     return result.value.conversations[0];
   }
 
@@ -151,7 +141,6 @@ class MongoBrain extends Brain {
       { $set: { [`conversations.0.${key}`]: value } },
       { returnOriginal: false, sort: { 'conversations.createdAt': -1 } },
     );
-
     return result.value.conversations[0];
   }
 
@@ -166,14 +155,13 @@ class MongoBrain extends Brain {
   }
 
   /** @inheritdoc */
-  async getValue(key) {
+  async botGet(key) {
     const bot = await this.bots.findOne({});
-
     return bot && bot[key];
   }
 
   /** @inheritdoc */
-  async setValue(key, value) {
+  async botSet(key, value) {
     const bot = await this.bots.findOneAndUpdate(
       {},
       {
@@ -183,7 +171,6 @@ class MongoBrain extends Brain {
         upsert: true,
       },
     );
-
     return bot[key];
   }
 }

diff --git a/packages/botfuel-dialog/tests/brains/brains.test.js b/packages/botfuel-dialog/tests/brains/brains.test.js
@@ -198,8 +198,8 @@ const brainTest = (brainLabel) => {
   });
 
   test('should set and get value', async () => {
-    await brain.setValue('test', 'hello');
-    const value = await brain.getValue('test');
+    await brain.botSet('test', 'hello');
+    const value = await brain.botGet('test');
     expect(value).toEqual('hello');
   });
 

diff --git a/packages/botfuel-dialog/tests/dialog-manager/dialog-manager.test.js b/packages/botfuel-dialog/tests/dialog-manager/dialog-manager.test.js
@@ -35,7 +35,7 @@ describe('DialogManager', () => {
 
   beforeEach(async () => {
     await brain.clean();
-    await brain.initUserIfNecessary(TEST_USER);
+    await brain.addUserIfNecessary(TEST_USER);
   });
 
   test('when given a name, it should return the correct path', () => {