feat(promiseState): add immediate option to skip wait

Close #37
jsr-core · Aug 20, 2024 · 9b7ecd0 · 9b7ecd0
1 parent cd7a48b
commit 9b7ecd0
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 6 deletions.
diff --git a/promise_state.ts b/promise_state.ts
@@ -1,8 +1,17 @@
+import { flushPromises } from "./flush_promises.ts";
+
 /**
  * Promise state
  */
 export type PromiseState = "fulfilled" | "rejected" | "pending";
 
+export type PromiseStateOptions = {
+  /**
+   * If true, the promise state is checked immediately without waiting for the next event loop.
+   */
+  immediate?: boolean;
+};
+
 /**
  * Return state (fulfilled/rejected/pending) of a promise
  *
@@ -15,12 +24,13 @@ export type PromiseState = "fulfilled" | "rejected" | "pending";
  * assertEquals(await promiseState(new Promise(() => {})), "pending");
  * ```
  */
-export async function promiseState(p: Promise<unknown>): Promise<PromiseState> {
-  // NOTE:
-  // This 0 delay promise is required to refresh internal states of promises
-  await new Promise<void>((resolve) => {
-    setTimeout(() => resolve(), 0);
-  });
+export async function promiseState(
+  p: Promise<unknown>,
+  { immediate }: PromiseStateOptions = {},
+): Promise<PromiseState> {
+  if (!immediate) {
+    await flushPromises();
+  }
   const t = {};
   return Promise.race([p, t]).then(
     (v) => (v === t ? "pending" : "fulfilled"),

diff --git a/promise_state_bench.ts b/promise_state_bench.ts
@@ -13,6 +13,15 @@ Deno.bench({
   baseline: true,
 });
 
+Deno.bench({
+  name: "current (immediate)",
+  fn: async () => {
+    await promiseState(Promise.resolve("fulfilled"), { immediate: true });
+  },
+  group: "promiseState (fulfilled)",
+  baseline: true,
+});
+
 Deno.bench({
   name: "v1.0.0",
   fn: async () => {
@@ -31,6 +40,16 @@ Deno.bench({
   baseline: true,
 });
 
+Deno.bench({
+  name: "current (immediate)",
+  fn: async () => {
+    const p = Promise.reject("reject").catch(() => {});
+    await promiseState(p, { immediate: true });
+  },
+  group: "promiseState (rejected)",
+  baseline: true,
+});
+
 Deno.bench({
   name: "v1.0.0",
   fn: async () => {
@@ -49,6 +68,15 @@ Deno.bench({
   baseline: true,
 });
 
+Deno.bench({
+  name: "current (immediate)",
+  fn: async () => {
+    await promiseState(new Promise(() => {}), { immediate: true });
+  },
+  group: "promiseState (pending)",
+  baseline: true,
+});
+
 Deno.bench({
   name: "v1.0.0",
   fn: async () => {

diff --git a/promise_state_test.ts b/promise_state_test.ts
@@ -1,5 +1,6 @@
 import { test } from "@cross/test";
 import { assertEquals } from "@std/assert";
+import { flushPromises } from "./flush_promises.ts";
 import { promiseState } from "./promise_state.ts";
 
 test(
@@ -36,3 +37,15 @@ test("promiseState() returns refreshed status", async () => {
   resolve();
   assertEquals(await promiseState(p), "fulfilled");
 });
+
+test("promiseState() returns unrefreshed status with { immediate: true }", async () => {
+  const { promise, resolve } = Promise.withResolvers<void>();
+  const p = (async () => {
+    await promise;
+  })();
+  assertEquals(await promiseState(p, { immediate: true }), "pending");
+  resolve();
+  assertEquals(await promiseState(p, { immediate: true }), "pending");
+  await flushPromises();
+  assertEquals(await promiseState(p, { immediate: true }), "fulfilled");
+});