Support for scheduling notifications #49
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
PSchmiedmayer
approved these changes
Oct 21, 2024
Sources/SpeziScheduler/Notifications/SchedulerNotifications.swift
Outdated
Show resolved
Hide resolved
Supereg
added a commit
that referenced
this pull request
Oct 29, 2024
…ecurrence Rule (#44) # 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`](https://developer.apple.com/documentation/foundation/datecomponents), we use the new [`RecurrenceRule`](https://developer.apple.com/documentation/foundation/calendar/recurrencerule) infrastructure introduced with iOS 18. Using a `Schedule`, you can generate a potentially infinite list of `Occurrence`s. 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`](https://swiftpackageindex.com/stanfordspezi/spezifoundation/2.0.0-beta.2/documentation/spezifoundation/shared-repository)-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: ```swift 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](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
Supereg
force-pushed
the
feature/il-notifications-support
branch
2 times, most recently
from
d3a98cc
to
a4ef210
Compare
…ns of legacy scheduler, use background tasks for updating scheduled notifications
Supereg
force-pushed
the
feature/il-notifications-support
branch
from
a4ef210
to
9fa8433
Compare
This was
linked to
issues
Oct 29, 2024
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Support for scheduling notifications
♻️ Current situation & Problem
The newly introduced SpeziScheduler #44 didn't include support for notifications (see #45). This PR adds back this feature, providing several improvements over the previous implementation.
A core challenge is that Apple limits the amount of locally scheduled notifications to 64 request at a time. Therefore, we optimize scheduling by applying the overall rules:
30notification at a time and never earlier than 1 month in advance to ensure other modules are still able to schedule local notifications. These settings can be adjusted by manually configuring theSchedulerNotificationsin yourSpeziAppDelegate⚙️ Release Notes
dailyandweeklyshorthand initializes of aSchedule) and prioritizes event notifications by their occurrence date.allDay.SchedulerNotificationsConstraint.notificationPresentationoption).automaticallyRequestProvisionalAuthorizationoption).📚 Documentation
Added a dedicated configuration section around notifications in the documentation catalog. The documentation of the
SchedulerNotificationsmodule highlights the necessary steps to set up notifications for your project.✅ Testing
Added the
XCTSpeziSchedulertarget that provide UI components to visualize scheduled notification requests. We use this in the UI tests to verify that notifications are scheduled as expected. The Test App schedules a repeating daily notification that has its first occurrence 40s after app launch. Additionally we schedule a daily repeating task that starts 1 week after initial app launch to test event-level scheduling.📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: