fix(async): abortable should not change original outputs (#5609)

* fix(async): abortable should not change original outputs * fix: according to code review * revert --------- Co-authored-by: Asher Gomez <[email protected]>
denoland · Aug 5, 2024 · ed19729 · ed19729
1 parent 82e50a9
commit ed19729
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 1 deletion.
diff --git a/async/abortable.ts b/async/abortable.ts
@@ -106,6 +106,7 @@ export function abortable<T>(p: Promise<T>, signal: AbortSignal): Promise<T>;
  * assertEquals(items, []);
  * ```
  */
+
 export function abortable<T>(
   p: AsyncIterable<T>,
   signal: AbortSignal,
@@ -153,7 +154,8 @@ async function* abortableAsyncIterable<T>(
       const { done, value } = await race;
       if (done) {
         signal.removeEventListener("abort", abort);
-        return;
+        const result = await it.return?.(value);
+        return result?.value;
       }
       yield value;
     }

diff --git a/async/abortable_test.ts b/async/abortable_test.ts
@@ -166,3 +166,43 @@ Deno.test("abortable.AsyncIterable() calls return before throwing", async () =>
   assertEquals(items, []);
   clearTimeout(timeoutId!);
 });
+
+Deno.test("abortable.AsyncIterable() behaves just like original when not aborted", async () => {
+  async function* gen() {
+    yield 1;
+    yield await Promise.resolve(2);
+    yield 3;
+    return 4;
+  }
+  const normalIterator = gen();
+  const abortController = new AbortController();
+  const abortableIterator = abortable(gen(), abortController.signal);
+
+  assertEquals(await abortableIterator.next(), await normalIterator.next());
+  assertEquals(await abortableIterator.next(), await normalIterator.next());
+  assertEquals(await abortableIterator.next(), await normalIterator.next());
+  assertEquals(await abortableIterator.next(), await normalIterator.next());
+  assertEquals(await abortableIterator.next(), await normalIterator.next());
+});
+
+Deno.test("abortable.AsyncIterable() behaves just like original when return is called", async () => {
+  async function* gen() {
+    yield 1;
+    yield await Promise.resolve(2);
+    yield 3;
+    return 4;
+  }
+  const normalIterator = gen();
+  const abortController = new AbortController();
+  const abortableIterator = abortable(gen(), abortController.signal);
+
+  assertEquals(
+    await abortableIterator.next(123),
+    await normalIterator.next(123),
+  );
+  assertEquals(
+    await abortableIterator.return(321),
+    await normalIterator.return(321),
+  );
+  assertEquals(await abortableIterator.next(), await normalIterator.next());
+});