Pod vector

CareKit.podspec

@@ -0,0 +1,25 @@
+Pod::Spec.new do |s|
+  s.name                  = 'CareKit'
+  s.version               = '2.0'
+  s.summary               = 'CareKit is an open source software framework for creating apps that help people better understand and manage their health.'
+  s.homepage              = 'https://github.com/carekit-apple/CareKit/'
+  s.documentation_url     = 'https://developer.apple.com/documentation/carekit'
+  s.screenshots           = [ 'https://user-images.githubusercontent.com/51756298/69096972-66de0b00-0a0a-11ea-96f0-4605d04ab396.gif',
+                              'https://user-images.githubusercontent.com/51756298/69107801-7586eb00-0a27-11ea-8aa2-eca687602c76.gif']
+  s.license               = { :type => 'BSD', :file => 'LICENSE' }
+  s.author                = { 'researchandcare.org' => 'https://www.researchandcare.org' }
+  s.platform              = :ios
+  s.ios.deployment_target = '13.0'
+  s.swift_versions = '5.0'
+  s.source                = { :git => 'https://github.com/carekit-apple/carekit.git', :tag => s.version.to_s}
+
+  s.source_files          = 'CareKit/CareKit/**/*'
+  s.exclude_files         = [ 'CareKit/CareKit/**/*.plist', 'OCKCatalog', 'OCKSample', 'DerivedData' ]
+  s.xcconfig              = { 'LIBRARY_SEARCH_PATHS' => "$(SRCROOT)/Pods/**" }
+  #sp.module_map            = 'CareKit/CareKit.modulemap'
+  s.requires_arc          = true
+  s.frameworks            = 'CareKitUI', 'CareKitStore'
+  s.dependency 'CareKitUI', '2.0'
+  s.dependency 'CareKitStore', '2.0'
+
+end

CareKitStore.podspec

@@ -0,0 +1,21 @@
+Pod::Spec.new do |s|
+  s.name                  = 'CareKitStore'
+  s.version               = '2.0'
+  s.summary               = 'CareKit is an open source software framework for creating apps that help people better understand and manage their health.'
+  s.homepage              = 'https://github.com/carekit-apple/CareKit/'
+  s.documentation_url     = 'https://developer.apple.com/documentation/carekit'
+  s.screenshots           = [ 'https://user-images.githubusercontent.com/51756298/69096972-66de0b00-0a0a-11ea-96f0-4605d04ab396.gif',
+                              'https://user-images.githubusercontent.com/51756298/69107801-7586eb00-0a27-11ea-8aa2-eca687602c76.gif']
+  s.license               = { :type => 'BSD', :file => 'LICENSE' }
+  s.author                = { 'researchandcare.org' => 'https://www.researchandcare.org' }
+  s.platform              = :ios
+  s.ios.deployment_target = '13.0'
+  #s.osx.deployment_target = '10.15'
+  s.swift_versions = '5.0'
+  s.source                = { :git => 'https://github.com/carekit-apple/carekit.git', :tag => s.version.to_s, :submodules => true }
+
+  s.source_files          = 'CareKitStore/CareKitStore/**/*'
+  s.exclude_files         = 'CareKitStore/CareKitStore/**/*.plist'
+  s.frameworks            = 'HealthKit', 'CoreData'
+
+end

CareKitStore/CareKitStore/CoreData/OCKStore+Outcomes.swift

