@tui-sandbox/library 1.2.0 → 2.0.0

package/src/client/style.css

@@ -1,6 +1,6 @@
 @font-face {
   font-family: "DejaVuSansMNerdFontMono";
-  src: url("../public/DejaVuSansMNerdFontMono-Regular.ttf");
+  src: url("./public/DejaVuSansMNerdFontMono-Regular.ttf");
   font-weight: normal;
   font-style: normal;
 }

package/src/client/websocket-client.ts

@@ -1,12 +1,8 @@
 import { flavors } from "@catppuccin/palette"
-import { createTRPCClient, createWSClient, wsLink } from "@trpc/client"
 import { FitAddon } from "@xterm/addon-fit"
 import { Terminal } from "@xterm/xterm"
 import "@xterm/xterm/css/xterm.css"
 import z from "zod"
-import type { StartNeovimGenericArguments } from "../server/neovim/NeovimApplication.ts"
-import type { AppRouter } from "../server/server.ts"
-import type { TestDirectory } from "../server/types.ts"
 import type { TabId } from "../server/utilities/tabId.ts"
 import "./style.css"
 import { validateMouseEvent } from "./validateMouseEvent"
@@ -90,68 +86,3 @@ export function getTabId(): TabId {
 
   return { tabId }
 }
-
-export class NeovimClient {
-  private readonly ready: Promise<void>
-  private readonly tabId: { tabId: string }
-  private readonly terminal: Terminal
-  private readonly trpc: ReturnType<typeof createTRPCClient<AppRouter>>
-
-  constructor(app: HTMLElement) {
-    const wsClient = createWSClient({ url: `ws://localhost:3000`, WebSocket })
-    const trpc = createTRPCClient<AppRouter>({
-      links: [wsLink({ client: wsClient })],
-    })
-    this.trpc = trpc
-
-    this.tabId = getTabId()
-    const tabId = this.tabId
-
-    const terminal = startTerminal(app, {
-      onMouseEvent(data: string) {
-        void trpc.neovim.sendStdin.mutate({ tabId, data }).catch((error: unknown) => {
-          console.error(`Error sending mouse event`, error)
-        })
-      },
-      onKeyPress(event) {
-        void trpc.neovim.sendStdin.mutate({ tabId, data: event.key })
-      },
-    })
-    this.terminal = terminal
-
-    // start listening to Neovim stdout - this will take some (short) amount of
-    // time to complete
-    this.ready = new Promise<void>(resolve => {
-      console.log("Subscribing to Neovim stdout")
-      trpc.neovim.onStdout.subscribe(
-        { client: tabId },
-        {
-          onStarted() {
-            resolve()
-          },
-          onData(data: string) {
-            terminal.write(data)
-          },
-          onError(err: unknown) {
-            console.error(`Error from Neovim`, err)
-          },
-        }
-      )
-    })
-  }
-
-  public async startNeovim(args: StartNeovimGenericArguments): Promise<TestDirectory> {
-    await this.ready
-
-    const neovim = await this.trpc.neovim.start.mutate({
-      startNeovimArguments: args,
-      tabId: this.tabId,
-      terminalDimensions: {
-        cols: this.terminal.cols,
-        rows: this.terminal.rows,
-      },
-    })
-
-    return neovim
-  }
-}

package/src/server/TestServer.ts

@@ -0,0 +1,54 @@
+import type { AnyTRPCRouter } from "@trpc/server"
+import { applyWSSHandler } from "@trpc/server/adapters/ws"
+import "core-js/proposals/async-explicit-resource-management"
+import { once } from "events"
+import { WebSocketServer } from "ws"
+import { createContext } from "./connection/trpc"
+import type { TestServerConfig } from "./updateTestdirectorySchemaFile"
+import { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile"
+
+export class TestServer {
+  public constructor(private readonly port: number) {}
+
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
+  public async startAndRun<TRouter extends AnyTRPCRouter>(appRouter: TRouter, config: TestServerConfig): Promise<void> {
+    console.log("🚀 Server starting")
+
+    await updateTestdirectorySchemaFile(config)
+
+    const wss = new WebSocketServer({ port: this.port })
+    const handler = applyWSSHandler<TRouter>({
+      wss,
+      router: appRouter,
+      createContext,
+      // Enable heartbeat messages to keep connection open (disabled by default)
+      keepAlive: {
+        enabled: true,
+        // server ping message interval in milliseconds
+        pingMs: 30_000,
+        // connection is terminated if pong message is not received in this many milliseconds
+        pongWaitMs: 5000,
+      },
+    })
+
+    wss.on("connection", socket => {
+      console.log(`➕➕ Connection (${wss.clients.size})`)
+      socket.once("close", () => {
+        console.log(`➖➖ Connection (${wss.clients.size})`)
+      })
+    })
+    console.log(`✅ WebSocket Server listening on ws://localhost:${this.port}`)
+
+    await Promise.race([once(process, "SIGTERM"), once(process, "SIGINT")])
+    console.log("Shutting down...")
+    handler.broadcastReconnectNotification()
+    wss.close(error => {
+      if (error) {
+        console.error("Error closing WebSocket server", error)
+        process.exit(1)
+      }
+      console.log("WebSocket server closed")
+      process.exit(0)
+    })
+  }
+}

package/src/server/dirtree/index.ts

@@ -54,13 +54,12 @@ export function convertDree(root: Dree): TreeNode {
     }
   }
 
