New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule #44

Supereg · 2024-08-23T08:53:22Z

New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule

♻️ Current situation & Problem

This PR completely rethinks the Scheduler package.
We introduce an updated Task model that is completely backed by SwiftData. Further, we provide a new Schedule model that provides greater flexibility for formulating recurring events. Instead of formulating events based on intervals using DateComponents, we use the new RecurrenceRule infrastructure introduced with iOS 18.

Using a Schedule, you can generate a potentially infinite list of Occurrences. A Task uses the occurrences of its Schedule to generate Events. When events are marked as completed, they are associated with an Outcome. Both a Task and an Outcome can be extended with arbitrary data. This is enabled using the @Property macro, that allows to define custom properties on tasks and outcomes using a SharedRepository-backed storage implementation.

Task are stored in an versioned, append-only store. Modifying the contents of a Task (e.g., instructions, schedules, ...), appends a new Task version and marks it as effective for the specified date. This allows to modify tasks without changing previous events or occurrences. Something that was impossible with the previous implementation.

Lastly, the updated Scheduler provides additional support for UI components out of the box. We provide the new @EventQuery property wrapper that you can use in your SwiftUI views. It allows to easily and efficiently query Events directly in SwiftUI.
Additionally, we provide several, reusable UI components out of the box to visualize events in your application.

Notifications are currently no longer supported with this version of SpeziScheduler: #45 (This is now tackled in #49 which will most likely be merged alongside this PR).

An example of how to configure tasks with this new model is depicted below:

import Spezi
import SpeziScheduler

class MySchedulerModule: Module {
    @Dependency(Scheduler.self)
    private var scheduler

    init() {}

    func configure() {
        do {
            try scheduler.createOrUpdateTask(
                id: "my-daily-task",
                title: "Daily Questionnaire",
                instructions: "Please fill out the Questionnaire every day.",
                category: Task.Category("Questionnaire", systemName: "list.clipboard.fill"),
                schedule: .daily(hour: 9, minute: 0, startingAt: .today)
            )
        } catch {
            // handle error (e.g., visualize in your UI)
        }
    }
}

⚙️ Release Notes

New version Scheduler Store using SwiftData.
New Task module using Events and Outcomes.
New Schedule model based on RecurrenceRule allowing for greater flexibility when specifying schedules.
Introduces new UI components to easily visualize events.
New @EventQuery property wrapper to easily query events in your SwiftUI view.

Breaking Changes

This version of SpeziScheduler is not compatible with the previous version. All previously persisted data will be permanently deleted when using this new version. Already scheduled Notifications may currently not be removed and may be continue to be delivered.

📚 Documentation

The documentation catalog was completely restructured, highlighting all the new API and functionality.

✅ Testing

New unit and UI tests have been written to verify functionality. We aimed to set a focus on unit tests for fastest possible test execution.

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

I agree to follow the Code of Conduct and Contributing Guidelines.

…s for simplifications

codecov · 2024-09-09T09:04:11Z

Codecov Report

Attention: Patch coverage is 63.65435% with 551 lines in your changes missing coverage. Please review.

Project coverage is 63.94%. Comparing base (896eb44) to head (b08e806).

Files with missing lines	Patch %	Lines
...s/SpeziSchedulerMacros/UserStorageEntryMacro.swift	0.00%	122 Missing ⚠️
Sources/SpeziSchedulerUI/TodayList.swift	0.00%	65 Missing ⚠️
Sources/SpeziScheduler/Task/Task.swift	68.33%	51 Missing ⚠️
Sources/SpeziScheduler/Schedule/Schedule.swift	71.01%	49 Missing ⚠️
Sources/SpeziScheduler/Scheduler.swift	81.30%	49 Missing ⚠️
...es/SpeziScheduler/Schedule/Schedule+Duration.swift	52.31%	31 Missing ⚠️
Sources/SpeziScheduler/Task/Outcome.swift	20.52%	31 Missing ⚠️
.../SpeziScheduler/Task/AllowedCompletionPolicy.swift	46.67%	24 Missing ⚠️
...rces/SpeziScheduler/UserInfo/UserInfoStorage.swift	64.41%	21 Missing ⚠️
...peziSchedulerMacros/SpeziSchedulerDiagnostic.swift	0.00%	18 Missing ⚠️
... and 11 more

Additional details and impacted files

@@            Coverage Diff            @@
##           main      #44       +/-   ##
=========================================
+ Coverage      0   63.94%   +63.94%     
=========================================
  Files         0       24       +24     
  Lines         0     1550     +1550     
=========================================
+ Hits          0      991      +991     
- Misses        0      559      +559