@@ -151,6 +151,7 @@ extension OCKStore {
         currentOutcomes.forEach {
             $0.deletedDate = Date()
             $0.values = Set()
+            $0.logicalClock = Int64(context.clockTime)
         }
 
         let newOutcomes = outcomes.map(self.createOutcome)

CareKitStore/CareKitStore/Protocols/CoreData/OCKCoreDataStoreProtocol.swift

@@ -177,6 +177,7 @@ extension OCKCoreDataStoreProtocol {
             guard let current = currentVersions.first(where: { $0.id == value.id }) else {
                 throw OCKStoreError.invalidValue(reason: "No matching object could be found for id: \(value.id)")
             }
+            current.logicalClock = Int64(context.clockTime)
             let newVersion = addNewVersion(value)
             newVersion.previous = current
             newVersion.uuid = UUID()

CareKitStore/CareKitStoreTests/OCKStore/TestStore+BuildRevisions.swift

@@ -94,7 +94,7 @@ class TestStoreBuildRevisions: XCTestCase {
         try store.deleteTasksAndWait([taskA2])
         let revision = store.computeRevision(since: store.context.clockTime)
 
-        XCTAssert(revision.entities.count == 1)
+        XCTAssert(revision.entities.count == 2)
         XCTAssert(revision.entities.first?.deletedDate != nil)
     }
 

CareKitStore/CareKitStoreTests/OCKStore/TestStore+Sync.swift

@@ -120,7 +120,7 @@ class TestStoreSync: XCTestCase {
         XCTAssert(localTasks.count == 2)
         XCTAssert(localOutcomes.count == 2)
     }
-
+    
     func testKeepRemoteTaskWithFirstVersionOfTasks() throws {
         peer.automaticallySynchronizes = false
         peer.conflictPolicy = .keepRemote
@@ -267,6 +267,92 @@ class TestStoreSync: XCTestCase {
         XCTAssert(localOutcomes == remoteOutcomes)
         XCTAssert(localOutcomes.count == 1)
     }
+
+    func testTombstoningOutcomePushedToRemote() throws {
+        let dummy2 = DummyEndpoint2()
+        let testStore = OCKStore(name: "test", type: .inMemory, remote: dummy2)
+        dummy2.automaticallySynchronizes = false
+
+        let schedule = OCKSchedule.mealTimesEachDay(start: Date(), end: nil)
+        let task = try testStore.addTaskAndWait(OCKTask(id: "A", title: "A", carePlanUUID: nil, schedule: schedule))
+        let taskUUID = try task.getUUID()
+
+        let outcome = try testStore.addOutcomeAndWait(OCKOutcome(taskUUID: taskUUID, taskOccurrenceIndex: 0, values: [OCKOutcomeValue("test")]))
+        let outcomeUUID = try outcome.getUUID()
+        XCTAssertNoThrow(try testStore.syncAndWait()) //Sync original outcome
+
+        try testStore.deleteOutcomeAndWait(outcome)
+        XCTAssertNoThrow(try testStore.syncAndWait()) //Sync tombstoned outcome
+        let latestRevisions = dummy2.revisionsPushedInLastSynch
+        XCTAssert(latestRevisions.count == 2)
+
+        let tombstonedOutcomes = latestRevisions.compactMap{
+            entity -> OCKOutcome? in
+            switch entity{
+            case .outcome(let outcome):
+                return outcome
+            default:
+                return nil
+            }
+        }
+        XCTAssert(tombstonedOutcomes.count == 2)
+
+        guard let tombstonedWithSameUUID = try tombstonedOutcomes.filter({try $0.getUUID() == outcomeUUID}).first else{
+            throw OCKStoreError.invalidValue(reason: "Filter doesn't contain UUID")
+        }
+        XCTAssert(tombstonedWithSameUUID.values.isEmpty)
+        XCTAssert(tombstonedWithSameUUID.deletedDate != nil)
+
+        guard let tombstonedWithDifferentUUID = try tombstonedOutcomes.filter({try $0.getUUID() != outcomeUUID}).first else{
+            throw OCKStoreError.invalidValue(reason: "Filter doesn't contain UUID")
+        }
+        XCTAssert(tombstonedWithDifferentUUID.values.count == 1)
+        XCTAssert(tombstonedWithDifferentUUID.deletedDate != nil)
+    }
+
+    func testUpdateTaskVersionPushedToRemote() throws {
+        let dummy2 = DummyEndpoint2()
+        let testStore = OCKStore(name: "test", type: .inMemory, remote: dummy2)
+        dummy2.automaticallySynchronizes = false
+
+        let schedule = OCKSchedule.mealTimesEachDay(start: Date(), end: nil)
+        var task = try testStore.addTaskAndWait(OCKTask(id: "A", title: "A", carePlanUUID: nil, schedule: schedule))
+        let taskUUID = try task.getUUID()
+
+        XCTAssertNoThrow(try testStore.syncAndWait()) //Sync original outcome
+
+        task.instructions = "Updated instructions"
+        try testStore.updateTaskAndWait(task)
+        XCTAssertNoThrow(try testStore.syncAndWait()) //Sync updated outcome
+
+        let latestRevisions = dummy2.revisionsPushedInLastSynch
+        XCTAssert(latestRevisions.count == 2)
+
+        let versionedTasks = latestRevisions.compactMap{
+            entity -> OCKTask? in
+            switch entity{
+            case .task(let task):
+                return task
+            default:
+                return nil
+            }
+        }
+        XCTAssert(versionedTasks.count == 2)
+
+        guard let previousVersionTask = try versionedTasks.filter({try $0.getUUID() == taskUUID}).first else{
+            throw OCKStoreError.invalidValue(reason: "Filter doesn't contain UUID")
+        }
+
+        guard let currentVersionTask = try versionedTasks.filter({try $0.getUUID() != taskUUID}).first else{
+            throw OCKStoreError.invalidValue(reason: "Filter doesn't contain UUID")
+        }
+        XCTAssert(previousVersionTask.instructions == nil)
+        XCTAssert(try previousVersionTask.getNextVersionUUID() == currentVersionTask.getUUID())
+
+        XCTAssert(currentVersionTask.instructions != nil)
+        XCTAssert(try currentVersionTask.getPreviousVersionUUID() == taskUUID)
+        XCTAssertThrowsError(try currentVersionTask.getNextVersionUUID())
+    }
 }
 
 class DummyEndpoint: OCKRemoteSynchronizable {
@@ -354,3 +440,98 @@ class DummyEndpoint: OCKRemoteSynchronizable {
         return revision
     }
 }
+
+class DummyEndpoint2: OCKRemoteSynchronizable {
+
+    var automaticallySynchronizes = true
+    var shouldSucceed = true
+    var delay: TimeInterval = 0.0
+    weak var delegate: OCKRemoteSynchronizationDelegate?
+
+    private(set) var timesPullWasCalled = 0
+    private(set) var timesPushWasCalled = 0
+    private(set) var timesForcePushed = 0
+    private(set) var uuid = UUID()
+    private(set) var dummyKnowledgeVector:OCKRevisionRecord.KnowledgeVector? = nil
+    public internal(set) var revisionsPushedInLastSynch = [OCKEntity]()
+
+    var conflictPolicy = OCKMergeConflictResolutionPolicy.keepRemote
+
+    func pullRevisions(
+        since knowledgeVector: OCKRevisionRecord.KnowledgeVector,
+        mergeRevision: @escaping (OCKRevisionRecord, @escaping (Error?) -> Void) -> Void,
+        completion: @escaping (Error?) -> Void) {
+
+        timesPullWasCalled += 1
+        DispatchQueue.global(qos: .userInteractive).asyncAfter(deadline: .now() + delay) {
+            if !self.shouldSucceed {
+                completion(OCKStoreError.remoteSynchronizationFailed(reason: "Failed on purpose"))
+                return
+            }
+
+            let revision: OCKRevisionRecord!
+            if self.dummyKnowledgeVector == nil{
+                revision = OCKRevisionRecord(entities: [], knowledgeVector: .init())
+            }else{
+                revision = OCKRevisionRecord(entities: [], knowledgeVector: self.dummyKnowledgeVector!)
+            }
+
+            mergeRevision(revision, completion)
+        }
+    }
+
+    func pushRevisions(
+        deviceRevision: OCKRevisionRecord,
+        overwriteRemote: Bool,
+        completion: @escaping (Error?) -> Void) {
+
+        timesPushWasCalled += 1
+        timesForcePushed += overwriteRemote ? 1 : 0
+
+        //Save latest revisions
+        revisionsPushedInLastSynch.removeAll()
+        revisionsPushedInLastSynch.append(contentsOf: deviceRevision.entities)
+
+        //Update KnowledgeVector
+        if dummyKnowledgeVector == nil{
+            dummyKnowledgeVector = .init([uuid:0])
+        }
+        dummyKnowledgeVector?.increment(clockFor: uuid)
+        dummyKnowledgeVector?.merge(with: deviceRevision.knowledgeVector)
+
+        completion(nil)
+    }
+
+    func chooseConflictResolutionPolicy(
+        _ conflict: OCKMergeConflictDescription,
+        completion: @escaping (OCKMergeConflictResolutionPolicy) -> Void) {
+        completion(conflictPolicy)
+    }
+
+    func dummyRevision() -> OCKRevisionRecord {
+        let schedule = OCKSchedule.mealTimesEachDay(start: Date(), end: nil)
+        var task = OCKTask(id: "a", title: "A", carePlanUUID: nil, schedule: schedule)
+        task.uuid = UUID()
+        task.createdDate = Date()
+        task.updatedDate = task.createdDate
+
+        var outcome = OCKOutcome(taskUUID: task.uuid!, taskOccurrenceIndex: 0, values: [])
+        outcome.uuid = UUID()
+        outcome.createdDate = Date()
+        outcome.updatedDate = outcome.createdDate
+
+        let entities: [OCKEntity] = [
+            .task(task),
+            .outcome(outcome)
+        ]
+
+        let revision: OCKRevisionRecord!
+        if self.dummyKnowledgeVector == nil{
+            revision = OCKRevisionRecord(entities: entities, knowledgeVector: .init())
+        }else{
+            revision = OCKRevisionRecord(entities: entities, knowledgeVector: self.dummyKnowledgeVector!)
+        }
+
+        return revision
+    }
+}

CareKitStore/CareKitStoreTests/Utils.swift

@@ -66,3 +66,16 @@ extension OCKObjectCompatible {
         return uuid
     }
 }
+
+extension OCKVersionedObjectCompatible {
+    func getPreviousVersionUUID() throws -> UUID {
+        guard let uuid = previousVersionUUID else { throw OCKStoreError.invalidValue(reason: "Missing previousVersionUUID") }
+        return uuid
+    }
+
+    func getNextVersionUUID() throws -> UUID {
+        guard let uuid = nextVersionUUID else { throw OCKStoreError.invalidValue(reason: "Missing nextVersionUUID") }
+        return uuid
+    }
+}
+

CareKitUI.podspec

@@ -0,0 +1,22 @@
+Pod::Spec.new do |s|
+  s.name                  = 'CareKitUI'
+  s.version               = '2.0'
+  s.summary               = 'CareKit is an open source software framework for creating apps that help people better understand and manage their health.'
+  s.homepage              = 'https://github.com/carekit-apple/CareKit/'
+  s.documentation_url     = 'https://developer.apple.com/documentation/carekit'
+  s.screenshots           = [ 'https://user-images.githubusercontent.com/51756298/69096972-66de0b00-0a0a-11ea-96f0-4605d04ab396.gif',
+                              'https://user-images.githubusercontent.com/51756298/69107801-7586eb00-0a27-11ea-8aa2-eca687602c76.gif']
+  s.license               = { :type => 'BSD', :file => 'LICENSE' }
+  s.author                = { 'researchandcare.org' => 'https://www.researchandcare.org' }
+  s.platform              = :ios
+  s.ios.deployment_target = '13.0'
+  #s.osx.deployment_target = '10.15'
+  s.swift_versions = '5.0'
+  s.source                = { :git => 'https://github.com/carekit-apple/carekit.git', :tag => s.version.to_s}
+
+  s.source_files          = 'CareKitUI/CareKitUI/**/*'
+  #s.resources             = ['CareKitUI/CareKitUI/Supporting Files/Localization/*.lproj']
+  s.exclude_files         = ['CareKitUI/CareKitUI/**/*.plist']
+  s.frameworks            = 'UIKit', 'SwiftUI'
+
+end