-  assert(root.children, `Expected children for directory node ${root.name}`)
   const node: DirectoryNode = {
     name: root.name,
     type: root.type,
     contents: {},
   }
-  for (const child of root.children) {
+  for (const child of root.children || []) {
     node.contents[child.name] = convertDree(child)
   }
 

package/src/server/index.ts

@@ -1,54 +1,7 @@
-import type { AnyRouter } from "@trpc/server"
-import { applyWSSHandler } from "@trpc/server/adapters/ws"
 import "core-js/proposals/async-explicit-resource-management"
-import { once } from "events"
-import { WebSocketServer } from "ws"
-import { createContext } from "./connection/trpc"
-import type { TestServerConfig } from "./updateTestdirectorySchemaFile"
-import { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile"
 
-export class TestServer {
-  public constructor(private readonly port: number) {}
+// This is the public server api. Semantic versioning will be applied to this.
 
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
-  public async startAndRun<TRouter extends AnyRouter>(appRouter: TRouter, config: TestServerConfig): Promise<void> {
-    console.log("🚀 Server starting")
-
-    await updateTestdirectorySchemaFile(config)
-
-    const wss = new WebSocketServer({ port: this.port })
-    const handler = applyWSSHandler<TRouter>({
-      wss,
-      router: appRouter,
-      createContext,
-      // Enable heartbeat messages to keep connection open (disabled by default)
-      keepAlive: {
-        enabled: true,
-        // server ping message interval in milliseconds
-        pingMs: 30_000,
-        // connection is terminated if pong message is not received in this many milliseconds
-        pongWaitMs: 5000,
-      },
-    })
-
-    wss.on("connection", socket => {
-      console.log(`➕➕ Connection (${wss.clients.size})`)
-      socket.once("close", () => {
-        console.log(`➖➖ Connection (${wss.clients.size})`)
-      })
-    })
-    console.log(`✅ WebSocket Server listening on ws://localhost:${this.port}`)
-
-    await Promise.race([once(process, "SIGTERM"), once(process, "SIGINT")])
-    console.log("Shutting down...")
-    handler.broadcastReconnectNotification()
-    wss.close(error => {
-      if (error) {
-        console.error("Error closing WebSocket server", error)
-        process.exit(1)
-      }
-      console.log("WebSocket server closed")
-      process.exit(0)
-    })
-  }
-}
+export { startTestServer } from "./server"
+export { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile"
+export type { TestServerConfig } from "./updateTestdirectorySchemaFile"

package/src/server/neovim/environment/createTempDir.test.ts

@@ -0,0 +1,34 @@
+import fs, { rmdirSync } from "fs"
+import nodePath from "path"
+import { expect, it } from "vitest"
+import type { TestDirsPath } from "./createTempDir"
+import { createTempDir } from "./createTempDir"
+
+type TestTempDirPrefix = "test-temp-dir-"
+
+class TempDirectory implements Disposable {
+  constructor(public readonly path: string) {}
+
+  public static create(): TempDirectory {
+    const tmp = fs.mkdtempSync("test-temp-dir-" satisfies TestTempDirPrefix)
+    return new TempDirectory(tmp)
+  }
+
+  [Symbol.dispose](): void {
+    rmdirSync(this.path, { recursive: true })
+  }
+}
+
+it("should create a temp dir with no contents", async () => {
+  // typically the user will want to have contents, but this should not be an error
+  await using dir = TempDirectory.create()
+  const result = await createTempDir({
+    testEnvironmentPath: dir.path,
+    outputFilePath: nodePath.join(dir.path, "MyTestDirectory.ts"),
+  })
+
+  expect(result.contents).toEqual({})
+  expect(result.testEnvironmentPath).toEqual(dir.path)
+  expect(result.testEnvironmentPath.startsWith("test-temp-dir-" satisfies TestTempDirPrefix)).toBeTruthy()
+  expect(result.testEnvironmentPathRelative.startsWith("testdirs" satisfies TestDirsPath)).toBeTruthy()
+})

package/src/server/neovim/environment/createTempDir.ts

@@ -14,7 +14,7 @@ export async function createTempDir(config: TestServerConfig): Promise<TestDirec
     const dir = await createUniqueDirectory(config.testEnvironmentPath)
 
     readdirSync(config.testEnvironmentPath).forEach(entry => {
-      if (entry === "testdirs") return
+      if (entry === ("testdirs" satisfies TestDirsPath)) return
       if (entry === ".repro") return
 
       execSync(`cp -a '${path.join(config.testEnvironmentPath, entry)}' ${dir}/`)
@@ -37,8 +37,10 @@ export async function createTempDir(config: TestServerConfig): Promise<TestDirec
   }
 }
 
+export type TestDirsPath = "testdirs"
+
 async function createUniqueDirectory(testEnvironmentPath: string): Promise<string> {
-  const testdirs = path.join(testEnvironmentPath, "testdirs")
+  const testdirs = path.join(testEnvironmentPath, "testdirs" satisfies TestDirsPath)
   try {
     await access(testdirs, constants.F_OK)
   } catch {

package/src/server/server.ts

@@ -1,8 +1,8 @@
 import type { inferRouterInputs } from "@trpc/server"
 import { z } from "zod"
-import { TestServer } from "."
 import { trpc } from "./connection/trpc"
 import * as neovim from "./neovim"
+import { TestServer } from "./TestServer"
 import type { TestServerConfig } from "./updateTestdirectorySchemaFile"
 import { tabIdSchema } from "./utilities/tabId"