Add telemetry toggle to gui and cleanup local files when telemetry is disabled

[a-johnston]

This change primarily adds a new toggle to the configuration popup menu to control whether or not telemetry is enabled. Compared to only supporting the environment variable, this is a more user-friendly approach especially on platforms where it can be annoying to set an environment variable persistently for a gui application (such as on macos). The toggle is only enabled if neither of the two controlling env vars are set and if so, the option is provided via env var for the python subprocess. If an env var is provided by the user, that enable/disable state is persisted to editor settings and used for future launches even if the env var is omitted at that point. Additionally, the python TelemetryConfig has been changed to cleanup local files when telemetry is disabled.

A few smaller supporting changes are also included:

• "Clients & Tools" has been renamed to "Clients & Settings" as the new telemetry toggle currently is added to the bottom of the 2nd tab. Since this is the tab controlling editor-persistent settings, this seemed like the most appropriate place to add it.
• The "Clients & Settings" popup min size is now scaled by the editor scale, making it a much more reasonable size with hidpi.
• The "Clients & Settings" popup margin has been added to each tab rather than being around the entire tab container.
• _on_reload_plugin now defers the actual plugin reload to prevent error spam due to the plugin reloading while the triggering input event (eg, clicking "Apply && Restart Server") is still propagating through the tree

Two things to call out with the current state of this PR, which can both be changed if desired:

• There are some things in the code which ideally would've been renamed for clarity (_get_data_directory, _tools_apply_btn, etc) but I didn't want to bloat the change too much and there was some precedent (eg _clients_window).
• The "Reset to defaults" button still only resets tools to their default state and leaves the telemetry preference alone.

Before:

After:

Parts of this PR were generated by claude code. Changes were manually tested with and without manually providing environment variables.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[Copilot]

Pull request overview

Adds a user-facing telemetry preference to the Godot dock settings flow, wires that preference into server subprocess startup, and updates Python telemetry cleanup behavior when telemetry is disabled.

Changes:

• Adds telemetry enable/disable state to the “Clients & Settings” dock UI and persists it in EditorSettings.
• Injects GODOT_AI_DISABLE_TELEMETRY for managed Python server spawns when the UI setting disables telemetry.
• Deletes persisted telemetry files on disabled Python telemetry config construction and adds related tests/docs.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 16 comments.

Show a summary per file

File	Description
plugin/addons/godot_ai/mcp_dock.gd	Adds telemetry toggle UI, dirty-state handling, popup layout updates, and deferred plugin reload helper.
plugin/addons/godot_ai/utils/server_lifecycle.gd	Adds telemetry env injection around managed server spawn/refresh paths.
src/godot_ai/telemetry.py	Adds disabled-mode cleanup of persisted telemetry files.
docs/TELEMETRY.md	Documents UI opt-out and cleanup behavior.
test_project/tests/test_telemetry_setting.gd	Adds GDScript tests for telemetry EditorSettings persistence.
test_project/tests/test_telemetry_setting.gd.uid	Adds Godot UID for the new test script.
tests/unit/test_telemetry.py	Adds Python cleanup tests for disabled telemetry.
tests/unit/conftest.py	Extends telemetry data-dir isolation to the new resolver helper.
tests/unit/test_telemetry_send.py	Formatting-only test signature changes.
tests/integration/_self_update_fixture.py	Formatting-only error construction change.

Comments suppressed due to low confidence (6)

plugin/addons/godot_ai/mcp_dock.gd:1697

• This now treats a telemetry-only toggle as dirty, but the confirmation dialog still says the user has checked/unchecked tool domains. Closing after only changing telemetry will show a misleading prompt; update the dialog copy to refer to unapplied settings rather than domains only.

	if _settings_are_dirty():

test_project/tests/test_telemetry_setting.gd:48

• This test path is not actually robust to the Godot versions called out below: if set_setting(null) leaves the key present with a null value, this branch is skipped and the assertion reads bool(null), failing instead of exercising the first-run default. Clear the setting with an API that guarantees absence or structure the test around the real _load_telemetry_setting behavior without depending on null-removal semantics.

		es.set_setting(SETTING_KEY, null)
	## After clearing, check absence — note: set_setting(null) may or may not
	## remove the key depending on Godot version. Work around: skip directly to
	## the init logic assertion.
	if not es.has_setting(SETTING_KEY):

docs/TELEMETRY.md:101

• This sentence now contradicts the preceding lines: deleting customer_uuid.txt and milestones.json on startup is an intentional filesystem side effect. Remove or rephrase the “fully side-effect-free” claim so the opt-out documentation matches the new cleanup behavior.

