feat: Build CareKit for macOS and visionOS by cbaker6 · Pull Request #716 · carekit-apple/CareKit

cbaker6 · 2024-07-05T03:42:15Z

CareKitUI currently can't be built for macOS due to its use of UIKit. In addition, the whole framework currently doesn't build for visionOS. Close #515. Tracking the build across all OS's can be seen here: cbaker6#14 along with more details about the PR.

The following items are completed:

Enable CareKitUI to build for macOS similar to watchOS by allowing SwiftUI based CareKit views
Enable CareStore and CareKit to build for macOS
Enable all CareKit frameworks to build for visionOS
Read/Write to HealthKit store on all OS's
All tests pass on all OS's locally

Note

This has a lot of file changes, but most are minimal changes like, #if !os(watchOS) && !os(macOS) && !os(visionOS)
An improvement over Build CareKitStore and CareKitFHIR for macOS #696

(cherry picked from commit 355b607)

(cherry picked from commit 150d2d4)

cbaker6 · 2024-07-06T03:06:04Z

CareKit/CareKit/Shared/Task/OCKTaskEvents.swift

+        #endif
+    }
+
+    private func rowValueOfIndexPath(_ indexPath: IndexPath) -> Int {


Added this method because iOS and macOS use row/item respectively

cbaker6 · 2024-07-06T03:06:47Z

CareKit/CareKit/Shared/Task/OCKTaskEvents.swift

        // First make sure there is no matching event already stored in the data structure.
        let indexPath = self.indexPath(of: event)
-        guard indexPath == nil else { return (self[indexPath!.section][indexPath!.row], false) }
+        guard indexPath == nil else {


See comment below about row/item is handled for how iOS/macOS

cbaker6 · 2024-07-06T03:13:38Z

CareKitStore/CareKitStoreTests/OCKStore/TestStore.swift

    }
+
+    #if os(macOS)
+    func checkStoreProtection(_ protection: FileProtectionType) throws {


This test is currently needed for macOS because macOS is the only one that reports these attributes directly on the file.

cbaker6 · 2024-07-06T03:15:00Z

CareKitUI/CareKitUI/Shared/Components/CardView.swift

        RoundedRectangle(cornerRadius: style.appearance.cornerRadius2, style: .continuous)
    }

+    private var foregroundColor: Color {


A helper computed property to help handle SwiftUI and UIKit types.

cbaker6 · 2024-07-06T03:15:54Z

CareKitUI/CareKitUI/Shared/Components/CircularCompletionView.swift

+        #if !os(macOS)
+        return isComplete ? Color.accentColor : Color(style.color.clear)
+        #else
+        return isComplete ? Color.accentColor : style.color.clear


Needed to modify this helper computed property to help handle SwiftUI and UIKit types.

cbaker6 · 2024-07-06T03:16:04Z

CareKitUI/CareKitUI/Shared/Components/RectangularCompletionView.swift

+        #if !os(macOS)
+        return isComplete ? .init(style.color.tertiaryCustomFill) : .accentColor
+        #else
+        return isComplete ? style.color.tertiaryCustomFill : .accentColor


Needed to modify this helper computed property to help handle SwiftUI and UIKit types.

cbaker6 · 2024-07-06T03:17:38Z

CareKitUI/CareKitUI/Shared/Extensions/Number+Extensions.swift

+
+        #else
+
+        return 1


This scale value may not be correct, made this change because I could only find UIFontMetrics in UIKit, let me know if you have an improvement on this.

cbaker6 · 2024-07-06T03:22:28Z

CareKitUI/CareKitUI/Shared/Style/OCKColorStyler.swift

+
+    #elseif os(macOS)
+
+    var secondaryCustomGroupedBackground: Color { get }


Using SwiftUI Color directly for macOS

cbaker6 · 2024-07-06T03:23:19Z

CareKitUI/CareKitUI/Shared/Style/OCKColorStyler.swift


+    #elseif os(macOS)
+
+    var secondaryCustomGroupedBackground: Color { .white }


I chose .white for this and tertiaryCustomFill, let me know if you think a better color should be used for macOS

cbaker6 · 2024-07-06T03:24:26Z

CareKitUI/CareKitUI/Shared/Style/OCKColorStyler.swift


+    #if os(iOS) || os(visionOS) || os(watchOS)
+
    var white: UIColor { .white }


Every supported OS except for macOS will use UIKit for these colors

cbaker6 · 2024-07-06T03:25:30Z

CareKitUI/CareKitUI/Shared/Task/InstructionsTaskView.swift

 private let completionButtonTextPadding: CGFloat = 14
-#elseif os(watchOS)
+#else
 private let completionButtonTextPadding: CGFloat = 8


I made every OS other than iOS use this padding value, let me know if we should update it to be more specific.

cbaker6 · 2024-07-06T03:27:10Z

CareKitUI/CareKitUI/iOS/Link/LinkButton.swift

        }
    }
