refactor(types): Remove generic state handler type and fix type

cofacts · Nov 12, 2023 · 9c83fb4 · 9c83fb4
1 parent 20ae085
commit 9c83fb4
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 59 deletions.
diff --git a/src/types/chatbotState.ts b/src/types/chatbotState.ts
@@ -1,4 +1,4 @@
-import type { Message, MessageEvent, PostbackEvent } from '@line/bot-sdk';
+import type { Message, MessageEvent } from '@line/bot-sdk';
 
 export type ChatbotState =
   | '__INIT__'
@@ -9,38 +9,6 @@ export type ChatbotState =
   | 'ASKING_ARTICLE_SUBMISSION_CONSENT'
   | 'Error';
 
-/**
- * Dummy event, used exclusively when calling handler from another handler
- */
-type ServerChooseEvent = {
-  type: 'server_choose';
-};
-
-/**
- * Parameters that are added by handleInput.
- *
- * @todo: We should consider using value from authentic event instead of manually adding fields.
- */
-type ArgumentedEventParams = {
-  /**
-   * The text in text message, or value from payload in actions.
-   */
-  input: string;
-};
-
-export type ChatbotEvent = (
-  | MessageEvent
-  | ServerChooseEvent
-  /**
-   * A special format of postback that Chatbot actually uses: postback + input (provided in `ArgumentedEventParams`)
-   * @FIXME Replace with original PostbackEvent and parse its action to support passing more thing than a string
-   */
-  | {
-      type: 'postback';
-    }
-) &
-  ArgumentedEventParams;
-
 export type Context = {
   /** Used to differientiate different search sessions (searched text or media) */
   sessionId: number;
@@ -58,27 +26,11 @@ export type Context = {
     }
 );
 
-export type ChatbotStateHandlerParams = {
-  /** Record<string, never> is for empty object and it's the default parameter in handleInput and handlePostback */
-  data: Context | Record<string, never>;
-  state: ChatbotState;
-  event: ChatbotEvent;
-  userId: string;
+export type ChatbotStateHandlerReturnType = {
+  data: Context;
   replies: Message[];
 };
 
-export type ChatbotStateHandlerReturnType = Pick<
-  ChatbotStateHandlerParams,
-  'data' | 'replies'
->;
-
-/**
- * Generic handler type for function under src/webhook/handlers
- */
-export type ChatbotStateHandler = (
-  params: ChatbotStateHandlerParams
-) => Promise<ChatbotStateHandlerReturnType>;
-
 /**
  * The data that postback action stores as JSON.
  *

diff --git a/src/webhook/__tests__/handlePostback.test.ts b/src/webhook/__tests__/handlePostback.test.ts
@@ -82,8 +82,7 @@ it('invokes state handler specified by event.postbackHandlerState', async () =>
   ] as const) {
     expectedHandler.mockImplementationOnce(() => {
       return Promise.resolve({
-        // Bare minimal return values by handlers for handlePostback to work without crash
-        data: {},
+        data: { sessionId: 0, searchedText: '' },
         replies: [],
       } as ChatbotStateHandlerReturnType);
     });
@@ -109,7 +108,7 @@ describe('defaultState', () => {
     const data: Context = { sessionId: FIXED_DATE, searchedText: '' };
     defaultState.mockImplementationOnce(() => {
       return {
-        data: {},
+        data: { sessionId: 0, searchedText: '' },
         replies: [],
       };
     });
@@ -127,7 +126,10 @@ describe('defaultState', () => {
     ).resolves.toMatchInlineSnapshot(`
       Object {
         "context": Object {
-          "data": Object {},
+          "data": Object {
+            "searchedText": "",
+            "sessionId": 0,
+          },
         },
         "replies": Array [],
       }
@@ -231,7 +233,7 @@ describe('tutorial', () => {
 
     tutorial.mockImplementationOnce(() => {
       return {
-        data: {},
+        data: { sessionId: 0, searchedText: '' },
         replies: [],
       };
     });
@@ -245,7 +247,10 @@ describe('tutorial', () => {
     ).resolves.toMatchInlineSnapshot(`
       Object {
         "context": Object {
-          "data": Object {},
+          "data": Object {
+            "searchedText": "",
+            "sessionId": 0,
+          },
         },
         "replies": Array [],
       }

diff --git a/src/webhook/handlers/defaultState.ts b/src/webhook/handlers/defaultState.ts
@@ -1,12 +1,11 @@
 import { Message } from '@line/bot-sdk';
 import {
-  ChatbotStateHandlerParams,
   ChatbotPostbackHandlerParams,
   ChatbotStateHandlerReturnType,
 } from 'src/types/chatbotState';
 
 export default function defaultState(
-  params: ChatbotPostbackHandlerParams | ChatbotStateHandlerParams
+  params: ChatbotPostbackHandlerParams
 ): ChatbotStateHandlerReturnType {
   const replies: Message[] = [
     {