Improve multi-executors RuleTypes flow

src/core/__tests__/bot.spec.ts

@@ -6,6 +6,7 @@ import { sleep, loadYaml } from '@test/utils';
 import { YveBot } from '../bot';
 import { Store } from '../store';
 import { Controller } from '../controller';
+import { WaitForUserInput } from '../types';
 
 const OPTS = {
   enableWaitForSleep: false,
@@ -372,13 +373,46 @@ test('ruleTypes with multi executors', async () => {
   bot.on('end', onEnd).start();
   await sleep();
   expect(bot.store.get('executors.testStep.currentIdx')).toEqual(undefined);
+  bot.hear('answer');
+  await sleep();
+  expect(bot.store.get('executors.testStep.currentIdx')).toEqual(undefined);
+  expect(bot.store.get('output.testStep')).toEqual('answer transformed transformed2');
+  expect(onEnd).toHaveBeenCalledTimes(1);
+});
+
+test('ruleTypes with multi executors and waitForUserInput', async () => {
+  const rules = loadYaml(`
+  - message: Hello
+    name: testStep2
+    type: MultiStep2
+  `);
+  const bot = new YveBot(rules, OPTS);
+  const onEnd = jest.fn();
+  bot.types.define('MultiStep2', {
+    executors: [
+      {
+        transform: async (answer) => `${answer} transformed`,
+      },
+      {
+        transform: async (answer) => `${answer} transformed2`,
+      },
+      WaitForUserInput,
+      {
+        transform: async (answer) => `${answer} transformed3`,
+      }
+    ]
+  });
+
+  bot.on('end', onEnd).start();
+  await sleep();
+  expect(bot.store.get('executors.testStep2.currentIdx')).toEqual(undefined);
   bot.hear('first answer');
   await sleep();
-  expect(bot.store.get('executors.testStep.currentIdx')).toEqual(1);
+  expect(bot.store.get('executors.testStep2.currentIdx')).toEqual(3);
   bot.hear('second answer');
   await sleep();
-  expect(bot.store.get('executors.testStep.currentIdx')).toEqual(undefined);
-  expect(bot.store.get('output.testStep')).toEqual('second answer transformed2');
+  expect(bot.store.get('executors.testStep2.currentIdx')).toEqual(undefined);
+  expect(bot.store.get('output.testStep2')).toEqual('second answer transformed3');
   expect(onEnd).toHaveBeenCalledTimes(1);
 });
 

src/core/bot.ts

@@ -2,9 +2,11 @@ import { YveBotOptions, Rule, Answer } from '../types';
 import { Store, StoreData } from './store';
 import { Controller } from './controller';
 import { Actions } from './actions';
-import { Types } from './types';
+import { Types, WaitForUserInput } from './types';
 import { Validators } from './validators';
 
+import * as Exceptions from './exceptions';
+
 function sanitizeRule(rule: Rule): Rule {
   if (typeof rule === 'string') {
     return { message: rule };
@@ -23,6 +25,9 @@ function sanitizeRule(rule: Rule): Rule {
 }
 
 export class YveBot {
+  static Exceptions: any;
+  static WaitForUserInputExecutor: typeof WaitForUserInput;
+
   private handlers: { [handler: string]: Array<() => any> };
   private _rules?: Rule[];
 
@@ -121,3 +126,7 @@ export class YveBot {
 YveBot.prototype.types = new Types;
 YveBot.prototype.actions = new Actions;
 YveBot.prototype.validators = new Validators;
+
+
+YveBot.Exceptions = Exceptions;
+YveBot.WaitForUserInputExecutor = WaitForUserInput;

src/core/controller.ts

@@ -1,8 +1,14 @@
 import { Rule, RuleNext, Answer } from '../types';
 import { YveBot } from './bot';
-import { ValidatorError, InvalidAttributeError, RuleNotFound } from './exceptions';
+import {
+  InvalidAttributeError,
+  PauseRuleTypeExecutors,
+  RuleNotFound,
+  ValidatorError,
+} from './exceptions';
 import * as utils from './utils';
 
+
 async function validateAnswer(
   answers: Answer | Answer[],
   rule: Rule,
@@ -190,12 +196,36 @@ export class Controller {
     return this.bot.store.get(`executors.${rule.name}.currentIdx`) || 0;
   }
 
-  setRuleExecutorIndex(rule: Rule, value?: any): void {
-    if (value !== undefined) {
-      this.bot.store.set(`executors.${rule.name}.currentIdx`, value);
-    } else {
-      this.bot.store.unset(`executors.${rule.name}.currentIdx`);
+  incRuleExecutorIndex(rule: Rule): void {
+    this.bot.store.set(
+      `executors.${rule.name}.currentIdx`, this.getRuleExecutorIndex(rule) + 1
+    );
+  }
+
+  resetRuleExecutorIndex(rule: Rule): void {
+    this.bot.store.unset(`executors.${rule.name}.currentIdx`);
+  }
+
+  async executeRuleTypeExecutors(rule: Rule, lastAnswer: Answer | Answer[]): Promise<any> {
+    const { bot } = this;
+    const executorIdx = this.getRuleExecutorIndex(rule);
+    const executors = bot.types[rule.type].executors;
+
+    const executor = executors.slice(executorIdx)[0] || {};
+    const { transform = (...args) => Promise.resolve(args[0]) } = executor;
+    const answer = await (
+      transform(lastAnswer, rule, bot)
+      .then(answer => validateAnswer(answer, rule, bot, this.getRuleExecutorIndex(rule)))
+    );
+
+    const completed = (this.getRuleExecutorIndex(rule) === executors.length-1);
+    if (!completed) {
+      this.incRuleExecutorIndex(rule);
+      return await this.executeRuleTypeExecutors(rule, answer);
     }
+
+    this.resetRuleExecutorIndex(rule);
+    return answer;
   }
 
   async receiveMessage(message: Answer | Answer[]): Promise<this> {
@@ -208,24 +238,19 @@ export class Controller {
     }
 
     let answer;
-    const { executors } = bot.types[rule.type];
-    const executor = executors[this.getRuleExecutorIndex(rule)] || {};
-    const { transform = (...args) => Promise.resolve(args[0]) } = executor;
     try {
-      answer = await transform(message, rule, bot).then(answer => validateAnswer(
-        answer, rule, bot, this.getRuleExecutorIndex(rule)
-      ));
-
-      if ( this.getRuleExecutorIndex(rule) < executors.length-1 ) {
-        this.setRuleExecutorIndex(rule, this.getRuleExecutorIndex(rule)+1);
-        bot.dispatch('hear');
-        return this;
-      }
-
-      this.setRuleExecutorIndex(rule);
+      answer = await this.executeRuleTypeExecutors(rule, message);
     } catch (e) {
+      let expectedError = false;
       if (e instanceof ValidatorError) {
+        expectedError = true;
         await this.sendMessage(e.message, rule);
+      } if (e instanceof PauseRuleTypeExecutors) {
+        expectedError = true;
+        this.incRuleExecutorIndex(rule);
+      }
+
+      if (expectedError) {
         bot.dispatch('hear');
         return this;
       }

src/core/exceptions.ts

@@ -20,3 +20,8 @@ export function RuleNotFound(name: string, indexes: { [k: string]: number }) {
   this.message = `Rule "${name}" not found in indexes`;
   this.indexes = indexes;
 }
+
+export function PauseRuleTypeExecutors(name: string) {
+  this.key = 'pauseRuleTypeExecutors';
+  this.message = `Rule "${name}" should pause exection`;
+}

src/core/types.ts

@@ -1,9 +1,19 @@
 import { uniq } from 'lodash';
 import { DefineModule } from './module';
-import { Rule, Answer } from '../types';
+import { PauseRuleTypeExecutors } from './exceptions';
+import { Rule, Answer, RuleType, RuleTypeExecutor } from '../types';
 import * as utils from './utils';
 
-const types = {
+
+export const WaitForUserInput: RuleTypeExecutor = {
+  validators: [{
+    function: (_: Answer, rule: Rule): void => {
+      throw new PauseRuleTypeExecutors(rule.name);
+    }
+  }]
+};
+
+const types: { [name: string]: RuleType } = {
   Any: { executors: [{}] },
 
   String: {

src/types.ts

@@ -1,8 +1,19 @@
+import { YveBot } from './core/bot';
+
 export interface YveBotOptions {
   enableWaitForSleep?: boolean;
   rule?: Rule;
 }
 
+export interface RuleType {
+  executors: RuleTypeExecutor[];
+}
+
+export interface RuleTypeExecutor {
+  validators?: RuleValidator[];
+  transform?: (value: any, rule?: Rule, bot?: YveBot) => Promise<any>;
+}
+
 export interface Rule {
   name?: string;
   type?: string;