Add notification status to firebase #36
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
Handlers for receiving a notification in the background or foreground, call methods in the PrismaStandard for setting the time received in Firestore.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #36 +/- ##
==========================================
- Coverage 37.38% 36.19% -1.18%
==========================================
Files 42 43 +1
Lines 1576 1622 +46
==========================================
- Hits 589 587 -2
- Misses 987 1035 +48
... and 1 file with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
carolinentran
approved these changes
Mar 7, 2024
bryant-jimenez
added a commit
that referenced
this pull request
Mar 12, 2024
# *Handling Background Notifications* ## ♻️ Current situation & Problem - #31 - #36 Currently, Prisma is only configured to handle notifications in the foreground. Handling notifications requires writing timestamps to Firestore when notifications are received and opened on the user's device, but this was not possible with the current configuration of background notification handling due to Apple throttling the amount of requests per hour [(see this link)](https://developer.apple.com/documentation/usernotifications/pushing-background-updates-to-your-app). ## ⚙️ Release Notes As a workaround, we utilize the UNNotificationServiceExtension class to provide an entry-point for pushing updates to Firestore on the arrival of background notifications. Normally we would use this extension to modify the notification’s content or download content related to the extension, but we are taking advantage of the fact that we are allowed a 30 second period to do so, in order to write to Firestore. Doing so required [creating a shared keychain for cross-app authentication](https://firebase.google.com/docs/auth/ios/single-sign-on), allowing access of the auth state for Firebase between the application and the extension, utilized for authorizing writes to Firestore using the same instance of Firebase as the application upon notification arrival. The following additions/changes were made to the Prisma application: - Added the Notification Service Extension `PrismaPushNotificationsExtension/NotificationsService.swift` - `didReceive` implements functionality for writing to Firestore, using the logs collection path passed in the notification payload. Because the main application and app extension run independently of each other, we needed to introduce an authorization mechanism that is checked in the function before actually doing any writes. - We also added a keychain access group, allowing for keychain sharing between the main app and the extension. We subsequently implemented the authorization function `authorizeAccessGroupForCurrentUser()` which checks for the shared access group instance for a user, documented in `PrismaStandard.swift`. - This function is called within both the Home view and the AccountOnboarding flow, ensuring that a user will always need to be authorized and logged in in order to receive background notification updates and have those writable to Firestore. ## 📚 Documentation *Please ensure that you properly document any additions in conformance to [Spezi Documentation Guide](https://github.com/StanfordSpezi/.github/blob/main/DOCUMENTATIONGUIDE.md).* *You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.* ## ✅ Testing *Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.* *This section describes important information about the tests and why some elements might not be testable.* ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md): - [ x] I agree to follow the [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md).
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.
Timestamp Notification Status to Firebase, Update Notification Handling
♻️ Current situation & Problem
With the release of Spezi 1.2, new support for Notifications was added, breaking the current implementation of push notifications. Additionally, we required support for notification handling on the client side, for background, foreground, and user-actions regarding notifications. To log data about notification status, such as "received" and "opened", these handlers were necessary, alongside updates to the standard for the delivery of timestamps to firestore and dealing with notifications for the path. "Sent" status is logged to firestore on the server side.
⚙️ Release Notes
Updates
getPath()inPrismaStandardfor anything related to the notifications collection in firestore, as well as the type of data "logs" or schedule"addNotificationOpened()andaddNotificationReceived()to Firestore.toISOFormat()method extension of theDate()classNext Steps
📚 Documentation
Please ensure that you properly document any additions in conformance to Spezi Documentation Guide.
You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.
✅ Testing
Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.
This section describes important information about the tests and why some elements might not be testable.
📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: