chore: Expose function to sleep or abort on AbortSignal

packages/base-test-utils/src/index.ts

@@ -1,6 +1,10 @@
 import type { CID } from 'multiformats/cid'
 import { randomCID, StreamID } from '@ceramicnetwork/streamid'
 
+const delay = async function (ms: number) {
+  return new Promise<void>((resolve) => setTimeout(() => resolve(), ms))
+}
+
 export class BaseTestUtils {
   static randomCID(version: 0 | 1 = 1, codec = 0x71, hasher = 0x12): CID {
     return randomCID(version, codec, hasher)
@@ -32,7 +36,7 @@ export class BaseTestUtils {
     const deadline = new Date(startTime.getTime() + timeoutMs)
     let now = startTime
     while (now < deadline) {
-      await BaseTestUtils.delay(100)
+      await delay(100)
       now = new Date()
 
       try {
@@ -53,19 +57,4 @@ export class BaseTestUtils {
     const customMsg = typeof errMsgGenerator == 'string' ? errMsgGenerator : errMsgGenerator()
     throw new Error(baseErrMsg + ': ' + customMsg)
   }
-
-  static async delay(ms: number, signal?: AbortSignal): Promise<void> {
-    return new Promise<void>((resolve, reject) => {
-      const timeout = setTimeout(() => resolve(), ms)
-      if (signal) {
-        const handleAbort = () => {
-          clearTimeout(timeout)
-          signal.removeEventListener('abort', handleAbort)
-          reject(signal.reason)
-        }
-        if (signal.aborted) handleAbort()
-        signal.addEventListener('abort', handleAbort)
-      }
-    })
-  }
 }

packages/common-test-utils/src/index.ts

@@ -5,6 +5,7 @@ import type { StreamState, Stream } from '@ceramicnetwork/common'
 import {
   AdminApi,
   AnchorStatus,
+  delayOrAbort,
   EnvironmentUtils,
   EventType,
   RunningStateLike,
@@ -45,8 +46,9 @@ export class CommonTestUtils {
   }
 
   static async delay(ms: number, signal?: AbortSignal): Promise<void> {
-    return BaseTestUtils.delay(ms, signal)
+    return delayOrAbort(ms, signal)
   }
+
   /**
    * Given a stream and a predicate that operates on the stream state, continuously waits for
    * changes to the stream until the predicate returns true.

packages/common/src/utils/abort-signal-utils.ts

@@ -66,3 +66,18 @@ export async function abortable<T>(
     original.removeEventListener('abort', onAbort)
   })
 }
+
+export async function delayOrAbort(ms: number, signal?: AbortSignal): Promise<void> {
+  return new Promise<void>((resolve, reject) => {
+    const timeout = setTimeout(() => resolve(), ms)
+    if (signal) {
+      const handleAbort = () => {
+        clearTimeout(timeout)
+        signal.removeEventListener('abort', handleAbort)
+        reject(signal.reason)
+      }
+      if (signal.aborted) handleAbort()
+      signal.addEventListener('abort', handleAbort)
+    }
+  })
+}