DeallocTests 4.0 (4/5): configuration, warning severity and grace period

[DanielCech]

Part 4 of 5. DeallocTests 4.0 series (merge in order): #25 groundwork → #26 expectDeallocation → #27 tracking, hints, DI → #28 configuration → #29 remove legacy, docs. Why 4.0, the breaking changes and the alternatives we looked at: see #25.

Configuration for a test, a suite or an XCTest class: timeout, leaks as warnings, and a grace period that tells "released late" from "leaked".

Why

• Some screens legitimately take longer to go away; passing timeout: to every call is noise.
• A project adopting dealloc tests finds leaks on day one, and needs to see them without blocking CI.
• On a loaded CI, or with a store finishing a short Task after its screen closes, an object can go away just after the timeout. That's bounded retention, not a leak, and flaky failures erode trust in the tests.

What changes

@Suite(.deallocationTimeout(.seconds(5)))
struct ScreenDeallocTests { … }

@Suite(.deallocationIssues(.warning))          // adopting: report, don't fail
struct LegacyDeallocTests { … }

// XCTest has no traits: around a test's code, or around invokeTest() for a whole class
override func invokeTest() {
    withDeallocationConfiguration({ $0.severity = .warning }) {
        super.invokeTest()
    }
}

• One rule: timeout describes the object, so expectDeallocation still takes it; severity and grace period are policies, so they're configuration only.
• An object is checked with the configuration in effect where it was tracked, so an XCTest teardown check or a nested trait doesn't fall back to the defaults.
• Warnings: a non-strict expected failure in XCTest, Issue.record(severity: .warning) on Swift 6.3+, an intermittent known issue before.
• Grace period (3 s): an object still alive at the timeout is watched a little longer. If it goes away then, it's a warning ("released after 3.2 sec … bounded retention, not a leak"). Passing checks never wait for it, and it's skipped when leaks are warnings anyway. .deallocationGracePeriod(.zero) turns it off.

How to review

Order	File	What
1	Expectation/DeallocationConfiguration.swift	struct, task-local, traits, sync/async withDeallocationConfiguration
2	Expectation/DeallocationTracker.swift	configuration captured at track time, the grace-period wait
3	Expectation/IssueReporting.swift	severity
4	Diagnostics/LeakReport.swift	late-release message

Source +221, tests +245. The grace period is the most optional piece of the series; it can be split out or dropped without affecting the rest.

Testing

ConfigurationTests (call vs test vs suite precedence, nested trait order), GracePeriodTests, XCTest configuration cases. No test asserts on wall-clock time, so they hold on a loaded runner. Green on macOS (both trait settings) and the iOS Simulator; a CI job on the latest Xcode compiles and tests the Swift 6.3 warning path (Issue.record(severity:)).

🤖 Generated with Claude Code

[Copilot]

Copilot review overview

🟡 Changes recommended

Trackers incorrectly apply the first object’s configuration to every tracked object, and warning emission lacks effective assertions.

Review effort: Balanced
Findings: 1 · 1

Open (2)

• Tracker incorrectly applies first object's configuration to all objects · New
• Missing assertions for emitted warning issues · New

What changed in this PR

Adds configurable deallocation timeouts, warning severity, and grace-period handling across Swift Testing and XCTest.

Changes:

• Adds task-local configuration and Swift Testing traits.
• Reports leaks as warnings and distinguishes late releases from leaks.
• Expands configuration, reporting, and CI coverage.

File	Description
.github/​workflows/​ci.yml	Tests the Swift 6.3 warning path.
Sources/​DeallocTests/​Diagnostics/​LeakReport.swift	Adds grace-period and late-release messages.
Sources/​DeallocTests/​Expectation/​DeallocationConfiguration.swift	Defines configuration APIs and traits.
Sources/​DeallocTests/​Expectation/​DeallocationTracker.swift	Applies timeout, grace-period, and severity policies.
Sources/​DeallocTests/​Expectation/​ExpectDeallocation.swift	Uses configured default timeouts.
Sources/​DeallocTests/​Expectation/​ExpectDeallocation+DependencyInjection.swift	Applies configuration to DI checks.
Sources/​DeallocTests/​Expectation/​IssueReporting.swift	Adds warning-level reporting.
Sources/​DeallocTests/​Expectation/​TrackForDeallocation.swift	Documents configuration capture.
Tests/​DeallocTestsTests/​ConfigurationTests.swift	Tests configuration precedence.
Tests/​DeallocTestsTests/​ExpectDeallocationTests.swift	Shortens configured tracking timeout.
Tests/​DeallocTestsTests/​GracePeriodTests.swift	Tests grace-period behavior.
Tests/​DeallocTestsTests/​LeakReportTests.swift	Tests new diagnostic messages.
Tests/​DeallocTestsTests/​TrackForDeallocationXCTests.swift	Covers XCTest configuration behavior.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.