gdharness 0.5.7 → 0.5.9

package/build/index.js

@@ -10126,9 +10126,9 @@ function defectReport(where, error, godotVersion) {
 
 // src/server.ts
 import { execFile as execFile3, spawn } from "node:child_process";
-import { existsSync as existsSync6, mkdtempSync as mkdtempSync2, readdirSync as readdirSync5, readFileSync as readFileSync7, realpathSync as realpathSync2, rmSync as rmSync2 } from "node:fs";
+import { existsSync as existsSync6, mkdtempSync as mkdtempSync2, readdirSync as readdirSync5, readFileSync as readFileSync7, realpathSync as realpathSync2, rmSync as rmSync3 } from "node:fs";
 import { tmpdir as tmpdir4 } from "node:os";
-import { basename, dirname as dirname2, join as join7, normalize as normalize2 } from "node:path";
+import { basename, dirname as dirname3, join as join8, normalize as normalize2 } from "node:path";
 import { setTimeout as delay2 } from "node:timers/promises";
 import { fileURLToPath as fileURLToPath2 } from "node:url";
 import { promisify as promisify3 } from "node:util";
@@ -24696,9 +24696,47 @@ class StdioServerTransport {
   }
 }
 
+// src/bridge-announce.ts
+import { mkdirSync as mkdirSync2, rmSync, writeFileSync as writeFileSync2 } from "node:fs";
+import { dirname, join as join2 } from "node:path";
+function announcementPath(projectPath) {
+  return join2(projectPath, ".godot", "gdharness-bridge.json");
+}
+var BRIDGE_ANNOUNCE_PROTOCOL = 1;
+function announceBridge(projectPath, bridge) {
+  const path = announcementPath(projectPath);
+  try {
+    mkdirSync2(dirname(path), { recursive: true });
+    const announcement = {
+      protocol: BRIDGE_ANNOUNCE_PROTOCOL,
+      host: bridge.host,
+      port: bridge.port,
+      pid: process.pid,
+      version: bridge.version,
+      startedAt: new Date().toISOString()
+    };
+    writeFileSync2(path, `${JSON.stringify(announcement, null, 2)}
+`, "utf8");
+    return path;
+  } catch (error) {
+    console.error(`[SERVER] Could not announce the editor bridge at ${path}: ${errorMessage(error)}`);
+    return null;
+  }
+}
+function withdrawBridge(path) {
+  if (path === null) {
+    return;
+  }
+  try {
+    rmSync(path, { force: true });
+  } catch (error) {
+    console.error(`[SERVER] Could not withdraw the editor bridge announcement: ${errorMessage(error)}`);
+  }
+}
+
 // src/class-cache.ts
 import { existsSync as existsSync2, readdirSync, readFileSync as readFileSync3 } from "node:fs";
