feat(Context): add context.setAsHandled() and context.setAsNotHandled()

packages/bottender-dialogflow/src/index.ts

@@ -59,6 +59,9 @@ module.exports = function dialogflow({
 
     if (intent) {
       context.setIntent(intent.displayName);
+      context.setAsHandled();
+    } else {
+      context.setAsNotHandled();
     }
 
     const Action = actions[intent.name] || actions[intent.displayName];

packages/bottender-luis/src/index.ts

@@ -75,6 +75,7 @@ module.exports = function luis({
 
     if (topScoringIntent && topScoringIntent.score > scoreThreshold) {
       context.setIntent(topScoringIntent.intent);
+      context.setAsHandled();
 
       const Action = actions[topScoringIntent.intent];
 
@@ -85,6 +86,8 @@ module.exports = function luis({
           sentimentAnalysis,
         });
       }
+    } else {
+      context.setAsNotHandled();
     }
 
     return next;

packages/bottender-qna-maker/src/index.ts

@@ -71,6 +71,9 @@ module.exports = function qnaMaker({
     return async function TopAnswer() {
       if (topAnswer.id !== -1) {
         context.setIntent(`qna_${topAnswer.id}`);
+        context.setAsHandled();
+      } else {
+        context.setAsNotHandled();
       }
 
       await context.sendText(topAnswer.answer);

packages/bottender-rasa/src/index.ts

@@ -55,11 +55,14 @@ module.exports = function rasa({
 
     if (intent && intent.confidence > confidenceThreshold) {
       context.setIntent(intent.name);
+      context.setAsHandled();
 
       const Action = actions[intent.name];
       if (Action) {
         return withProps(Action as any, { intent, entities });
       }
+    } else {
+      context.setAsNotHandled();
     }
 
     return next;

packages/bottender/src/console/ConsoleContext.ts

@@ -91,7 +91,6 @@ export default class ConsoleContext extends Context<
    *
    */
   async sendText(text: string, ...args: any[]): Promise<void> {
-    this._isHandled = true;
     if (args.length > 0 && this._fallbackMethods) {
       this._client.sendText(
         `${text}\nwith other args:\n${JSON.stringify(args, null, 2)}`
@@ -102,7 +101,6 @@ export default class ConsoleContext extends Context<
   }
 
   async _methodMissing(method: string, args: any[]): Promise<void> {
-    this._isHandled = true;
     this._client.sendText(
       `${method} with args:\n${JSON.stringify(args, null, 2)}`
     );

packages/bottender/src/console/__tests__/ConsoleContext.spec.ts

@@ -86,14 +86,6 @@ describe('#sendText', () => {
     expect(client.sendText).toBeCalledWith('hello');
   });
 
-  it('should mark context as handled', async () => {
-    const { context } = setup();
-
-    await context.sendText('hello');
-
-    expect(context.isHandled).toBe(true);
-  });
-
   it('should support fallbackMethods with other args', async () => {
     const { context, client } = setup({ fallbackMethods: true });
 
@@ -131,14 +123,6 @@ describe('method missing', () => {
     );
   });
 
-  it('should mark context as handled', async () => {
-    const { context } = setup({ fallbackMethods: true });
-
-    await context.sendABC('hello');
-
-    expect(context.isHandled).toBe(true);
-  });
-
   it('should not proxy blacklisted methods', async () => {
     const { context } = setup({ fallbackMethods: true });
 

packages/bottender/src/context/Context.ts

@@ -34,7 +34,7 @@ export default abstract class Context<C extends Client, E extends Event> {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   abstract sendText(text: string, options?: Record<string, any>): any;
 
-  _isHandled = false;
+  _isHandled: boolean | null = null;
 
   _isSessionWritten = false;
 
@@ -117,7 +117,7 @@ export default abstract class Context<C extends Client, E extends Event> {
     return this._session;
   }
 
-  get isHandled(): boolean {
+  get isHandled(): boolean | null {
     return this._isHandled;
   }
 
@@ -205,6 +205,22 @@ export default abstract class Context<C extends Client, E extends Event> {
     this._intent = intent;
   }
 
+  /**
+   * Set the conversation context as handled or not handled by boolean.
+   *
+   */
+  setAsHandled(handled = true) {
+    this._isHandled = handled;
+  }
+
+  /**
+   * Set the conversation context as not handled.
+   *
+   */
+  setAsNotHandled() {
+    this.setAsHandled(false);
+  }
+
   emitError(err: Error): void {
     if (this._emitter) {
       this._emitter.emit('error', err, this);

packages/bottender/src/context/__tests__/Context.spec.ts

@@ -24,3 +24,43 @@ describe('intent', () => {
     expect(context.intent).toEqual('hello-world');
   });
 });
+
+describe('handled', () => {
+  it('should default to null', () => {
+    const context = new TestContext({ client: {}, event: {} });
+
+    expect(context.isHandled).toBeNull();
+  });
+
+  it('should be true after calling context.setAsHandled()', () => {
+    const context = new TestContext({ client: {}, event: {} });
+
+    context.setAsHandled();
+
+    expect(context.isHandled).toEqual(true);
+  });
+
+  it('should be true after calling context.setAsHandled(true)', () => {
+    const context = new TestContext({ client: {}, event: {} });
+
+    context.setAsHandled(true);
+
+    expect(context.isHandled).toEqual(true);
+  });
+
+  it('should be false after calling context.setAsHandled(false)', () => {
+    const context = new TestContext({ client: {}, event: {} });
+
+    context.setAsHandled(false);
+
+    expect(context.isHandled).toEqual(false);
+  });
+
+  it('should be false after calling context.setAsNotHandled()', () => {
+    const context = new TestContext({ client: {}, event: {} });
+
+    context.setAsNotHandled();
+
+    expect(context.isHandled).toEqual(false);
+  });
+});

packages/bottender/src/line/LineContext.ts

@@ -179,14 +179,12 @@ class LineContext extends Context<LineClient, LineEvent> {
 
     switch (this._session.type) {
       case 'room':
-        this._isHandled = true;
         return this._client.leaveRoom(this._session.room.id, {
           ...(this._customAccessToken
             ? { accessToken: this._customAccessToken }
             : undefined),
         } as any);
       case 'group':
-        this._isHandled = true;
         return this._client.leaveGroup(this._session.group.id, {
           ...(this._customAccessToken
             ? { accessToken: this._customAccessToken }
@@ -446,8 +444,6 @@ class LineContext extends Context<LineClient, LineEvent> {
   reply(messages: LineTypes.Message[], options: LineTypes.MessageOptions = {}) {
     invariant(!this._isReplied, 'Can not reply event multiple times');
 
-    this._isHandled = true;
-
     if (this._shouldBatch) {
       this._replyMessages.push(...messages);
 
@@ -614,8 +610,6 @@ class LineContext extends Context<LineClient, LineEvent> {
       return;
     }
 
-    this._isHandled = true;
-
     if (this._shouldBatch) {
       this._pushMessages.push(...messages);
       return;

packages/bottender/src/line/__tests__/LineContext.spec.ts

@@ -189,7 +189,6 @@ describe('#leave', () => {
     expect(client.leaveGroup).not.toBeCalled();
     expect(client.leaveRoom).not.toBeCalled();
     expect(warning).toBeCalled();
-    expect(context.isHandled).toBe(false);
   });
 
   it('leave group', async () => {
@@ -198,7 +197,6 @@ describe('#leave', () => {
     await context.leave();
 
     expect(client.leaveGroup).toBeCalledWith('fakeGroupId', {});
-    expect(context.isHandled).toBe(true);
   });
 
   it('leave room', async () => {
@@ -207,7 +205,6 @@ describe('#leave', () => {
     await context.leave();
 
     expect(client.leaveRoom).toBeCalledWith('fakeRoomId', {});
-    expect(context.isHandled).toBe(true);
   });
 
   it('not leave user', async () => {
@@ -218,7 +215,6 @@ describe('#leave', () => {
     expect(client.leaveGroup).not.toBeCalled();
     expect(client.leaveRoom).not.toBeCalled();
     expect(warning).toBeCalled();
-    expect(context.isHandled).toBe(false);
   });
 });
 
@@ -321,14 +317,6 @@ describe('#replyText', () => {
     expect(error.message).toEqual('Can not reply event multiple times');
   });
 
-  it('should mark context as handled', async () => {
-    const { context } = setup();
-
-    await context.replyText('hello');
-
-    expect(context.isHandled).toBe(true);
-  });
-
   it('should support custom token', async () => {
     const { context, client } = setup({
       customAccessToken: 'anyToken',
@@ -457,14 +445,6 @@ describe('#pushText', () => {
     );
   });
 
-  it('should mark context as handled', async () => {
-    const { context } = setup();
-
-    await context.pushText('hello');
-
-    expect(context.isHandled).toBe(true);
-  });
-
   it('should call warning and not to send if dont have session', async () => {
     const { context, client } = setup({ session: false });
 
@@ -513,14 +493,6 @@ describe('send APIs', () => {
         {}
       );
     });
-
-    it('should mark context as handled', async () => {
-      const { context } = setup();
-
-      await context.send([Line.createText('2'), Line.createText('3')]);
-
-      expect(context.isHandled).toBe(true);
-    });
   });
 
   describe('#sendText', () => {
@@ -1329,7 +1301,6 @@ describe('profile APIs', () => {
       expect(client.getGroupMemberProfile).not.toBeCalled();
       expect(client.getRoomMemberProfile).not.toBeCalled();
       expect(warning).toBeCalled();
-      expect(context.isHandled).toBe(false);
     });
 
     it('not get profile without user in session', async () => {
@@ -1349,7 +1320,6 @@ describe('profile APIs', () => {
       expect(client.getGroupMemberProfile).not.toBeCalled();
       expect(client.getRoomMemberProfile).not.toBeCalled();
       expect(warning).toBeCalled();
-      expect(context.isHandled).toBe(false);
     });
 
     it('get user profile in group', async () => {
@@ -1394,7 +1364,6 @@ describe('profile APIs', () => {
       expect(client.getGroupMemberProfile).not.toBeCalled();
       expect(client.getRoomMemberProfile).not.toBeCalled();
       expect(warning).toBeCalled();
-      expect(context.isHandled).toBe(false);
     });
 
     it('get member profile in group', async () => {
@@ -1429,7 +1398,6 @@ describe('profile APIs', () => {
       expect(client.getGroupMemberProfile).not.toBeCalled();
       expect(client.getRoomMemberProfile).not.toBeCalled();
       expect(warning).toBeCalled();
-      expect(context.isHandled).toBe(false);
     });
   });
 });
@@ -1444,7 +1412,6 @@ describe('member IDs APIs', () => {
       expect(client.getRoomMemberIds).not.toBeCalled();
       expect(client.getGroupMemberIds).not.toBeCalled();
       expect(warning).toBeCalled();
-      expect(context.isHandled).toBe(false);
     });
 
     it('get memeber ids in group', async () => {
@@ -1479,7 +1446,6 @@ describe('member IDs APIs', () => {
       expect(client.getRoomMemberIds).not.toBeCalled();
       expect(client.getGroupMemberIds).not.toBeCalled();
       expect(warning).toBeCalled();
-      expect(context.isHandled).toBe(false);
     });
   });
 
@@ -1492,7 +1458,6 @@ describe('member IDs APIs', () => {
       expect(client.getAllRoomMemberIds).not.toBeCalled();
       expect(client.getAllGroupMemberIds).not.toBeCalled();
       expect(warning).toBeCalled();
-      expect(context.isHandled).toBe(false);
     });
 
     it('get memeber ids in group', async () => {
@@ -1519,7 +1484,6 @@ describe('member IDs APIs', () => {
       expect(client.getAllRoomMemberIds).not.toBeCalled();
       expect(client.getAllGroupMemberIds).not.toBeCalled();
       expect(warning).toBeCalled();
-      expect(context.isHandled).toBe(false);
     });
   });
 });