macltok

mod support;

use std::{sync::Arc, time::Duration};

use macltok::{

    AttachmentUpload, ClientHandle, Engine, EngineConfig, EngineError, ErrorKind, Event,

    EventStream, MediaFile, MediaId, MediaLocation, MediaSize, RichText, UploadDetails,

    UploadOutcome, UploadThumbnail,

};

use matrix_sdk::{

    media::{MediaFormat, MediaRequestParameters},

    ruma::{

        api::client::sync::sync_events::v5,

        event_id,

        events::room::{

            EncryptedFile, MediaSource,

            message::{

                AudioMessageEventContent, FileInfo, FileMessageEventContent,

                ImageMessageEventContent, MessageType, RoomMessageEventContent,

                VideoMessageEventContent,

            },

        },

        media::Method,

        mxc_uri, room_id,

    },

    test_utils::mocks::MatrixMockServer,

};

use matrix_sdk_test::{ALICE, JoinedRoomBuilder, event_factory::EventFactory};

use serde_json::{Value, json};

use wiremock::{

    Mock, ResponseTemplate,

    matchers::{method, path_regex},

};

struct MediaHarness {

    server: MatrixMockServer,

    client: matrix_sdk::Client,

    handle: ClientHandle,

    events: EventStream,

    running: tokio::task::JoinHandle<Result<macltok::Termination, EngineError>>,

    media_id: MediaId,

}

#[tokio::test]

