feat(report-issue): bundle sanitized data.json in the Agent Mode issue report

[zeroliu]

What

Adds a sanitized copy of the plugin settings (data.json) to the Agent Mode "Report an Issue" bundle, so maintainers can diagnose configuration-dependent bugs. Previously the bundle contained only report.md, the screenshot, the frame log, and the optional opencode log.

Behavior

• New file in the bundle: the raw on-disk data.json (via Plugin.loadData(), so the report reflects what is actually persisted) is sanitized and written as data.json.txt — same .txt suffix workaround as the frame log, since GitHub's issue-attachment allowlist rejects .json.
• Proactive redaction via a new pure sanitizeSettingsDataForReport() (src/utils/sanitizeSettingsData.ts). Sensitive values are masked as [REDACTED] rather than removed, so which providers/keys are configured stays visible. Covered:
  • everything matching the canonical isSensitiveKey() (all *ApiKey fields, plusLicenseKey, tokens, secrets, passwords), at any depth — including per-model apiKey in activeModels / activeEmbeddingModels
  • every value in any envOverrides map (backend env vars like AWS_ACCESS_KEY_ID don't match key-name patterns, so they're masked wholesale, key names kept)
  • infra identifiers (Azure instance/deployment names, org IDs, API versions), userId, and legacy enc_* encrypted strings wherever they appear
  • empty values pass through unchanged so "not configured" stays visible
• Surfaced in the dialog: the "When you click Prepare report" list now states that a copy of your Copilot settings is included with secrets replaced by [REDACTED], and the privacy callout notes the copy still describes your configuration. The settings-page button description and report.md's attachment list ("data.json.txt (plugin settings; secrets redacted)") say the same.
• Graceful degradation: if settings can't be loaded or written, the report is still produced without the snapshot (same best-effort pattern as the other bundle files).

Tests

• New src/utils/sanitizeSettingsData.test.ts (10 tests) against a realistic disk-mode data.json fixture, including a catch-all assertion that no secret string appears anywhere in the serialized output.
• Extended src/utils/issueReport.test.ts: snapshot written and listed when provided, skipped when null or on write failure, annotated in report.md.
• Full suite: 4415 passing. npm run format, npm run lint, and tsc --noEmit clean.

Docs

• docs/agent-mode-and-tools.md "Reporting an Issue" section updated, including the privacy note.

🤖 Generated with Claude Code

https://claude.ai/code/session_01W4ZjSKUSbWyWjx4CLeJS5v

[gitguardian]

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
34767473	Triggered	Generic High Entropy Secret	2a26ac5	src/utils/sanitizeSettingsData.test.ts	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secret safely. Learn here the best practices.
3. Revoke and rotate this secret.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[chatgpt-codex-connector]

💡 Codex Review

obsidian-copilot/src/utils/rendererEventsShim.ts

Line 2 in 2a26ac5

import { EventEmitter } from "node:events";

Gate node:events import behind desktop check

When the plugin is loaded on mobile or emulated mobile, main.ts imports this module unconditionally, so this top-level node:events import is evaluated before installRendererEventsShim() can return on Platform.isMobile. Because esbuild leaves node:events external, the mobile bundle touches a Node-only module during plugin load and can abort the entire plugin before any Agent Mode code is used; move this import into a desktop-gated dynamic path.

---

obsidian-copilot/src/main.ts

Line 315 in 2a26ac5

preserveOnViewTypes: [CHAT_VIEWTYPE],

Preserve active web tab for Agent Chat

With only CHAT_VIEWTYPE in preserveOnViewTypes, switching focus from a Web Viewer leaf to the new Agent Chat view triggers recomputeActiveWebTabState's active-leaf-change path to clear activeWebTabForMentions. AgentChatInput reads that same state to show and resolve {activeWebTab}, so the Active Web Tab option disappears and sends omit the web tab whenever the user opens/focuses Agent Chat from Web Viewer; include CHAT_AGENT_VIEWTYPE here as well.

---

obsidian-copilot/src/agentMode/acp/AcpProcessManager.ts

Line 45 in 2a26ac5

logInfo(`[AgentMode] spawning ${this.opts.command} ${this.opts.args.join(" ")} (tag=${tag})`);

Avoid logging prompt-bearing spawn arguments

Codex appends the composed system prompt as -c developer_instructions=..., so logging args.join(" ") writes the full prompt/user custom instructions to the regular Copilot log every time Codex starts. That log is explicitly saved/opened for sharing from Advanced Settings, so private prompt content can leak even when the user only needs process diagnostics; redact prompt-bearing flags or log only the argv shape.

---

obsidian-copilot/src/agentMode/session/AgentChatPersistenceManager.ts

Line 499 in 2a26ac5

`mode: ${AGENT_CHAT_MODE}`,

Exclude agent chats from legacy history modal

Global Agent Mode saves write mode: agent but no projectId, while CopilotPlugin.loadCopilotChatHistory() still feeds the legacy modal with getChatHistoryFiles() and its selection callback calls loadChatHistory directly. Because filterChatHistoryFiles() only excludes projectId/project prefixes, these global agent notes are listed by the Load Copilot Chat Conversation command and then parsed by the legacy chat loader instead of resuming Agent Mode; filter mode: agent out of legacy history or route that modal through loadChatById.

---

obsidian-copilot/src/settings/deviceProfiles.ts

Line 154 in 2a26ac5

const nextBackends = stripDeviceFieldsFromBackends(agentMode.backends);

Preserve flat agent settings during profile hydration

On a vault that already has flat Agent Mode settings from the pre-device-profile shape (for example agentMode.backends.opencode.binaryPath) but no deviceProfiles[deviceId], profile is undefined and this unconditional strip removes every device-specific field before saveData can move it into the current device segment. The UI then shows the backend as unconfigured and a later save persists the loss; seed the current profile from flat fields when no profile exists before stripping stale values.

---

obsidian-copilot/src/commands/customCommandManager.ts

Lines 35 to 37 in 2a26ac5

	* Returns the singleton. `app` is required on the first call (which creates
	* the instance) and ignored afterward; the plugin seeds it once at load
	* (see main.ts) so subsequent call sites can omit it.

Refresh CustomCommandManager when App changes

After a plugin reload or another lifecycle that constructs a new App in the same renderer, main.ts calls CustomCommandManager.getInstance(this.app) again, but this singleton deliberately ignores the new app once the first instance exists. Because this patch moved create/update/delete paths to this.app.vault and this.app.fileManager, custom command edits after that lifecycle can still target the previous app; update the stored app or reset the singleton on unload.

---

obsidian-copilot/src/agentMode/session/AgentChatPersistenceManager.ts

Lines 148 to 151 in 2a26ac5

	const existingFile = options?.existingPath
	? this.resolveExistingFile(options.existingPath)
	: null;
	const existingMeta = existingFile ? await this.readExistingMeta(existingFile) : {};

Honor existingPath for hidden agent saves

When defaultSaveFolder is hidden or otherwise not indexed by the vault cache, the first autosave returns an adapter-only path, but the next autosave passes that path through resolveExistingFile() and gets null. The save then regenerates the filename with empty existingMeta instead of updating the pinned file, so a renamed topic can be overwritten and a changed naming template can create a second chat; resolve existingPath via the adapter before falling back to a new name.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".