@tui-sandbox/library 2.2.0 → 3.0.0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "license": "MIT",
   "type": "module",
   "dependencies": {
-    "@catppuccin/palette": "1.5.0",
+    "@catppuccin/palette": "1.7.1",
     "@trpc/client": "11.0.0-rc.608",
     "@trpc/server": "11.0.0-rc.608",
     "@xterm/addon-attach": "0.11.0",
@@ -14,6 +14,7 @@
     "core-js": "3.39.0",
     "cors": "2.8.5",
     "dree": "5.1.5",
+    "neovim": "5.3.0",
     "node-pty": "1.0.0",
     "prettier": "3.3.3",
     "type-fest": "4.26.1",
@@ -24,7 +25,7 @@
     "@runtyping/zod": "2.1.1",
     "@types/command-exists": "1.2.3",
     "@types/cors": "2.8.17",
-    "@types/node": "22.8.6",
+    "@types/node": "22.9.0",
     "nodemon": "3.1.7",
     "vitest": "2.1.4"
   },

package/src/server/dirtree/index.test.ts

@@ -36,11 +36,11 @@ describe("dirtree", () => {
       import { z } from "zod"
 
       export const MyDirectoryTreeSchema = z.object({
-        name: z.literal("test-environment"),
+        name: z.literal("test-environment/"),
         type: z.literal("directory"),
         contents: z.object({
           "config-modifications": z.object({
-            name: z.literal("config-modifications"),
+            name: z.literal("config-modifications/"),
             type: z.literal("directory"),
             contents: z.object({
               "add_command_to_count_open_buffers.lua": z.object({
@@ -52,7 +52,7 @@ describe("dirtree", () => {
             }),
           }),
           "dir with spaces": z.object({
-            name: z.literal("dir with spaces"),
+            name: z.literal("dir with spaces/"),
             type: z.literal("directory"),
             contents: z.object({
               "file1.txt": z.object({
@@ -82,7 +82,7 @@ describe("dirtree", () => {
             stem: z.literal("initial-file."),
           }),
           "other-subdirectory": z.object({
-            name: z.literal("other-subdirectory"),
+            name: z.literal("other-subdirectory/"),
             type: z.literal("directory"),
             contents: z.object({
               "other-sub-file.txt": z.object({
@@ -94,11 +94,11 @@ describe("dirtree", () => {
             }),
           }),
           routes: z.object({
-            name: z.literal("routes"),
+            name: z.literal("routes/"),
             type: z.literal("directory"),
             contents: z.object({
               "posts.$postId": z.object({
-                name: z.literal("posts.$postId"),
+                name: z.literal("posts.$postId/"),
                 type: z.literal("directory"),
                 contents: z.object({
                   "adjacent-file.txt": z.object({
@@ -124,7 +124,7 @@ describe("dirtree", () => {
             }),
           }),
           subdirectory: z.object({
-            name: z.literal("subdirectory"),
+            name: z.literal("subdirectory/"),
             type: z.literal("directory"),
             contents: z.object({
               "subdirectory-file.txt": z.object({

package/src/server/dirtree/index.ts

@@ -55,7 +55,7 @@ export function convertDree(root: Dree): TreeNode {
   }
 
   const node: DirectoryNode = {
-    name: root.name,
+    name: `${root.name}/`,
     type: root.type,
     contents: {},
   }

package/src/server/neovim/NeovimApplication.ts

@@ -1,11 +1,15 @@
 import assert from "assert"
 import { exec } from "child_process"
 import EventEmitter from "events"
-import { existsSync } from "fs"
+import { access } from "fs/promises"
+import type { NeovimClient as NeovimApiClient } from "neovim"
+import { tmpdir } from "os"
 import path from "path"
 import type { TestDirectory } from "../types"
 import { DisposableSingleApplication } from "../utilities/DisposableSingleApplication"
+import type { Lazy } from "../utilities/Lazy"
 import { TerminalApplication } from "../utilities/TerminalApplication"
+import { connectNeovimApi } from "./NeovimJavascriptApiClient"
 
 /*
 
@@ -60,8 +64,14 @@ export type StartNeovimGenericArguments = {
   startupScriptModifications?: string[]
 }
 
+type ResettableState = {
+  testDirectory: TestDirectory
+  socketPath: string
+  client: Lazy<Promise<NeovimApiClient>>
+}
+
 export class NeovimApplication {
-  private testDirectory: TestDirectory | undefined
+  private state: ResettableState | undefined
   public readonly events: EventEmitter
 
   public constructor(
@@ -79,15 +89,20 @@ export class NeovimApplication {
     startArgs: StartNeovimGenericArguments
   ): Promise<void> {
     await this[Symbol.asyncDispose]()
-    this.testDirectory = testDirectory
+    assert(
+      this.state === undefined,
+      "NeovimApplication state should be undefined after disposing so that no previous state is reused."
+    )
 
     const neovimArguments = ["-u", "test-setup.lua"]
 
     if (startArgs.startupScriptModifications) {
       for (const modification of startArgs.startupScriptModifications) {
         const file = path.join(testDirectory.rootPathAbsolute, "config-modifications", modification)
-        if (!existsSync(file)) {
-          throw new Error(`startupScriptModifications file does not exist: ${file}`)
+        try {
+          await access(file)
+        } catch (e) {
+          throw new Error(`startupScriptModifications file does not exist: ${file}. Error: ${String(e)}`)
         }
 
         neovimArguments.push("-c", `lua dofile('${file}')`)
@@ -106,6 +121,11 @@ export class NeovimApplication {
         neovimArguments.push(filePath)
       }
     }
+
+    const id = Math.random().toString().slice(2, 8)
+    const socketPath = `${tmpdir()}/tui-sandbox-nvim-socket-${id}`
+    neovimArguments.push("--listen", socketPath)
+
     const stdout = this.events
 
     await this.application.startNextAndKillCurrent(async () => {
@@ -126,13 +146,30 @@ export class NeovimApplication {
 
     const processId = this.application.processId()
     assert(processId !== undefined, "Neovim was started without a process ID. This is a bug - please open an issue.")
+
+    this.state = {
+      testDirectory,
+      socketPath,
+      client: connectNeovimApi(socketPath),
+    }
+
     console.log(`🚀 Started Neovim instance ${processId}`)
   }
 
   async [Symbol.asyncDispose](): Promise<void> {
     await this.application[Symbol.asyncDispose]()
-    if (this.testDirectory) {
-      exec(`rm -rf ${this.testDirectory.rootPathAbsolute}`)
+
+    if (!this.state) return
+
+    exec(`rm -rf ${this.state.testDirectory.rootPathAbsolute}`)
+
+    try {
+      await access(this.state.socketPath)
+      throw new Error(`Socket file ${this.state.socketPath} should have been removed by neovim when it exited.`)
+    } catch (e) {
+      // all good
     }
+
+    this.state = undefined
   }
 }

package/src/server/neovim/NeovimJavascriptApiClient.test.ts

@@ -0,0 +1,42 @@
+import { access } from "fs/promises"
+import { attach } from "neovim"
+import type { PollingInterval } from "./NeovimJavascriptApiClient"
+import { connectNeovimApi } from "./NeovimJavascriptApiClient"
+
+vi.mock("neovim")
+vi.mock("fs/promises")
+
+const mocked = {
+  attach: vi.mocked(attach),
+  access: vi.mocked(access),
+  log: vi.spyOn(console, "log").mockImplementation(() => {
+    //
+  }),
+}
+const pollingInterval = 100 satisfies PollingInterval
+
+beforeEach(() => {
+  vi.useFakeTimers()
+})
+
+afterEach(() => {
+  vi.useRealTimers()
+})
+
+it("is lazy - does not connect right away", async () => {
+  mocked.access.mockRejectedValue(new Error("no such file or directory"))
+  connectNeovimApi("foosocket")
+
+  vi.advanceTimersByTime(pollingInterval)
+  expect(mocked.attach).not.toHaveBeenCalled()
+})
+
+it("connects right away if the socket file is already there", async () => {
+  mocked.access.mockResolvedValue(undefined)
+  const lazyClient = connectNeovimApi("foosocket")
+  await lazyClient.get()
+
+  vi.advanceTimersByTime(pollingInterval)
+  expect(mocked.attach).toHaveBeenCalledWith({ socket: "foosocket" })
+  expect(mocked.attach).toHaveBeenCalledTimes(1)
+})

package/src/server/neovim/NeovimJavascriptApiClient.ts

@@ -0,0 +1,27 @@
+import { access } from "fs/promises"
+import type { NeovimClient as NeovimApiClient } from "neovim"
+import { attach } from "neovim"
+import { Lazy } from "../utilities/Lazy"
+
+export type NeovimJavascriptApiClient = NeovimApiClient
+
+export type PollingInterval = 100
+
+export function connectNeovimApi(socketPath: string): Lazy<Promise<NeovimJavascriptApiClient>> {
+  // it takes about 100ms for the socket file to be created - best make this
+  // Lazy so that we don't wait for it unnecessarily.
+  return new Lazy(async () => {
+    for (let i = 0; i < 100; i++) {
+      try {
+        await access(socketPath)
+        console.log(`socket file ${socketPath} created after at attempt ${i + 1}`)
+        break
+      } catch (e) {
+        console.log(`polling for socket file ${socketPath} to be created (attempt ${i + 1})`)
+        await new Promise(resolve => setTimeout(resolve, 100 satisfies PollingInterval))
+      }
+    }
+
+    return attach({ socket: socketPath })
+  })
+}