npm - @pixel-point/toolcraft - Versions diffs - 0.0.8 → 0.0.11 - Mend

@pixel-point/toolcraft 0.0.8 → 0.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (88) hide show

package/templates/starter/scripts/toolcraft-port.test.mjs CHANGED Viewed

@@ -1,8 +1,19 @@
 import assert from "node:assert/strict";
+import fs from "node:fs/promises";
 import net from "node:net";
+import os from "node:os";
+import path from "node:path";
 import test from "node:test";
-import { findAvailablePort } from "./toolcraft-port.mjs";
+import {
+  findAvailablePort,
+  getListeningProcessIds,
+  killListeningProcessesOnPort,
+  readToolcraftAppIdentityFromHtml,
+  readSavedToolcraftPort,
+  waitForToolcraftAppOnPort,
+  writeSavedToolcraftPort,
+} from "./toolcraft-port.mjs";
 function listen(host) {
   return new Promise((resolve, reject) => {
@@ -71,3 +82,198 @@ test("findAvailablePort skips ports occupied on IPv4 localhost", async (t) => {
     "A port occupied on 127.0.0.1 must be treated as unavailable for localhost URLs.",
   );
 });
+test("saved Toolcraft port round-trips through local project state", async (t) => {
+  const cwd = await fs.mkdtemp(path.join(os.tmpdir(), "toolcraft-port-"));
+  t.after(() => fs.rm(cwd, { force: true, recursive: true }));
+  assert.equal(await readSavedToolcraftPort(cwd), null);
+  await writeSavedToolcraftPort(4123, cwd);
+  assert.equal(await readSavedToolcraftPort(cwd), 4123);
+});
+test("getListeningProcessIds parses unique listening process ids", async () => {
+  const pids = await getListeningProcessIds(4123, async () => ({
+    stderr: "",
+    stdout: "123\n456\n123\nnot-a-pid\n",
+  }));
+  assert.deepEqual(pids, [123, 456]);
+});
+test("killListeningProcessesOnPort targets listeners found on the port", async () => {
+  const killed = [];
+  const pids = await killListeningProcessesOnPort(4123, {
+    execFileImpl: async () => ({ stderr: "", stdout: "123\n456\n" }),
+    killProcess: (pid, signal) => {
+      killed.push({ pid, signal });
+    },
+  });
+  assert.deepEqual(pids, [123, 456]);
+  assert.deepEqual(killed, [
+    { pid: 123, signal: "SIGTERM" },
+    { pid: 456, signal: "SIGTERM" },
+  ]);
+});
+test("killListeningProcessesOnPort supports forced restart cleanup", async () => {
+  const killed = [];
+  const pids = await killListeningProcessesOnPort(4123, {
+    execFileImpl: async () => ({ stderr: "", stdout: "789\n" }),
+    killProcess: (pid, signal) => {
+      killed.push({ pid, signal });
+    },
+    signal: "SIGKILL",
+  });
+  assert.deepEqual(pids, [789]);
+  assert.deepEqual(killed, [{ pid: 789, signal: "SIGKILL" }]);
+});
+test("readToolcraftAppIdentityFromHtml prefers the app title meta marker", () => {
+  assert.deepEqual(
+    readToolcraftAppIdentityFromHtml(`
+      <html>
+        <head>
+          <meta name="toolcraft-app-title" content="Generated App" />
+          <title>Other Title</title>
+        </head>
+      </html>
+    `),
+    {
+      appTitle: "Generated App",
+      title: "Other Title",
+    },
+  );
+});
+test("waitForToolcraftAppOnPort accepts the current app identity", async (t) => {
+  const cwd = await fs.mkdtemp(path.join(os.tmpdir(), "toolcraft-port-identity-"));
+  t.after(() => fs.rm(cwd, { force: true, recursive: true }));
+  await fs.writeFile(
+    path.join(cwd, "index.html"),
+    '<meta name="toolcraft-app-title" content="Current App" /><title>Current App</title>',
+  );
+  const currentRoot = await fs.realpath(cwd);
+  const result = await waitForToolcraftAppOnPort(4321, {
+    cwd,
+    fetchImpl: async () => ({
+      ok: true,
+      text: async () => JSON.stringify({ appTitle: "Current App", root: currentRoot }),
+    }),
+    timeoutMs: 1,
+  });
+  assert.equal(result.url, "http://127.0.0.1:4321/");
+});
+test("waitForToolcraftAppOnPort verifies the current project root when the server identity endpoint exists", async (t) => {
+  const cwd = await fs.mkdtemp(path.join(os.tmpdir(), "toolcraft-port-root-"));
+  t.after(() => fs.rm(cwd, { force: true, recursive: true }));
+  await fs.writeFile(
+    path.join(cwd, "index.html"),
+    '<meta name="toolcraft-app-title" content="Current App" /><title>Current App</title>',
+  );
+  const currentRoot = await fs.realpath(cwd);
+  const result = await waitForToolcraftAppOnPort(4321, {
+    cwd,
+    fetchImpl: async (url) => ({
+      ok: true,
+      text: async () =>
+        String(url).includes("/.toolcraft/server-identity.json")
+          ? JSON.stringify({ appTitle: "Current App", root: currentRoot })
+          : '<meta name="toolcraft-app-title" content="Different App" /><title>Different App</title>',
+    }),
+    timeoutMs: 1,
+  });
+  assert.equal(result.url, "http://127.0.0.1:4321/");
+});
+test("waitForToolcraftAppOnPort checks IPv6 localhost when IPv4 does not respond", async (t) => {
+  const cwd = await fs.mkdtemp(path.join(os.tmpdir(), "toolcraft-port-ipv6-"));
+  t.after(() => fs.rm(cwd, { force: true, recursive: true }));
+  await fs.writeFile(
+    path.join(cwd, "index.html"),
+    '<meta name="toolcraft-app-title" content="Current App" /><title>Current App</title>',
+  );
+  const currentRoot = await fs.realpath(cwd);
+  const result = await waitForToolcraftAppOnPort(4321, {
+    cwd,
+    fetchImpl: async (url) => {
+      if (String(url).startsWith("http://127.0.0.1:4321")) {
+        throw new Error("fetch failed");
+      }
+      return {
+        ok: true,
+        text: async () =>
+          String(url).includes("/.toolcraft/server-identity.json")
+            ? JSON.stringify({ appTitle: "Current App", root: currentRoot })
+            : '<meta name="toolcraft-app-title" content="Current App" /><title>Current App</title>',
+      };
+    },
+    timeoutMs: 1,
+  });
+  assert.equal(result.url, "http://[::1]:4321/");
+});
+test("waitForToolcraftAppOnPort rejects a port serving another app", async (t) => {
+  const cwd = await fs.mkdtemp(path.join(os.tmpdir(), "toolcraft-port-foreign-"));
+  t.after(() => fs.rm(cwd, { force: true, recursive: true }));
+  await fs.writeFile(
+    path.join(cwd, "index.html"),
+    '<meta name="toolcraft-app-title" content="Current App" /><title>Current App</title>',
+  );
+  const otherRoot = await fs.mkdtemp(path.join(os.tmpdir(), "toolcraft-port-foreign-root-"));
+  t.after(() => fs.rm(otherRoot, { force: true, recursive: true }));
+  const otherRealRoot = await fs.realpath(otherRoot);
+  await assert.rejects(
+    () =>
+      waitForToolcraftAppOnPort(4321, {
+        cwd,
+        fetchImpl: async () => ({
+          ok: true,
+          text: async () => JSON.stringify({ appTitle: "Different App", root: otherRealRoot }),
+        }),
+        timeoutMs: 1,
+      }),
+    /Port 4321 is serving Different App at .* instead of this app Current App at /,
+  );
+});
+test("waitForToolcraftAppOnPort rejects a matching title from a different project root", async (t) => {
+  const cwd = await fs.mkdtemp(path.join(os.tmpdir(), "toolcraft-port-root-current-"));
+  const otherRoot = await fs.mkdtemp(path.join(os.tmpdir(), "toolcraft-port-root-other-"));
+  t.after(() => fs.rm(cwd, { force: true, recursive: true }));
+  t.after(() => fs.rm(otherRoot, { force: true, recursive: true }));
+  await fs.writeFile(
+    path.join(cwd, "index.html"),
+    '<meta name="toolcraft-app-title" content="Current App" /><title>Current App</title>',
+  );
+  const otherRealRoot = await fs.realpath(otherRoot);
+  await assert.rejects(
+    () =>
+      waitForToolcraftAppOnPort(4321, {
+        cwd,
+        fetchImpl: async (url) => ({
+          ok: true,
+          text: async () =>
+            String(url).includes("/.toolcraft/server-identity.json")
+              ? JSON.stringify({ appTitle: "Current App", root: otherRealRoot })
+              : '<meta name="toolcraft-app-title" content="Current App" /><title>Current App</title>',
+        }),
+        timeoutMs: 1,
+      }),
+    /Port 4321 is serving Current App at .* instead of this app Current App at /,
+  );
+});