@tui-sandbox/library 2.0.2 → 2.2.0

package/src/server/utilities/generator.test.ts

@@ -0,0 +1,49 @@
+import { EventEmitter } from "stream"
+import { convertEventEmitterToAsyncGenerator } from "./generator"
+
+describe("when a listener is attached", () => {
+  it("forwards events from an EventEmitter to an async generator", async () => {
+    const eventEmitter = new EventEmitter()
+    const generator = convertEventEmitterToAsyncGenerator(eventEmitter, "test")
+
+    {
+      const promise = generator.next()
+      eventEmitter.emit("test", "message")
+
+      expect(await promise).toMatchInlineSnapshot(`
+        {
+          "done": false,
+          "value": "message",
+        }
+      `)
+
+      const promise2 = generator.next()
+      eventEmitter.emit("test", "message2")
+
+      expect(await promise2).toMatchInlineSnapshot(`
+        {
+          "done": false,
+          "value": "message2",
+        }
+      `)
+    }
+  })
+})
+
+describe("when no listener is attached, messages are lost permanently", () => {
+  it("does not resend lost events after a subscriber attaches", async () => {
+    const eventEmitter = new EventEmitter()
+    eventEmitter.emit("test", "this message should be lost")
+
+    const generator = convertEventEmitterToAsyncGenerator(eventEmitter, "test")
+    const promise = generator.next()
+    eventEmitter.emit("test", "new message that will be received")
+
+    expect(await promise).toMatchInlineSnapshot(`
+      {
+        "done": false,
+        "value": "new message that will be received",
+      }
+    `)
+  })
+})

package/src/server/utilities/generator.ts

@@ -0,0 +1,13 @@
+import type EventEmitter from "events"
+
+export async function* convertEventEmitterToAsyncGenerator(
+  emitter: EventEmitter,
+  eventName: string
+): AsyncGenerator<string, void, unknown> {
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  while (true) {
+    yield await new Promise(resolve => {
+      emitter.once(eventName, resolve)
+    })
+  }
+}

package/tsconfig.json

@@ -11,7 +11,7 @@
     "esModuleInterop": true,
     "outDir": "dist",
     "lib": ["ES2023", "ESNext.Disposable"],
-    "types": ["node"],
+    "types": ["node", "vitest/globals"],
     "composite": true,
 
     /* Linting */
@@ -21,5 +21,5 @@
     "noFallthroughCasesInSwitch": true
   },
 
-  "include": ["./src/"]
+  "include": ["./src/", "./vitest.config.ts"]
 }

package/vitest.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from "vitest/config"
+
+export default defineConfig({
+  test: {
+    globals: true, // This will make describe, it, etc. available globally
+    environment: "node",
+    mockReset: true,
+  },
+})