fix: Query HealthKit samples over specified date interval #723

cbaker6 · 2025-02-23T01:48:50Z

This fixes a problem where all HealthKit queries using CareKit don't take advantage of the DateInterval specified in OCKOutcomeQuery and instead default to the DateInterval of the current day, resulting in all HealthKit samples being queried for the whole day. This can become expensive when a developer only needs samples for a small interval. In addition, it doesn't allow querying over days different from the current day. This is because the task dateInterval is propagated to generate HKQueryDescriptor's here:

CareKit/CareKitStore/CareKitStore/HealthKit/OCKHealthKitPassthroughStore+EventUtilities.swift

Lines 577 to 590 in b16d15c

    
           // Create a lookup table to quickly locate all events for a specific sample type 
        
           let eventsGroupedByQuantityType = Dictionary(grouping: events) { 
        
               extractQuantityType(from: $0.task) 
        
           } 
        
           // Create a single query descriptor for each quantity type. The date interval 
        
           // for the query descriptor predicate is determined by the events for the quantity type. 
        
           let queryDescriptors = eventsGroupedByQuantityType.map { sampleType, events -> HKQueryDescriptor in 
        
               let predicates = events.map { makePredicate(for: $0.scheduleEvent) } 
        
               let predicate = NSCompoundPredicate(orPredicateWithSubpredicates: predicates) 
        
               return HKQueryDescriptor(sampleType: sampleType, predicate: predicate) 
        
           }

Use the date interval specified by OCKOutcomeQuery if provided or else default to current day
Fix fetchAnyTask(withID...) to always return the current version based on the taskID
Add sort descriptors for effectiveDate and groupIdentifier to OCKOutcomeQuery
Sort by effectiveDate assending as false for all single entity fetches

cbaker6 · 2025-02-24T17:09:57Z

CareKitStore/CareKitStore/HealthKit/OCKHealthKitPassthroughStore+EventUtilities.swift

+        // Search over the interval provided by OCKOutcomeQuery if present
+        // or else constrain sample query over the current day.
+        let dateInterval = outcomeQuery.dateInterval ??
+            Calendar.current.dateInterval(of: .day, for: Date())!


Similar to

CareKit/CareKitStore/CareKitStore/Protocols/Events/OCKReadOnlyEventStore+VersioningUtilities.swift

Lines 225 to 232 in b16d15c

// We need to explicitly set the date interval in case it's nil

// to ensure that we fetch the most recent version of a task in a

// given date interval, and not all versions of the task

let dateInterval = latestTaskVersionsQuery.dateInterval ??

Calendar.current.dateInterval(of: .day, for: Date())!

latestTaskVersionsQuery.dateInterval = dateInterval

* feat: All OCKOutcomeQuery sorting * effectiveDate ascending should be false for all single queries * add unit tests

cbaker6 · 2025-03-03T01:40:31Z

CareKitStore/CareKitStore/CoreData/OCKStore+CarePlans.swift

