gdharness 1.3.6 → 1.3.7

package/build/godot/addons/gdharness_editor/reading.gd

@@ -152,7 +152,7 @@ static func not_of_kind(
 	if not found.is_empty():
 		told += ' The node at "%s" is %s, not %s.' % [node_path, with_article(found), with_article(kind)]
 	if holders.is_empty():
-		return told + " The scene holds no %s." % kind
+		return told + " The scene holds no %s; scene_node add with nodeType %s puts one in it." % [kind, kind]
 	var quoted: PackedStringArray = []
 	for holder: String in holders.slice(0, NAMED_CHILDREN):
 		var _quoted: bool = quoted.append('"%s"' % holder)

package/build/godot/addons/gdharness_editor/tools/play_tools.gd

@@ -170,17 +170,18 @@ func restart_editor(_args: Dictionary) -> Dictionary:
 			)
 		}
 
-	var unsaved: Dictionary = _save_everything()
-	if not unsaved.is_empty():
-		return unsaved
+	var saving: Dictionary = _save_everything()
+	if not saving.has("saved"):
+		return saving
 
 	# Deferred so this answer is on its way out before the editor goes.
 	EditorInterface.restart_editor.call_deferred(true)
 
-	return {"ok": true, "restarting": true, "saved": true}
+	return {"ok": true, "restarting": true, "saved": saving["saved"]}
 
 
-## Saves every open scene, answering a refusal naming what is still unsaved, or {}.
+## Saves every open scene, answering a refusal naming what is still unsaved, or the scenes that had
+## changes and were saved, under `saved`.
 ##
 ## Read back rather than assumed: save_all_scenes answers nothing and passes over a scene that has
 ## never been saved, which has no path to go to, so an untitled scene was lost with the editor while
@@ -188,10 +189,11 @@ func restart_editor(_args: Dictionary) -> Dictionary:
 static func _save_everything() -> Dictionary:
 	if EditorInterface.is_playing_scene():
 		EditorInterface.stop_playing_scene()
+	var changed: PackedStringArray = EditorInterface.get_unsaved_scenes()
 	EditorInterface.save_all_scenes()
 	var left: PackedStringArray = EditorInterface.get_unsaved_scenes()
 	if left.is_empty():
-		return {}
+		return {"ok": true, "saved": changed}
 	var named: Array[String] = []
 	for scene: String in left:
 		named.append(scene if not scene.is_empty() else "a scene that has never been saved")
@@ -221,14 +223,14 @@ static func _save_everything() -> Dictionary:
 ## Saved first, exactly as the restart above saves. The editor is going either way, and unsaved
 ## scenes are not this tool's to lose.
 func quit_editor(_args: Dictionary) -> Dictionary:
-	var unsaved: Dictionary = _save_everything()
-	if not unsaved.is_empty():
-		return unsaved
+	var saving: Dictionary = _save_everything()
+	if not saving.has("saved"):
+		return saving
 
 	# Deferred so this answer is on its way out before the editor goes.
 	_leave.call_deferred()
 
-	return {"ok": true, "quitting": true, "saved": true}
+	return {"ok": true, "quitting": true, "saved": saving["saved"]}
 
 
 ## What the editor said as it started each of its servers, and the debug adapter started again when

package/build/godot/addons/gdharness_editor/tools/resource_tools.gd

@@ -285,6 +285,17 @@ func modify_resource(args: Dictionary) -> Dictionary:
 	var resource: Resource = ResourceLoader.load(res_path, "", ResourceLoader.CACHE_MODE_IGNORE)
 	if resource == null:
 		return {"ok": false, "error": "%s did not load as a resource." % res_path}
+	# A scene's own properties are its packed bundle, so a property named for a scene is one of its
+	# nodes', and "PackedScene has no property" left the caller looking for the tool that sets it.
+	if resource is PackedScene:
+		return {
+			"ok": false,
+			"error":
+			(
+				"%s is a scene: scene_node set changes one node's properties, the root's at nodePath \".\"."
+				% res_path
+			)
+		}
 
 	var properties: Dictionary = _parse_properties_dict(args.get("properties", ""))
 	var refused: String = _properties.write_all(resource, properties)

package/build/godot/addons/gdharness_runtime/reading.gd