+
+    func webView(withURL url: URL, link: LinkItem) -> some View {


Created this method because some of the OS's don't support UIKit for SafariView or it didn't work properly (visionOS using Canvas). Let me know if you have an improvement here.

cbaker6 · 2024-07-06T03:27:39Z

CareKitUI/CareKitUI/iOS/Link/SafariView.swift

    func makeUIViewController(context: UIViewControllerRepresentableContext<SafariView>) -> SFSafariViewController {
        let config = SFSafariViewController.Configuration()
+        #if !os(visionOS)
        config.barCollapsingEnabled = true


Not available on visionOS

cbaker6 · 2024-07-06T03:30:31Z

CareKitStore/CareKitStore/CoreData/OCKStore.swift


+    private func updateFileProtectionPathAtURL(_ url: URL) throws {
+
+        #if os(macOS)


Currently only needed for macOS, but this method calls through just incase it's needed for other OS's later

cbaker6 · 2024-07-06T03:31:10Z

CareKitStore/CareKitStore/CoreData/OCKStore.swift

        descriptor.type = NSSQLiteStoreType
        descriptor.shouldAddStoreAsynchronously = false
+        #if !os(macOS)
        descriptor.setOption(storeType.securityClass as NSObject, forKey: NSPersistentStoreFileProtectionKey)


Handling macOS and a later call below

cbaker6 · 2024-07-06T03:31:48Z

CareKitStore/CareKitStoreTests/OCKHealthKitStore/TestHealthKitPassthroughStore+Events.swift

                XCTAssertEqual(outcomeValues.count, 2)
                XCTAssertEqual(outcomeValues.first?.doubleValue, 70)
+                #if !os(macOS) && !os(visionOS)
                XCTAssertEqual(outcomeValues[safe: 1]?.doubleValue, 80)


macOS and visionOS don't like safe

Removed the 'testRepetitionMode' property from the test plan.

cbaker6 · 2025-12-15T03:44:02Z

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

cbaker6 added 8 commits July 4, 2024 20:28

feat: Build CareKitUI for macOS

f1e8bbc

(cherry picked from commit 355b607)

update CI to test against macOS

bb36446

xcode proj builds for macOS

40e88e7

add macOS to test projects

8f4f043

Update swift.yml

1f9385c

Update swift.yml

c87e91c

build for visionOS

56406fd

(cherry picked from commit 150d2d4)

add visionOS to CI

857dd83

cbaker6 changed the title ~~feat: Build CareKitUI for macOS~~ feat: Build CareKit for macOS and visionOS Jul 5, 2024

cbaker6 added 3 commits July 5, 2024 10:48

add min visionOS requirement

41aee7b

fix file protections for macOS

8ae3970

nit

5421c7b

cbaker6 commented Jul 6, 2024

View reviewed changes

nits

d9149c3

cbaker6 commented Jul 6, 2024

View reviewed changes

Update Xcode

3adb362

cbaker6 added 24 commits February 19, 2025 19:27

Merge branch 'carekit-apple:main' into buildCareKitUI

f9afe82

Update swift.yml

b8ef119

replace xcpretty, it's producing errors

dff891a

nit

a7dce67

retry tests on failure up to 3 times

8b2862d

Merge remote-tracking branch 'refs/remotes/origin/buildCareKitUI'

af2ded5

Update swift.yml

3bad297

repeat tests on store up to 3 times

1122642

nit

bae166f

Merge branch 'main' into buildCareKitUI

e7647e7

add code back for macOS store

0cd2e3f

health stores can read/write on all OS's

6c6e427

Merge branch 'main' into buildCareKitUI

77265bb

nits

9bcb036

Update Swift CI workflow for new macOS and iOS versions

6273b0c

Only set file attribute key

2b23912

Merge remote-tracking branch 'refs/remotes/origin/buildCareKitUI'

e04359b

fix check on all OS's

1bda006

Remove testRepetitionMode from test plan

52e2692

Removed the 'testRepetitionMode' property from the test plan.

ensure store is deleted in tests

566bd61

comment out macOS tests for now

7636a0a

create unique OCKStore for tests

c15fd78

test one

c110224

revert

c123899


		#elseif os(macOS)

		var secondaryCustomGroupedBackground: Color { get }


		#if os(iOS) \|\| os(visionOS) \|\| os(watchOS)

		var white: UIColor { .white }


		private func updateFileProtectionPathAtURL(_ url: URL) throws {

		#if os(macOS)

Conversation

cbaker6 commented Jul 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Note

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!

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!

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!

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!

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 Jul 6, 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!

cbaker6 commented Dec 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

cbaker6 commented Jul 5, 2024 •

edited

Loading

cbaker6 Jul 6, 2024 •

edited

Loading