@tui-sandbox/library 2.2.0 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [3.0.0](https://github.com/mikavilpas/tui-sandbox/compare/library-v2.3.0...library-v3.0.0) (2024-11-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* This change modifies the directory names in the MyTestDirectory file. To upgrade, run your tests once, and then commit the changes to that file. That's all.
+
+### Features
+
+* add `/` to the end of directory names to make it clear ([#114](https://github.com/mikavilpas/tui-sandbox/issues/114)) ([f40c912](https://github.com/mikavilpas/tui-sandbox/commit/f40c9129ad8ac5ec62bdf3276caead1606b2fedc))
+
+## [2.3.0](https://github.com/mikavilpas/tui-sandbox/compare/library-v2.2.0...library-v2.3.0) (2024-11-03)
+
+
+### Features
+
+* **wip:** allow access to neovim via a type safe socket connection ([#109](https://github.com/mikavilpas/tui-sandbox/issues/109)) ([1c4d919](https://github.com/mikavilpas/tui-sandbox/commit/1c4d9194ec8961bde0e8f84d500c27363c66a61b))
+
 ## [2.2.0](https://github.com/mikavilpas/tui-sandbox/compare/library-v2.1.0...library-v2.2.0) (2024-11-03)
 
 

package/dist/src/server/dirtree/index.js

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

package/dist/src/server/dirtree/index.test.js

@@ -29,11 +29,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({
@@ -45,7 +45,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({
@@ -75,7 +75,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({
@@ -87,11 +87,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({
@@ -117,7 +117,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/dist/src/server/neovim/NeovimApplication.d.ts

@@ -15,7 +15,7 @@ export type StartNeovimGenericArguments = {
 export declare class NeovimApplication {
     private readonly testEnvironmentPath;
     readonly application: DisposableSingleApplication;
-    private testDirectory;
+    private state;
     readonly events: EventEmitter;
     constructor(testEnvironmentPath: string, application?: DisposableSingleApplication);
     /**

package/dist/src/server/neovim/NeovimApplication.js

@@ -1,14 +1,16 @@
 import assert from "assert";
 import { exec } from "child_process";
 import EventEmitter from "events";
-import { existsSync } from "fs";
+import { access } from "fs/promises";
+import { tmpdir } from "os";
 import path from "path";
 import { DisposableSingleApplication } from "../utilities/DisposableSingleApplication";
 import { TerminalApplication } from "../utilities/TerminalApplication";
+import { connectNeovimApi } from "./NeovimJavascriptApiClient";
 export class NeovimApplication {
     testEnvironmentPath;
     application;
-    testDirectory;
+    state;
     events;
     constructor(testEnvironmentPath, application = new DisposableSingleApplication()) {
         this.testEnvironmentPath = testEnvironmentPath;
@@ -20,13 +22,16 @@ export class NeovimApplication {
      */
     async startNextAndKillCurrent(testDirectory, startArgs) {
         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}')`);
             }
@@ -43,6 +48,9 @@ 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 () => {
             return TerminalApplication.start({
@@ -59,12 +67,25 @@ 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]() {
         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/dist/src/server/neovim/NeovimJavascriptApiClient.d.ts

@@ -0,0 +1,5 @@
+import type { NeovimClient as NeovimApiClient } from "neovim";
+import { Lazy } from "../utilities/Lazy";
+export type NeovimJavascriptApiClient = NeovimApiClient;
+export type PollingInterval = 100;
+export declare function connectNeovimApi(socketPath: string): Lazy<Promise<NeovimJavascriptApiClient>>;

package/dist/src/server/neovim/NeovimJavascriptApiClient.js

@@ -0,0 +1,21 @@
+import { access } from "fs/promises";
+import { attach } from "neovim";
+import { Lazy } from "../utilities/Lazy";
+export function connectNeovimApi(socketPath) {
+    // 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));
+            }
+        }
+        return attach({ socket: socketPath });
+    });
+}

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

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

package/dist/src/server/neovim/NeovimJavascriptApiClient.test.js

@@ -0,0 +1,33 @@
+import { access } from "fs/promises";
+import { attach } from "neovim";
+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;
+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);
+});