fix: KeyPath crash when querying CareStore (#718)

cbaker6 · web-flow · commit b16d15c543ca · 2025-02-19T17:07:53.000-08:00
* test outcome fix (cherry picked from commit 4f10b62) * make all sort descriptors use class keyPaths (cherry picked from commit 671cfa7)
diff --git a/CareKitStore/CareKitStore/StoreCoordinator/OCKPersistentStoreCoordinator+Outcomes.swift b/CareKitStore/CareKitStore/StoreCoordinator/OCKPersistentStoreCoordinator+Outcomes.swift
@@ -45,7 +45,7 @@ extension OCKStoreCoordinator {
         }
 
         let sortDescriptor = NSSortDescriptor(
-            keyPath: \OCKAnyOutcome.id,
+            keyPath: \OCKCDOutcome.id,
             ascending: true
         )
 
diff --git a/CareKitStore/CareKitStore/Structs/Queries/OCKCarePlanQuery.swift b/CareKitStore/CareKitStore/Structs/Queries/OCKCarePlanQuery.swift
@@ -42,9 +42,9 @@ public struct OCKCarePlanQuery: Equatable, OCKQueryProtocol {
         var nsSortDescriptor: NSSortDescriptor {
             switch self {
             case let .effectiveDate(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyCarePlan.effectiveDate, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDCarePlan.effectiveDate, ascending: ascending)
             case let .title(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyCarePlan.title, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDCarePlan.title, ascending: ascending)
             }
         }
     }
diff --git a/CareKitStore/CareKitStore/Structs/Queries/OCKContactQuery.swift b/CareKitStore/CareKitStore/Structs/Queries/OCKContactQuery.swift
@@ -43,11 +43,11 @@ public struct OCKContactQuery: Equatable, OCKQueryProtocol {
         var nsSortDescriptor: NSSortDescriptor {
             switch self {
             case let .effectiveDate(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyContact.effectiveDate, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDContact.effectiveDate, ascending: ascending)
             case let .givenName(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyContact.name.givenName, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDContact.name.givenName, ascending: ascending)
             case let .familyName(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyContact.name.familyName, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDContact.name.familyName, ascending: ascending)
             }
         }
     }
diff --git a/CareKitStore/CareKitStore/Structs/Queries/OCKPatientQuery.swift b/CareKitStore/CareKitStore/Structs/Queries/OCKPatientQuery.swift
@@ -44,13 +44,13 @@ public struct OCKPatientQuery: Equatable, OCKQueryProtocol {
         var nsSortDescriptor: NSSortDescriptor {
             switch self {
             case let .groupIdentifier(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyPatient.groupIdentifier, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDPatient.groupIdentifier, ascending: ascending)
             case let .givenName(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyPatient.name.givenName, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDPatient.name.givenName, ascending: ascending)
             case let .familyName(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyPatient.name.familyName, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDPatient.name.familyName, ascending: ascending)
             case let .effectiveDate(ascending):
-                return NSSortDescriptor(keyPath: \OCKAnyPatient.effectiveDate, ascending: ascending)
+                return NSSortDescriptor(keyPath: \OCKCDPatient.effectiveDate, ascending: ascending)
             }
         }
     }
diff --git a/CareKitStore/CareKitStore/Structs/Queries/OCKTaskQuery.swift b/CareKitStore/CareKitStore/Structs/Queries/OCKTaskQuery.swift
@@ -44,19 +44,19 @@ public struct OCKTaskQuery: Equatable, OCKQueryProtocol {
 
             case let .effectiveDate(ascending):
                 return NSSortDescriptor(
-                    keyPath: \OCKAnyTask.effectiveDate,
+                    keyPath: \OCKCDTask.effectiveDate,
                     ascending: ascending
                 )
 
             case let .groupIdentifier(ascending):
                 return NSSortDescriptor(
-                    keyPath: \OCKAnyTask.groupIdentifier,
+                    keyPath: \OCKCDTask.groupIdentifier,
                     ascending: ascending
                 )
 
             case let .title(ascending):
                 return NSSortDescriptor(
-                    keyPath: \OCKAnyTask.title,
+                    keyPath: \OCKCDTask.title,
                     ascending: ascending
                 )
             }

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ extension OCKStoreCoordinator {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`let sortDescriptor = NSSortDescriptor(`
`48`		`- keyPath: \OCKAnyOutcome.id,`
	`48`	`+ keyPath: \OCKCDOutcome.id,`
`49`	`49`	`ascending: true`
`50`	`50`	`)`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,9 @@ public struct OCKCarePlanQuery: Equatable, OCKQueryProtocol {`
`42`	`42`	`var nsSortDescriptor: NSSortDescriptor {`
`43`	`43`	`switch self {`
`44`	`44`	`case let .effectiveDate(ascending):`
`45`		`- return NSSortDescriptor(keyPath: \OCKAnyCarePlan.effectiveDate, ascending: ascending)`
	`45`	`+ return NSSortDescriptor(keyPath: \OCKCDCarePlan.effectiveDate, ascending: ascending)`
`46`	`46`	`case let .title(ascending):`
`47`		`- return NSSortDescriptor(keyPath: \OCKAnyCarePlan.title, ascending: ascending)`
	`47`	`+ return NSSortDescriptor(keyPath: \OCKCDCarePlan.title, ascending: ascending)`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,11 +43,11 @@ public struct OCKContactQuery: Equatable, OCKQueryProtocol {`
`43`	`43`	`var nsSortDescriptor: NSSortDescriptor {`
`44`	`44`	`switch self {`
`45`	`45`	`case let .effectiveDate(ascending):`
`46`		`- return NSSortDescriptor(keyPath: \OCKAnyContact.effectiveDate, ascending: ascending)`
	`46`	`+ return NSSortDescriptor(keyPath: \OCKCDContact.effectiveDate, ascending: ascending)`
`47`	`47`	`case let .givenName(ascending):`
`48`		`- return NSSortDescriptor(keyPath: \OCKAnyContact.name.givenName, ascending: ascending)`
	`48`	`+ return NSSortDescriptor(keyPath: \OCKCDContact.name.givenName, ascending: ascending)`
`49`	`49`	`case let .familyName(ascending):`
`50`		`- return NSSortDescriptor(keyPath: \OCKAnyContact.name.familyName, ascending: ascending)`
	`50`	`+ return NSSortDescriptor(keyPath: \OCKCDContact.name.familyName, ascending: ascending)`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,13 +44,13 @@ public struct OCKPatientQuery: Equatable, OCKQueryProtocol {`
`44`	`44`	`var nsSortDescriptor: NSSortDescriptor {`
`45`	`45`	`switch self {`
`46`	`46`	`case let .groupIdentifier(ascending):`
`47`		`- return NSSortDescriptor(keyPath: \OCKAnyPatient.groupIdentifier, ascending: ascending)`
	`47`	`+ return NSSortDescriptor(keyPath: \OCKCDPatient.groupIdentifier, ascending: ascending)`
`48`	`48`	`case let .givenName(ascending):`
`49`		`- return NSSortDescriptor(keyPath: \OCKAnyPatient.name.givenName, ascending: ascending)`
	`49`	`+ return NSSortDescriptor(keyPath: \OCKCDPatient.name.givenName, ascending: ascending)`
`50`	`50`	`case let .familyName(ascending):`
`51`		`- return NSSortDescriptor(keyPath: \OCKAnyPatient.name.familyName, ascending: ascending)`
	`51`	`+ return NSSortDescriptor(keyPath: \OCKCDPatient.name.familyName, ascending: ascending)`
`52`	`52`	`case let .effectiveDate(ascending):`
`53`		`- return NSSortDescriptor(keyPath: \OCKAnyPatient.effectiveDate, ascending: ascending)`
	`53`	`+ return NSSortDescriptor(keyPath: \OCKCDPatient.effectiveDate, ascending: ascending)`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,19 +44,19 @@ public struct OCKTaskQuery: Equatable, OCKQueryProtocol {`
`44`	`44`
`45`	`45`	`case let .effectiveDate(ascending):`
`46`	`46`	`return NSSortDescriptor(`
`47`		`- keyPath: \OCKAnyTask.effectiveDate,`
	`47`	`+ keyPath: \OCKCDTask.effectiveDate,`
`48`	`48`	`ascending: ascending`
`49`	`49`	`)`
`50`	`50`
`51`	`51`	`case let .groupIdentifier(ascending):`
`52`	`52`	`return NSSortDescriptor(`
`53`		`- keyPath: \OCKAnyTask.groupIdentifier,`
	`53`	`+ keyPath: \OCKCDTask.groupIdentifier,`
`54`	`54`	`ascending: ascending`
`55`	`55`	`)`
`56`	`56`
`57`	`57`	`case let .title(ascending):`
`58`	`58`	`return NSSortDescriptor(`
`59`		`- keyPath: \OCKAnyTask.title,`
	`59`	`+ keyPath: \OCKCDTask.title,`
`60`	`60`	`ascending: ascending`
`61`	`61`	`)`
`62`	`62`	`}`