refactor(indexeddb): add migrations and types for media source index

Signed-off-by: Michael Goldenberg <[email protected]>

Author: mgoldenberg

crates/matrix-sdk-indexeddb/src/event_cache_store/migrations.rs

@@ -133,6 +133,8 @@ pub mod v1 {
         pub const MEDIA_RETENTION_POLICY_KEY: &str = "media_retention_policy";
         pub const MEDIA: &str = "media";
         pub const MEDIA_KEY_PATH: &str = "id";
+        pub const MEDIA_SOURCE: &str = "media_source";
+        pub const MEDIA_SOURCE_KEY_PATH: &str = "source";
         pub const MEDIA_CONTENT_SIZE: &str = "media_content_size";
         pub const MEDIA_CONTENT_SIZE_KEY_PATH: &str = "content_size";
     }
@@ -227,14 +229,18 @@ pub mod v1 {
     /// Create an object store for tracking information about media.
     ///
     /// * Primary Key - `id`
+    /// * Index - `source` - tracks the [`MediaSource`][1] of the associated
+    ///   media
     /// * Index - `content_size` - tracks the size of the media content and
-    ///   whether to ignore the [`MediaRetentionPolicy`][1]
+    ///   whether to ignore the [`MediaRetentionPolicy`][2]
     ///
-    /// [1]: matrix_sdk_base::event_cache::store::media::MediaRetentionPolicy
+    /// [1]: ruma::events::room::MediaSource
+    /// [2]: matrix_sdk_base::event_cache::store::media::MediaRetentionPolicy
     fn create_media_object_store(db: &IdbDatabase) -> Result<(), DomException> {
         let mut object_store_params = IdbObjectStoreParameters::new();
         object_store_params.key_path(Some(&keys::MEDIA_KEY_PATH.into()));
         let media = db.create_object_store_with_params(keys::MEDIA, &object_store_params)?;
+        media.create_index(keys::MEDIA_SOURCE, &keys::MEDIA_SOURCE_KEY_PATH.into())?;
         media.create_index(keys::MEDIA_CONTENT_SIZE, &keys::MEDIA_CONTENT_SIZE_KEY_PATH.into())?;
         Ok(())
     }

crates/matrix-sdk-indexeddb/src/event_cache_store/serializer/types.rs

@@ -35,7 +35,10 @@ use matrix_sdk_base::{
     media::{MediaRequestParameters, UniqueKey},
 };
 use matrix_sdk_crypto::CryptoStoreError;
-use ruma::{events::relation::RelationType, EventId, OwnedEventId, RoomId};
+use ruma::{
+    events::{relation::RelationType, room::MediaSource},
+    EventId, OwnedEventId, RoomId,
+};
 use serde::{Deserialize, Serialize};
 use thiserror::Error;
 
@@ -907,6 +910,9 @@ impl IndexedKey<MediaRetentionPolicy> for IndexedCoreIdKey {
 pub struct IndexedMedia {
     /// The primary key of the object store
     pub id: IndexedMediaIdKey,
+    /// The (possibly) hashed source of the media derived from
+    /// [`MediaSource::unique_key`]
+    pub source: IndexedMediaSourceKey,
     /// The size (in bytes) of the media content and whether to ignore the
     /// [`MediaRetentionPolicy`]
     pub content_size: IndexedMediaContentSizeKey,
@@ -944,6 +950,10 @@ impl Indexed for Media {
                 &self.metadata.request_parameters,
                 serializer,
             ),
+            source: <IndexedMediaSourceKey as IndexedKey<Self>>::encode(
+                &self.metadata.request_parameters.source,
+                serializer,
+            ),
             content_size: IndexedMediaContentSizeKey::encode(
                 (self.metadata.ignore_policy, content.len()),
                 serializer,
@@ -981,6 +991,23 @@ impl IndexedKey<Media> for IndexedMediaIdKey {
     }
 }
 
+/// The value associated with the [`source`](IndexedMedia::source) index of the
+/// [`MEDIA`][1] object store, which is constructed from:
+///
+/// - The (possibly) hashed value returned by [`MediaSource::unique_key`]
+///
+/// [1]: crate::event_cache_store::migrations::v1::create_media_object_store
+#[derive(Debug, Serialize, Deserialize)]
+pub struct IndexedMediaSourceKey(String);
+
+impl IndexedKey<Media> for IndexedMediaSourceKey {
+    type KeyComponents<'a> = &'a MediaSource;
+
+    fn encode(components: Self::KeyComponents<'_>, serializer: &IndexeddbSerializer) -> Self {
+        Self(serializer.encode_key_as_string(keys::MEDIA_SOURCE, components.unique_key()))
+    }
+}
+
 /// The value associated with the [`content_size`](IndexedMedia::content_size)
 /// index of the [`MEDIA`][1] object store, which is constructed from:
 ///