Files with missing lines	Coverage Δ
...iScheduler/Task/Task+LocalizedStringResource.swift	`100.00% <100.00%> (ø)`
...SchedulerUI/Category/TaskCategoryAppearances.swift	`100.00% <100.00%> (ø)`
...rUI/Category/TaskCategoryAppearancesModifier.swift	`100.00% <100.00%> (ø)`
...es/SpeziSchedulerMacros/SpeziSchedulerMacros.swift	`0.00% <0.00%> (ø)`
...rces/SpeziScheduler/Schedule/Date+Extensions.swift	`86.67% <86.67%> (ø)`
Sources/SpeziScheduler/UserInfo/UserInfoKey.swift	`0.00% <0.00%> (ø)`
Sources/SpeziScheduler/EventQuery.swift	`95.24% <95.24%> (ø)`
Sources/SpeziScheduler/Schedule/Occurence.swift	`61.91% <61.91%> (ø)`
Sources/SpeziSchedulerUI/DefaultTileHeader.swift	`89.34% <89.34%> (ø)`
Sources/SpeziSchedulerUI/InstructionsTile.swift	`90.43% <90.43%> (ø)`
... and 14 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 896eb44...b08e806. Read the comment docs.

…nd future proof

PSchmiedmayer

Thank you for all the work in this PR; amazing job!!

It would be amazing to update the README accordingly and address the smaller comments I had in the PR review. A huge step toward improving on the Scheduler module; amazing job!

PSchmiedmayer · 2024-09-25T22:36:01Z

.github/workflows/build-and-test.yml

@@ -16,39 +16,56 @@ on:
  workflow_dispatch:

 jobs:
+  determine_macos_version: # Currently some runners still run on macOS 14


All our runners should be update to macOS 15, we should be able to remove this now.

PSchmiedmayer · 2024-09-25T22:36:43Z

Package.swift

-        .package(url: "https://github.com/StanfordSpezi/SpeziStorage", from: "1.1.2")
+        .package(url: "https://github.com/StanfordSpezi/SpeziViews", branch: "feature/additional-infrastructure"),
+        .package(url: "https://github.com/StanfordSpezi/SpeziStorage", from: "1.1.2"),
+        .package(url: "https://github.com/swiftlang/swift-syntax", from: "600.0.0-prerelease-2024-08-14"),


We could probably update this to https://github.com/swiftlang/swift-syntax/releases/tag/600.0.1

PSchmiedmayer · 2024-09-25T22:36:59Z

Package.swift

        .package(url: "https://github.com/StanfordSpezi/Spezi", from: "1.7.0"),
-        .package(url: "https://github.com/StanfordSpezi/SpeziStorage", from: "1.1.2")
+        .package(url: "https://github.com/StanfordSpezi/SpeziViews", branch: "feature/additional-infrastructure"),


TODO to use a release before we merge the PR.

PSchmiedmayer · 2024-09-25T22:42:35Z

Sources/SpeziScheduler/EventQuery.swift

