Skip to content

[Observation] Restrict deinitialization fired events to be limited to one per registrar and send a \Self.self as the keypath to avoid property confusions #82307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[Observation] Restrict deinitialization fired events to be limited to one per registrar and send a \Self.self as the keypath to avoid property confusions #82307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
071d5b5
[Observation] Restrict deinitialization fired events to be limited to…
phausler Jun 17, 2025
9f39256
Break the outer loop of iteration for deinitialization tracker
phausler Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions stdlib/public/Observation/Sources/Observation/ObservationRegistrar.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,20 +110,27 @@ public struct ObservationRegistrar: Sendable {
}
}

internal mutating func deinitialize() -> [@Sendable () -> Void] {
var trackers = [@Sendable () -> Void]()
for (keyPath, ids) in lookups {
internal mutating func deinitialize() -> (@Sendable () -> Void)? {
func extractSelf<T>(_ ty: T.Type) -> AnyKeyPath {
return \T.self
}

var tracker: (@Sendable () -> Void)?
lookupIteration: for (keyPath, ids) in lookups {
for id in ids {
if let tracker = observations[id]?.willSetTracker {
trackers.append({
tracker(keyPath)
})
if let found = observations[id]?.willSetTracker {
// convert the keyPath into its \Self.self version
let selfKp = _openExistential(type(of: keyPath).rootType, do: extractSelf)
tracker = {
found(selfKp)
}
break lookupIteration
}
}
}
observations.removeAll()
lookups.removeAll()
return trackers
return tracker
}

internal mutating func willSet(keyPath: AnyKeyPath) -> [@Sendable (AnyKeyPath) -> Void] {
Expand Down Expand Up @@ -169,10 +176,7 @@ public struct ObservationRegistrar: Sendable {
}

internal func deinitialize() {
let tracking = state.withCriticalRegion { $0.deinitialize() }
for action in tracking {
action()
}
state.withCriticalRegion { $0.deinitialize() }?()
}

internal func willSet<Subject: Observable, Member>(
Expand Down
8 changes: 5 additions & 3 deletions test/stdlib/Observation/Observable.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,7 @@ final class CowTest {
@Observable
final class DeinitTriggeredObserver {
var property: Int = 3
var property2: Int = 4
let deinitTrigger: () -> Void

init(_ deinitTrigger: @escaping () -> Void) {
Expand Down Expand Up @@ -528,17 +529,18 @@ struct Validator {

suite.test("weak container observation") {
let changed = CapturedState(state: false)
let deinitialized = CapturedState(state: false)
let deinitialized = CapturedState(state: 0)
var test = DeinitTriggeredObserver {
deinitialized.state = true
deinitialized.state += 1
}
withObservationTracking { [weak test] in
_blackHole(test?.property)
_blackHole(test?.property2)
} onChange: {
changed.state = true
}
test = DeinitTriggeredObserver { }
expectEqual(deinitialized.state, true)
expectEqual(deinitialized.state, 1) // ensure only one invocation is done per deinitialization
expectEqual(changed.state, true)
}

Expand Down