fix: call onExit when conversation.halt without conversation.wait (#145)

Author: KnightNiwrem

src/plugin.ts

@@ -499,6 +499,11 @@ export function conversations<OC extends Context, C extends Context>(
         }
 
         const index: ConversationIndex<OC, C> = new Map();
+        const exit = options.onExit !== undefined
+            ? async (name: string) => {
+                await options.onExit?.(name, ctx);
+            }
+            : undefined;
         async function enter(id: string, ...args: unknown[]) {
             const entry = index.get(id);
             if (entry === undefined) {
@@ -516,18 +521,17 @@ export function conversations<OC extends Context, C extends Context>(
                 api: ctx.api,
                 me: ctx.me,
             };
+            const onHalt = async () => {
+                await exit?.(id);
+            };
             return await enterConversation(builder, base, {
                 args,
                 ctx,
                 plugins,
+                onHalt,
                 maxMillisecondsToWait,
             });
         }
-        const exit = options.onExit !== undefined
-            ? async (name: string) => {
-                await options.onExit?.(name, ctx);
-            }
-            : undefined;
         function isParallel(name: string) {
             return index.get(name)?.parallel ?? true;
         }

test/plugin.test.ts

@@ -363,6 +363,55 @@ describe("createConversation", () => {
         assertSpyCalls(onExit, 1);
         assertSpyCallArg(onExit, 0, 0, "convo");
     });
+    it("should call onExit upon halt without wait", async () => {
+        const onExit = spy(() => {});
+        const mw = new Composer<TestContext>();
+        let i = 0;
+        let j = 0;
+        mw.use(
+            conversations({ onExit }),
+            createConversation(async (convo) => {
+                i++;
+                await convo.halt();
+                j++;
+            }, { id: "convo" }),
+            async (ctx) => {
+                await ctx.conversation.enter("convo");
+            },
+        );
+        const up = { message: { chat: { id: 0 } } };
+        await mw.middleware()(mkctx(up), next);
+        await mw.middleware()(mkctx(up), next);
+        assertEquals(i, 2);
+        assertEquals(j, 0);
+        assertSpyCalls(onExit, 2); // enter, halt, enter, halt
+        assertSpyCallArg(onExit, 0, 0, "convo");
+    });
+    it("should call onExit upon halt after wait", async () => {
+        const onExit = spy(() => {});
+        const mw = new Composer<TestContext>();
+        let i = 0;
+        let j = 0;
+        mw.use(
+            conversations({ onExit }),
+            createConversation(async (convo) => {
+                i++;
+                await convo.wait();
+                await convo.halt();
+                j++;
+            }, { id: "convo" }),
+            async (ctx) => {
+                await ctx.conversation.enter("convo");
+            },
+        );
+        const up = { message: { chat: { id: 0 } } };
+        await mw.middleware()(mkctx(up), next);
+        await mw.middleware()(mkctx(up), next);
+        assertEquals(i, 2);
+        assertEquals(j, 0);
+        assertSpyCalls(onExit, 1); // enter, wait, resume, halt
+        assertSpyCallArg(onExit, 0, 0, "convo");
+    });
     it("should continue if default wait timeouts do not kick in", async () => {
         const onExit = spy(() => {});
         const mw = new Composer<TestContext>();