Skip to main content

matrix_sdk_indexeddb/state_store/
mod.rs

1// Copyright 2021 The Matrix.org Foundation C.I.C.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::{
16    cmp::Reverse,
17    collections::{BTreeMap, BTreeSet, HashMap, HashSet},
18    str::FromStr as _,
19    sync::Arc,
20};
21
22use async_trait::async_trait;
23use gloo_utils::format::JsValueSerdeExt;
24use growable_bloom_filter::GrowableBloom;
25use indexed_db_futures::{
26    KeyRange, cursor::CursorDirection, database::Database, error::OpenDbError, prelude::*,
27    transaction::TransactionMode,
28};
29use matrix_sdk_base::{
30    MinimalRoomMemberEvent, ROOM_VERSION_FALLBACK, ROOM_VERSION_RULES_FALLBACK, RoomInfo,
31    RoomMemberships, StateStoreDataKey, StateStoreDataValue, ThreadSubscriptionCatchupToken,
32    deserialized_responses::{DisplayName, RawAnySyncOrStrippedState},
33    store::{
34        ChildTransactionId, ComposerDraft, DependentQueuedRequest, DependentQueuedRequestKind,
35        QueuedRequest, QueuedRequestKind, RoomLoadSettings, SentRequestKey,
36        SerializableEventContent, StateChanges, StateStore, StoreError, StoredThreadSubscription,
37        SupportedVersionsResponse, ThreadSubscriptionStatus, WellKnownResponse,
38        compare_thread_subscription_bump_stamps,
39    },
40    ttl::TtlValue,
41};
42use matrix_sdk_store_encryption::{Error as EncryptionError, StoreCipher};
43use ruma::{
44    CanonicalJsonObject, EventId, MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedMxcUri,
45    OwnedRoomId, OwnedTransactionId, OwnedUserId, RoomId, TransactionId, UserId,
46    api::client::discovery::get_capabilities::v3::Capabilities,
47    canonical_json::{RedactedBecause, redact},
48    events::{
49        AnyGlobalAccountDataEvent, AnyRoomAccountDataEvent, AnySyncStateEvent,
50        GlobalAccountDataEventType, RoomAccountDataEventType, StateEventType, SyncStateEvent,
51        presence::PresenceEvent,
52        receipt::{Receipt, ReceiptThread, ReceiptType},
53        room::member::{
54            MembershipState, RoomMemberEventContent, StrippedRoomMemberEvent, SyncRoomMemberEvent,
55        },
56    },
57    profile::UserProfile,
58    serde::Raw,
59};
60use serde::{Deserialize, Serialize, de::DeserializeOwned, ser::Error};
61use tracing::{debug, warn};
62use wasm_bindgen::JsValue;
63
64mod migrations;
65
66pub use self::migrations::MigrationConflictStrategy;
67use self::migrations::{upgrade_inner_db, upgrade_meta_db};
68use crate::{error::GenericError, serializer::safe_encode::traits::SafeEncode};
69
70#[derive(Debug, thiserror::Error)]
71pub enum IndexeddbStateStoreError {
72    #[error(transparent)]
73    Json(#[from] serde_json::Error),
74    #[error(transparent)]
75    Encryption(#[from] EncryptionError),
76    #[error("DomException {name} ({code}): {message}")]
77    DomException { name: String, message: String, code: u16 },
78    #[error(transparent)]
79    StoreError(#[from] StoreError),
80    #[error(
81        "Can't migrate {name} from {old_version} to {new_version} without deleting data. \
82         See MigrationConflictStrategy for ways to configure."
83    )]
84    MigrationConflict { name: String, old_version: u32, new_version: u32 },
85}
86
87impl From<GenericError> for IndexeddbStateStoreError {
88    fn from(value: GenericError) -> Self {
89        Self::StoreError(value.into())
90    }
91}
92
93impl From<web_sys::DomException> for IndexeddbStateStoreError {
94    fn from(frm: web_sys::DomException) -> IndexeddbStateStoreError {
95        IndexeddbStateStoreError::DomException {
96            name: frm.name(),
97            message: frm.message(),
98            code: frm.code(),
99        }
100    }
101}
102
103impl From<IndexeddbStateStoreError> for StoreError {
104    fn from(e: IndexeddbStateStoreError) -> Self {
105        match e {
106            IndexeddbStateStoreError::Json(e) => StoreError::Json(e),
107            IndexeddbStateStoreError::StoreError(e) => e,
108            IndexeddbStateStoreError::Encryption(e) => StoreError::Encryption(e),
109            _ => StoreError::backend(e),
110        }
111    }
112}
113
114impl From<indexed_db_futures::error::DomException> for IndexeddbStateStoreError {
115    fn from(value: indexed_db_futures::error::DomException) -> Self {
116        web_sys::DomException::from(value).into()
117    }
118}
119
120impl From<indexed_db_futures::error::SerialisationError> for IndexeddbStateStoreError {
121    fn from(value: indexed_db_futures::error::SerialisationError) -> Self {
122        Self::Json(serde_json::Error::custom(value.to_string()))
123    }
124}
125
126impl From<indexed_db_futures::error::UnexpectedDataError> for IndexeddbStateStoreError {
127    fn from(value: indexed_db_futures::error::UnexpectedDataError) -> Self {
128        IndexeddbStateStoreError::StoreError(StoreError::backend(value))
129    }
130}
131
132impl From<indexed_db_futures::error::JSError> for IndexeddbStateStoreError {
133    fn from(value: indexed_db_futures::error::JSError) -> Self {
134        GenericError::from(value.to_string()).into()
135    }
136}
137
138impl From<indexed_db_futures::error::Error> for IndexeddbStateStoreError {
139    fn from(value: indexed_db_futures::error::Error) -> Self {
140        use indexed_db_futures::error::Error;
141        match value {
142            Error::DomException(e) => e.into(),
143            Error::Serialisation(e) => e.into(),
144            Error::MissingData(e) => e.into(),
145            Error::Unknown(e) => e.into(),
146        }
147    }
148}
149
150impl From<OpenDbError> for IndexeddbStateStoreError {
151    fn from(value: OpenDbError) -> Self {
152        match value {
153            OpenDbError::Base(error) => error.into(),
154            _ => GenericError::from(value.to_string()).into(),
155        }
156    }
157}
158
159mod keys {
160    pub const INTERNAL_STATE: &str = "matrix-sdk-state";
161    pub const BACKUPS_META: &str = "backups";
162
163    pub const ACCOUNT_DATA: &str = "account_data";
164
165    /// Room profiles.
166    pub const PROFILES: &str = "profiles";
167    pub const DISPLAY_NAMES: &str = "display_names";
168    pub const USER_IDS: &str = "user_ids";
169
170    pub const ROOM_STATE: &str = "room_state";
171    pub const ROOM_INFOS: &str = "room_infos";
172    pub const PRESENCE: &str = "presence";
173    pub const ROOM_ACCOUNT_DATA: &str = "room_account_data";
174    /// Table used to save send queue events.
175    pub const ROOM_SEND_QUEUE: &str = "room_send_queue";
176    /// Table used to save dependent send queue events.
177    pub const DEPENDENT_SEND_QUEUE: &str = "room_dependent_send_queue";
178    pub const THREAD_SUBSCRIPTIONS: &str = "room_thread_subscriptions";
179
180    pub const STRIPPED_ROOM_STATE: &str = "stripped_room_state";
181    pub const STRIPPED_USER_IDS: &str = "stripped_user_ids";
182
183    pub const ROOM_USER_RECEIPTS: &str = "room_user_receipts";
184    pub const ROOM_EVENT_RECEIPTS: &str = "room_event_receipts";
185
186    pub const GLOBAL_PROFILES: &str = "global_profiles";
187
188    pub const CUSTOM: &str = "custom";
189    pub const KV: &str = "kv";
190
191    /// All names of the current state stores for convenience.
192    pub const ALL_STORES: &[&str] = &[
193        ACCOUNT_DATA,
194        PROFILES,
195        DISPLAY_NAMES,
196        USER_IDS,
197        ROOM_STATE,
198        ROOM_INFOS,
199        PRESENCE,
200        ROOM_ACCOUNT_DATA,
201        STRIPPED_ROOM_STATE,
202        STRIPPED_USER_IDS,
203        ROOM_USER_RECEIPTS,
204        ROOM_EVENT_RECEIPTS,
205        ROOM_SEND_QUEUE,
206        THREAD_SUBSCRIPTIONS,
207        DEPENDENT_SEND_QUEUE,
208        GLOBAL_PROFILES,
209        CUSTOM,
210        KV,
211    ];
212
213    // static keys
214
215    pub const STORE_KEY: &str = "store_key";
216}
217
218pub use keys::ALL_STORES;
219use matrix_sdk_base::store::QueueWedgeError;
220
221/// Encrypt (if needs be) then JSON-serialize a value.
222fn serialize_value(store_cipher: Option<&StoreCipher>, event: &impl Serialize) -> Result<JsValue> {
223    Ok(match store_cipher {
224        Some(cipher) => {
225            let data = serde_json::to_vec(event)?;
226            JsValue::from_serde(&cipher.encrypt_value_data(data)?)?
227        }
228        None => JsValue::from_serde(event)?,
229    })
230}
231
232/// Deserialize a JSON value and then decrypt it (if needs be).
233fn deserialize_value<T: DeserializeOwned>(
234    store_cipher: Option<&StoreCipher>,
235    event: &JsValue,
236) -> Result<T> {
237    match store_cipher {
238        Some(cipher) => {
239            use zeroize::Zeroize;
240            let mut plaintext = cipher.decrypt_value_data(event.into_serde()?)?;
241            let ret = serde_json::from_slice(&plaintext);
242            plaintext.zeroize();
243            Ok(ret?)
244        }
245        None => Ok(event.into_serde()?),
246    }
247}
248
249fn encode_key<T>(store_cipher: Option<&StoreCipher>, table_name: &str, key: T) -> JsValue
250where
251    T: SafeEncode,
252{
253    match store_cipher {
254        Some(cipher) => key.as_secure_string(table_name, cipher),
255        None => key.as_encoded_string(),
256    }
257    .into()
258}
259
260fn encode_to_range<T>(
261    store_cipher: Option<&StoreCipher>,
262    table_name: &str,
263    key: T,
264) -> KeyRange<JsValue>
265where
266    T: SafeEncode,
267{
268    match store_cipher {
269        Some(cipher) => key.encode_to_range_secure(table_name, cipher),
270        None => key.encode_to_range(),
271    }
272}
273
274/// Builder for [`IndexeddbStateStore`].
275#[derive(Debug)]
276pub struct IndexeddbStateStoreBuilder {
277    name: Option<String>,
278    passphrase: Option<String>,
279    migration_conflict_strategy: MigrationConflictStrategy,
280}
281
282impl IndexeddbStateStoreBuilder {
283    fn new() -> Self {
284        Self {
285            name: None,
286            passphrase: None,
287            migration_conflict_strategy: MigrationConflictStrategy::BackupAndDrop,
288        }
289    }
290
291    /// Set the name for the indexeddb store to use, `state` is none given.
292    pub fn name(mut self, value: String) -> Self {
293        self.name = Some(value);
294        self
295    }
296
297    /// Set the password the indexeddb should be encrypted with.
298    ///
299    /// If not given, the DB is not encrypted.
300    pub fn passphrase(mut self, value: String) -> Self {
301        self.passphrase = Some(value);
302        self
303    }
304
305    /// The strategy to use when a merge conflict is found.
306    ///
307    /// See [`MigrationConflictStrategy`] for details.
308    pub fn migration_conflict_strategy(mut self, value: MigrationConflictStrategy) -> Self {
309        self.migration_conflict_strategy = value;
310        self
311    }
312
313    pub async fn build(self) -> Result<IndexeddbStateStore> {
314        let migration_strategy = self.migration_conflict_strategy.clone();
315        let name = self.name.unwrap_or_else(|| "state".to_owned());
316
317        let meta_name = format!("{name}::{}", keys::INTERNAL_STATE);
318
319        let (meta, store_cipher) = upgrade_meta_db(&meta_name, self.passphrase.as_deref()).await?;
320        let inner =
321            upgrade_inner_db(&name, store_cipher.as_deref(), migration_strategy, &meta).await?;
322
323        Ok(IndexeddbStateStore { name, inner, meta, store_cipher })
324    }
325}
326
327pub struct IndexeddbStateStore {
328    name: String,
329    pub(crate) inner: Database,
330    pub(crate) meta: Database,
331    pub(crate) store_cipher: Option<Arc<StoreCipher>>,
332}
333
334#[cfg(not(tarpaulin_include))]
335impl std::fmt::Debug for IndexeddbStateStore {
336    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
337        f.debug_struct("IndexeddbStateStore").field("name", &self.name).finish()
338    }
339}
340
341type Result<A, E = IndexeddbStateStoreError> = std::result::Result<A, E>;
342
343impl IndexeddbStateStore {
344    /// Generate a IndexeddbStateStoreBuilder with default parameters
345    pub fn builder() -> IndexeddbStateStoreBuilder {
346        IndexeddbStateStoreBuilder::new()
347    }
348
349    /// The version of the database containing the data.
350    pub fn version(&self) -> u32 {
351        self.inner.version() as u32
352    }
353
354    /// The version of the database containing the metadata.
355    pub fn meta_version(&self) -> u32 {
356        self.meta.version() as u32
357    }
358
359    /// Whether this database has any migration backups
360    pub async fn has_backups(&self) -> Result<bool> {
361        Ok(self
362            .meta
363            .transaction(keys::BACKUPS_META)
364            .with_mode(TransactionMode::Readonly)
365            .build()?
366            .object_store(keys::BACKUPS_META)?
367            .count()
368            .await?
369            > 0)
370    }
371
372    /// What's the database name of the latest backup<
373    pub async fn latest_backup(&self) -> Result<Option<String>> {
374        if let Some(mut cursor) = self
375            .meta
376            .transaction(keys::BACKUPS_META)
377            .with_mode(TransactionMode::Readonly)
378            .build()?
379            .object_store(keys::BACKUPS_META)?
380            .open_cursor()
381            .with_direction(CursorDirection::Prev)
382            .await?
383            && let Some(record) = cursor.next_record::<JsValue>().await?
384        {
385            Ok(record.as_string())
386        } else {
387            Ok(None)
388        }
389    }
390
391    /// Encrypt (if needs be) then JSON-serialize a value.
392    fn serialize_value(&self, event: &impl Serialize) -> Result<JsValue> {
393        serialize_value(self.store_cipher.as_deref(), event)
394    }
395
396    /// Deserialize a JSON value and then decrypt it (if needs be).
397    fn deserialize_value<T: DeserializeOwned>(&self, event: &JsValue) -> Result<T> {
398        deserialize_value(self.store_cipher.as_deref(), event)
399    }
400
401    fn encode_key<T>(&self, table_name: &str, key: T) -> JsValue
402    where
403        T: SafeEncode,
404    {
405        encode_key(self.store_cipher.as_deref(), table_name, key)
406    }
407
408    fn encode_to_range<T>(&self, table_name: &str, key: T) -> KeyRange<JsValue>
409    where
410        T: SafeEncode,
411    {
412        encode_to_range(self.store_cipher.as_deref(), table_name, key)
413    }
414
415    /// Get user IDs for the given room with the given memberships and stripped
416    /// state.
417    pub async fn get_user_ids_inner(
418        &self,
419        room_id: &RoomId,
420        memberships: RoomMemberships,
421        stripped: bool,
422    ) -> Result<Vec<OwnedUserId>> {
423        let store_name = if stripped { keys::STRIPPED_USER_IDS } else { keys::USER_IDS };
424
425        let tx = self.inner.transaction(store_name).with_mode(TransactionMode::Readonly).build()?;
426        let store = tx.object_store(store_name)?;
427        let range = self.encode_to_range(store_name, room_id);
428
429        let user_ids = if memberships.is_empty() {
430            // It should be faster to just get all user IDs in this case.
431            store
432                .get_all()
433                .with_query(&range)
434                .await?
435                .filter_map(Result::ok)
436                .filter_map(|f| self.deserialize_value::<RoomMember>(&f).ok().map(|m| m.user_id))
437                .collect::<Vec<_>>()
438        } else {
439            let mut user_ids = Vec::new();
440            let cursor = store.open_cursor().with_query(&range).await?;
441
442            if let Some(mut cursor) = cursor {
443                while let Some(value) = cursor.next_record().await? {
444                    let member = self.deserialize_value::<RoomMember>(&value)?;
445
446                    if memberships.matches(&member.membership) {
447                        user_ids.push(member.user_id);
448                    }
449                }
450            }
451
452            user_ids
453        };
454
455        Ok(user_ids)
456    }
457
458    async fn get_custom_value_for_js(&self, jskey: &JsValue) -> Result<Option<Vec<u8>>> {
459        self.inner
460            .transaction(keys::CUSTOM)
461            .with_mode(TransactionMode::Readonly)
462            .build()?
463            .object_store(keys::CUSTOM)?
464            .get(jskey)
465            .await?
466            .map(|f| self.deserialize_value(&f))
467            .transpose()
468    }
469
470    fn encode_kv_data_key(&self, key: StateStoreDataKey<'_>) -> JsValue {
471        // Use the key (prefix) for the table name as well, to keep encoded
472        // keys compatible for the sync token and filters, which were in
473        // separate tables initially.
474        match key {
475            StateStoreDataKey::SyncToken => {
476                self.encode_key(StateStoreDataKey::SYNC_TOKEN, StateStoreDataKey::SYNC_TOKEN)
477            }
478            StateStoreDataKey::SupportedVersions => self.encode_key(
479                StateStoreDataKey::SUPPORTED_VERSIONS,
480                StateStoreDataKey::SUPPORTED_VERSIONS,
481            ),
482            StateStoreDataKey::WellKnown => {
483                self.encode_key(keys::KV, StateStoreDataKey::WELL_KNOWN)
484            }
485            StateStoreDataKey::Filter(filter_name) => {
486                self.encode_key(StateStoreDataKey::FILTER, (StateStoreDataKey::FILTER, filter_name))
487            }
488            StateStoreDataKey::UserAvatarUrl(user_id) => {
489                self.encode_key(keys::KV, (StateStoreDataKey::USER_AVATAR_URL, user_id))
490            }
491            StateStoreDataKey::RecentlyVisitedRooms(user_id) => {
492                self.encode_key(keys::KV, (StateStoreDataKey::RECENTLY_VISITED_ROOMS, user_id))
493            }
494            StateStoreDataKey::UtdHookManagerData => {
495                self.encode_key(keys::KV, StateStoreDataKey::UTD_HOOK_MANAGER_DATA)
496            }
497            StateStoreDataKey::OneTimeKeyAlreadyUploaded => {
498                self.encode_key(keys::KV, StateStoreDataKey::ONE_TIME_KEY_ALREADY_UPLOADED)
499            }
500            StateStoreDataKey::ComposerDraft(room_id, thread_root) => {
501                if let Some(thread_root) = thread_root {
502                    self.encode_key(
503                        keys::KV,
504                        (StateStoreDataKey::COMPOSER_DRAFT, (room_id, thread_root)),
505                    )
506                } else {
507                    self.encode_key(keys::KV, (StateStoreDataKey::COMPOSER_DRAFT, room_id))
508                }
509            }
510            StateStoreDataKey::SeenKnockRequests(room_id) => {
511                self.encode_key(keys::KV, (StateStoreDataKey::SEEN_KNOCK_REQUESTS, room_id))
512            }
513            StateStoreDataKey::ThreadSubscriptionsCatchupTokens => {
514                self.encode_key(keys::KV, StateStoreDataKey::THREAD_SUBSCRIPTIONS_CATCHUP_TOKENS)
515            }
516            StateStoreDataKey::HomeserverCapabilities => {
517                self.encode_key(keys::KV, StateStoreDataKey::HOMESERVER_CAPABILITIES)
518            }
519        }
520    }
521}
522
523/// A superset of [`QueuedRequest`] that also contains the room id, since we
524/// want to return them.
525#[derive(Serialize, Deserialize)]
526struct PersistedQueuedRequest {
527    /// In which room is this event going to be sent.
528    pub room_id: OwnedRoomId,
529
530    // All these fields are the same as in [`QueuedRequest`].
531    /// Kind. Optional because it might be missing from previous formats.
532    kind: Option<QueuedRequestKind>,
533    transaction_id: OwnedTransactionId,
534
535    pub error: Option<QueueWedgeError>,
536
537    priority: Option<usize>,
538
539    /// The time the original message was first attempted to be sent at.
540    #[serde(default = "created_now")]
541    created_at: MilliSecondsSinceUnixEpoch,
542
543    // Migrated fields: keep these private, they're not used anymore elsewhere in the code base.
544    /// Deprecated (from old format), now replaced with error field.
545    is_wedged: Option<bool>,
546
547    event: Option<SerializableEventContent>,
548}
549
550fn created_now() -> MilliSecondsSinceUnixEpoch {
551    MilliSecondsSinceUnixEpoch::now()
552}
553
554impl PersistedQueuedRequest {
555    fn into_queued_request(self) -> Option<QueuedRequest> {
556        let kind =
557            self.kind.or_else(|| self.event.map(|content| QueuedRequestKind::Event { content }))?;
558
559        let error = match self.is_wedged {
560            Some(true) => {
561                // Migrate to a generic error.
562                Some(QueueWedgeError::GenericApiError {
563                    msg: "local echo failed to send in a previous session".into(),
564                })
565            }
566            _ => self.error,
567        };
568
569        // By default, events without a priority have a priority of 0.
570        let priority = self.priority.unwrap_or(0);
571
572        Some(QueuedRequest {
573            kind,
574            transaction_id: self.transaction_id,
575            error,
576            priority,
577            created_at: self.created_at,
578        })
579    }
580}
581
582#[derive(Serialize, Deserialize, PartialEq)]
583struct PersistedThreadSubscription {
584    status: String,
585    bump_stamp: Option<u64>,
586}
587
588impl From<StoredThreadSubscription> for PersistedThreadSubscription {
589    fn from(value: StoredThreadSubscription) -> Self {
590        Self { status: value.status.as_str().to_owned(), bump_stamp: value.bump_stamp }
591    }
592}
593
594// Small hack to have the following macro invocation act as the appropriate
595// trait impl block on wasm, but still be compiled on non-wasm as a regular
596// impl block otherwise.
597//
598// The trait impl doesn't compile on non-wasm due to unfulfilled trait bounds,
599// this hack allows us to still have most of rust-analyzer's IDE functionality
600// within the impl block without having to set it up to check things against
601// the wasm target (which would disable many other parts of the codebase).
602#[cfg(target_family = "wasm")]
603macro_rules! impl_state_store {
604    ({ $($body:tt)* }) => {
605        #[async_trait(?Send)]
606        impl StateStore for IndexeddbStateStore {
607            type Error = IndexeddbStateStoreError;
608
609            $($body)*
610        }
611    };
612}
613
614#[cfg(not(target_family = "wasm"))]
615macro_rules! impl_state_store {
616    ({ $($body:tt)* }) => {
617        impl IndexeddbStateStore {
618            $($body)*
619        }
620    };
621}
622
623impl_state_store!({
624    async fn get_kv_data(&self, key: StateStoreDataKey<'_>) -> Result<Option<StateStoreDataValue>> {
625        let encoded_key = self.encode_kv_data_key(key);
626
627        let value = self
628            .inner
629            .transaction(keys::KV)
630            .with_mode(TransactionMode::Readonly)
631            .build()?
632            .object_store(keys::KV)?
633            .get(&encoded_key)
634            .await?;
635
636        let value = match key {
637            StateStoreDataKey::SyncToken => value
638                .map(|f| self.deserialize_value::<String>(&f))
639                .transpose()?
640                .map(StateStoreDataValue::SyncToken),
641            StateStoreDataKey::SupportedVersions => value
642                .map(|f| self.deserialize_value::<TtlValue<SupportedVersionsResponse>>(&f))
643                .transpose()?
644                .map(StateStoreDataValue::SupportedVersions),
645            StateStoreDataKey::WellKnown => value
646                .map(|f| self.deserialize_value::<TtlValue<Option<WellKnownResponse>>>(&f))
647                .transpose()?
648                .map(StateStoreDataValue::WellKnown),
649            StateStoreDataKey::Filter(_) => value
650                .map(|f| self.deserialize_value::<String>(&f))
651                .transpose()?
652                .map(StateStoreDataValue::Filter),
653            StateStoreDataKey::UserAvatarUrl(_) => value
654                .map(|f| self.deserialize_value::<OwnedMxcUri>(&f))
655                .transpose()?
656                .map(StateStoreDataValue::UserAvatarUrl),
657            StateStoreDataKey::RecentlyVisitedRooms(_) => value
658                .map(|f| self.deserialize_value::<Vec<OwnedRoomId>>(&f))
659                .transpose()?
660                .map(StateStoreDataValue::RecentlyVisitedRooms),
661            StateStoreDataKey::UtdHookManagerData => value
662                .map(|f| self.deserialize_value::<GrowableBloom>(&f))
663                .transpose()?
664                .map(StateStoreDataValue::UtdHookManagerData),
665            StateStoreDataKey::OneTimeKeyAlreadyUploaded => value
666                .map(|f| self.deserialize_value::<bool>(&f))
667                .transpose()?
668                .map(|_| StateStoreDataValue::OneTimeKeyAlreadyUploaded),
669            StateStoreDataKey::ComposerDraft(_, _) => value
670                .map(|f| self.deserialize_value::<ComposerDraft>(&f))
671                .transpose()?
672                .map(StateStoreDataValue::ComposerDraft),
673            StateStoreDataKey::SeenKnockRequests(_) => value
674                .map(|f| self.deserialize_value::<BTreeMap<OwnedEventId, OwnedUserId>>(&f))
675                .transpose()?
676                .map(StateStoreDataValue::SeenKnockRequests),
677            StateStoreDataKey::ThreadSubscriptionsCatchupTokens => value
678                .map(|f| self.deserialize_value::<Vec<ThreadSubscriptionCatchupToken>>(&f))
679                .transpose()?
680                .map(StateStoreDataValue::ThreadSubscriptionsCatchupTokens),
681            StateStoreDataKey::HomeserverCapabilities => value
682                .map(|f| self.deserialize_value::<TtlValue<Capabilities>>(&f))
683                .transpose()?
684                .map(StateStoreDataValue::HomeserverCapabilities),
685        };
686
687        Ok(value)
688    }
689
690    async fn set_kv_data(
691        &self,
692        key: StateStoreDataKey<'_>,
693        value: StateStoreDataValue,
694    ) -> Result<()> {
695        let encoded_key = self.encode_kv_data_key(key);
696
697        let serialized_value = match key {
698            StateStoreDataKey::SyncToken => self
699                .serialize_value(&value.into_sync_token().expect("Session data not a sync token")),
700            StateStoreDataKey::SupportedVersions => self.serialize_value(
701                &value
702                    .into_supported_versions()
703                    .expect("Session data not containing supported versions"),
704            ),
705            StateStoreDataKey::WellKnown => self.serialize_value(
706                &value.into_well_known().expect("Session data not containing well-known"),
707            ),
708            StateStoreDataKey::Filter(_) => {
709                self.serialize_value(&value.into_filter().expect("Session data not a filter"))
710            }
711            StateStoreDataKey::UserAvatarUrl(_) => self.serialize_value(
712                &value.into_user_avatar_url().expect("Session data not an user avatar url"),
713            ),
714            StateStoreDataKey::RecentlyVisitedRooms(_) => self.serialize_value(
715                &value
716                    .into_recently_visited_rooms()
717                    .expect("Session data not a recently visited room list"),
718            ),
719            StateStoreDataKey::UtdHookManagerData => self.serialize_value(
720                &value.into_utd_hook_manager_data().expect("Session data not UtdHookManagerData"),
721            ),
722            StateStoreDataKey::OneTimeKeyAlreadyUploaded => self.serialize_value(&true),
723            StateStoreDataKey::ComposerDraft(_, _) => self.serialize_value(
724                &value.into_composer_draft().expect("Session data not a composer draft"),
725            ),
726            StateStoreDataKey::SeenKnockRequests(_) => self.serialize_value(
727                &value
728                    .into_seen_knock_requests()
729                    .expect("Session data is not a set of seen knock request ids"),
730            ),
731            StateStoreDataKey::ThreadSubscriptionsCatchupTokens => self.serialize_value(
732                &value
733                    .into_thread_subscriptions_catchup_tokens()
734                    .expect("Session data is not a list of thread subscription catchup tokens"),
735            ),
736            StateStoreDataKey::HomeserverCapabilities => self.serialize_value(
737                &value
738                    .into_homeserver_capabilities()
739                    .expect("Session data is not a homeserver capabilities"),
740            ),
741        };
742
743        let tx = self.inner.transaction(keys::KV).with_mode(TransactionMode::Readwrite).build()?;
744
745        let obj = tx.object_store(keys::KV)?;
746
747        obj.put(&serialized_value?).with_key(encoded_key).build()?;
748
749        tx.commit().await?;
750
751        Ok(())
752    }
753
754    async fn remove_kv_data(&self, key: StateStoreDataKey<'_>) -> Result<()> {
755        let encoded_key = self.encode_kv_data_key(key);
756
757        let tx = self.inner.transaction(keys::KV).with_mode(TransactionMode::Readwrite).build()?;
758        let obj = tx.object_store(keys::KV)?;
759
760        obj.delete(&encoded_key).build()?;
761
762        tx.commit().await?;
763
764        Ok(())
765    }
766
767    async fn save_changes(&self, changes: &StateChanges) -> Result<()> {
768        let mut stores: HashSet<&'static str> = [
769            (changes.sync_token.is_some(), keys::KV),
770            (!changes.ambiguity_maps.is_empty(), keys::DISPLAY_NAMES),
771            (!changes.account_data.is_empty(), keys::ACCOUNT_DATA),
772            (!changes.presence.is_empty(), keys::PRESENCE),
773            (
774                !changes.profiles.is_empty() || !changes.profiles_to_delete.is_empty(),
775                keys::PROFILES,
776            ),
777            (!changes.room_account_data.is_empty(), keys::ROOM_ACCOUNT_DATA),
778            (!changes.receipts.is_empty(), keys::ROOM_EVENT_RECEIPTS),
779            (!changes.global_profiles.is_empty(), keys::GLOBAL_PROFILES),
780        ]
781        .iter()
782        .filter_map(|(id, key)| if *id { Some(*key) } else { None })
783        .collect();
784
785        if !changes.state.is_empty() {
786            stores.extend([
787                keys::ROOM_STATE,
788                keys::USER_IDS,
789                keys::STRIPPED_USER_IDS,
790                keys::STRIPPED_ROOM_STATE,
791                keys::PROFILES,
792            ]);
793        }
794
795        if !changes.redactions.is_empty() {
796            stores.extend([keys::ROOM_STATE, keys::ROOM_INFOS]);
797        }
798
799        if !changes.room_infos.is_empty() {
800            stores.insert(keys::ROOM_INFOS);
801        }
802
803        if !changes.stripped_state.is_empty() {
804            stores.extend([keys::STRIPPED_ROOM_STATE, keys::STRIPPED_USER_IDS]);
805        }
806
807        if !changes.receipts.is_empty() {
808            stores.extend([keys::ROOM_EVENT_RECEIPTS, keys::ROOM_USER_RECEIPTS])
809        }
810
811        if stores.is_empty() {
812            // nothing to do, quit early
813            return Ok(());
814        }
815
816        let stores: Vec<&'static str> = stores.into_iter().collect();
817        let tx = self.inner.transaction(stores).with_mode(TransactionMode::Readwrite).build()?;
818
819        if let Some(s) = &changes.sync_token {
820            tx.object_store(keys::KV)?
821                .put(&self.serialize_value(s)?)
822                .with_key(self.encode_kv_data_key(StateStoreDataKey::SyncToken))
823                .build()?;
824        }
825
826        if !changes.ambiguity_maps.is_empty() {
827            let store = tx.object_store(keys::DISPLAY_NAMES)?;
828            for (room_id, ambiguity_maps) in &changes.ambiguity_maps {
829                for (display_name, map) in ambiguity_maps {
830                    let key = self.encode_key(
831                        keys::DISPLAY_NAMES,
832                        (
833                            room_id,
834                            display_name
835                                .as_normalized_str()
836                                .unwrap_or_else(|| display_name.as_raw_str()),
837                        ),
838                    );
839
840                    store.put(&self.serialize_value(&map)?).with_key(key).build()?;
841                }
842            }
843        }
844
845        if !changes.account_data.is_empty() {
846            let store = tx.object_store(keys::ACCOUNT_DATA)?;
847            for (event_type, event) in &changes.account_data {
848                store
849                    .put(&self.serialize_value(&event)?)
850                    .with_key(self.encode_key(keys::ACCOUNT_DATA, event_type))
851                    .build()?;
852            }
853        }
854
855        if !changes.room_account_data.is_empty() {
856            let store = tx.object_store(keys::ROOM_ACCOUNT_DATA)?;
857            for (room, events) in &changes.room_account_data {
858                for (event_type, event) in events {
859                    let key = self.encode_key(keys::ROOM_ACCOUNT_DATA, (room, event_type));
860                    store.put(&self.serialize_value(&event)?).with_key(key).build()?;
861                }
862            }
863        }
864
865        if !changes.state.is_empty() {
866            let state = tx.object_store(keys::ROOM_STATE)?;
867            let profiles = tx.object_store(keys::PROFILES)?;
868            let user_ids = tx.object_store(keys::USER_IDS)?;
869            let stripped_state = tx.object_store(keys::STRIPPED_ROOM_STATE)?;
870            let stripped_user_ids = tx.object_store(keys::STRIPPED_USER_IDS)?;
871
872            for (room, user_ids) in &changes.profiles_to_delete {
873                for user_id in user_ids {
874                    let key = self.encode_key(keys::PROFILES, (room, user_id));
875                    profiles.delete(&key).build()?;
876                }
877            }
878
879            for (room, event_types) in &changes.state {
880                let profile_changes = changes.profiles.get(room);
881
882                for (event_type, events) in event_types {
883                    for (state_key, raw_event) in events {
884                        let key = self.encode_key(keys::ROOM_STATE, (room, event_type, state_key));
885                        state
886                            .put(&self.serialize_value(&raw_event)?)
887                            .with_key(key.clone())
888                            .build()?;
889                        stripped_state.delete(&key).build()?;
890
891                        if *event_type == StateEventType::RoomMember {
892                            let event =
893                                match raw_event.deserialize_as_unchecked::<SyncRoomMemberEvent>() {
894                                    Ok(ev) => ev,
895                                    Err(e) => {
896                                        let event_id: Option<String> =
897                                            raw_event.get_field("event_id").ok().flatten();
898                                        debug!(event_id, "Failed to deserialize member event: {e}");
899                                        continue;
900                                    }
901                                };
902
903                            let key = (room, state_key);
904
905                            stripped_user_ids
906                                .delete(&self.encode_key(keys::STRIPPED_USER_IDS, key))
907                                .build()?;
908
909                            user_ids
910                                .put(&self.serialize_value(&RoomMember::from(&event))?)
911                                .with_key(self.encode_key(keys::USER_IDS, key))
912                                .build()?;
913
914                            if let Some(profile) =
915                                profile_changes.and_then(|p| p.get(event.state_key()))
916                            {
917                                profiles
918                                    .put(&self.serialize_value(&profile)?)
919                                    .with_key(self.encode_key(keys::PROFILES, key))
920                                    .build()?;
921                            }
922                        }
923                    }
924                }
925            }
926        }
927
928        if !changes.room_infos.is_empty() {
929            let room_infos = tx.object_store(keys::ROOM_INFOS)?;
930            for (room_id, room_info) in &changes.room_infos {
931                room_infos
932                    .put(&self.serialize_value(&room_info)?)
933                    .with_key(self.encode_key(keys::ROOM_INFOS, room_id))
934                    .build()?;
935            }
936        }
937
938        if !changes.presence.is_empty() {
939            let store = tx.object_store(keys::PRESENCE)?;
940            for (sender, event) in &changes.presence {
941                store
942                    .put(&self.serialize_value(&event)?)
943                    .with_key(self.encode_key(keys::PRESENCE, sender))
944                    .build()?;
945            }
946        }
947
948        if !changes.stripped_state.is_empty() {
949            let store = tx.object_store(keys::STRIPPED_ROOM_STATE)?;
950            let user_ids = tx.object_store(keys::STRIPPED_USER_IDS)?;
951
952            for (room, event_types) in &changes.stripped_state {
953                for (event_type, events) in event_types {
954                    for (state_key, raw_event) in events {
955                        let key = self
956                            .encode_key(keys::STRIPPED_ROOM_STATE, (room, event_type, state_key));
957                        store.put(&self.serialize_value(&raw_event)?).with_key(key).build()?;
958
959                        if *event_type == StateEventType::RoomMember {
960                            let event = match raw_event
961                                .deserialize_as_unchecked::<StrippedRoomMemberEvent>()
962                            {
963                                Ok(ev) => ev,
964                                Err(e) => {
965                                    let event_id: Option<String> =
966                                        raw_event.get_field("event_id").ok().flatten();
967                                    debug!(
968                                        event_id,
969                                        "Failed to deserialize stripped member event: {e}"
970                                    );
971                                    continue;
972                                }
973                            };
974
975                            let key = (room, state_key);
976
977                            user_ids
978                                .put(&self.serialize_value(&RoomMember::from(&event))?)
979                                .with_key(self.encode_key(keys::STRIPPED_USER_IDS, key))
980                                .build()?;
981                        }
982                    }
983                }
984            }
985        }
986
987        if !changes.receipts.is_empty() {
988            let room_user_receipts = tx.object_store(keys::ROOM_USER_RECEIPTS)?;
989            let room_event_receipts = tx.object_store(keys::ROOM_EVENT_RECEIPTS)?;
990
991            for (room, content) in &changes.receipts {
992                for (event_id, receipts) in &content.0 {
993                    for (receipt_type, receipts) in receipts {
994                        for (user_id, receipt) in receipts {
995                            let key = match receipt.thread.as_str() {
996                                Some(thread_id) => self.encode_key(
997                                    keys::ROOM_USER_RECEIPTS,
998                                    (room, receipt_type, thread_id, user_id),
999                                ),
1000                                None => self.encode_key(
1001                                    keys::ROOM_USER_RECEIPTS,
1002                                    (room, receipt_type, user_id),
1003                                ),
1004                            };
1005
1006                            if let Some((old_event, _)) =
1007                                room_user_receipts.get(&key).await?.and_then(|f| {
1008                                    self.deserialize_value::<(OwnedEventId, Receipt)>(&f).ok()
1009                                })
1010                            {
1011                                let key = match receipt.thread.as_str() {
1012                                    Some(thread_id) => self.encode_key(
1013                                        keys::ROOM_EVENT_RECEIPTS,
1014                                        (room, receipt_type, thread_id, old_event, user_id),
1015                                    ),
1016                                    None => self.encode_key(
1017                                        keys::ROOM_EVENT_RECEIPTS,
1018                                        (room, receipt_type, old_event, user_id),
1019                                    ),
1020                                };
1021                                room_event_receipts.delete(&key).build()?;
1022                            }
1023
1024                            room_user_receipts
1025                                .put(&self.serialize_value(&(event_id, receipt))?)
1026                                .with_key(key)
1027                                .build()?;
1028
1029                            // Add the receipt to the room event receipts
1030                            let key = match receipt.thread.as_str() {
1031                                Some(thread_id) => self.encode_key(
1032                                    keys::ROOM_EVENT_RECEIPTS,
1033                                    (room, receipt_type, thread_id, event_id, user_id),
1034                                ),
1035                                None => self.encode_key(
1036                                    keys::ROOM_EVENT_RECEIPTS,
1037                                    (room, receipt_type, event_id, user_id),
1038                                ),
1039                            };
1040                            room_event_receipts
1041                                .put(&self.serialize_value(&(user_id, receipt))?)
1042                                .with_key(key)
1043                                .build()?;
1044                        }
1045                    }
1046                }
1047            }
1048        }
1049
1050        if !changes.redactions.is_empty() {
1051            let state = tx.object_store(keys::ROOM_STATE)?;
1052            let room_info = tx.object_store(keys::ROOM_INFOS)?;
1053
1054            for (room_id, redactions) in &changes.redactions {
1055                let range = self.encode_to_range(keys::ROOM_STATE, room_id);
1056                let Some(mut cursor) = state.open_cursor().with_query(&range).await? else {
1057                    continue;
1058                };
1059
1060                let mut redaction_rules = None;
1061
1062                while let Some(value) = cursor.next_record().await? {
1063                    let Some(key) = cursor.key::<JsValue>()? else {
1064                        break;
1065                    };
1066
1067                    let raw_evt = self.deserialize_value::<Raw<AnySyncStateEvent>>(&value)?;
1068                    if let Ok(Some(event_id)) = raw_evt.get_field::<OwnedEventId>("event_id")
1069                        && let Some(redaction) = redactions.get(&event_id)
1070                    {
1071                        let redaction_rules = match &redaction_rules {
1072                            Some(r) => r,
1073                            None => {
1074                                let value = room_info
1075                                    .get(&self.encode_key(keys::ROOM_INFOS, room_id))
1076                                    .await?
1077                                    .and_then(|f| self.deserialize_value::<RoomInfo>(&f).ok())
1078                                    .map(|info| info.room_version_rules_or_default())
1079                                    .unwrap_or_else(|| {
1080                                        warn!(
1081                                            ?room_id,
1082                                            "Unable to get the room version rules, \
1083                                             defaulting to rules for room version \
1084                                             {ROOM_VERSION_FALLBACK}"
1085                                        );
1086                                        ROOM_VERSION_RULES_FALLBACK
1087                                    })
1088                                    .redaction;
1089                                redaction_rules.get_or_insert(value)
1090                            }
1091                        };
1092
1093                        let redacted = redact(
1094                            raw_evt.deserialize_as::<CanonicalJsonObject>()?,
1095                            redaction_rules,
1096                            Some(RedactedBecause::from_raw_event(redaction)?),
1097                        )
1098                        .map_err(StoreError::Redaction)?;
1099                        state.put(&self.serialize_value(&redacted)?).with_key(key).build()?;
1100                    }
1101                }
1102            }
1103        }
1104
1105        if !changes.global_profiles.is_empty() {
1106            let store = tx.object_store(keys::GLOBAL_PROFILES)?;
1107            for (user_id, profile_update) in &changes.global_profiles {
1108                let key = self.encode_key(keys::GLOBAL_PROFILES, user_id);
1109                let existing: Option<UserProfile> =
1110                    store.get(&key).await?.map(|f| self.deserialize_value(&f)).transpose()?;
1111
1112                let mut profile = existing.unwrap_or_default();
1113                profile.merge(profile_update.clone());
1114
1115                store.put(&self.serialize_value(&profile)?).with_key(key).build()?;
1116            }
1117        }
1118
1119        tx.commit().await.map_err(|e| e.into())
1120    }
1121
1122    async fn get_presence_event(&self, user_id: &UserId) -> Result<Option<Raw<PresenceEvent>>> {
1123        self.inner
1124            .transaction(keys::PRESENCE)
1125            .with_mode(TransactionMode::Readonly)
1126            .build()?
1127            .object_store(keys::PRESENCE)?
1128            .get(&self.encode_key(keys::PRESENCE, user_id))
1129            .await?
1130            .map(|f| self.deserialize_value(&f))
1131            .transpose()
1132    }
1133
1134    async fn get_presence_events(
1135        &self,
1136        user_ids: &[OwnedUserId],
1137    ) -> Result<Vec<Raw<PresenceEvent>>> {
1138        if user_ids.is_empty() {
1139            return Ok(Vec::new());
1140        }
1141
1142        let txn =
1143            self.inner.transaction(keys::PRESENCE).with_mode(TransactionMode::Readonly).build()?;
1144        let store = txn.object_store(keys::PRESENCE)?;
1145
1146        let mut events = Vec::with_capacity(user_ids.len());
1147
1148        for user_id in user_ids {
1149            if let Some(event) = store
1150                .get(&self.encode_key(keys::PRESENCE, user_id))
1151                .await?
1152                .map(|f| self.deserialize_value(&f))
1153                .transpose()?
1154            {
1155                events.push(event)
1156            }
1157        }
1158
1159        Ok(events)
1160    }
1161
1162    async fn get_state_event(
1163        &self,
1164        room_id: &RoomId,
1165        event_type: StateEventType,
1166        state_key: &str,
1167    ) -> Result<Option<RawAnySyncOrStrippedState>> {
1168        Ok(self
1169            .get_state_events_for_keys(room_id, event_type, &[state_key])
1170            .await?
1171            .into_iter()
1172            .next())
1173    }
1174
1175    async fn get_state_events(
1176        &self,
1177        room_id: &RoomId,
1178        event_type: StateEventType,
1179    ) -> Result<Vec<RawAnySyncOrStrippedState>> {
1180        let stripped_range =
1181            self.encode_to_range(keys::STRIPPED_ROOM_STATE, (room_id, &event_type));
1182        let stripped_events = self
1183            .inner
1184            .transaction(keys::STRIPPED_ROOM_STATE)
1185            .with_mode(TransactionMode::Readonly)
1186            .build()?
1187            .object_store(keys::STRIPPED_ROOM_STATE)?
1188            .get_all()
1189            .with_query(&stripped_range)
1190            .await?
1191            .filter_map(Result::ok)
1192            .filter_map(|f| {
1193                self.deserialize_value(&f).ok().map(RawAnySyncOrStrippedState::Stripped)
1194            })
1195            .collect::<Vec<_>>();
1196
1197        if !stripped_events.is_empty() {
1198            return Ok(stripped_events);
1199        }
1200
1201        let range = self.encode_to_range(keys::ROOM_STATE, (room_id, event_type));
1202        Ok(self
1203            .inner
1204            .transaction(keys::ROOM_STATE)
1205            .with_mode(TransactionMode::Readonly)
1206            .build()?
1207            .object_store(keys::ROOM_STATE)?
1208            .get_all()
1209            .with_query(&range)
1210            .await?
1211            .filter_map(Result::ok)
1212            .filter_map(|f| self.deserialize_value(&f).ok().map(RawAnySyncOrStrippedState::Sync))
1213            .collect::<Vec<_>>())
1214    }
1215
1216    async fn get_state_events_for_keys(
1217        &self,
1218        room_id: &RoomId,
1219        event_type: StateEventType,
1220        state_keys: &[&str],
1221    ) -> Result<Vec<RawAnySyncOrStrippedState>> {
1222        if state_keys.is_empty() {
1223            return Ok(Vec::new());
1224        }
1225
1226        let mut events = Vec::with_capacity(state_keys.len());
1227
1228        {
1229            let txn = self
1230                .inner
1231                .transaction(keys::STRIPPED_ROOM_STATE)
1232                .with_mode(TransactionMode::Readonly)
1233                .build()?;
1234            let store = txn.object_store(keys::STRIPPED_ROOM_STATE)?;
1235
1236            for state_key in state_keys {
1237                if let Some(event) =
1238                    store
1239                        .get(&self.encode_key(
1240                            keys::STRIPPED_ROOM_STATE,
1241                            (room_id, &event_type, state_key),
1242                        ))
1243                        .await?
1244                        .map(|f| self.deserialize_value(&f))
1245                        .transpose()?
1246                {
1247                    events.push(RawAnySyncOrStrippedState::Stripped(event));
1248                }
1249            }
1250
1251            if !events.is_empty() {
1252                return Ok(events);
1253            }
1254        }
1255
1256        let txn = self
1257            .inner
1258            .transaction(keys::ROOM_STATE)
1259            .with_mode(TransactionMode::Readonly)
1260            .build()?;
1261        let store = txn.object_store(keys::ROOM_STATE)?;
1262
1263        for state_key in state_keys {
1264            if let Some(event) = store
1265                .get(&self.encode_key(keys::ROOM_STATE, (room_id, &event_type, state_key)))
1266                .await?
1267                .map(|f| self.deserialize_value(&f))
1268                .transpose()?
1269            {
1270                events.push(RawAnySyncOrStrippedState::Sync(event));
1271            }
1272        }
1273
1274        Ok(events)
1275    }
1276
1277    async fn get_profile(
1278        &self,
1279        room_id: &RoomId,
1280        user_id: &UserId,
1281    ) -> Result<Option<MinimalRoomMemberEvent>> {
1282        self.inner
1283            .transaction(keys::PROFILES)
1284            .with_mode(TransactionMode::Readonly)
1285            .build()?
1286            .object_store(keys::PROFILES)?
1287            .get(&self.encode_key(keys::PROFILES, (room_id, user_id)))
1288            .await?
1289            .map(|f| self.deserialize_value(&f))
1290            .transpose()
1291    }
1292
1293    async fn get_profiles<'a>(
1294        &self,
1295        room_id: &RoomId,
1296        user_ids: &'a [OwnedUserId],
1297    ) -> Result<BTreeMap<&'a UserId, MinimalRoomMemberEvent>> {
1298        if user_ids.is_empty() {
1299            return Ok(BTreeMap::new());
1300        }
1301
1302        let txn =
1303            self.inner.transaction(keys::PROFILES).with_mode(TransactionMode::Readonly).build()?;
1304        let store = txn.object_store(keys::PROFILES)?;
1305
1306        let mut profiles = BTreeMap::new();
1307        for user_id in user_ids {
1308            if let Some(profile) = store
1309                .get(&self.encode_key(keys::PROFILES, (room_id, user_id)))
1310                .await?
1311                .map(|f| self.deserialize_value(&f))
1312                .transpose()?
1313            {
1314                profiles.insert(user_id.as_ref(), profile);
1315            }
1316        }
1317
1318        Ok(profiles)
1319    }
1320
1321    async fn get_room_infos(&self, room_load_settings: &RoomLoadSettings) -> Result<Vec<RoomInfo>> {
1322        let transaction = self
1323            .inner
1324            .transaction(keys::ROOM_INFOS)
1325            .with_mode(TransactionMode::Readonly)
1326            .build()?;
1327
1328        let object_store = transaction.object_store(keys::ROOM_INFOS)?;
1329
1330        Ok(match room_load_settings {
1331            RoomLoadSettings::All => object_store
1332                .get_all()
1333                .await?
1334                .map(|room_info| self.deserialize_value::<RoomInfo>(&room_info?))
1335                .collect::<Result<_>>()?,
1336
1337            RoomLoadSettings::One(room_id) => {
1338                match object_store.get(&self.encode_key(keys::ROOM_INFOS, room_id)).await? {
1339                    Some(room_info) => vec![self.deserialize_value::<RoomInfo>(&room_info)?],
1340                    None => vec![],
1341                }
1342            }
1343        })
1344    }
1345
1346    async fn get_users_with_display_name(
1347        &self,
1348        room_id: &RoomId,
1349        display_name: &DisplayName,
1350    ) -> Result<BTreeSet<OwnedUserId>> {
1351        self.inner
1352            .transaction(keys::DISPLAY_NAMES)
1353            .with_mode(TransactionMode::Readonly)
1354            .build()?
1355            .object_store(keys::DISPLAY_NAMES)?
1356            .get(&self.encode_key(
1357                keys::DISPLAY_NAMES,
1358                (
1359                    room_id,
1360                    display_name.as_normalized_str().unwrap_or_else(|| display_name.as_raw_str()),
1361                ),
1362            ))
1363            .await?
1364            .map(|f| self.deserialize_value::<BTreeSet<OwnedUserId>>(&f))
1365            .unwrap_or_else(|| Ok(Default::default()))
1366    }
1367
1368    async fn get_users_with_display_names<'a>(
1369        &self,
1370        room_id: &RoomId,
1371        display_names: &'a [DisplayName],
1372    ) -> Result<HashMap<&'a DisplayName, BTreeSet<OwnedUserId>>> {
1373        let mut map = HashMap::new();
1374
1375        if display_names.is_empty() {
1376            return Ok(map);
1377        }
1378
1379        let txn = self
1380            .inner
1381            .transaction(keys::DISPLAY_NAMES)
1382            .with_mode(TransactionMode::Readonly)
1383            .build()?;
1384        let store = txn.object_store(keys::DISPLAY_NAMES)?;
1385
1386        for display_name in display_names {
1387            if let Some(user_ids) = store
1388                .get(
1389                    &self.encode_key(
1390                        keys::DISPLAY_NAMES,
1391                        (
1392                            room_id,
1393                            display_name
1394                                .as_normalized_str()
1395                                .unwrap_or_else(|| display_name.as_raw_str()),
1396                        ),
1397                    ),
1398                )
1399                .await?
1400                .map(|f| self.deserialize_value::<BTreeSet<OwnedUserId>>(&f))
1401                .transpose()?
1402            {
1403                map.insert(display_name, user_ids);
1404            }
1405        }
1406
1407        Ok(map)
1408    }
1409
1410    async fn get_account_data_event(
1411        &self,
1412        event_type: GlobalAccountDataEventType,
1413    ) -> Result<Option<Raw<AnyGlobalAccountDataEvent>>> {
1414        self.inner
1415            .transaction(keys::ACCOUNT_DATA)
1416            .with_mode(TransactionMode::Readonly)
1417            .build()?
1418            .object_store(keys::ACCOUNT_DATA)?
1419            .get(&self.encode_key(keys::ACCOUNT_DATA, event_type))
1420            .await?
1421            .map(|f| self.deserialize_value(&f))
1422            .transpose()
1423    }
1424
1425    async fn get_room_account_data_event(
1426        &self,
1427        room_id: &RoomId,
1428        event_type: RoomAccountDataEventType,
1429    ) -> Result<Option<Raw<AnyRoomAccountDataEvent>>> {
1430        self.inner
1431            .transaction(keys::ROOM_ACCOUNT_DATA)
1432            .with_mode(TransactionMode::Readonly)
1433            .build()?
1434            .object_store(keys::ROOM_ACCOUNT_DATA)?
1435            .get(&self.encode_key(keys::ROOM_ACCOUNT_DATA, (room_id, event_type)))
1436            .await?
1437            .map(|f| self.deserialize_value(&f))
1438            .transpose()
1439    }
1440
1441    async fn get_user_room_receipt_event(
1442        &self,
1443        room_id: &RoomId,
1444        receipt_type: ReceiptType,
1445        thread: ReceiptThread,
1446        user_id: &UserId,
1447    ) -> Result<Option<(OwnedEventId, Receipt)>> {
1448        let key = match thread.as_str() {
1449            Some(thread_id) => self
1450                .encode_key(keys::ROOM_USER_RECEIPTS, (room_id, receipt_type, thread_id, user_id)),
1451            None => self.encode_key(keys::ROOM_USER_RECEIPTS, (room_id, receipt_type, user_id)),
1452        };
1453        self.inner
1454            .transaction(keys::ROOM_USER_RECEIPTS)
1455            .with_mode(TransactionMode::Readonly)
1456            .build()?
1457            .object_store(keys::ROOM_USER_RECEIPTS)?
1458            .get(&key)
1459            .await?
1460            .map(|f| self.deserialize_value(&f))
1461            .transpose()
1462    }
1463
1464    async fn get_event_room_receipt_events(
1465        &self,
1466        room_id: &RoomId,
1467        receipt_type: ReceiptType,
1468        thread: ReceiptThread,
1469        event_id: &EventId,
1470    ) -> Result<Vec<(OwnedUserId, Receipt)>> {
1471        let range = match thread.as_str() {
1472            Some(thread_id) => self.encode_to_range(
1473                keys::ROOM_EVENT_RECEIPTS,
1474                (room_id, receipt_type, thread_id, event_id),
1475            ),
1476            None => {
1477                self.encode_to_range(keys::ROOM_EVENT_RECEIPTS, (room_id, receipt_type, event_id))
1478            }
1479        };
1480        let tx = self
1481            .inner
1482            .transaction(keys::ROOM_EVENT_RECEIPTS)
1483            .with_mode(TransactionMode::Readonly)
1484            .build()?;
1485        let store = tx.object_store(keys::ROOM_EVENT_RECEIPTS)?;
1486
1487        Ok(store
1488            .get_all()
1489            .with_query(&range)
1490            .await?
1491            .filter_map(Result::ok)
1492            .filter_map(|f| self.deserialize_value(&f).ok())
1493            .collect::<Vec<_>>())
1494    }
1495
1496    async fn get_custom_value(&self, key: &[u8]) -> Result<Option<Vec<u8>>> {
1497        let jskey = &JsValue::from_str(core::str::from_utf8(key).map_err(StoreError::Codec)?);
1498        self.get_custom_value_for_js(jskey).await
1499    }
1500
1501    async fn set_custom_value(&self, key: &[u8], value: Vec<u8>) -> Result<Option<Vec<u8>>> {
1502        let jskey = JsValue::from_str(core::str::from_utf8(key).map_err(StoreError::Codec)?);
1503
1504        let prev = self.get_custom_value_for_js(&jskey).await?;
1505
1506        let tx =
1507            self.inner.transaction(keys::CUSTOM).with_mode(TransactionMode::Readwrite).build()?;
1508
1509        tx.object_store(keys::CUSTOM)?
1510            .put(&self.serialize_value(&value)?)
1511            .with_key(jskey)
1512            .build()?;
1513
1514        tx.commit().await.map_err(IndexeddbStateStoreError::from)?;
1515        Ok(prev)
1516    }
1517
1518    async fn remove_custom_value(&self, key: &[u8]) -> Result<Option<Vec<u8>>> {
1519        let jskey = JsValue::from_str(core::str::from_utf8(key).map_err(StoreError::Codec)?);
1520
1521        let prev = self.get_custom_value_for_js(&jskey).await?;
1522
1523        let tx =
1524            self.inner.transaction(keys::CUSTOM).with_mode(TransactionMode::Readwrite).build()?;
1525
1526        tx.object_store(keys::CUSTOM)?.delete(&jskey).build()?;
1527
1528        tx.commit().await.map_err(IndexeddbStateStoreError::from)?;
1529        Ok(prev)
1530    }
1531
1532    async fn remove_room(&self, room_id: &RoomId) -> Result<()> {
1533        // All the stores which use a RoomId as their key (and nothing additional).
1534        let direct_stores = [keys::ROOM_INFOS, keys::ROOM_SEND_QUEUE, keys::DEPENDENT_SEND_QUEUE];
1535
1536        // All the stores which use a RoomId as the first part of their key, but may
1537        // have some additional data in the key.
1538        let prefixed_stores = [
1539            keys::PROFILES,
1540            keys::DISPLAY_NAMES,
1541            keys::USER_IDS,
1542            keys::ROOM_STATE,
1543            keys::ROOM_ACCOUNT_DATA,
1544            keys::ROOM_EVENT_RECEIPTS,
1545            keys::ROOM_USER_RECEIPTS,
1546            keys::STRIPPED_ROOM_STATE,
1547            keys::STRIPPED_USER_IDS,
1548            keys::THREAD_SUBSCRIPTIONS,
1549        ];
1550
1551        let all_stores = {
1552            let mut v = Vec::new();
1553            v.extend(prefixed_stores);
1554            v.extend(direct_stores);
1555            v
1556        };
1557
1558        let tx =
1559            self.inner.transaction(all_stores).with_mode(TransactionMode::Readwrite).build()?;
1560
1561        for store_name in direct_stores {
1562            tx.object_store(store_name)?.delete(&self.encode_key(store_name, room_id)).build()?;
1563        }
1564
1565        for store_name in prefixed_stores {
1566            let store = tx.object_store(store_name)?;
1567            let range = self.encode_to_range(store_name, room_id);
1568            for key in store.get_all_keys::<JsValue>().with_query(&range).await? {
1569                store.delete(&key?).build()?;
1570            }
1571        }
1572
1573        tx.commit().await.map_err(|e| e.into())
1574    }
1575
1576    async fn get_user_ids(
1577        &self,
1578        room_id: &RoomId,
1579        memberships: RoomMemberships,
1580    ) -> Result<Vec<OwnedUserId>> {
1581        let ids = self.get_user_ids_inner(room_id, memberships, true).await?;
1582        if !ids.is_empty() {
1583            return Ok(ids);
1584        }
1585        self.get_user_ids_inner(room_id, memberships, false).await
1586    }
1587
1588    async fn save_send_queue_request(
1589        &self,
1590        room_id: &RoomId,
1591        transaction_id: OwnedTransactionId,
1592        created_at: MilliSecondsSinceUnixEpoch,
1593        kind: QueuedRequestKind,
1594        priority: usize,
1595    ) -> Result<()> {
1596        let encoded_key = self.encode_key(keys::ROOM_SEND_QUEUE, room_id);
1597
1598        let tx = self
1599            .inner
1600            .transaction(keys::ROOM_SEND_QUEUE)
1601            .with_mode(TransactionMode::Readwrite)
1602            .build()?;
1603
1604        let obj = tx.object_store(keys::ROOM_SEND_QUEUE)?;
1605
1606        // We store an encoded vector of the queued requests, with their transaction
1607        // ids.
1608
1609        // Reload the previous vector for this room, or create an empty one.
1610        let prev = obj.get(&encoded_key).await?;
1611
1612        let mut prev = prev.map_or_else(
1613            || Ok(Vec::new()),
1614            |val| self.deserialize_value::<Vec<PersistedQueuedRequest>>(&val),
1615        )?;
1616
1617        // Push the new request.
1618        prev.push(PersistedQueuedRequest {
1619            room_id: room_id.to_owned(),
1620            kind: Some(kind),
1621            transaction_id,
1622            error: None,
1623            is_wedged: None,
1624            event: None,
1625            priority: Some(priority),
1626            created_at,
1627        });
1628
1629        // Save the new vector into db.
1630        obj.put(&self.serialize_value(&prev)?).with_key(encoded_key).build()?;
1631
1632        tx.commit().await?;
1633
1634        Ok(())
1635    }
1636
1637    async fn update_send_queue_request(
1638        &self,
1639        room_id: &RoomId,
1640        transaction_id: &TransactionId,
1641        kind: QueuedRequestKind,
1642    ) -> Result<bool> {
1643        let encoded_key = self.encode_key(keys::ROOM_SEND_QUEUE, room_id);
1644
1645        let tx = self
1646            .inner
1647            .transaction(keys::ROOM_SEND_QUEUE)
1648            .with_mode(TransactionMode::Readwrite)
1649            .build()?;
1650
1651        let obj = tx.object_store(keys::ROOM_SEND_QUEUE)?;
1652
1653        // We store an encoded vector of the queued requests, with their transaction
1654        // ids.
1655
1656        // Reload the previous vector for this room, or create an empty one.
1657        let prev = obj.get(&encoded_key).await?;
1658
1659        let mut prev = prev.map_or_else(
1660            || Ok(Vec::new()),
1661            |val| self.deserialize_value::<Vec<PersistedQueuedRequest>>(&val),
1662        )?;
1663
1664        // Modify the one request.
1665        if let Some(entry) = prev.iter_mut().find(|entry| entry.transaction_id == transaction_id) {
1666            entry.kind = Some(kind);
1667            // Reset the error state.
1668            entry.error = None;
1669            // Remove migrated fields.
1670            entry.is_wedged = None;
1671            entry.event = None;
1672
1673            // Save the new vector into db.
1674            obj.put(&self.serialize_value(&prev)?).with_key(encoded_key).build()?;
1675            tx.commit().await?;
1676
1677            Ok(true)
1678        } else {
1679            Ok(false)
1680        }
1681    }
1682
1683    async fn remove_send_queue_request(
1684        &self,
1685        room_id: &RoomId,
1686        transaction_id: &TransactionId,
1687    ) -> Result<bool> {
1688        let encoded_key = self.encode_key(keys::ROOM_SEND_QUEUE, room_id);
1689
1690        let tx = self
1691            .inner
1692            .transaction([keys::ROOM_SEND_QUEUE, keys::DEPENDENT_SEND_QUEUE])
1693            .with_mode(TransactionMode::Readwrite)
1694            .build()?;
1695
1696        let obj = tx.object_store(keys::ROOM_SEND_QUEUE)?;
1697
1698        // We store an encoded vector of the queued requests, with their transaction
1699        // ids.
1700
1701        // Reload the previous vector for this room.
1702        if let Some(val) = obj.get(&encoded_key).await? {
1703            let mut prev = self.deserialize_value::<Vec<PersistedQueuedRequest>>(&val)?;
1704            if let Some(pos) = prev.iter().position(|item| item.transaction_id == transaction_id) {
1705                prev.remove(pos);
1706
1707                if prev.is_empty() {
1708                    obj.delete(&encoded_key).build()?;
1709                } else {
1710                    obj.put(&self.serialize_value(&prev)?).with_key(encoded_key).build()?;
1711                }
1712
1713                tx.commit().await?;
1714                return Ok(true);
1715            }
1716        }
1717
1718        Ok(false)
1719    }
1720
1721    async fn load_send_queue_requests(&self, room_id: &RoomId) -> Result<Vec<QueuedRequest>> {
1722        let encoded_key = self.encode_key(keys::ROOM_SEND_QUEUE, room_id);
1723
1724        // We store an encoded vector of the queued requests, with their transaction
1725        // ids.
1726        let prev = self
1727            .inner
1728            .transaction(keys::ROOM_SEND_QUEUE)
1729            .with_mode(TransactionMode::Readwrite)
1730            .build()?
1731            .object_store(keys::ROOM_SEND_QUEUE)?
1732            .get(&encoded_key)
1733            .await?;
1734
1735        let mut prev = prev.map_or_else(
1736            || Ok(Vec::new()),
1737            |val| self.deserialize_value::<Vec<PersistedQueuedRequest>>(&val),
1738        )?;
1739
1740        // Inverted stable ordering on priority.
1741        prev.sort_by_key(|item| Reverse(item.priority.unwrap_or(0)));
1742
1743        Ok(prev.into_iter().filter_map(PersistedQueuedRequest::into_queued_request).collect())
1744    }
1745
1746    async fn update_send_queue_request_status(
1747        &self,
1748        room_id: &RoomId,
1749        transaction_id: &TransactionId,
1750        error: Option<QueueWedgeError>,
1751    ) -> Result<()> {
1752        let encoded_key = self.encode_key(keys::ROOM_SEND_QUEUE, room_id);
1753
1754        let tx = self
1755            .inner
1756            .transaction(keys::ROOM_SEND_QUEUE)
1757            .with_mode(TransactionMode::Readwrite)
1758            .build()?;
1759
1760        let obj = tx.object_store(keys::ROOM_SEND_QUEUE)?;
1761
1762        if let Some(val) = obj.get(&encoded_key).await? {
1763            let mut prev = self.deserialize_value::<Vec<PersistedQueuedRequest>>(&val)?;
1764            if let Some(request) =
1765                prev.iter_mut().find(|item| item.transaction_id == transaction_id)
1766            {
1767                request.is_wedged = None;
1768                request.error = error;
1769                obj.put(&self.serialize_value(&prev)?).with_key(encoded_key).build()?;
1770            }
1771        }
1772
1773        tx.commit().await?;
1774
1775        Ok(())
1776    }
1777
1778    async fn load_rooms_with_unsent_requests(&self) -> Result<Vec<OwnedRoomId>> {
1779        let tx = self
1780            .inner
1781            .transaction(keys::ROOM_SEND_QUEUE)
1782            .with_mode(TransactionMode::Readwrite)
1783            .build()?;
1784
1785        let obj = tx.object_store(keys::ROOM_SEND_QUEUE)?;
1786
1787        let all_entries = obj
1788            .get_all()
1789            .await?
1790            .map(|item| self.deserialize_value::<Vec<PersistedQueuedRequest>>(&item?))
1791            .collect::<Result<Vec<Vec<PersistedQueuedRequest>>, _>>()?
1792            .into_iter()
1793            .flat_map(|vec| vec.into_iter().map(|item| item.room_id))
1794            .collect::<BTreeSet<_>>();
1795
1796        Ok(all_entries.into_iter().collect())
1797    }
1798
1799    async fn save_dependent_queued_request(
1800        &self,
1801        room_id: &RoomId,
1802        parent_txn_id: &TransactionId,
1803        own_txn_id: ChildTransactionId,
1804        created_at: MilliSecondsSinceUnixEpoch,
1805        content: DependentQueuedRequestKind,
1806    ) -> Result<()> {
1807        let encoded_key = self.encode_key(keys::DEPENDENT_SEND_QUEUE, room_id);
1808
1809        let tx = self
1810            .inner
1811            .transaction(keys::DEPENDENT_SEND_QUEUE)
1812            .with_mode(TransactionMode::Readwrite)
1813            .build()?;
1814
1815        let obj = tx.object_store(keys::DEPENDENT_SEND_QUEUE)?;
1816
1817        // We store an encoded vector of the dependent requests.
1818        // Reload the previous vector for this room, or create an empty one.
1819        let prev = obj.get(&encoded_key).await?;
1820
1821        let mut prev = prev.map_or_else(
1822            || Ok(Vec::new()),
1823            |val| self.deserialize_value::<Vec<DependentQueuedRequest>>(&val),
1824        )?;
1825
1826        // Push the new request.
1827        prev.push(DependentQueuedRequest {
1828            kind: content,
1829            parent_transaction_id: parent_txn_id.to_owned(),
1830            own_transaction_id: own_txn_id,
1831            parent_key: None,
1832            created_at,
1833        });
1834
1835        // Save the new vector into db.
1836        obj.put(&self.serialize_value(&prev)?).with_key(encoded_key).build()?;
1837
1838        tx.commit().await?;
1839
1840        Ok(())
1841    }
1842
1843    async fn update_dependent_queued_request(
1844        &self,
1845        room_id: &RoomId,
1846        own_transaction_id: &ChildTransactionId,
1847        new_content: DependentQueuedRequestKind,
1848    ) -> Result<bool> {
1849        let encoded_key = self.encode_key(keys::DEPENDENT_SEND_QUEUE, room_id);
1850
1851        let tx = self
1852            .inner
1853            .transaction(keys::DEPENDENT_SEND_QUEUE)
1854            .with_mode(TransactionMode::Readwrite)
1855            .build()?;
1856
1857        let obj = tx.object_store(keys::DEPENDENT_SEND_QUEUE)?;
1858
1859        // We store an encoded vector of the dependent requests.
1860        // Reload the previous vector for this room, or create an empty one.
1861        let prev = obj.get(&encoded_key).await?;
1862
1863        let mut prev = prev.map_or_else(
1864            || Ok(Vec::new()),
1865            |val| self.deserialize_value::<Vec<DependentQueuedRequest>>(&val),
1866        )?;
1867
1868        // Modify the dependent request, if found.
1869        let mut found = false;
1870        for entry in prev.iter_mut() {
1871            if entry.own_transaction_id == *own_transaction_id {
1872                found = true;
1873                entry.kind = new_content;
1874                break;
1875            }
1876        }
1877
1878        if found {
1879            obj.put(&self.serialize_value(&prev)?).with_key(encoded_key).build()?;
1880            tx.commit().await?;
1881        }
1882
1883        Ok(found)
1884    }
1885
1886    async fn mark_dependent_queued_requests_as_ready(
1887        &self,
1888        room_id: &RoomId,
1889        parent_txn_id: &TransactionId,
1890        parent_key: SentRequestKey,
1891    ) -> Result<usize> {
1892        let encoded_key = self.encode_key(keys::DEPENDENT_SEND_QUEUE, room_id);
1893
1894        let tx = self
1895            .inner
1896            .transaction(keys::DEPENDENT_SEND_QUEUE)
1897            .with_mode(TransactionMode::Readwrite)
1898            .build()?;
1899
1900        let obj = tx.object_store(keys::DEPENDENT_SEND_QUEUE)?;
1901
1902        // We store an encoded vector of the dependent requests.
1903        // Reload the previous vector for this room, or create an empty one.
1904        let prev = obj.get(&encoded_key).await?;
1905
1906        let mut prev = prev.map_or_else(
1907            || Ok(Vec::new()),
1908            |val| self.deserialize_value::<Vec<DependentQueuedRequest>>(&val),
1909        )?;
1910
1911        // Modify all requests that match.
1912        let mut num_updated = 0;
1913        for entry in prev.iter_mut().filter(|entry| entry.parent_transaction_id == parent_txn_id) {
1914            entry.parent_key = Some(parent_key.clone());
1915            num_updated += 1;
1916        }
1917
1918        if num_updated > 0 {
1919            obj.put(&self.serialize_value(&prev)?).with_key(encoded_key).build()?;
1920            tx.commit().await?;
1921        }
1922
1923        Ok(num_updated)
1924    }
1925
1926    async fn remove_dependent_queued_request(
1927        &self,
1928        room_id: &RoomId,
1929        txn_id: &ChildTransactionId,
1930    ) -> Result<bool> {
1931        let encoded_key = self.encode_key(keys::DEPENDENT_SEND_QUEUE, room_id);
1932
1933        let tx = self
1934            .inner
1935            .transaction(keys::DEPENDENT_SEND_QUEUE)
1936            .with_mode(TransactionMode::Readwrite)
1937            .build()?;
1938
1939        let obj = tx.object_store(keys::DEPENDENT_SEND_QUEUE)?;
1940
1941        // We store an encoded vector of the dependent requests.
1942        // Reload the previous vector for this room.
1943        if let Some(val) = obj.get(&encoded_key).await? {
1944            let mut prev = self.deserialize_value::<Vec<DependentQueuedRequest>>(&val)?;
1945            if let Some(pos) = prev.iter().position(|item| item.own_transaction_id == *txn_id) {
1946                prev.remove(pos);
1947
1948                if prev.is_empty() {
1949                    obj.delete(&encoded_key).build()?;
1950                } else {
1951                    obj.put(&self.serialize_value(&prev)?).with_key(encoded_key).build()?;
1952                }
1953
1954                tx.commit().await?;
1955                return Ok(true);
1956            }
1957        }
1958
1959        Ok(false)
1960    }
1961
1962    async fn load_dependent_queued_requests(
1963        &self,
1964        room_id: &RoomId,
1965    ) -> Result<Vec<DependentQueuedRequest>> {
1966        let encoded_key = self.encode_key(keys::DEPENDENT_SEND_QUEUE, room_id);
1967
1968        // We store an encoded vector of the dependent requests.
1969        let prev = self
1970            .inner
1971            .transaction(keys::DEPENDENT_SEND_QUEUE)
1972            .with_mode(TransactionMode::Readwrite)
1973            .build()?
1974            .object_store(keys::DEPENDENT_SEND_QUEUE)?
1975            .get(&encoded_key)
1976            .await?;
1977
1978        prev.map_or_else(
1979            || Ok(Vec::new()),
1980            |val| self.deserialize_value::<Vec<DependentQueuedRequest>>(&val),
1981        )
1982    }
1983
1984    async fn upsert_thread_subscriptions(
1985        &self,
1986        updates: Vec<(&RoomId, &EventId, StoredThreadSubscription)>,
1987    ) -> Result<()> {
1988        let tx = self
1989            .inner
1990            .transaction(keys::THREAD_SUBSCRIPTIONS)
1991            .with_mode(TransactionMode::Readwrite)
1992            .build()?;
1993        let obj = tx.object_store(keys::THREAD_SUBSCRIPTIONS)?;
1994
1995        for (room_id, thread_id, subscription) in updates {
1996            let encoded_key = self.encode_key(keys::THREAD_SUBSCRIPTIONS, (room_id, thread_id));
1997            let mut new = PersistedThreadSubscription::from(subscription);
1998
1999            // See if there's a previous subscription.
2000            if let Some(previous_value) = obj.get(&encoded_key).await? {
2001                let previous: PersistedThreadSubscription =
2002                    self.deserialize_value(&previous_value)?;
2003
2004                // If the previous status is the same as the new one, don't do anything.
2005                if new == previous {
2006                    continue;
2007                }
2008                if !compare_thread_subscription_bump_stamps(
2009                    previous.bump_stamp,
2010                    &mut new.bump_stamp,
2011                ) {
2012                    continue;
2013                }
2014            }
2015
2016            let serialized_value = self.serialize_value(&new);
2017            obj.put(&serialized_value?).with_key(encoded_key).build()?;
2018        }
2019
2020        tx.commit().await?;
2021
2022        Ok(())
2023    }
2024
2025    async fn load_thread_subscription(
2026        &self,
2027        room: &RoomId,
2028        thread_id: &EventId,
2029    ) -> Result<Option<StoredThreadSubscription>> {
2030        let encoded_key = self.encode_key(keys::THREAD_SUBSCRIPTIONS, (room, thread_id));
2031
2032        let js_value = self
2033            .inner
2034            .transaction(keys::THREAD_SUBSCRIPTIONS)
2035            .with_mode(TransactionMode::Readonly)
2036            .build()?
2037            .object_store(keys::THREAD_SUBSCRIPTIONS)?
2038            .get(&encoded_key)
2039            .await?;
2040
2041        let Some(js_value) = js_value else {
2042            // We didn't have a previous subscription for this thread.
2043            return Ok(None);
2044        };
2045
2046        let sub: PersistedThreadSubscription = self.deserialize_value(&js_value)?;
2047
2048        let status = ThreadSubscriptionStatus::from_str(&sub.status).map_err(|_| {
2049            StoreError::InvalidData {
2050                details: format!(
2051                    "invalid thread status for room {room} and thread {thread_id}: {}",
2052                    sub.status
2053                ),
2054            }
2055        })?;
2056
2057        Ok(Some(StoredThreadSubscription { status, bump_stamp: sub.bump_stamp }))
2058    }
2059
2060    async fn remove_thread_subscription(&self, room: &RoomId, thread_id: &EventId) -> Result<()> {
2061        let encoded_key = self.encode_key(keys::THREAD_SUBSCRIPTIONS, (room, thread_id));
2062
2063        let transaction = self
2064            .inner
2065            .transaction(keys::THREAD_SUBSCRIPTIONS)
2066            .with_mode(TransactionMode::Readwrite)
2067            .build()?;
2068        transaction.object_store(keys::THREAD_SUBSCRIPTIONS)?.delete(&encoded_key).await?;
2069        transaction.commit().await?;
2070
2071        Ok(())
2072    }
2073
2074    async fn get_global_profile(&self, user_id: &UserId) -> Result<Option<UserProfile>> {
2075        let transaction = self
2076            .inner
2077            .transaction(keys::GLOBAL_PROFILES)
2078            .with_mode(TransactionMode::Readonly)
2079            .build()?;
2080        let store = transaction.object_store(keys::GLOBAL_PROFILES)?;
2081        let key = self.encode_key(keys::GLOBAL_PROFILES, user_id);
2082
2083        store.get(&key).await?.map(|f| self.deserialize_value(&f)).transpose()
2084    }
2085
2086    async fn get_global_profiles<'a>(
2087        &self,
2088        user_ids: &'a [OwnedUserId],
2089    ) -> Result<BTreeMap<&'a UserId, UserProfile>> {
2090        let transaction = self
2091            .inner
2092            .transaction(keys::GLOBAL_PROFILES)
2093            .with_mode(TransactionMode::Readonly)
2094            .build()?;
2095        let store = transaction.object_store(keys::GLOBAL_PROFILES)?;
2096
2097        let mut profiles = BTreeMap::new();
2098        for user_id in user_ids {
2099            let key = self.encode_key(keys::GLOBAL_PROFILES, user_id);
2100            if let Some(value) = store.get(&key).await? {
2101                profiles.insert(user_id.as_ref(), self.deserialize_value(&value)?);
2102            }
2103        }
2104
2105        Ok(profiles)
2106    }
2107
2108    #[allow(clippy::unused_async)]
2109    async fn optimize(&self) -> Result<()> {
2110        Ok(())
2111    }
2112
2113    #[allow(clippy::unused_async)]
2114    async fn get_size(&self) -> Result<Option<usize>> {
2115        Ok(None)
2116    }
2117
2118    #[allow(clippy::unused_async)]
2119    async fn close(&self) -> Result<()> {
2120        Ok(())
2121    }
2122
2123    #[allow(clippy::unused_async)]
2124    async fn reopen(&self) -> Result<()> {
2125        Ok(())
2126    }
2127});
2128
2129/// A room member.
2130#[derive(Debug, Serialize, Deserialize)]
2131struct RoomMember {
2132    user_id: OwnedUserId,
2133    membership: MembershipState,
2134}
2135
2136impl From<&SyncStateEvent<RoomMemberEventContent>> for RoomMember {
2137    fn from(event: &SyncStateEvent<RoomMemberEventContent>) -> Self {
2138        Self { user_id: event.state_key().clone(), membership: event.membership().clone() }
2139    }
2140}
2141
2142impl From<&StrippedRoomMemberEvent> for RoomMember {
2143    fn from(event: &StrippedRoomMemberEvent) -> Self {
2144        Self { user_id: event.state_key.clone(), membership: event.content.membership.clone() }
2145    }
2146}
2147
2148#[cfg(test)]
2149mod migration_tests {
2150    use assert_matches2::assert_matches;
2151    use matrix_sdk_base::store::{QueuedRequestKind, SerializableEventContent};
2152    use ruma::{
2153        OwnedRoomId, OwnedTransactionId, TransactionId,
2154        events::room::message::RoomMessageEventContent, room_id,
2155    };
2156    use serde::{Deserialize, Serialize};
2157
2158    use crate::state_store::PersistedQueuedRequest;
2159
2160    #[derive(Serialize, Deserialize)]
2161    struct OldPersistedQueuedRequest {
2162        room_id: OwnedRoomId,
2163        event: SerializableEventContent,
2164        transaction_id: OwnedTransactionId,
2165        is_wedged: bool,
2166    }
2167
2168    // We now persist an error when an event failed to send instead of just a
2169    // boolean. To support that, `PersistedQueueEvent` changed a bool to
2170    // Option<bool>, ensures that this work properly.
2171    #[test]
2172    fn test_migrating_persisted_queue_event_serialization() {
2173        let room_a_id = room_id!("!room_a:dummy.local");
2174        let transaction_id = TransactionId::new();
2175        let content =
2176            SerializableEventContent::new(&RoomMessageEventContent::text_plain("Hello").into())
2177                .unwrap();
2178
2179        let old_persisted_queue_event = OldPersistedQueuedRequest {
2180            room_id: room_a_id.to_owned(),
2181            event: content,
2182            transaction_id: transaction_id.clone(),
2183            is_wedged: true,
2184        };
2185
2186        let serialized_persisted = serde_json::to_vec(&old_persisted_queue_event).unwrap();
2187
2188        // Load it with the new version.
2189        let new_persisted: PersistedQueuedRequest =
2190            serde_json::from_slice(&serialized_persisted).unwrap();
2191
2192        assert_eq!(new_persisted.is_wedged, Some(true));
2193        assert!(new_persisted.error.is_none());
2194
2195        assert!(new_persisted.event.is_some());
2196        assert!(new_persisted.kind.is_none());
2197
2198        let queued = new_persisted.into_queued_request().unwrap();
2199        assert_matches!(queued.kind, QueuedRequestKind::Event { .. });
2200        assert_eq!(queued.transaction_id, transaction_id);
2201        assert!(queued.error.is_some());
2202    }
2203}
2204
2205#[cfg(all(test, target_family = "wasm"))]
2206mod tests {
2207    #[cfg(target_family = "wasm")]
2208    wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
2209
2210    use matrix_sdk_base::statestore_integration_tests;
2211    use uuid::Uuid;
2212
2213    use super::{IndexeddbStateStore, Result};
2214
2215    async fn get_store() -> Result<IndexeddbStateStore> {
2216        let db_name = format!("test-state-plain-{}", Uuid::new_v4().as_hyphenated());
2217        Ok(IndexeddbStateStore::builder().name(db_name).build().await?)
2218    }
2219
2220    statestore_integration_tests!();
2221}
2222
2223#[cfg(all(test, target_family = "wasm"))]
2224mod encrypted_tests {
2225    #[cfg(target_family = "wasm")]
2226    wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
2227
2228    use matrix_sdk_base::statestore_integration_tests;
2229    use uuid::Uuid;
2230
2231    use super::{IndexeddbStateStore, Result};
2232
2233    async fn get_store() -> Result<IndexeddbStateStore> {
2234        let db_name = format!("test-state-encrypted-{}", Uuid::new_v4().as_hyphenated());
2235        let passphrase = format!("some_passphrase-{}", Uuid::new_v4().as_hyphenated());
2236        Ok(IndexeddbStateStore::builder().name(db_name).passphrase(passphrase).build().await?)
2237    }
2238
2239    statestore_integration_tests!();
2240}