@@ -152,7 +152,7 @@ static func not_of_kind(
 	if not found.is_empty():
 		told += ' The node at "%s" is %s, not %s.' % [node_path, with_article(found), with_article(kind)]
 	if holders.is_empty():
-		return told + " The scene holds no %s." % kind
+		return told + " The scene holds no %s; scene_node add with nodeType %s puts one in it." % [kind, kind]
 	var quoted: PackedStringArray = []
 	for holder: String in holders.slice(0, NAMED_CHILDREN):
 		var _quoted: bool = quoted.append('"%s"' % holder)

package/build/godot/addons/gdharness_runtime/runtime_autoload.gd

@@ -67,6 +67,13 @@ const SCRIPT_FLAGS: PackedStringArray = ["-s", "--script"]
 ## Serve a script run anyway, for somebody driving a `-s` script rather than a game.
 const SCRIPT_RUNS_SETTING: String = "gdharness/runtime/serve_script_runs"
 
+## The `res://` folders of scenes that are not the game, such as a bench: a run started on one is
+## not served. Kept in step with `QUIET_SCENES_SETTING` in src/setup.ts.
+const QUIET_SCENES_SETTING: String = "gdharness/runtime/quiet_scenes_under"
+
+## What the engine takes a bare argument for as the scene to run, by its extension.
+const SCENE_EXTENSIONS: PackedStringArray = ["tscn", "scn", "escn", "res", "tres"]
+
 ## The variable the editor addon puts into its own environment, which every game the editor plays
 ## inherits: it says which editor played this game, so a server can tell the editor's game from
 ## another of the same project that some other server started. Kept in step with
@@ -123,6 +130,9 @@ var _commands: Dictionary = {}
 var _loaded_version: String = _read_marker(VERSION_MARKER)
 var _loaded_digest: String = _read_marker(DIGEST_MARKER)
 var _profile_received: bool = false
+## Whether whatever started this game asked for a profile from its start, read before the variable
+## is taken out of the environment.
+var _profiled_from_start: bool = false
 var _close_asked: bool = false
 var _close_frames: int = 0
 var _profiler_calibrated: bool = false
@@ -200,7 +210,9 @@ static func _window_dimension(axis: String, fallback: int) -> int:
 func _wait_for_the_profiler() -> void:
 	if OS.get_environment(PROFILE_FROM_START).is_empty():
 		return
-	# Read once: a process this game starts inherits its environment and must not wait as well.
+	_profiled_from_start = true
+	# Read once: a process this game starts inherits its environment and must not wait as well, nor
+	# be served as a profiled run where a quiet scene would not be, as a bench's workers are.
 	OS.unset_environment(PROFILE_FROM_START)
 	if not EngineDebugger.is_active():
 		return
@@ -446,6 +458,15 @@ func _start_server() -> void:
 		_enabled = false
 		return
 
+	# Nor a scene the project says is not the game. A bench is handed to the engine as a scene, the
+	# way a screen is, so it announced as the game for as long as it ran, and so did every worker
+	# engine it started, all under the project's own path. One started to be profiled from its start
+	# is served all the same, since only this addon hands the totals back as it quits.
+	var prefixes: Variant = ProjectSettings.get_setting(QUIET_SCENES_SETTING, PackedStringArray())
+	if not _profiled_from_start and not quiet_scene_in(OS.get_cmdline_args(), prefixes).is_empty():
+		_enabled = false
+		return
+
 	_server = TCPServer.new()
 	# listen() defaults bind_address to "*", which exposes the game to the whole network.
 	var bind_address: String = str(ProjectSettings.get_setting(BIND_ADDRESS_SETTING, DEFAULT_BIND_ADDRESS))
@@ -474,6 +495,29 @@ func _start_server() -> void:
 		print(listening)
 
 
+## The scene [param given] names for the engine to run, as a `res://` path, when it lies under one of
+## [param prefixes]; otherwise empty. The engine takes any bare argument ending in a scene's
+## extension for the scene, relative to the project or absolute, so each is read as it would.
+static func quiet_scene_in(given: PackedStringArray, prefixes: Variant) -> String:
+	# A PackedStringArray as project.godot writes one, or an Array of strings as a hand might.
+	var folders: PackedStringArray = []
+	if prefixes is PackedStringArray:
+		folders = prefixes
+	elif prefixes is Array:
+		var listed: Array = prefixes
+		for prefix: Variant in listed:
+			if prefix is String:
+				var _kept: bool = folders.append(str(prefix))
+	for argument: String in given:
+		if argument.begins_with("-") or not SCENE_EXTENSIONS.has(argument.get_extension().to_lower()):
+			continue
+		var scene: String = ProjectSettings.localize_path(argument)
+		for folder: String in folders:
+			if not folder.is_empty() and scene.begins_with(folder):
+				return scene
+	return ""
+
+
 ## Whether the engine was told to run a script rather than the game.
 func _script_run() -> bool:
 	var given: PackedStringArray = OS.get_cmdline_args()

package/build/godot/addons/gdharness_runtime/runtime_capture.gd

@@ -10,6 +10,9 @@ const GdhScreen = preload("runtime_screen.gd")
 ## How far zoom enlarges at most. Sixteen makes a 3-pixel ring 48 pixels across, past any need to
 ## see it, and a 200-pixel region 3200, past the size anybody reads a picture at.
 const ZOOM_MOST: int = 16
+## Measured on a downstream game's 1280x720 frame: its interface text and pixel art read as they do
+## in the PNG, at a fifth of the PNG's size.
+const JPEG_QUALITY: float = 0.8
 
 var _host: Node
 var _values: GdhValues
@@ -385,16 +388,28 @@ func _capture(viewport: Viewport, params: Dictionary, with_windows: bool = false
 				% screenshot_path.get_base_dir()
 			)
 		)
