@tui-sandbox/library 2.0.1 → 2.1.0

package/dist/src/server/utilities/TerminalApplication.d.ts

@@ -1,19 +1,20 @@
 import type winston from "winston";
 import type { ITerminalDimensions } from "@xterm/addon-fit";
-export declare class TerminalApplication {
+import type { StartableApplication } from "./DisposableSingleApplication";
+export declare class TerminalApplication implements StartableApplication {
     private readonly subProcess;
     readonly onStdoutOrStderr: (data: string) => void;
     readonly processId: number;
     readonly logger: winston.Logger;
     private constructor();
     /** @constructor Start a new terminal application. */
-    static start({ onStdoutOrStderr, command, args, cwd, env, dimensions: givenDimensions, }: {
+    static start({ onStdoutOrStderr, command, args, cwd, env, dimensions, }: {
         onStdoutOrStderr: (data: string) => void;
         command: string;
         args: string[];
         cwd: string;
         env?: NodeJS.ProcessEnv;
-        dimensions?: ITerminalDimensions;
+        dimensions: ITerminalDimensions;
     }): TerminalApplication;
     /** Write to the terminal's stdin. */
     write(data: string): void;

package/dist/src/server/utilities/TerminalApplication.js

@@ -1,8 +1,5 @@
 import { createLogger, format, transports } from "winston";
 import pty from "node-pty";
-// NOTE the size for the terminal was chosen so that it looks good in my
-// cypress test preview
-const defaultDimensions = { cols: 125, rows: 43 };
 // NOTE separating stdout and stderr is not supported by node-pty
 // https://github.com/microsoft/node-pty/issues/71
 export class TerminalApplication {
@@ -26,8 +23,7 @@ export class TerminalApplication {
         });
     }
     /** @constructor Start a new terminal application. */
-    static start({ onStdoutOrStderr, command, args, cwd, env, dimensions: givenDimensions, }) {
-        const dimensions = givenDimensions ?? defaultDimensions;
+    static start({ onStdoutOrStderr, command, args, cwd, env, dimensions, }) {
         console.log(`Starting '${command} ${args.join(" ")}' in cwd '${cwd}'`);
         const ptyProcess = pty.spawn(command, args, {
             name: "xterm-color",

package/dist/src/server/utilities/generator.d.ts

@@ -0,0 +1,2 @@
+import type EventEmitter from "events";
+export declare function convertEventEmitterToAsyncGenerator(emitter: EventEmitter, eventName: string): AsyncGenerator<string, void, unknown>;

package/dist/src/server/utilities/generator.js

@@ -0,0 +1,8 @@
+export async function* convertEventEmitterToAsyncGenerator(emitter, eventName) {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    while (true) {
+        yield await new Promise(resolve => {
+            emitter.once(eventName, resolve);
+        });
+    }
+}

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

@@ -0,0 +1 @@
+export {};

package/dist/src/server/utilities/generator.test.js

@@ -0,0 +1,41 @@
+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",
+      }
+    `);
+    });
+});