feat: Add endDate to OCKOutcomeValue by Rodrigox30 · Pull Request #719 · carekit-apple/CareKit

Rodrigox30 · 2024-08-06T17:29:47Z

Currently, when querying OCKHealthKitTask from the CareStore, the captured dates of samples are not accessible by developers from their respective OCKOutcomeValues. Adding this information to OCKOutcomeValue will allow developers to differentiate when samples were taken to provide insights into trends over time. The current problem is the createdDate can only be accessed on an OCKOutcomeValue which for a HealthKit sample is incorrect because the createdDate is the date the sample was queried from HealthKit (see here) as opposed to the actual start/end dates of the HealthKit sample. To reflect HealthKit samples startDate and endDate in OCKOutcomeValues, OCKOutcomeValue.createdDate is now set to the start date of the sample, and the newly added endDate is set to the end date of the sample.

These are the proposed changes to CareKit:

Updated CareKitStore2.1 to CareKitStore3.0 by adding endDate attributes to OCKCDOutcomeValue
Reflected these changes in OCKCDOutcomeValue.swift and OCKOutcomeValue.swift (this allows the endDate to be accessed for HealthKit samples but also allows developers to store/retrieve their own dates for these values)
Converting a sample to an outcome value and storing it on the event's outcome now has endDate sample values, with startDate sample values stored in createdDate
Test to confirm that these changes were made
Provided migration for CareKitStore2.0->CareKtStore3.0 and CareKitStore2.1->CareKtStore3.0

@gavirawson-apple please let me know if you want me to make any additional updates

Collaborators: @cbaker6

* feat: date acesses for created date to end date to task outcomes * endDate documentation update * Updated OCKOutcomeValue startDate and endDate documentation to HealthKit documentation. * Added 2.0 to 3.0 CoreData mapping and adjusted OCKOutcomeValue members * nits * Test added for Outcome Value * CareKitStore3.0 mapping update * Succesful migration from CareKitStore 2.1 to CareKitStore 3.0. * Add file to Package.swift * add files to Xcode project * fix coredata in project * nits * fix absolute path for coredata * deleted files --------- Co-authored-by: Corey Baker <coreyearleon@icloud.com>

Rodrigox30 · 2024-08-07T00:20:13Z

This CareKitStore only adds two new attributes to OCKCDOutcomeValue, startDate and endDate, to CareKitStore 2.1. Nothing else has changed from the 2.1 store

Rodrigox30 · 2024-08-07T00:23:17Z

This is the same custom migration policy from CareKitStore 2.0 to CareKitStore 2.1 updated to migrate CKS 2.0 to CKS 3.0. The only change that occurred was updating the schema version to 3.0.0.

Rodrigox30 · 2024-08-07T00:24:48Z

+
+            // Update the schema version to 3.0
+            if key == "schemaVersion" {
+                dInstance.setValue("3.0.0", forKey: key)


Updated schema version

Rodrigox30 · 2024-08-07T00:36:14Z

Mapping is one-to-one for CKS 2.1 to CKS 3.0. I need to hardcode the schemaVersion to 3.0.0 since $source.schemaVersion would not be correct, and I do not want to introduce a new custom migration policy for one change.

Changes occurred to:

OCKCDOutcomeToOCKCDOutcome

OCKCDCarePlanToOCKCDCarePlan

OCKCDTaskToOCKCDTask

OCKCDContactToOCKCDContact

OCKCDPatientToOCKCDPatient

Rodrigox30 · 2024-08-07T00:45:05Z

    @NSManaged var units: String?
    @NSManaged var createdDate: Date
+    @NSManaged var startDate: Date?
+    @NSManaged var endDate: Date?


Added startDate and endDate

Rodrigox30 · 2024-08-07T00:55:28Z

        )
+
+        outcomeValue.startDate = sample.dateInterval.start
+        outcomeValue.endDate = sample.dateInterval.end