-	var save_error: Error = image.save_png(screenshot_path)
+	var answer: Dictionary = saved(image, screenshot_path)
+	answer.merge(described)
+	return answer
+
+
+## [param image] saved as a PNG at [param png_path], and as a JPEG beside it, which the server sends
+## instead when it is the smaller: a rendered frame is several times smaller as one, and every
+## picture sent stays in the caller's session. Not for a picture with transparency, which a JPEG
+## would flatten.
+static func saved(image: Image, png_path: String) -> Dictionary:
+	var save_error: Error = image.save_png(png_path)
 	if save_error != OK:
 		return {"type": "error", "message": "Failed to save screenshot as PNG: " + str(save_error)}
-
 	var answer: Dictionary = {
 		"type": "screenshot_file",
 		"format": "png",
 		"width": image.get_width(),
 		"height": image.get_height(),
-		"path": screenshot_path
+		"path": png_path
 	}
-	answer.merge(described)
+	if image.detect_alpha() == Image.ALPHA_NONE:
+		var jpeg_path: String = png_path.get_basename() + ".jpg"
+		if image.save_jpg(jpeg_path, JPEG_QUALITY) == OK:
+			answer["jpegPath"] = jpeg_path
 	return answer

package/build/godot/addons/gdharness_runtime/runtime_hover.gd

@@ -9,7 +9,7 @@ extends RefCounted
 ## platform when the pointer crosses into the window, sets it. An injected event never crosses
 ## anything, and on gdharness's own desktop no pointer ever enters a window, so nothing was hovered.
 ## A BaseButton takes a mouse press only while hovered, so every click on a button in such a window
-## was dropped while the press itself was routed to it. Reported from Tall Tales Inn, whose strip
+## was dropped while the press itself was routed to it. Reported from Game C, whose strip
 ## window holds its first-run question, and traced through Godot 4.7.2's source.
 ##
 ## What is supplied is what the engine does once the window has been entered: the control its own

package/build/godot/addons/gdharness_runtime/runtime_paths.gd

@@ -257,7 +257,7 @@ static func can_read(holder: Variant, named: String) -> bool:
 ## counted as unclean for a read.
 ##
 ## A step written in double quotes is the key inside them, so a key holding a colon is one step:
-## Alchemill keys its stock by namespaced ids, "stock:\"base:dew\"", and split at that colon the
+## Game D keys its stock by namespaced ids, "stock:\"base:dew\"", and split at that colon the
 ## step named a key "base" the map had never had.
 static func _key_in(map: Dictionary, named: String) -> Array:
 	var word: String = key_written(named)

package/build/godot/operations/reading.gd