-import { join as join2 } from "node:path";
+import { join as join3 } from "node:path";
 function declaredClasses(projectPath) {
   const declared = new Map;
   const visit = (directory, prefix) => {
@@ -24706,7 +24744,7 @@ function declaredClasses(projectPath) {
       if (entry.name.startsWith(".")) {
         continue;
       }
-      const path = join2(directory, entry.name);
+      const path = join3(directory, entry.name);
       if (entry.isDirectory()) {
         visit(path, `${prefix}${entry.name}/`);
       } else if (entry.isFile() && entry.name.endsWith(".gd")) {
@@ -24721,7 +24759,7 @@ function declaredClasses(projectPath) {
   return declared;
 }
 function cachedClasses(projectPath) {
-  const cache = join2(projectPath, ".godot", "global_script_class_cache.cfg");
+  const cache = join3(projectPath, ".godot", "global_script_class_cache.cfg");
   if (!existsSync2(cache)) {
     return null;
   }
@@ -25426,19 +25464,37 @@ class GodotBridge extends EventEmitter {
   connectionInfo = null;
   pendingRequests = new Map;
   resourceQueues = new Map;
-  port;
+  wantedPort;
+  boundPort = null;
   host;
   timeoutMs;
-  constructor(port = DEFAULT_PORT, host = DEFAULT_HOST, timeoutMs = DEFAULT_TIMEOUT_MS) {
+  mayMove;
+  constructor(port = DEFAULT_PORT, host = DEFAULT_HOST, timeoutMs = DEFAULT_TIMEOUT_MS, mayMove = false) {
     super();
-    this.port = port;
+    this.wantedPort = port;
     this.host = host;
     this.timeoutMs = timeoutMs;
+    this.mayMove = mayMove;
   }
-  start() {
+  get port() {
+    return this.boundPort ?? this.wantedPort;
+  }
+  async start() {
     if (this.httpServer) {
-      return Promise.resolve();
+      return;
+    }
+    try {
+      await this.listenOn(this.wantedPort);
+    } catch (error) {
+      const held = error instanceof Error && "code" in error && error.code === "EADDRINUSE";
+      if (!held || !this.mayMove) {
+        throw error;
+      }
+      this.log("warn", `Editor bridge port ${this.wantedPort} is held; taking another one.`);
+      await this.listenOn(0);
     }
+  }
+  listenOn(port) {
     return new Promise((resolve, reject) => {
       const server = http.createServer((_req, res) => {
         res.writeHead(404);
@@ -25462,6 +25518,8 @@ class GodotBridge extends EventEmitter {
         settled = true;
         this.httpServer = server;
         this.godotWss = godotWss;
+        const bound = server.address();
+        this.boundPort = typeof bound === "object" && bound !== null ? bound.port : port;
         this.log("info", `Editor bridge listening on ${this.host}:${this.port}`);
         resolve();
       });
@@ -25478,7 +25536,7 @@ class GodotBridge extends EventEmitter {
       godotWss.on("error", (error) => {
         this.log("error", `Godot WebSocket server error: ${error.message}`);
       });
-      server.listen(this.port, this.host);
+      server.listen(port, this.host);
     });
   }
   async stop() {
@@ -25512,6 +25570,7 @@ class GodotBridge extends EventEmitter {
       this.httpServer = null;
     }
     await Promise.all(closeTasks);
+    this.boundPort = null;
     this.connectionInfo = null;
     this.log("info", "WebSocket bridge stopped");
   }
@@ -25813,8 +25872,8 @@ class GodotBridge extends EventEmitter {
   }
 }
 var defaultBridge = null;
-function getDefaultBridge() {
-  defaultBridge ??= new GodotBridge(resolveDefaultBridgePort(), resolveDefaultBridgeHost());
+function getDefaultBridge(mayMove = false) {
+  defaultBridge ??= new GodotBridge(resolveDefaultBridgePort(), resolveDefaultBridgeHost(), DEFAULT_TIMEOUT_MS, mayMove);
   return defaultBridge;
 }
 
@@ -25827,7 +25886,7 @@ import { promisify } from "node:util";
 // src/detection.ts
 import { existsSync as existsSync3, readdirSync as readdirSync2, statSync } from "node:fs";
 import { homedir as homedir2 } from "node:os";
-import { join as join3 } from "node:path";
+import { join as join4 } from "node:path";
 function resolveHomeDirectory() {
   try {
     return homedir2();
@@ -25851,7 +25910,7 @@ function scanDirectoryForGodotBinaries(directory, platform) {
     if (!pattern.test(name)) {
       continue;
     }
-    const fullPath = join3(directory, name);
+    const fullPath = join4(directory, name);
     try {
       const stat = statSync(fullPath);
       if (stat.isFile()) {
@@ -25860,7 +25919,7 @@ function scanDirectoryForGodotBinaries(directory, platform) {
     } catch {}
   }
   matches.sort((a, b) => b.mtime - a.mtime);
-  return matches.map((m) => join3(directory, m.name));
+  return matches.map((m) => join4(directory, m.name));
 }
 function conventionalPaths(platform, home) {
   const paths = ["godot"];
@@ -26003,9 +26062,9 @@ class GodotLocator {
 
 // src/headless.ts
 import { execFile as execFile2 } from "node:child_process";
-import { mkdtempSync, rmSync, writeFileSync as writeFileSync2 } from "node:fs";
+import { mkdtempSync, rmSync as rmSync2, writeFileSync as writeFileSync3 } from "node:fs";
 import { tmpdir as tmpdir2 } from "node:os";
-import { join as join4 } from "node:path";
+import { join as join5 } from "node:path";
 import { promisify as promisify2 } from "node:util";
 var run2 = promisify2(execFile2);
 function snakeCased(params) {
@@ -26046,9 +26105,9 @@ function reason(stdout, stderr) {
   return stdout.trim().split(/\r?\n/).at(-1) ?? "no output at all";
 }
 async function runOperation(engine, operation, params, projectPath) {
-  const paramsDir = mkdtempSync(join4(tmpdir2(), "gdharness-params-"));
-  const paramsFile = join4(paramsDir, `${operation}.json`);
-  writeFileSync2(paramsFile, JSON.stringify(snakeCased(params)), "utf8");
+  const paramsDir = mkdtempSync(join5(tmpdir2(), "gdharness-params-"));
+  const paramsFile = join5(paramsDir, `${operation}.json`);
+  writeFileSync3(paramsFile, JSON.stringify(snakeCased(params)), "utf8");
   const args = [
     "--headless",
     "--path",
@@ -26078,7 +26137,7 @@ async function runOperation(engine, operation, params, projectPath) {
       messages: []
     };
   } finally {
-    rmSync(paramsDir, { recursive: true, force: true });
+    rmSync2(paramsDir, { recursive: true, force: true });
   }
   const payload = lastJsonObject(stdout);
   if (payload === null) {
@@ -26373,7 +26432,7 @@ function parseJUnit(xml) {
 import { realpathSync } from "node:fs";
 import { readFile, realpath } from "node:fs/promises";
 import { createConnection as createConnection2 } from "node:net";
-import { dirname, resolve as resolve2 } from "node:path";
+import { dirname as dirname2, resolve as resolve2 } from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
 
 // src/paths.ts
@@ -26551,7 +26610,7 @@ class GodotLSPClient {
     if (this.initialized) {
       return;
     }
-    const rootPath = this.rootPath ?? dirname(resolve2(filePath));
+    const rootPath = this.rootPath ?? dirname2(resolve2(filePath));
     await this.initialize(rootPath);
   }
   async sendRequest(method, params) {
@@ -26919,7 +26978,7 @@ async function handleLSPTool(client, toolName, args) {
 
 // src/project-scan.ts
 import { readdirSync as readdirSync3, readFileSync as readFileSync4 } from "node:fs";
-import { join as join5 } from "node:path";
+import { join as join6 } from "node:path";
 var SKIPPED = new Set([".git", ".godot", ".import", "node_modules"]);
 var ASSET_EXTENSIONS = new Set(["png", "jpg", "jpeg", "webp", "svg", "ttf", "otf", "wav", "mp3", "ogg"]);
 function projectStructure(projectPath) {
@@ -26930,7 +26989,7 @@ function projectStructure(projectPath) {
         continue;
       }
       if (entry.isDirectory()) {
-        visit(join5(directory, entry.name));
+        visit(join6(directory, entry.name));
       } else if (entry.isFile()) {
         const extension = entry.name.split(".").pop()?.toLowerCase() ?? "";
         if (extension === "tscn") {
@@ -26972,7 +27031,7 @@ function searchProject(projectPath, options) {
       if (SKIPPED.has(entry.name)) {
         continue;
       }
-      const entryPath = join5(directory, entry.name);
+      const entryPath = join6(directory, entry.name);
       if (entry.isDirectory()) {
         visit(entryPath);
         continue;
@@ -27226,7 +27285,7 @@ function setupResourceHandlers(mcp, getProjectPath) {
 import { existsSync as existsSync5, readdirSync as readdirSync4, readFileSync as readFileSync6, unlinkSync } from "node:fs";
 import { createConnection as createConnection3 } from "node:net";
 import { tmpdir as tmpdir3 } from "node:os";
-import { join as join6, resolve as resolve4 } from "node:path";
+import { join as join7, resolve as resolve4 } from "node:path";
 
 // src/tool-args.ts
 function asParams(value) {
@@ -27288,13 +27347,13 @@ function runtimeDirectory(variables = process.env) {
     return explicit;
   }
   const perUser = envValue("XDG_RUNTIME_DIR", variables);
-  return join6(perUser ?? tmpdir3(), "gdharness");
+  return join7(perUser ?? tmpdir3(), "gdharness");
 }
 function runtimeDirectories(variables = process.env) {
   const candidates = [runtimeDirectory(variables)];
   const fallbacks = process.platform === "win32" ? [envValue("SystemRoot", variables) ?? envValue("windir", variables) ?? "C:\\Windows"] : ["/tmp", "/var/tmp"];
   for (const base of fallbacks) {
-    candidates.push(join6(base, process.platform === "win32" ? "Temp" : "", "gdharness"));
+    candidates.push(join7(base, process.platform === "win32" ? "Temp" : "", "gdharness"));
   }
   return [...new Set(candidates.map((path) => resolve4(path)))];
 }
@@ -27357,7 +27416,7 @@ function announcedIn(directory) {
     if (!match) {
       continue;
     }
-    const file = join6(directory, entry);
+    const file = join7(directory, entry);
     const pid = Number.parseInt(match[1] ?? "", 10);
     const announced = processAlive(pid) ? parseAnnouncement(file, pid) : { kind: "rubbish" };
     if (announced.kind === "rubbish") {
@@ -28251,7 +28310,7 @@ var TOOL_SPECS = [
   },
   {
     name: "runtime_input",
-    description: "Input to the running game: a whole click on a Control named by path, or a raw action, key, mouse button or mouse motion. All of it works headless, where the window is 64 by 64 and the GUI only takes what is inside it.",
+    description: "Input to the running game: a whole click on a Control named by path, typing into whatever has the focus, or a raw action, key, mouse button or mouse motion. All of it works headless, where the window is 64 by 64 and the GUI only takes what is inside it.",
     parameters: {
       projectPath: RUNNING_PROJECT_PATH,
       nodePath: { type: "string", description: "click: the Control to click, at its centre." },
@@ -28259,6 +28318,10 @@ var TOOL_SPECS = [
       pressed: { type: "boolean", description: "Press or release. Default true." },
       strength: { type: "number", description: "action: 0 to 1. Default 1." },
       keycode: { type: "string", description: 'key: the key name, such as "Space" or "A".' },
+      text: {
+        type: "string",
+        description: "text: what to type. A newline is Enter and a tab is Tab."
+      },
       shift: { type: "boolean" },
       ctrl: { type: "boolean" },
       alt: { type: "boolean" },
@@ -28281,6 +28344,10 @@ var TOOL_SPECS = [
       },
       action: { summary: "press or release an action", requires: ["action"] },
       key: { summary: "press or release a key", requires: ["keycode"] },
+      text: {
+        summary: "type a string wherever the focus is, a character at a time",
+        requires: ["text"]
+      },
       mouse_click: { summary: "one mouse button event at a position", requires: ["x", "y"] },
       mouse_motion: { summary: "move the mouse to a position", requires: ["x", "y"] }
     }
@@ -28405,7 +28472,7 @@ function buildToolDefinitions() {
 var UPDATE_NOTICE_EVERY = 500;
 var FEEDBACK_NOTICE_EVERY = 250;
 var run3 = promisify3(execFile3);
-var __dirname2 = dirname2(fileURLToPath2(import.meta.url));
+var __dirname2 = dirname3(fileURLToPath2(import.meta.url));
 var EDITOR_RESTART_TIMEOUT_MS = 90000;
 var BRIDGE_RETRY_MS = 2000;
 var PATH_SOLUTIONS = [
@@ -28503,7 +28570,7 @@ function camelCased(params) {
 class GodotServer {
   mcp;
   locator = new GodotLocator;
-  operationsScript = join7(__dirname2, "godot", "operations", "godot_operations.gd");
+  operationsScript = join8(__dirname2, "godot", "operations", "godot_operations.gd");
   godotBridge;
   tools = buildToolDefinitions();
   activeProcess = null;
@@ -28517,8 +28584,11 @@ class GodotServer {
   bridgeRetry = null;
   lastProjectPath = null;
   shutdownInitiated = false;
+  ownProject;
+  announcedAt = null;
   constructor() {
-    this.godotBridge = getDefaultBridge();
+    this.ownProject = envValue("GDHARNESS_PROJECT") ?? null;
+    this.godotBridge = getDefaultBridge(this.ownProject !== null);
     this.mcp = new McpServer({ name: "gdharness", version: SERVER_VERSION }, { capabilities: { tools: {}, resources: {} } });
     this.setupToolHandlers();
     setupResourceHandlers(this.mcp, () => this.lastProjectPath);
@@ -28566,6 +28636,7 @@ class GodotServer {
       this.bridgeStartupError = null;
       const bridgeStatus = this.godotBridge.getStatus();
       console.error(`[SERVER] Godot Editor Bridge started on ${bridgeStatus.host}:${bridgeStatus.port}`);
+      this.announceTheBridge();
     } catch (bridgeError) {
       const code = bridgeError instanceof Error && "code" in bridgeError && typeof bridgeError.code === "string" ? bridgeError.code : null;
       const reason = errorMessage(bridgeError);
@@ -28598,6 +28669,18 @@ class GodotServer {
     this.stopTryingTheBridge();
     const bridgeStatus = this.godotBridge.getStatus();
     console.error(`[SERVER] Godot Editor Bridge came up on ${bridgeStatus.host}:${bridgeStatus.port}; editor tools are live.`);
+    this.announceTheBridge();
+  }
+  announceTheBridge() {
+    if (this.ownProject === null) {
+      return;
+    }
+    const status = this.godotBridge.getStatus();
+    this.announcedAt = announceBridge(this.ownProject, {
+      host: status.host,
+      port: status.port,
+      version: SERVER_VERSION
+    });
   }
   stopTryingTheBridge() {
     if (this.bridgeRetry !== null) {
@@ -28608,6 +28691,8 @@ class GodotServer {
   async cleanup() {
     this.logDebug("Cleaning up resources");
     this.stopTryingTheBridge();
+    withdrawBridge(this.announcedAt);
+    this.announcedAt = null;
     if (this.activeProcess) {
       this.activeProcess.process?.kill();
       this.activeProcess = null;
@@ -28990,7 +29075,7 @@ class GodotServer {
     if (path === undefined) {
       return { ok: false, response: this.createErrorResponse("projectPath is required.") };
     }
-    const file = join7(path, "project.godot");
+    const file = join8(path, "project.godot");
     if (!existsSync6(file)) {
       return {
         ok: false,
@@ -29255,7 +29340,7 @@ class GodotServer {
       return contained.response;
     }
     const runner = "addons/gdUnit4/bin/GdUnitCmdTool.gd";
-    if (!existsSync6(join7(project.value.path, runner))) {
+    if (!existsSync6(join8(project.value.path, runner))) {
       return this.createErrorResponse(`gdUnit4 is not installed in this project: no ${runner}.`, [
         "Install gdUnit4 under addons/gdUnit4, from https://github.com/godot-gdunit-labs/gdUnit4"
       ]);
@@ -29288,7 +29373,7 @@ class GodotServer {
     ];
     const timeoutMs = readPositiveNumber(args, "timeoutMs") ?? 600000;
     this.logDebug(`Running tests: ${engine.value} ${cmdArgs.join(" ")}`);
-    const userData = mkdtempSync2(join7(tmpdir4(), "gdharness-tests-"));
+    const userData = mkdtempSync2(join8(tmpdir4(), "gdharness-tests-"));
     const run = this.spawnGame(engine.value, cmdArgs, userDataIn(userData));
     const hung = await new Promise((resolve) => {
       const timer = setTimeout(() => {
@@ -29304,20 +29389,20 @@ class GodotServer {
         resolve(false);
       });
     });
-    const reportsDir = join7(project.value.path, ".godot", "gdharness-reports");
+    const reportsDir = join8(project.value.path, ".godot", "gdharness-reports");
     let report = null;
     let reportProblem = null;
     try {
       const written = existsSync6(reportsDir) ? readdirSync5(reportsDir).filter((name) => name.startsWith("report_")).sort((a, b) => Number(a.slice("report_".length)) - Number(b.slice("report_".length))) : [];
       const newest = written.at(-1);
       if (newest !== undefined) {
-        report = parseJUnit(readFileSync7(join7(reportsDir, newest, "results.xml"), "utf8"));
+        report = parseJUnit(readFileSync7(join8(reportsDir, newest, "results.xml"), "utf8"));
       }
     } catch (error) {
       reportProblem = errorMessage(error);
     } finally {
-      rmSync2(reportsDir, { recursive: true, force: true });
-      rmSync2(userData, { recursive: true, force: true });
+      rmSync3(reportsDir, { recursive: true, force: true });
+      rmSync3(userData, { recursive: true, force: true });
     }
     const engineEntries = run.log.select({ severity: "warning", sinceLastCall: false, limit: 200 }).entries;
     const verdicts = {
@@ -29430,6 +29515,7 @@ class GodotServer {
       startupError: this.bridgeStartupError,
       staleNote: stale ? addonMismatch(status.addonVersion, SERVER_VERSION) : undefined,
       retryingBridge: this.bridgeRetry === null ? undefined : true,
+      announcedAt: this.announcedAt ?? undefined,
       note: isPortConflict ? "Bridge port is already in use. Another gdharness instance owns the editor bridge, so this server cannot reach the editor. Usually the server this one replaced, still on its way out." : undefined,
       suggestion: isPortConflict ? `This server is asking for the port again every ${BRIDGE_RETRY_MS / 1000}s and takes it the moment the other one lets go, so editor tools come back on their own. Ask again, or end the older gdharness process to have it now.` : undefined
     };
@@ -29825,8 +29911,8 @@ class GodotServer {
       return this.createErrorResponse(choice.problem);
     }
     const expectsScreenshot = command === "capture_screenshot" || command === "capture_viewport";
-    const screenshotDir = expectsScreenshot ? mkdtempSync2(join7(tmpdir4(), "gdharness-runtime-screenshot-")) : null;
-    const screenshotPath = screenshotDir ? join7(screenshotDir, "capture.png") : null;
+    const screenshotDir = expectsScreenshot ? mkdtempSync2(join8(tmpdir4(), "gdharness-runtime-screenshot-")) : null;
+    const screenshotPath = screenshotDir ? join8(screenshotDir, "capture.png") : null;
     try {
       const reply = await runtimeRequest(choice.endpoint, command, screenshotPath ? { ...params, output_path: screenshotPath } : params, timeoutMs);
       if (!reply.ok) {
@@ -29852,7 +29938,7 @@ class GodotServer {
       };
     } finally {
       if (screenshotDir) {
-        rmSync2(screenshotDir, { recursive: true, force: true });
+        rmSync3(screenshotDir, { recursive: true, force: true });
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdharness",
-  "version": "0.5.7",
+  "version": "0.5.9",
   "mcpName": "io.github.Aureliolo/gdharness",
   "description": "A harness for driving a Godot 4 project from an agent: editor addons, a runtime bridge into the running game, an MCP server in front of them, and a CLI that installs and diagnoses the Godot side.",
   "type": "module",