@@ -144,6 +144,7 @@ extension OCKStore {
            switch order {
            case .effectiveDate(let ascending): return NSSortDescriptor(keyPath: \OCKCDCarePlan.effectiveDate, ascending: ascending)
            case .title(let ascending): return NSSortDescriptor(keyPath: \OCKCDCarePlan.title, ascending: ascending)
+            case .groupIdentifier(let ascending): return NSSortDescriptor(keyPath: \OCKCDCarePlan.groupIdentifier, ascending: ascending)


Added groupIdentifier sort to all that was missing

cbaker6 · 2025-03-03T01:45:13Z

CareKitStore/CareKitStore/HealthKit/OCKHealthKitPassthroughStore+EventUtilities.swift


        var taskQuery = OCKTaskQuery(dateInterval: dateInterval)
        taskQuery.ids = outcomeQuery.taskIDs
        taskQuery.remoteIDs = outcomeQuery.taskRemoteIDs
        taskQuery.uuids = outcomeQuery.taskUUIDs
+        taskQuery.sortDescriptors = outcomeQuery.sortDescriptors.map { descriptor in


Pass relevant sort criteria to the task query.

cbaker6 · 2025-03-03T01:46:37Z

CareKitStore/CareKitStore/Protocols/CarePlans/OCKAnyCarePlanStore.swift

@@ -138,7 +138,7 @@ public extension OCKAnyReadOnlyCarePlanStore {
                          completion: @escaping OCKResultClosure<OCKAnyCarePlan>) {
        var query = OCKCarePlanQuery(for: Date())
        query.limit = 1
-        query.sortDescriptors = [.effectiveDate(ascending: true)]
+        query.sortDescriptors = [.effectiveDate(ascending: false)]


All of these should be false to always get the newest version related to today, similar to how the fetching task was set up.

cbaker6 · 2025-03-03T01:48:09Z

CareKitStore/CareKitStore/StoreCoordinator/OCKPersistentStoreCoordinator+Outcomes.swift

@@ -44,14 +44,13 @@ extension OCKStoreCoordinator {
            $0.anyOutcomes(matching: query)
        }

-        let sortDescriptor = NSSortDescriptor(
-            keyPath: \OCKCDOutcome.id,


I'm assuming this is leftover from when the OCKCDOutcome.id had the the task occurrence appended to it:

CareKit/CareKitStore/CareKitStore/Structs/OCKOutcome.swift

Line 43 in 0ea1535

public var id: String { taskUUID.uuidString + "_\(taskOccurrenceIndex)" }

cbaker6 · 2025-03-03T02:51:14Z

CareKitStore/CareKitStore/Structs/Queries/OCKOutcomeQuery.swift

@@ -33,6 +33,22 @@ import Foundation
 /// A query that limits which outcomes will be returned when fetching.
 public struct OCKOutcomeQuery: Equatable, OCKQueryProtocol {

+    /// Specifies the order in which query results will be sorted.
+    public enum SortDescriptor: Equatable {


Add a sort descriptor for OCKOutcomeQuery

cbaker6 · 2025-03-03T18:29:49Z

CareKitStore/CareKitStore/Protocols/Tasks/OCKAnyTaskStore.swift

@@ -133,7 +133,7 @@ public protocol OCKAnyTaskStore: OCKAnyReadOnlyTaskStore {

 public extension OCKAnyReadOnlyTaskStore {
    func fetchAnyTask(withID id: String, callbackQueue: DispatchQueue = .main, completion: @escaping OCKResultClosure<OCKAnyTask>) {
-        var query = OCKTaskQuery(id: id)
+        var query = OCKTaskQuery(for: Date())


Switched this so it's aligned with the other Entity fetches. It was setting the id twice instead of querying the current version for today. Without the change, it's possible for this fetch to return a future version of the task since it would have a future effectiveDate.

cbaker6 · 2025-03-03T18:31:25Z

CareKitStore/CareKitStoreTests/OCKStore/TestStore+Tasks.swift

@@ -356,13 +356,34 @@ class TestStoreTasks: XCTestCase {

        var taskV2 = taskV1
        taskV2.title = "V2"
-        taskV2.effectiveDate = Calendar.current.date(byAdding: .year, value: 1, to: Date())!


Adjusted this test based on #723 (comment). This effectiveDate essentially could have been next year and it would have returned next years task today, which would be unexpected

fix: Query HealthKitSamples over specified date interval

c4037df

cbaker6 changed the title ~~fix: Query HealthKitSamples over specified date interval~~ fix: Query HealthKit samples over specified date interval Feb 23, 2025

cbaker6 added 2 commits February 23, 2025 13:55

test: All relevant properties of outcome query

b085481

nit

957c213

cbaker6 commented Feb 24, 2025

View reviewed changes

feat: All OCKOutcomeQuery sorting (#22)

2ad0695

* feat: All OCKOutcomeQuery sorting * effectiveDate ascending should be false for all single queries * add unit tests

cbaker6 commented Mar 3, 2025

View reviewed changes

add more unit tests

83f4d2d

cbaker6 commented Mar 3, 2025

View reviewed changes

nit

e9be043

cbaker6 force-pushed the updateHealthKitOutcomeDateInterval branch from 98bc61c to e9be043 Compare April 24, 2025 00:12

Merge branch 'main' into updateHealthKitOutcomeDateInterval

981cb22

cbaker6 mentioned this pull request May 15, 2025

feat: Add endDate to OCKOutcomeValue #719

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Query HealthKit samples over specified date interval #723

fix: Query HealthKit samples over specified date interval #723

Uh oh!

cbaker6 commented Feb 23, 2025 •

edited

Loading

Uh oh!

cbaker6 Feb 24, 2025

Uh oh!

cbaker6 Mar 3, 2025

Uh oh!

cbaker6 Mar 3, 2025

Uh oh!

cbaker6 Mar 3, 2025

Uh oh!

cbaker6 Mar 3, 2025 •

edited

Loading

Uh oh!

cbaker6 Mar 3, 2025

Uh oh!

cbaker6 Mar 3, 2025 •

edited

Loading

Uh oh!

cbaker6 Mar 3, 2025 •

edited

Loading

Uh oh!

Uh oh!

	// Create a lookup table to quickly locate all events for a specific sample type
	let eventsGroupedByQuantityType = Dictionary(grouping: events) {
	extractQuantityType(from: $0.task)
	}

	// Create a single query descriptor for each quantity type. The date interval
	// for the query descriptor predicate is determined by the events for the quantity type.
	let queryDescriptors = eventsGroupedByQuantityType.map { sampleType, events -> HKQueryDescriptor in

	let predicates = events.map { makePredicate(for: $0.scheduleEvent) }
	let predicate = NSCompoundPredicate(orPredicateWithSubpredicates: predicates)

	return HKQueryDescriptor(sampleType: sampleType, predicate: predicate)
	}

	// We need to explicitly set the date interval in case it's nil
	// to ensure that we fetch the most recent version of a task in a
	// given date interval, and not all versions of the task

	let dateInterval = latestTaskVersionsQuery.dateInterval ??
	Calendar.current.dateInterval(of: .day, for: Date())!

	latestTaskVersionsQuery.dateInterval = dateInterval

fix: Query HealthKit samples over specified date interval #723

Are you sure you want to change the base?

fix: Query HealthKit samples over specified date interval #723

Uh oh!

Conversation

cbaker6 commented Feb 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cbaker6 Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

cbaker6 Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

cbaker6 Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

cbaker6 Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

cbaker6 Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cbaker6 Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

cbaker6 Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cbaker6 Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cbaker6 commented Feb 23, 2025 •

edited

Loading

cbaker6 Mar 3, 2025 •

edited

Loading

cbaker6 Mar 3, 2025 •

edited

Loading

cbaker6 Mar 3, 2025 •

edited

Loading