async fn full_size_uses_full_source() {

    let mut harness = start(file_with_thumbnail()).await;

    mount_downloads(&harness.server).await;

    let bytes = fetch(&harness, MediaSize::Full).await;

    assert_eq!(&*bytes, b"binaryjpegfullimagedata");

    assert!(

        media_paths(&harness.server)

            .await

            .iter()

            .any(|path| path.ends_with("/localhost/full"))

    );

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn encrypted_media_is_cached_as_plaintext_like_the_sdk_does() {

    use std::io::Read as _;

    let plaintext = b"very secret image".to_vec();

    let mut cursor = std::io::Cursor::new(plaintext.clone());

    let mut encryptor = matrix_sdk_crypto::AttachmentEncryptor::new(&mut cursor);

    let mut ciphertext = Vec::new();

    encryptor.read_to_end(&mut ciphertext).unwrap();

    let keys = encryptor.finish();

    let file = EncryptedFile::new(

        mxc_uri!("mxc://localhost/secret").to_owned(),

        keys.encryption_info,

        keys.hashes,

    );

    let source = MediaSource::Encrypted(Box::new(file.clone()));

    let mut harness = start(RoomMessageEventContent::new(MessageType::Image(

        ImageMessageEventContent::encrypted("secret.png".to_owned(), file),

    )))

    .await;

    Mock::given(method("GET"))

        .and(path_regex("/download/localhost/secret$"))

        .respond_with(ResponseTemplate::new(200).set_body_bytes(ciphertext))

        .mount(harness.server.server())

        .await;

    let from_sdk = harness

        .client

        .media()

        .get_media_content(

            &MediaRequestParameters {

                source,

                format: MediaFormat::File,

            },

            true,

        )

        .await

        .unwrap();

    assert_eq!(from_sdk, plaintext);

    assert_eq!(&*fetch(&harness, MediaSize::Full).await, &plaintext[..]);

    assert_eq!(media_paths(&harness.server).await.len(), 1);

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn a_plain_event_cannot_poison_an_encrypted_files_cache() {

    use std::io::Read as _;

    let plaintext = b"very secret image".to_vec();

    let mut cursor = std::io::Cursor::new(plaintext.clone());

    let mut encryptor = matrix_sdk_crypto::AttachmentEncryptor::new(&mut cursor);

    let mut ciphertext = Vec::new();

    encryptor.read_to_end(&mut ciphertext).unwrap();

    let keys = encryptor.finish();

    let uri = mxc_uri!("mxc://localhost/secret").to_owned();

    let file = EncryptedFile::new(uri.clone(), keys.encryption_info, keys.hashes);

    let mut harness = start(RoomMessageEventContent::new(MessageType::Image(

        ImageMessageEventContent::plain("bait.png".to_owned(), uri),

    )))

    .await;

    Mock::given(method("GET"))

        .and(path_regex("/download/localhost/secret$"))

        .respond_with(ResponseTemplate::new(200).set_body_bytes(ciphertext.clone()))

        .mount(harness.server.server())

        .await;

    assert_eq!(&*fetch(&harness, MediaSize::Full).await, &ciphertext[..]);

    harness

        .server

        .sync_room(

            &harness.client,

            JoinedRoomBuilder::new(room_id!("!media:localhost")).add_timeline_event(

                EventFactory::new()

                    .event(RoomMessageEventContent::new(MessageType::Image(

                        ImageMessageEventContent::encrypted("secret.png".to_owned(), file),

                    )))

                    .sender(&ALICE),

            ),

        )

        .await;

    let event = support::receive_until(&mut harness.events, |event| {

        support::event_messages(event).into_iter().any(|message| {

            support::media_of(message).is_some_and(|media| media.filename == "secret.png")

        })

    })

    .await;

    let media_id = support::event_messages(&event)

        .into_iter()

        .find_map(|message| {

            support::media_of(message).filter(|media| media.filename == "secret.png")

        })

        .map(|media| media.id.clone())

        .unwrap();

    let media = harness

        .handle

        .media(&media_id, MediaSize::Full)

        .await

        .unwrap();

    assert_eq!(&*media.bytes, &plaintext[..]);

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn simultaneous_fetches_share_one_download() {

    let mut harness = start(plain_image()).await;

    Mock::given(method("GET"))

        .and(path_regex("/download/localhost/image$"))

        .respond_with(

            ResponseTemplate::new(200)

                .set_body_bytes(b"shared image bytes".to_vec())

                .set_delay(Duration::from_millis(300)),

        )

        .mount(harness.server.server())

        .await;

    let (first, second) = tokio::time::timeout(Duration::from_secs(5), async {

        tokio::join!(

            harness.handle.media(&harness.media_id, MediaSize::Full),

            harness.handle.media(&harness.media_id, MediaSize::Full),

        )

    })

    .await

    .expect("both fetches did not complete");

    assert_eq!(&*first.unwrap().bytes, b"shared image bytes");

    assert_eq!(&*second.unwrap().bytes, b"shared image bytes");

    let downloads = harness

        .server

        .received_requests()

        .await

        .unwrap()

        .iter()

        .filter(|request| request.url.path().ends_with("/download/localhost/image"))

        .count();

    assert_eq!(downloads, 1, "duplicate in-flight media download");

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn downloaded_media_over_limit_is_rejected() {

    let mut harness = start_with_config(

        plain_image(),

        EngineConfig::default()

            .with_initial_history_limit(0)

            .with_max_media_bytes(4),

    )

    .await;

    Mock::given(method("GET"))

        .and(path_regex("/download/localhost/image$"))

        .respond_with(ResponseTemplate::new(200).set_body_bytes(b"too large".to_vec()))

        .mount(harness.server.server())

        .await;

    let error = harness

        .handle

        .media(&harness.media_id, MediaSize::Full)

        .await

        .unwrap_err();

    assert_eq!(error.kind, ErrorKind::MediaTooLarge);

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn thumbnail_size_prefers_explicit_thumbnail() {

    let mut harness = start(file_with_thumbnail()).await;

    mount_downloads(&harness.server).await;

    let bytes = fetch(&harness, thumbnail_size()).await;

    assert_eq!(&*bytes, b"binaryjpegfullimagedata");

    let paths = media_paths(&harness.server).await;

    assert!(

        paths

            .iter()

            .any(|path| path.ends_with("/localhost/explicit-thumbnail"))

    );

    assert!(!paths.iter().any(|path| path.ends_with("/localhost/full")));

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn plain_image_thumbnail_uses_thumbnail_endpoint() {

    let mut harness = start(plain_image()).await;

    harness

        .server

        .mock_media_thumbnail(Method::Scale, 800, 800, false)

        .ok()

        .mount()

        .await;

    harness

        .server

        .mock_authed_media_thumbnail(Method::Scale, 800, 800, false)

        .ok()

        .mount()

        .await;

    let bytes = fetch(&harness, thumbnail_size()).await;

    assert_eq!(&*bytes, b"binaryjpegthumbnaildata");

    assert!(

        media_paths(&harness.server)

            .await

            .iter()

            .any(|path| path.contains("/thumbnail/localhost/image"))

    );

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn audio_thumbnail_fetch_fails_with_media_unavailable() {

    let mut harness = start(plain_audio()).await;

    let error = harness

        .handle

        .media(&harness.media_id, thumbnail_size())

        .await

        .unwrap_err();

    assert_eq!(error.kind, ErrorKind::MediaUnavailable);

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn media_source_locates_what_media_would_fetch() {

    let keys =

        matrix_sdk_crypto::AttachmentEncryptor::new(&mut std::io::Cursor::new(b"secret")).finish();

    let file = EncryptedFile::new(

        mxc_uri!("mxc://localhost/secret").to_owned(),

        keys.encryption_info,

        keys.hashes,

    );

    let wire = serde_json::to_value(&file).unwrap();

    let mut harness = start(RoomMessageEventContent::new(MessageType::File(

        FileMessageEventContent::encrypted("secret.bin".to_owned(), file),

    )))

    .await;

    let MediaLocation::File(MediaFile {

        url,

        encryption: Some(encryption),

        ..

    }) = harness

        .handle

        .media_source(&harness.media_id, MediaSize::Full)

        .await

        .unwrap()

    else {

        panic!("an encrypted file should locate as one");

    };

    assert_eq!(

        url,

        format!(

            "{}/_matrix/client/v1/media/download/localhost/secret",

            harness.server.uri()

        )

    );

    assert_eq!(encryption.key, wire["key"]["k"]);

    assert_eq!(encryption.iv, wire["iv"]);

    assert_eq!(encryption.sha256, wire["hashes"]["sha256"]);

    let video = sync_media(

        &mut harness,

        "video.mp4",

        RoomMessageEventContent::new(MessageType::Video(VideoMessageEventContent::plain(

            "video.mp4".to_owned(),

            mxc_uri!("mxc://localhost/video").to_owned(),

        ))),

    )

    .await;

    let MediaLocation::ServerThumbnail { url, fallback } = harness

        .handle

        .media_source(&video, thumbnail_size())

        .await

        .unwrap()

    else {

        panic!("a video with no thumbnail of its own should ask the server for one");

    };

    let url = matrix_sdk::reqwest::Url::parse(&url).unwrap();

    assert_eq!(

        url.path(),

        "/_matrix/client/v1/media/thumbnail/localhost/video"

    );

    let query: Vec<_> = url.query_pairs().into_owned().collect();

    for pair in [("width", "800"), ("height", "800"), ("method", "scale")] {

        assert!(query.contains(&(pair.0.to_owned(), pair.1.to_owned())));

    }

    assert_eq!(

        MediaLocation::File(fallback),

        harness

            .handle

            .media_source(&video, MediaSize::Full)

            .await

            .unwrap()

    );

    let error = harness

        .handle

        .media_source(&MediaId::from("made up".to_owned()), MediaSize::Full)

        .await

        .unwrap_err();

    assert_eq!(error.kind, ErrorKind::MediaUnknown);

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn media_upload_is_queued_and_sent() {

    let mut harness = start(plain_image()).await;

    harness

        .server

        .mock_authenticated_media_config()

        .ok_default()

        .mount()

        .await;

    harness

        .server

        .mock_upload()

        .expect_mime_type("image/jpeg")

        .ok(mxc_uri!("mxc://localhost/uploaded"))

        .expect(1)

        .mount()

        .await;

    harness

        .server

        .mock_room_send()

        .ok(event_id!("$uploaded:localhost"))

        .expect(1)

        .mount()

        .await;

    let mut upload = AttachmentUpload::new(

        room_id!("!media:localhost").to_owned(),

        "photo.jpg",

        "image/jpeg",

        b"photo data".to_vec(),

    );

    upload.caption = Some(RichText::plain("holiday"));

    harness.handle.upload(upload).await.unwrap();

    tokio::time::timeout(Duration::from_secs(5), async {

        loop {

            let requests = harness.server.received_requests().await.unwrap();

            if requests.iter().any(|request| {

                request.url.path().contains("/send/m.room.message/")

                    && String::from_utf8_lossy(&request.body).contains("mxc://localhost/uploaded")

            }) {

                break;

            }

            tokio::task::yield_now().await;

        }

    })

    .await

    .expect("queued media was not sent");

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn queued_offline_attachment_exposes_fetchable_local_media() {

    let mut harness = start(plain_image()).await;

    harness.client.send_queue().set_enabled(false).await;

    let original = b"offline image bytes".to_vec();

    let mut upload = AttachmentUpload::new(

        room_id!("!media:localhost").to_owned(),

        "pending.png",

        "image/png",

        original.clone(),

    );

    upload.details = Some(UploadDetails::Image {

        width: Some(32),

        height: Some(16),

        blurhash: None,

    });

    harness.handle.upload(upload).await.unwrap();

    let event = support::receive_until(&mut harness.events, |event| {

        support::event_messages(event).into_iter().any(|event| {

            event.own

                && event.transaction_id.is_some()

                && support::media_of(event).is_some_and(|media| media.filename == "pending.png")

        })

    })

    .await;

    let media = support::event_messages(&event)

        .into_iter()

        .find(|event| event.own && support::media_of(event).is_some())

        .and_then(support::media_of)

        .unwrap();

    assert_eq!((media.width, media.height), (Some(32), Some(16)));

    assert_eq!(media.size_bytes, Some(original.len() as u64));

    let media_id = media.id.clone();

    let fetched = harness

        .handle

        .media(&media_id, MediaSize::Full)

        .await

        .unwrap();

    assert_eq!(&*fetched.bytes, &original[..]);

    assert_eq!(

        harness

            .handle

            .media_source(&media_id, MediaSize::Full)

            .await

            .unwrap(),

        MediaLocation::Local

    );

    support::shut_down(&harness.handle, &mut harness.events, harness.running).await;

}

#[tokio::test]

async fn image_upload_uses_caller_supplied_metadata_and_thumbnail() {