files (`customer_uuid.txt`, `milestones.json`) are deleted on the next
server startup. The plugin-side helper honors the same variables and
stops buffering events. Opt-out is fully side-effect-free.

plugin/addons/godot_ai/mcp_dock.gd:1924

• The Apply button now also saves the telemetry preference, but its tooltip still says it only saves the excluded tool-domain list. Update the copy so users understand that clicking this button applies all settings on the tab, including telemetry.

		es.set_setting(ClientConfigurator.SETTING_EXCLUDED_DOMAINS, canonical_excluded)
		es.set_setting("godot_ai/telemetry_enabled", _telemetry_pending_enabled)

plugin/addons/godot_ai/mcp_dock.gd:72

• This comment renames the tab to Settings but still describes the state as only domain-exclusion UI. It now also owns telemetry pending/saved state, so the comment should mention both settings to avoid misleading future changes.

This issue also appears on line 1711 of the same file.

# Settings tab (secondary window, Tab 2) — domain-exclusion UI for clients
# that cap total tool count (Antigravity: 100). Pending set is mutated by
# checkbox clicks; saved set reflects what the spawned server actually
# sees. `Apply & Restart Server` writes pending → setting and triggers a
# plugin reload so the new server comes up with the trimmed list.

plugin/addons/godot_ai/mcp_dock.gd:1713

• The tab is now named “Settings” and includes telemetry, but the surrounding comments still describe it as the Tools/domain-exclusion tab only. Update the comments to reflect the broader contents so future UI changes don't miss the telemetry state.

	var tools_margin := _build_margin_container()
	tools_margin.name = "Settings"
	tools_margin.add_child(tools_tab)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[dsarno]

@a-johnston This is a great PR, I've been playing with it for the last few minutes. I have a few fixes and nits -- would you prefer I post as suggestions or just push them directly to the PR?

[a-johnston]

I'm going through the comments right now so we might step on each others toes a bit. Shouldn't take much longer though. I guess feel free to make changes but don't squash so I can rebase more easily?

[dsarno]

@a-johnston Live-tested the PR end-to-end on macOS — toggle ON creates ~/Library/Application Support/godot-ai/{customer_uuid.txt, milestones.json} on next spawn, toggle OFF deletes them, env-var lock greys the toggle as expected, plugin reload restarts the server with the right env. Works as advertised.

One suggestion since you flagged it in the PR description — wiring "Reset to defaults" up to also restore the telemetry toggle:

func _on_tools_reset() -> void:
    _tools_pending_excluded = PackedStringArray()
    for id in _tools_domain_checkboxes:
        var chk: CheckBox = _tools_domain_checkboxes[id]
        chk.set_pressed_no_signal(true)
    # Skip when env-locked so we don't create a dirty pending state
    # the user can't apply from the UI.
    if _telemetry_toggle != null and not _telemetry_toggle.disabled:
        _telemetry_pending_enabled = true
        _telemetry_toggle.set_pressed_no_signal(true)
    _refresh_tools_ui_state()

Otherwise looks great — happy to re-test once the Copilot pass is done.

[dsarno]

@a-johnston I need to take off for the rest of the day, but I'd love to get this in an cut a new version so users can update to it. Is it good to go, or you still working?

[dsarno]

Merging — I added the "Reset to defaults also resets telemetry" fix as a follow-up commit (9299dbe) since you'd flagged that gap in the PR description. Full validation before merge:

• ✅ Live smoke (macOS): telemetry toggle ON/OFF, file create/delete, env-var lock, Reset-to-defaults flow
• ✅ GDScript test suite: 1292 pass / 0 fail / 6 skip
• ✅ CI: 11/11 green on 9299dbe
• ✅ script/local-self-update-smoke: all 8 PASS assertions (covers the _do_plugin_reload timing change)

Thanks for the great PR!

[a-johnston]

I had to step away for a few minutes. Sounds good, I had two copilot comments regarding the env injection behavior left to consider but I'll finish those and submit a followup pr with the other changes requested by copilot. I'm personally of the opinion that the telemetry preference should be left alone when resetting but it's easy enough for the user to change that back themselves.

[dsarno]

@a-johnston Oh I'm sorry, I misread that and claude didn't help me catch your actual (correct) intent about resetting telemetry. Yes I agree -- it's confusing to reset it -- likely people who turn it off just want it off forever and we should honor that. Pushing a fix PR now.

[dsarno]

@a-johnston Good catch — agree, you had it right the first time. Fix PR up at #448 to revert the Reset-touches-telemetry behavior; sorry for the privacy footgun.

[a-johnston]

No problem, thanks for the followup. I'll push up a new branch with the other changes soonish but none of the changes are imo blocking so it's fine to cut a release as is.