+private let logger = Logger(subsystem: "edu.stanford.spezi.scheduler", category: "EventQuery")
+
+
+func measure<T, C: Clock>(


Nice mechanism! We might want to make this private or fileprivate if we only use it here?

PSchmiedmayer · 2024-09-25T22:45:16Z

Sources/SpeziScheduler/Schedule/Occurence.swift

+}
+
+
+extension Occurrence: CustomStringConvertible {


Wonder if would be helpful to also add https://developer.apple.com/documentation/swift/debugdescription() here to make the types easier to debug as well?

PSchmiedmayer · 2024-10-21T20:14:25Z

Sources/SpeziScheduler/UserInfo/UserStorageEntry.swift

Very cool mechanism; great job!

PSchmiedmayer · 2024-10-21T20:20:50Z

Sources/SpeziSchedulerUI/InstructionsTile.swift

+/// ### Providing hints and tips
+///
+/// Sometimes it might be necessary to provide more detailed information or explanation about a event. You can supply a "More Information" view to the tile.
+/// In this case a small "(i)" button will be displayed that presents the view as a sheet.


Very cool mechanism!

PSchmiedmayer · 2024-10-21T20:25:23Z

Sources/SpeziSchedulerUI/TodayList.swift

+/// }
+///     .navigationTitle("Schedule")
+/// ```
+public struct TodayList<Tile: View>: View {


Very cool reusable mechanism; we might want to extend this to display any arbitrary date in the future that can be driven by a nice UI adding a date selector 👍

PSchmiedmayer · 2024-10-21T20:29:30Z

Tests/SpeziSchedulerMacrosTest/UserStorageEntryMacroTests.swift

+]
+
+
+final class UserStorageEntryMacroTests: XCTestCase { // swiftlint:disable:this type_body_length


Very cool to see these tests validating the behavior!

PSchmiedmayer · 2024-10-21T20:30:55Z

Tests/SpeziSchedulerUITests/__Snapshots__/SpeziSchedulerUITests/testInstructionsTile.action.png

Wondering if we can include some of the UI images in the documentation to have some visual examples using the images.

Supereg added 19 commits August 23, 2024 10:52

Initial draft state

0db1f38

Use Foundation RecurrenceRule for Schedule. Remove schedule component…

c9efcc7

…s for simplifications

Public init

8c444c7

Ensure it compiles

010dfd7

Iterate on Model and add support to query events

a3f0f3d

Make environment accessible

2b7c443

Some progress

1ca335c

Iterate

102dd7d

A working version

7848353

Some docs and cleanup

5c0dc60

Keep it working for now

6d65471

Fix some previews

8394cd5

Refining a lot of things

5961889

Initial preview release

9d52d0a

Bug fixes and adjustments and initial unit tests

136fe89

Run on latest Xcode

61a9a5a

redo

79e9398

Concurrency for Xcode beta 5

e6cf165

Do not require the macOS job right now

952bf47

Supereg added 4 commits September 9, 2024 14:41

Finalize UI components

1f95c28

Add macros 🚀

92f0cc3

Remove previous scheduler and provide most of the documentation

ea7e1e9

Add UI tests

0ef47b8

Supereg changed the title ~~Infinity Loop~~ New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule Sep 10, 2024

This was linked to issues Sep 10, 2024

Use Swift Data to Store Tasks and Events #20

Open

Schedule Tasks at a Predefined Time in the Future #18

Open

Spezi Scheduler UI #17

Open

Supereg mentioned this pull request Sep 10, 2024

Time Zone Configuration #22

Open

1 task

Supereg marked this pull request as ready for review September 10, 2024 18:00

This was referenced Sep 10, 2024

Bring back Notifications support with new Scheduler #45

Open

Introduce Checklist style UI #46

Open

Support marking a task as ended/deleted #47

Open

Supereg added 16 commits September 10, 2024 20:38

Additional changes

dcea771

Add unit tests for macro

117e466

REUSE

49e2f2c

SchedulerUI target and redo category infrastructure to be more easy a…

77ae023

…nd future proof

Add snapshot testing for ui components

7cc6590

Fix REUSE

9e0618a

Update scheme

a81aaf0

Declare SpeziSchedulerUI as a dependency for UI tests

c608f87

Only run macOS unit tests if major version is 15

5af6d19

Use new environment file based output

dac8d08

Fix missing imports

39df9f4

Moved Tile infrastructure to SpeziViews

aa31601

Create TodayList

478c777

Docs

b57e276

SwiftData is insanity

e1e2986

Fix description

55ed104

Supereg requested a review from PSchmiedmayer September 12, 2024 13:53

Supereg added 5 commits September 13, 2024 10:22

Final restructuring and documentation

a3c6ba6

Do not purge previous storage for now

c609cf2

Move some tests do a different target

4a92a88

Fix imports

68895a9

Fix import

b08e806

Supereg mentioned this pull request Sep 20, 2024

Support for scheduling notifications #49

Open

1 task

PSchmiedmayer approved these changes Oct 21, 2024

View reviewed changes

PSchmiedmayer assigned Supereg Oct 21, 2024

PSchmiedmayer added the enhancement New feature or request label Oct 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule #44

New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule #44

Supereg commented Aug 23, 2024 •

edited

Loading

codecov bot commented Sep 9, 2024 •

edited

Loading

PSchmiedmayer left a comment

PSchmiedmayer Sep 25, 2024

PSchmiedmayer Sep 25, 2024

PSchmiedmayer Sep 25, 2024

PSchmiedmayer Sep 25, 2024

PSchmiedmayer Sep 25, 2024

PSchmiedmayer Oct 21, 2024

PSchmiedmayer Oct 21, 2024

PSchmiedmayer Oct 21, 2024

PSchmiedmayer Oct 21, 2024

PSchmiedmayer Oct 21, 2024

		private let logger = Logger(subsystem: "edu.stanford.spezi.scheduler", category: "EventQuery")


		func measure<T, C: Clock>(

		]


		final class UserStorageEntryMacroTests: XCTestCase { // swiftlint:disable:this type_body_length

New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule #44

Are you sure you want to change the base?

New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule #44

Conversation

Supereg commented Aug 23, 2024 • edited Loading

New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule

♻️ Current situation & Problem

⚙️ Release Notes

Breaking Changes

📚 Documentation

✅ Testing

📝 Code of Conduct & Contributing Guidelines

codecov bot commented Sep 9, 2024 • edited Loading

Codecov Report

PSchmiedmayer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Supereg commented Aug 23, 2024 •

edited

Loading

codecov bot commented Sep 9, 2024 •

edited

Loading