Skip to content

Predicate incorrectly asserts on some keypaths #216

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

Merged
merged 3 commits into from
Aug 11, 2023
Merged

Predicate incorrectly asserts on some keypaths #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1626116
(113652078) Predicate incorrectly asserts on some keypaths to resilie…
jmschonfeld Aug 9, 2023
19535d5
(113652078) Switch to using MemoryLayout.offset(of:) for stored prope…
jmschonfeld Aug 10, 2023
54419c6
(113652078) Fix AnyKeyPath to PartialKeyPath casting
jmschonfeld Aug 11, 2023
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
14 changes: 9 additions & 5 deletions Sources/FoundationEssentials/Predicate/KeyPath+Inspection.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ extension UInt32 {
private static var COMPUTED_COMPONENT_PAYLOAD_ARGUMENTS_MASK: UInt32 { 0x0008_0000 }
private static var COMPUTED_COMPONENT_PAYLOAD_SETTABLE_MASK: UInt32 { 0x0040_0000 }

fileprivate static var PROPERTY_OFFSET_TOO_LARGE: UInt32 { 0x00FF_FFFF }

fileprivate var _keyPathHeader_bufferSize: Int {
Int(self & Self.KEYPATH_HEADER_BUFFER_SIZE_MASK)
}
Expand All @@ -42,6 +40,10 @@ extension UInt32 {
}
}

private func _keyPathOffset<T>(_ root: T.Type, _ keyPath: AnyKeyPath) -> Int? {
MemoryLayout<T>.offset(of: keyPath as! PartialKeyPath<T>)
}

extension AnyKeyPath {
private static var WORD_SIZE: Int { MemoryLayout<Int>.size }

Expand All @@ -55,9 +57,11 @@ extension AnyKeyPath {
case 1: // struct/tuple/self stored property
fallthrough
case 3: // class stored property
// Stored property components are either just the payload, or the payload plus 32 bits if the payload is the sentinel value
let size = (firstComponentHeader._keyPathComponentHeader_payload == .PROPERTY_OFFSET_TOO_LARGE) ? MemoryLayout<UInt64>.size : MemoryLayout<UInt32>.size
if header._keyPathHeader_bufferSize > size {
// Key paths to stored properties are only single-component if MemoryLayout.offset(of:) returns an offset
func project<T>(_: T.Type) -> Bool {
_keyPathOffset(T.self, self) == nil
}
if _openExistential(Self.rootType, do: project) {
fatalError("Predicate does not support keypaths with multiple components")
}
case 2: // computed
Expand Down
32 changes: 32 additions & 0 deletions Tests/FoundationEssentialsTests/PredicateTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,6 +680,38 @@ final class PredicateTests: XCTestCase {
XCTAssertTrue(try _build(true).evaluate(1))
XCTAssertFalse(try _build(false).evaluate(1))
}

func testResilientKeyPaths() {
// Local, non-resilient type
struct Foo {
let a: String // Non-resilient
let b: Date // Resilient (in Foundation)
let c: String // Non-resilient
}

let now = Date.now
let _ = Predicate<Foo> {
PredicateExpressions.build_Conjunction(
lhs: PredicateExpressions.build_Equal(
lhs: PredicateExpressions.build_KeyPath(
root: PredicateExpressions.build_Arg($0),
keyPath: \.a
),
rhs: PredicateExpressions.build_KeyPath(
root: PredicateExpressions.build_Arg($0),
keyPath: \.c
)
),
rhs: PredicateExpressions.build_Equal(
lhs: PredicateExpressions.build_KeyPath(
root: PredicateExpressions.build_Arg($0),
keyPath: \.b
),
rhs: PredicateExpressions.build_Arg(now)
)
)
}
}
}

#endif