Here we add the sample's startDate and endDate to its OCKOutcomeValue

Rodrigox30 · 2024-08-07T00:57:58Z

These files were added to test migration from CareKitStore2.1 to CareKitStore3.0 (used in testMigrationFrom2_1to3_0)

Rodrigox30 · 2024-08-07T01:09:36Z

    ///   Outcomes: 3
    ///   OutcomeValues: 3
-    func testMigrationFrom2_0to2_1() throws {
+    func testMigrationFrom2_0to3_0() throws {


Removed testMigrationFrom2_0to2_1 because we are not using CareKitStore 2.1. Created new tests for the previous stores to check if their migration was successfull.

Rodrigox30 · 2024-08-07T01:10:56Z

An example of how this updated OCKOutcomeValue allows developers to store/retrieve their own dates for these values

Rodrigox30 · 2024-08-07T01:12:26Z

                XCTAssertEqual(outcomeValues.count, 2)
                XCTAssertEqual(outcomeValues.first?.doubleValue, 70)
+                XCTAssertEqual(outcomeValues.first?.startDate, heartRateStart)
+                XCTAssertEqual(outcomeValues.first?.endDate, heartRateEnd)


Test to check if the sample's startDate and endDate were successfully saved in their OCKOutcomeValue

Rodrigox30 · 2024-08-07T03:33:57Z

+
+    /// The value's end date.
+    public var endDate: Date?
+


Added startDate and endDate to OCKOutcomeValue

…date

cbaker6 · 2025-05-15T20:49:39Z

@gavirawson-apple @aplummer-apple if this ends up getting merged after a successful review (🤞🏾) we plan to open up another PR that enables OCKOutcomeValue's to represent HKQuantity and HKCategory samples that consist of all valid HK properties in the Care Store and on OCKOutcomeValue. This will also allow CareKit to access HKCategory types using linkage:

public struct OCKHealthKitLinkage: Equatable, Codable {
    /// Initialize by specifying HealthKit types.
    ///
    /// - Parameter categoryIdentifier: A HealthKitCategoryIdentifier that describes the outcome's data type.
    public init(categoryIdentifier: HKCategoryTypeIdentifier) {
        self.sampleIdentifier = categoryIdentifier.rawValue
    }
}

For details on the working implementation see: cbaker6#23, cbaker6@79c88ab, cbaker6#26

HKQuantity and HKCategory samples can then be queried, graphed, saved to the OCKStore, etc. over any date interval using #723

cbaker6 · 2025-12-15T03:43:25Z

@gavirawson-apple this PR has the latest updates and is ready for review

Copilot

Pull request overview

This pull request adds an endDate property to OCKOutcomeValue to properly capture the time intervals of HealthKit samples. Previously, only the createdDate was available, which for HealthKit samples incorrectly represented when the sample was queried rather than when it was captured. The PR updates the data model to version 3.0, implements migrations from both 2.0 and 2.1, and modifies the HealthKit integration to preserve sample date information.

Changes:

Added optional endDate property to OCKOutcomeValue struct and Core Data entity
Updated Core Data schema to version 3.0 with migration paths from 2.0 and 2.1
Modified HealthKit integration to set createdDate to sample start date and endDate to sample end date

Reviewed changes

Copilot reviewed 14 out of 19 changed files in this pull request and generated 14 comments.

Show a summary per file

File	Description
Package.swift	Added migration mapping model resources for 2.0→3.0 and 2.1→3.0
CareKitStore/CareKitStore/Structs/OCKOutcomeValue.swift	Added endDate property, updated equality operator and Codable implementation
CareKitStore/CareKitStore/CoreData/OCKCDOutcomeValue.swift	Added endDate managed property and updated conversion methods
CareKitStore/CareKitStore/CoreData/OCKCDObject.swift	Updated schema version to 3.0.0
CareKitStore/CareKitStore/HealthKit/OCKHealthKitPassthroughStore+EventUtilities.swift	Updated to set createdDate and endDate from HealthKit sample intervals
CareKitStore/CareKitStore/CoreData/Migrations/2_0To3_0/OCKStoreMigration2_0To3_0Policy.swift	New migration policy for 2.0→3.0 schema upgrade
CareKitStore/CareKitStore/CoreData/CareKitStore.xcdatamodeld/CareKitStore3.0.xcdatamodel/contents	New Core Data model version with endDate attribute
CareKitStore/CareKitStore/CoreData/CareKitStore.xcdatamodeld/.xccurrentversion	Updated current version to 3.0
CareKitStore/CareKitStoreTests/Structs/TestOutcomeValue.swift	Added test for endDate serialization
CareKitStore/CareKitStoreTests/OCKStore/TestStore+Outcomes.swift	Added test verifying endDate persistence
CareKitStore/CareKitStoreTests/OCKHealthKitStore/TestHealthKitPassthroughStore+Events.swift	Updated tests to verify HealthKit sample dates are preserved
CareKitStore/CareKitStoreTests/CoreDataSchema/TestCoreDataSchema+Migrations.swift	Added migration tests for both upgrade paths
CareKitStore/CareKitStore.xcodeproj/project.pbxproj	Updated Xcode project with new files and references

Comments suppressed due to low confidence (1)

CareKitStore/CareKitStore/Structs/OCKOutcomeValue.swift:79

The hash function does not include endDate, which is inconsistent with the equality operator that does check endDate. This violates the Hashable contract: if two objects are equal, they must have the same hash value. The hash function should include endDate.

    public func hash(into hasher: inout Hasher) {
        switch type {
        case .binary: hasher.combine(dataValue)
        case .boolean: hasher.combine(booleanValue)
        case .date: hasher.combine(dateValue)
        case .double: hasher.combine(doubleValue)
        case .integer: hasher.combine(integerValue)
        case .text: hasher.combine(stringValue)
        }
        hasher.combine(type)
        hasher.combine(kind)
        hasher.combine(units)
        hasher.combine(createdDate)
    }

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-18T18:45:00Z

-                .process("CoreData/Migrations/2_0To2_1/2.0_2.1_Mapping.xcmappingmodel")
+                .process("CoreData/Migrations/2_0To2_1/2.0_2.1_Mapping.xcmappingmodel"),
+                .process("CoreData/Migrations/2_0To3_0/2.0_3.0_Mapping.xcmappingmodel"),
+				.process("CoreData/Migrations/2_1To3_0/2.1_3.0_Mapping.xcmappingmodel")


The indentation is inconsistent here. This line uses tabs instead of spaces, which differs from the surrounding code style. The file appears to use 4-space indentation based on the previous lines.

Suggested change

.process("CoreData/Migrations/2_1To3_0/2.1_3.0_Mapping.xcmappingmodel")

.process("CoreData/Migrations/2_1To3_0/2.1_3.0_Mapping.xcmappingmodel")

Copilot · 2026-01-18T18:45:00Z

        lhs.units == rhs.units &&
-        lhs.createdDate == rhs.createdDate
+        lhs.createdDate == rhs.createdDate &&
+		lhs.endDate == rhs.endDate


The indentation is inconsistent here. This line uses tabs instead of spaces, which differs from the surrounding code style.

Suggested change

lhs.endDate == rhs.endDate

lhs.endDate == rhs.endDate

Copilot · 2026-01-18T18:45:00Z

+		outcomeValue.value = newSum
+		outcomeValue.units = units


The indentation is inconsistent here. Lines 518-519 use tabs instead of spaces. The file should use consistent indentation throughout.

Suggested change

outcomeValue.value = newSum

outcomeValue.units = units

outcomeValue.value = newSum

outcomeValue.units = units

Copilot · 2026-01-18T18:45:01Z

@@ -0,0 +1,264 @@
+/*
+ Copyright (c) 2021, Apple Inc. All rights reserved.


The copyright year appears outdated. Other similar migration policy files in the codebase use a range like "2016-2025" or similar. Consider updating the copyright to reflect when this file was created or modified.

Suggested change

Copyright (c) 2021, Apple Inc. All rights reserved.

Copyright (c) 2016-2025, Apple Inc. All rights reserved.

Copilot · 2026-01-18T18:45:01Z

+        #endif
+        descriptor.shouldMigrateStoreAutomatically = true
+
+		let container = NSPersistentContainer(name: "sut", managedObjectModel: OCKStore.sharedManagedObjectModel)


The indentation is inconsistent here. This line uses tabs instead of spaces, which differs from the surrounding code style.

Suggested change

let container = NSPersistentContainer(name: "sut", managedObjectModel: OCKStore.sharedManagedObjectModel)

let container = NSPersistentContainer(name: "sut", managedObjectModel: OCKStore.sharedManagedObjectModel)

Copilot · 2026-01-18T18:45:01Z

    /// The date that this value was created.
    public var createdDate = Date()

+    /// The value's end date.


The documentation comment for the endDate property is too brief. Given this is a key addition to the PR, the documentation should explain what this field represents, especially in the context of HealthKit samples (e.g., "The value's end date. For HealthKit samples, this represents the end date of the sample's time interval.").

Suggested change

/// The value's end date.

/// The value's end date.

///

/// For time-based measurements, this represents the time at which the

/// associated event or observation finished. For HealthKit samples, this

/// corresponds to the end date of the sample's time interval.

Copilot · 2026-01-18T18:45:02Z

            event.outcome?.healthKitUUIDs.first != nil
        else {

+			let value = -1


Unused variable 'value' is assigned but never used. This line can be removed.

Copilot · 2026-01-18T18:45:02Z

    ///   Outcomes: 3
    ///   OutcomeValues: 3
-    func testMigrationFrom2_0to2_1() throws {
+    func testMigrationFrom2_0to3_0() throws {


The test function name was changed from 'testMigrationFrom2_0to2_1' to 'testMigrationFrom2_0to3_0', but this test is actually testing migration from version 2.0 (as evidenced by the SampleStore2.0.sqlite files being used). The name should reflect what it actually tests.

Copilot · 2026-01-18T18:45:02Z

+		updatedEvent.outcome?.values[0].createdDate = addedSample.dateInterval.start
+		updatedEvent.outcome?.values[0].endDate = addedSample.dateInterval.end


For cumulative outcomes, when invalidating an existing outcome value (setting it to -1), the dates are set to the addedSample's dates. However, this may not be semantically correct when the outcome represents a sum of multiple samples across a time range. Consider whether the dates should reflect the event's schedule dates or be preserved from the existing outcome, rather than using a single sample's dates.

Suggested change

updatedEvent.outcome?.values[0].createdDate = addedSample.dateInterval.start

updatedEvent.outcome?.values[0].endDate = addedSample.dateInterval.end

Copilot · 2026-01-18T18:45:02Z

@@ -86,6 +87,9 @@ public struct OCKOutcomeValue: Codable, Hashable, Sendable, CustomStringConverti
    /// The date that this value was created.


The documentation comment for createdDate should be updated to reflect its new dual purpose. According to the PR description, for HealthKit samples, createdDate now represents the sample's start date, not just when the value was created. The documentation should clarify this to avoid confusion.

Suggested change

/// The date that this value was created.

/// The primary date associated with this outcome value.

/// - For most outcome values, this is the date the value was created or recorded.

/// - For outcome values derived from HealthKit samples, this represents the sample's start date.

Rodrigox30 and others added 3 commits August 6, 2024 10:05

Fix merge conflicts

8f06df9

nits

c43aa63

Rodrigox30 marked this pull request as draft August 6, 2024 17:43

Rodrigox30 marked this pull request as ready for review August 6, 2024 19:40

Rodrigox30 commented Aug 7, 2024

View reviewed changes

nits

206a83b

Rodrigox30 commented Aug 7, 2024

View reviewed changes

Rodrigox30 and others added 3 commits February 14, 2025 15:03

encode and decode startDate and endDate

fe87109

remove spm file

070dbaf

Merge branch 'cbaker6:main' into fixHealthkit

6882a78

cbaker6 mentioned this pull request Mar 2, 2025

fix: Add HealthKit sample metadata Rodrigox30/CareKit#1

Open

1 task

cbaker6 added 4 commits May 9, 2025 11:37

use createdDate as startDate for HK samples

f4eac13

remove extra file

8aea83c

Ensure OCKOutcomeValues that reflect HK cumulative samples are up-to-…

ba70010

…date

remove extra file

573f00a

Rodrigox30 changed the title ~~feat: Add startDate and endDate to OCKOutcomeValue~~ feat: Add endDate to OCKOutcomeValue May 10, 2025

cbaker6 added 2 commits May 13, 2025 22:40

Merge branch 'main' into fixHealthkit

38dce75

fix unit HealthKit sample unit tests

7585ab3

Merge branch 'main' into fixHealthkit

bfd8f56

cbaker6 added 2 commits December 13, 2025 21:14

Merge branch 'main'

d2ea096

nits

b9c982c

fix: Processing of new migration file

8472a80

Copilot AI review requested due to automatic review settings January 18, 2026 18:38

Copilot started reviewing on behalf of cbaker6 January 18, 2026 18:38 View session

Copilot AI reviewed Jan 18, 2026

View reviewed changes

Improvements in cumulative sum dates

e4527db

	.process("CoreData/Migrations/2_1To3_0/2.1_3.0_Mapping.xcmappingmodel")
	.process("CoreData/Migrations/2_1To3_0/2.1_3.0_Mapping.xcmappingmodel")

		@@ -0,0 +1,264 @@
		/*
		Copyright (c) 2021, Apple Inc. All rights reserved.

	Copyright (c) 2021, Apple Inc. All rights reserved.
	Copyright (c) 2016-2025, Apple Inc. All rights reserved.

	let container = NSPersistentContainer(name: "sut", managedObjectModel: OCKStore.sharedManagedObjectModel)
	let container = NSPersistentContainer(name: "sut", managedObjectModel: OCKStore.sharedManagedObjectModel)

-    /// The value's end date.
+    /// The value's end date.
+    ///
+    /// For time-based measurements, this represents the time at which the
+    /// associated event or observation finished. For HealthKit samples, this
+    /// corresponds to the end date of the sample's time interval.

		updatedEvent.outcome?.values[0].createdDate = addedSample.dateInterval.start
		updatedEvent.outcome?.values[0].endDate = addedSample.dateInterval.end

		@@ -86,6 +87,9 @@ public struct OCKOutcomeValue: Codable, Hashable, Sendable, CustomStringConverti
		/// The date that this value was created.

-    /// The date that this value was created.
+    /// The primary date associated with this outcome value.
+    /// - For most outcome values, this is the date the value was created or recorded.
+    /// - For outcome values derived from HealthKit samples, this represents the sample's start date.

Uh oh!

Conversation

Rodrigox30 commented Aug 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rodrigox30 Aug 7, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

Rodrigox30 Aug 7, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

Rodrigox30 Aug 7, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rodrigox30 Aug 7, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

cbaker6 commented Dec 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Rodrigox30 commented Aug 6, 2024 •

edited

Loading

Rodrigox30 Aug 7, 2024 •

edited

Loading

Rodrigox30 Aug 7, 2024 •

edited

Loading

Rodrigox30 Aug 7, 2024 •

edited

Loading

Rodrigox30 Aug 7, 2024 •

edited

Loading

cbaker6 commented May 15, 2025 •

edited

Loading