Skip to content

docs: promote three docs-audit technical-debt findings to issues #285-#287 - #288

Merged
drmoisan merged 1 commit into
mainfrom
docs/tech-debt-audit-promotions-285-286-287
Jul 9, 2026
Merged

drmoisan merged 1 commit into
mainfrom
docs/tech-debt-audit-promotions-285-286-287

Conversation

@drmoisan

@drmoisan drmoisan commented Jul 9, 2026

Copy link
Copy Markdown
Owner

Suggested title

docs: promote three docs-audit technical-debt findings to issues #285-#287

Summary

  • Audited docs/ and its subdirectories for technical-debt callouts (deferred/follow-up notes, coverage-ceiling constraints, out-of-scope items) recorded in prior feature and remediation artifacts.
  • Validated each candidate directly against current source before treating it as real, current debt.
  • Three candidates were confirmed still present in the codebase and had no existing tracking issue; each was written up and promoted to a GitHub issue via the repository's new_potential_bug_entry / potential_to_issue MCP tooling.
  • This PR adds only the resulting provenance markdown files under docs/features/potential/promoted/; no production or test code is changed.

Why

The user asked for a sweep of docs/ to find technical-debt callouts, confirm which still apply to the current codebase, and promote the real ones to tracked issues using the MCP promotion tooling, so they become visible, actionable work items instead of buried notes in archived feature folders.

What Changed

Docs (issue-promotion provenance only):

  • docs/features/potential/promoted/2026-07-09-timeouttask-runwithtimeout-exception-type-mismatch.md — record for #285: TimeOutTask.RunWithTimeout<T1,TResult> (UtilitiesCS/Threading/TimeOutTask.cs:199) catches TimeoutException instead of TaskCanceledException, so its timer-driven timeout/retry path never fires — inconsistent with all four sibling overloads. Originally identified during issue Bug: onedrive-writer-timeout-test-determinism #253 and explicitly deferred there for a separate issue.
  • docs/features/potential/promoted/2026-07-09-qfc-collectioncontroller-removespecificcontrolgroup-counter-leak.md — record for #286: QfcCollectionController.RemoveSpecificControlGroupAsync (QuickFiler/Controllers/QfcCollectionController.cs:1142-1233) increments a static reentrancy counter with no try/finally, so any mid-method exception leaks the counter and produces false-positive "race condition" log noise on every subsequent call. Originally identified during issue Bug: quickfiler-navigation-key-collision #232 and explicitly deferred there for a separate issue.
  • docs/features/potential/promoted/2026-07-09-storewrapper-dialog-imprecise-for-genuine-failure.md — record for #287: StoreWrapperController.Launch (UtilitiesCS/OutlookObjects/Store/StoreWrapperController.cs:119-127) shows the identical "try again after startup completes" dialog copy for both the transient-load and genuine-failure readiness states. Explicitly flagged as a deliberate, unimplemented follow-up in the store-lockup-resilience epic's spec (docs/features/active/2026-07-07-folder-settings-store-model-null-262/spec.md).

No other files are touched. No .cs, .csproj, workflow, or configuration file is part of this change.

Architecture / How It Fits Together

No architecture or wiring change. This is a pure documentation/issue-provenance commit: the three files are the durable record of the new_potential_bug_entry → potential_to_issue promotion already performed against this repository's GitHub issue tracker (issues #285, #286, #287).

Verification

Completed (this PR):

  • Each of the three defects was confirmed by reading the exact cited source lines on the current branch before promotion (not inferred from the historical docs alone).
  • Confirmed via gh issue list --search that no existing open or closed issue already tracked any of the three defects prior to this promotion.
  • git status is clean other than the three new files; no production/test code is present in this diff.

Recommended:

  • No build/test/lint run is required for this PR (zero .cs/.csproj/script changes). Standard CI should still pass since it also runs on documentation-only diffs.

Backward Compatibility / Migration Notes

None. No code, schema, or configuration changed.

Risks and Mitigations

  • Risk: None identified — the change is additive documentation only, with no runtime, build, or test surface.
  • Mitigation: N/A.

Review Guide

Single-commit, three-file diff; each file is independent and can be read in any order. No suggested review ordering is needed.

Follow-ups

GitHub Auto-close

None. This PR documents the promotion of issues #285, #286, and #287; it does not fix them, so it must not auto-close them. Related: #285, #286, #287.

…287

Audited docs/ for technical-debt callouts, validated each against current
source, and promoted three confirmed defects via the potential-bug/issue
MCP tooling: TimeOutTask exception-type mismatch (#285), QfcCollectionController
reentrancy-counter leak (#286), and StoreWrapperController dialog copy
imprecise for genuine failure (#287).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@drmoisan
drmoisan merged commit 9e03927 into main Jul 9, 2026
2 checks passed
@drmoisan
drmoisan deleted the docs/tech-debt-audit-promotions-285-286-287 branch July 9, 2026 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant