forked from matrix-org/matrix-rust-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ui): Implement
Notification API (matrix-org#2023)
This is the first PR for splitting the sync loop into two. This offers a new high-level API, `NotificationApi`, that makes use of a separate `SlidingSync` instance which sole role is to listen to to-device events and e2ee; it's pre-configured to do so. That means we're not force-enabling e2ee and to-device by default for every sliding sync instance, and as such we won't either generate Olm requests to the home server in general. In the future, this new high-level API will hide some low-level dirty details so that its can be instantiated in multiple processes at the same time (lock across process, invalidate and refill crypto caches, etc.). An embedder who would want to make use of this would need the following: - a main sliding sync instance, without e2ee and to-device. Using the `matrix_sdk_ui::RoomList` would be the best bet, at this time. - an instance of this `matrix_sdk_ui::NotificationApi`, with a different identifier. Note that this is not ready to be used in an external process; or it will cause the same kind of issues that we're seeing as of today: invalid crypto caches resulting in UTD, etc. Fixes matrix-org#1961.
- Loading branch information
Showing
14 changed files
with
528 additions
and
122 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| // Copyright 2023 The Matrix.org Foundation C.I.C. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for that specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| //! Notification API. | ||
| //! | ||
| //! The notification API is a high-level helper that is designed to take care of | ||
| //! handling the synchronization of notifications, be they received within the | ||
| //! app or within a dedicated notification process (e.g. the [NSE] process on | ||
| //! iOS devices). | ||
| //! | ||
| //! Under the hood, this uses a sliding sync instance configured with no lists, | ||
| //! but that enables the e2ee and to-device extensions, so that it can both | ||
| //! handle encryption and manage encryption keys; that's sufficient to decrypt | ||
| //! messages received in the notification processes. | ||
| //! | ||
| //! As this may be used across different processes, this also makes sure that | ||
| //! there's only one process writing to the databases holding encryption | ||
| //! information. TODO as of 2023-06-06, this hasn't been done yet. | ||
| //! | ||
| //! [NSE]: https://developer.apple.com/documentation/usernotifications/unnotificationserviceextension | ||
| use async_stream::stream; | ||
| use futures_core::stream::Stream; | ||
| use futures_util::{pin_mut, StreamExt}; | ||
| use matrix_sdk::{Client, SlidingSync}; | ||
| use ruma::{api::client::sync::sync_events::v4, assign}; | ||
| use tracing::error; | ||
|
|
||
| /// High-level helper for synchronizing notifications using sliding sync. | ||
| /// | ||
| /// See the module's documentation for more details. | ||
| #[derive(Clone)] | ||
| pub struct NotificationSync { | ||
| sliding_sync: SlidingSync, | ||
| } | ||
|
|
||
| impl NotificationSync { | ||
| /// Creates a new instance of a `NotificationSync`. | ||
| /// | ||
| /// This will create and manage an instance of [`matrix_sdk::SlidingSync`]. | ||
| /// The `id` is used as the identifier of that instance, as such make | ||
| /// sure to not reuse a name used by another Sliding Sync instance, at | ||
| /// the risk of causing problems. | ||
| pub async fn new(id: impl Into<String>, client: Client) -> Result<Self, Error> { | ||
| let sliding_sync = client | ||
| .sliding_sync(id)? | ||
| .enable_caching()? | ||
| .with_to_device_extension( | ||
| assign!(v4::ToDeviceConfig::default(), { enabled: Some(true)}), | ||
| ) | ||
| .with_e2ee_extension(assign!(v4::E2EEConfig::default(), { enabled: Some(true)})) | ||
| .build() | ||
| .await?; | ||
|
|
||
| Ok(Self { sliding_sync }) | ||
| } | ||
|
|
||
| /// Start synchronization of notifications. | ||
| /// | ||
| /// This should be regularly polled, so as to ensure that the notifications | ||
| /// are sync'd. | ||
| pub fn sync(&self) -> impl Stream<Item = Result<(), Error>> + '_ { | ||
| stream!({ | ||
| let sync = self.sliding_sync.sync(); | ||
|
|
||
| pin_mut!(sync); | ||
|
|
||
| loop { | ||
| match sync.next().await { | ||
| Some(Ok(update_summary)) => { | ||
| // This API is only concerned with the e2ee and to-device extensions. | ||
| // Warn if anything weird has been received from the proxy. | ||
| if !update_summary.lists.is_empty() || !update_summary.rooms.is_empty() { | ||
| yield Err(Error::UnexpectedNonEmptyListsOrRooms); | ||
| } else { | ||
| // Cool cool, let's do it again. | ||
| yield Ok(()); | ||
| } | ||
|
|
||
| continue; | ||
| } | ||
|
|
||
| Some(Err(err)) => { | ||
| yield Err(err.into()); | ||
|
|
||
| break; | ||
| } | ||
|
|
||
| None => { | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| /// Errors for the [`NotificationSync`]. | ||
| #[derive(Debug, thiserror::Error)] | ||
| pub enum Error { | ||
| #[error("Unexpected rooms or lists in the sliding sync response.")] | ||
| UnexpectedNonEmptyListsOrRooms, | ||
|
|
||
| #[error("Something wrong happened in sliding sync: {0:#}")] | ||
| SlidingSyncError(#[from] matrix_sdk::Error), | ||
| } |
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
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
Oops, something went wrong.