@@ -152,7 +152,7 @@ static func not_of_kind(
 	if not found.is_empty():
 		told += ' The node at "%s" is %s, not %s.' % [node_path, with_article(found), with_article(kind)]
 	if holders.is_empty():
-		return told + " The scene holds no %s." % kind
+		return told + " The scene holds no %s; scene_node add with nodeType %s puts one in it." % [kind, kind]
 	var quoted: PackedStringArray = []
 	for holder: String in holders.slice(0, NAMED_CHILDREN):
 		var _quoted: bool = quoted.append('"%s"' % holder)

package/build/godot/tests/listed.gd

@@ -218,12 +218,14 @@ static func argument_after(args: PackedStringArray, flag: String) -> String:
 
 
 ## The errors each of [param suites] declares it expects, by suite path and then case name, read off
-## the compiled suite's constants so a declaration is whatever the engine made of it. A suite
-## declaring none is left out.
+## the compiled suite's constants so a declaration is whatever the engine made of it. A directory
+## listed is walked for its scripts, as gdUnit4 walks it for suites. Only a script whose source names
+## the constant is loaded: gdUnit4 stops on a suite that does not load only when its own load is the
+## one that fails, so a broken suite loaded here first let the rest of its directory run.
 static func expected_by_suite(suites: PackedStringArray) -> Dictionary:
 	var expected: Dictionary = {}
-	for path: String in suites:
-		if not path.ends_with(".gd") or not ResourceLoader.exists(path):
+	for path: String in scripts_in(suites):
+		if not FileAccess.file_exists(path) or not FileAccess.get_file_as_string(path).contains(EXPECTED):
 			continue
 		var suite: Script = load(path)
 		var declared: Variant = suite.get_script_constant_map().get(EXPECTED)
@@ -232,6 +234,26 @@ static func expected_by_suite(suites: PackedStringArray) -> Dictionary:
 	return expected
 
 
+## The scripts [param paths] names: each script, and every script under each directory.
+static func scripts_in(paths: PackedStringArray) -> PackedStringArray:
+	var found: PackedStringArray = []
+	var pending: PackedStringArray = []
+	for path: String in paths:
+		if path.ends_with(".gd"):
+			var _script: bool = found.append(path)
+		else:
+			var _directory: bool = pending.append(path.trim_suffix("/"))
+	while not pending.is_empty():
+		var directory: String = pending[pending.size() - 1]
+		pending.remove_at(pending.size() - 1)
+		for file: String in DirAccess.get_files_at(directory):
+			if file.ends_with(".gd"):
+				var _file: bool = found.append("%s/%s" % [directory, file])
+		for inner: String in DirAccess.get_directories_at(directory):
+			var _inner: bool = pending.append("%s/%s" % [directory, inner])
+	return found
+
+
 static func write_expected(path: String, suites: PackedStringArray) -> void:
 	var file: FileAccess = FileAccess.open(path, FileAccess.WRITE)
 	if file == null:

package/build/keeper.js

@@ -703,6 +703,8 @@ function readMessage(body) {
 // src/game-debugger.ts
 var PAUSE_MS = 30000;
 var STEP_MS = 1e4;
+var ADDON_STEP_MS = 5000;
+var RUNTIME_ADDON = "res://addons/gdharness_runtime/";
 var READ_MS = 5000;
 var REPLIES = new Set([
   "debug_enter",
@@ -1085,9 +1087,29 @@ class GameDebugger {
         };
       }
     }
+    let frames = await this.stack();
+    const stepping = Date.now();
+    while (frames !== null && this.held !== null && (frames[0]?.script.startsWith(RUNTIME_ADDON) ?? false) && Date.now() - stepping < ADDON_STEP_MS) {
+      this.forget("debug_enter");
+      this.send("step", [], this.held.thread);
+      if (await this.next(GameDebugger.named("debug_enter"), STEP_MS) === null) {
+        return {
+          paused: false,
+          note: `The game stopped in gdharness's runtime addon and was stepped on to reach its own script, and did not stop again within ${STEP_MS / 1000}s. It stops at the next line of script it runs; debug_state stack reads it then.`
+        };
+      }
+      frames = await this.stack();
+    }
     this.stoppedBy("Paused");
-    const frames = await this.stack();
-    return { paused: true, held: this.heldState(), stack: frames ?? [] };
+    const stack = frames ?? [];
+    return {
+      paused: true,
+      held: this.heldState(),
+      stack,
+      ...stack[0]?.script.startsWith(RUNTIME_ADDON) === true ? {
+        note: `The game is held in gdharness's runtime addon, whose _process runs first in every frame: ${ADDON_STEP_MS / 1000}s of stepping reached no line of the game's own script, so it runs none from frame to frame. A breakpoint in the game's script stops it there.`
+      } : {}
+    };
   }
   stoppedBy(cause) {
     if (this.held !== null) {
@@ -1108,7 +1130,7 @@ class GameDebugger {
       return await exited === null ? { refused: `The game did not say it had gone on within ${READ_MS / 1000}s.` } : { continued: true };
     }
     this.forget("debug_enter");
-    this.send(how, [], held.thread);
+    this.send(held.hasStack ? how : "step", [], held.thread);
     const entered = await this.next(GameDebugger.named("debug_enter"), STEP_MS);
     if (entered === null) {
       return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdharness",
-  "version": "1.3.6",
+  "version": "1.3.7",
   "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",