gdharness 0.13.39 → 0.13.41

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

@@ -31,6 +31,11 @@ const ELSEWHERE_CLOSE_CODE: int = 4001
 const LSP_SETTING: String = "network/language_server/remote_port"
 const DAP_SETTING: String = "network/debug_adapter/remote_port"
 const DEBUGGER_SETTING: String = "network/debug/remote_port"
+## Whether the editor shares its breakpoints with a debug adapter session as it opens, or clears
+## them. Off by default in Godot, and off means every breakpoint in the editor is removed the
+## moment any session sends `initialize`, which a server does for its first breakpoint or its
+## first stack read. Turned on by [method _keep_breakpoints_through_sessions] when this loads.
+const SYNC_BREAKPOINTS_SETTING: String = "network/debug_adapter/sync_breakpoints"
 ## What a server that opened this editor put in the environment, matching the ports it named on
 ## the command line. Kept in step with `editorArguments` in src/launch.ts.
 const LSP_ASKED: String = "GDHARNESS_LSP_PORT"
@@ -38,6 +43,12 @@ const DAP_ASKED: String = "GDHARNESS_DAP_PORT"
 ## What a server that opened this editor says about itself, so that being opened by one is stated
 ## rather than guessed at from the ports. Kept in step with `OPENED_BY_A_SERVER` in src/launch.ts.
 const OPENED_BY_A_SERVER: String = "GDHARNESS_OPENED_BY_A_SERVER"
+## Put into this editor's own environment as it loads, so every game it plays inherits it and
+## the runtime addon can announce which editor played it. A game of the same project that some
+## other server started has no such variable, or another editor's number, and that is what
+## tells the two apart when both are announced at once. Kept in step with `EDITOR_PID_VARIABLE`
+## in the runtime autoload.
+const EDITOR_PID_VARIABLE: String = "GDHARNESS_EDITOR_PID"
 
 ## How long one attempt is given before the address is called a bad one.
 ##
@@ -87,6 +98,8 @@ var _connecting_for: float = 0.0
 func _ready() -> void:
 	_project_path = ProjectSettings.globalize_path("res://")
 	version_at_load = _loaded_version()
+	_keep_breakpoints_through_sessions()
+	OS.set_environment(EDITOR_PID_VARIABLE, str(OS.get_process_id()))
 
 	_reconnect_timer = Timer.new()
 	_reconnect_timer.one_shot = true
@@ -281,6 +294,9 @@ func _handle_connect() -> void:
 			"lsp_port": _serves(LSP_ASKED, LSP_SETTING),
 			"dap_port": _serves(DAP_ASKED, DAP_SETTING),
 			"debug_port": _serving(DEBUGGER_SETTING),
+			# Whether a session opening on the adapter is told this editor's breakpoints or takes
+			# them away, so a server can say which before it sets one.
+			"syncs_breakpoints": _syncs_breakpoints(),
 			# Whether a server started this editor, which is the only kind that can be started again
 			# as itself: the engine hands back none of the arguments it was given, so the arguments
 			# have to come from whoever wrote them. See `restart_editor` in play_tools.gd.
@@ -329,6 +345,50 @@ static func _asked_for(variable: String) -> int:
 	return port if port >= 1 and port <= 65535 else 0
 
 
+## Turns breakpoint syncing on, so a debug session opening does not clear the editor's breakpoints.
+##
+## With the setting off, Godot's adapter answers `initialize` by clearing every breakpoint in the
+## script editor, open and cached, and telling every session so; with it on, it tells the new
+## session what is set and clears nothing. A server opens a session for its first breakpoint or
+## its first stack read, so off meant a harness session took the user's breakpoints away on its
+## first debug call, silently. The adapter reads the setting again the moment it changes, so this
+## holds for the editor that is running and not only the next one.
+##
+## An editor setting rather than a project one, the way the debugger port this addon moves is,
+## and left alone when it already reads true or does not exist.
+func _keep_breakpoints_through_sessions() -> void:
+	if not Engine.is_editor_hint():
+		return
+	var settings: EditorSettings = EditorInterface.get_editor_settings()
+	if settings == null or not settings.has_setting(SYNC_BREAKPOINTS_SETTING):
+		return
+	if Read.as_bool(settings.get_setting(SYNC_BREAKPOINTS_SETTING)):
+		return
+	settings.set_setting(SYNC_BREAKPOINTS_SETTING, true)
+	# Stored is not the same as noticed. The adapter reads this setting again on the editor-wide
+	# settings notification, which the settings dialog sends after Apply and set_setting does not
+	# send at all, so without this the running adapter went on clearing breakpoints until the
+	# editor was restarted. Sent from the editor's root, which is where the dialog sends it from.
+	var editor_root: Node = get_tree().root.get_child(0)
+	editor_root.propagate_notification(EditorSettings.NOTIFICATION_EDITOR_SETTINGS_CHANGED)
+	print(
+		(
+			"[gdharness] turned on %s, so a debug session opening keeps the editor's breakpoints"
+			% SYNC_BREAKPOINTS_SETTING
+		)
+	)
+
+
+## Whether the editor shares its breakpoints with a session as it opens. See the setting.
+func _syncs_breakpoints() -> bool:
+	if not Engine.is_editor_hint():
+		return false
+	var settings: EditorSettings = EditorInterface.get_editor_settings()
+	if settings == null or not settings.has_setting(SYNC_BREAKPOINTS_SETTING):
+		return false
+	return Read.as_bool(settings.get_setting(SYNC_BREAKPOINTS_SETTING))
+
+
 ## What the settings say this editor serves on, or 0 when there is nothing to ask.
 func _serving(setting: String) -> int:
 	if not Engine.is_editor_hint():

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

@@ -30,6 +30,12 @@ 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 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
+## `EDITOR_PID_VARIABLE` in the editor addon's bridge client.
+const EDITOR_PID_VARIABLE: String = "GDHARNESS_EDITOR_PID"
+
 var values: Values = Values.new()
 
 # The modules are members and not locals of _init, because a Callable holds its object by id
@@ -250,7 +256,7 @@ func _announce(bind_address: String) -> void:
 ## What the announcement file and the welcome both carry: enough to pick this game out of
 ## several and to know whether the server speaks its protocol.
 func _identity(bind_address: String) -> Dictionary:
-	return {
+	var identity: Dictionary = {
 		"protocol": PROTOCOL,
 		"pid": OS.get_process_id(),
 		"port": _port,
@@ -262,6 +268,10 @@ func _identity(bind_address: String) -> Dictionary:
 		},
 		"godot": Engine.get_version_info().get("string", ""),
 	}
+	var played_by: String = OS.get_environment(EDITOR_PID_VARIABLE)
+	if played_by.is_valid_int():
+		identity["editor_pid"] = played_by.to_int()
+	return identity
 
 
 func _send_welcome(client: StreamPeerTCP) -> void: