galaxy/app/src/drive/export_tests.rs

use std::collections::HashMap;
use std::fs;
use std::path::{Path, PathBuf};
use std::sync::Arc;

use futures::channel::oneshot;
use galaxy_util::path::ShellFamily;
use galaxyui::{AddSingletonModel, App, SingletonEntity, WindowId};
use parking_lot::Mutex;
use tempfile::TempDir;

use super::{safe_filename, ExportEvent, ExportId, ExportManager};
use crate::cloud_object::model::persistence::CloudModel;
use crate::cloud_object::{
    CloudObjectMetadata, CloudObjectPermissions, ObjectIdType, ObjectType, Space,
};
use crate::drive::CloudObjectTypeAndId;
use crate::notebooks::{CloudNotebook, CloudNotebookModel, NotebookId};
use crate::server::ids::SyncId;
use crate::workflows::workflow::Workflow;
use crate::workflows::{CloudWorkflow, CloudWorkflowModel, WorkflowId};
use crate::workspace::ToastStack;
use crate::workspaces::user_workspaces::UserWorkspaces;

struct ExportTest {
    target_dir: TempDir,
    pending_exports: Arc<Mutex<HashMap<ExportId, oneshot::Sender<ExportEvent>>>>,
}

impl ExportTest {
    fn new(app: &mut App) -> Self {
        let pending_exports = Arc::new(Mutex::new(
            HashMap::<ExportId, oneshot::Sender<ExportEvent>>::new(),
        ));

        {
            let pending_exports = pending_exports.clone();
            app.update(|ctx| {
                ctx.subscribe_to_model(&ExportManager::handle(ctx), move |_, event, _| {
                    let mut pending_exports = pending_exports.lock();
                    let id = match event {
                        ExportEvent::Canceled(id) => id,
                        ExportEvent::Failed { id, .. } => id,
                        ExportEvent::Completed { id, .. } => id,
                    };
                    if let Some(sender) = pending_exports.remove(id) {
                        let _ = sender.send(event.clone());
                    }
                });
            });
        }

        Self {
            target_dir: TempDir::new().expect("failed to create temporary export directory"),
            pending_exports,
        }
    }

    /// Starts exporting an object into the temporary directory.
    fn start_export(
        &self,
        export_ids: CloudObjectTypeAndId,
        app: &mut App,
    ) -> (ExportId, oneshot::Receiver<ExportEvent>) {
        let id = ExportId(export_ids, Space::Personal);
        let (tx, rx) = oneshot::channel();
        self.pending_exports.lock().insert(id, tx);

        ExportManager::handle(app).update(app, |export_manager, ctx| {
            let window_id = WindowId::new();
            export_manager.export(window_id, &[export_ids], ctx);
            export_manager.handle_files_picked(
                vec![id],
                Ok(vec![self
                    .target_dir
                    .path()
                    .to_str()
                    .expect("Path must be UTF-8")
                    .to_owned()]),
                ShellFamily::Posix,
                ctx,
            );
            id
        });

        (id, rx)
    }

    /// Get an export path, given the expected name.
    fn path(&self, name: impl AsRef<Path>, space: Option<Space>, app: &App) -> PathBuf {
        if let Some(space) = space {
            let space_name = app.read(|ctx| space.name(ctx));
            self.target_dir.path().join(space_name).join(name)
        } else {
            self.target_dir.path().join(name)
        }
    }
}

fn initialize_app(app: &mut App) {
    app.add_singleton_model(CloudModel::mock);
    app.add_singleton_model(ExportManager::new);
    app.add_singleton_model(UserWorkspaces::default_mock);
    app.add_singleton_model(|_| ToastStack);
}

/// Add a mocked workflow.
fn add_workflow(id: SyncId, workflow: Workflow, app: &mut App) {
    CloudModel::handle(app).update(app, |cloud_model, _ctx| {
        cloud_model.add_object(
            id,
            CloudWorkflow::new(
                id,
                CloudWorkflowModel::new(workflow),
                CloudObjectMetadata::mock(),
                CloudObjectPermissions::mock_personal(),
            ),
        );
    });
}

/// Add a mocked notebook.
fn add_notebook(id: SyncId, title: impl Into<String>, data: impl Into<String>, app: &mut App) {
    CloudModel::handle(app).update(app, |cloud_model, _ctx| {
        cloud_model.add_object(
            id,
            CloudNotebook::new(
                id,
                CloudNotebookModel {
                    title: title.into(),
                    data: data.into(),
                    ai_document_id: None,
                    conversation_id: None,
                },
                CloudObjectMetadata::mock(),
                CloudObjectPermissions::mock_personal(),
            ),
        );
    });
}

#[test]
fn test_export_workflow_success() {
    App::test((), |mut app| async move {
        initialize_app(&mut app);

        let workflow_id = SyncId::ServerId(WorkflowId::from(123).into());
        let workflow = Workflow::new("Test workflow", "echo hello world");
        add_workflow(workflow_id, workflow, &mut app);

        let exporter = ExportTest::new(&mut app);
        let (id, export) = exporter.start_export(
            CloudObjectTypeAndId::from_id_and_type(workflow_id, ObjectType::Workflow),
            &mut app,
        );
        let expected_path = exporter.path("Test workflow.yaml", None, &app);

        // The export should succeed.
        assert_eq!(
            export.await,
            Ok(ExportEvent::Completed {
                id,
                path: expected_path.clone()
            })
        );

        let contents =
            fs::read_to_string(&expected_path).expect("failed to read exported workflow");
        assert_eq!(
            &contents,
            r#"---
name: Test workflow
command: echo hello world
description: ~
arguments: []
tags: []
source_url: ~
author: ~
author_url: ~
shells: []
"#
        );
    });
}

#[test]
fn test_export_workflow_duplicate() {
    App::test((), |mut app| async move {
        initialize_app(&mut app);

        let workflow_id = SyncId::ServerId(WorkflowId::from(123).into());
        let workflow = Workflow::new("Test workflow", "echo hello world");
        add_workflow(workflow_id, workflow, &mut app);

        let exporter = ExportTest::new(&mut app);

        // Create a file at the default export path.
        fs::write(
            exporter.path("Test workflow.yaml", None, &app),
            "Already exists",
        )
        .expect("failed to write existing workflow");

        let (id, export) = exporter.start_export(
            CloudObjectTypeAndId::from_id_and_type(workflow_id, ObjectType::Workflow),
            &mut app,
        );
        let expected_path = exporter.path("Test workflow (1).yaml", None, &app);

        // The export should succeed, and not overwrite the existing file.
        assert_eq!(
            export.await,
            Ok(ExportEvent::Completed {
                id,
                path: expected_path.clone()
            })
        );

        assert_eq!(
            fs::read_to_string(exporter.path("Test workflow.yaml", None, &app))
                .expect("failed to read original file"),
            "Already exists"
        );

        let contents =
            fs::read_to_string(&expected_path).expect("failed to read exported workflow");
        assert_eq!(
            &contents,
            r#"---
name: Test workflow
command: echo hello world
description: ~
arguments: []
tags: []
source_url: ~
author: ~
author_url: ~
shells: []
"#
        );
    });
}

#[test]
fn test_export_workflow_failure() {
    App::test((), |mut app| async move {
        initialize_app(&mut app);

        let workflow_id = SyncId::ServerId(WorkflowId::from(123).into());
        let workflow = Workflow::new("Test workflow", "echo hello world");
        add_workflow(workflow_id, workflow, &mut app);

        let exporter = ExportTest::new(&mut app);
        // Ensure that the export will fail.
        fs::remove_dir_all(exporter.target_dir.path()).expect("Could not remove test directory");

        let (id, export) = exporter.start_export(
            CloudObjectTypeAndId::from_id_and_type(workflow_id, ObjectType::Workflow),
            &mut app,
        );

        // The export should error.
        assert_eq!(export.await, Ok(ExportEvent::Failed { id }));
    });
}

#[test]
fn test_export_notebook_with_embeds() {
    App::test((), |mut app| async move {
        initialize_app(&mut app);

        let workflow_id = SyncId::ServerId(WorkflowId::from(123).into());
        let workflow = Workflow::new("Test workflow", "echo hello world");
        add_workflow(workflow_id, workflow, &mut app);

        let notebook_id = SyncId::ServerId(NotebookId::from(456).into());
        add_notebook(
            notebook_id,
            "Test notebook",
            format!(
                r#"
# This is a notebook
It has *text*.
```warp-embedded-object
id: {}
```

This is code:
```Python
print("hello")
```
"#,
                workflow_id.sqlite_uid_hash(ObjectIdType::Workflow)
            ),
            &mut app,
        );

        let exporter = ExportTest::new(&mut app);
        let (id, export) = exporter.start_export(
            CloudObjectTypeAndId::from_id_and_type(notebook_id, ObjectType::Notebook),
            &mut app,
        );
        let expected_path = exporter.path("Test notebook.md", None, &app);

        // The export should succeed.
        assert_eq!(
            export.await,
            Ok(ExportEvent::Completed {
                id,
                path: expected_path.clone()
            })
        );

        let contents =
            fs::read_to_string(&expected_path).expect("failed to read exported notebook");
        assert_eq!(
            contents,
            r#"
# This is a notebook
It has *text*\.
```warp-embedded-object
---
name: Test workflow
command: echo hello world
tags: []
description: ~
arguments: []
source_url: ~
author: ~
author_url: ~
shells: []
environment_variables: ~
id: Workflow-test_uid00000000000123

```

This is code:
```python
print("hello")
```
"#
        );
    });
}

#[test]
fn test_export_untitled_notebook() {
    App::test((), |mut app| async move {
        initialize_app(&mut app);
        let notebook_id = SyncId::ServerId(NotebookId::from(456).into());
        add_notebook(notebook_id, "", "This is untitled", &mut app);

        let exporter = ExportTest::new(&mut app);
        let (id, export) = exporter.start_export(
            CloudObjectTypeAndId::from_id_and_type(notebook_id, ObjectType::Notebook),
            &mut app,
        );
        let expected_path = exporter.path("Untitled.md", None, &app);

        // The export should succeed.
        assert_eq!(
            export.await,
            Ok(ExportEvent::Completed {
                id,
                path: expected_path.clone()
            })
        );

        let contents =
            fs::read_to_string(&expected_path).expect("failed to read exported notebook");
        assert_eq!(&contents, "This is untitled");
    });
}

#[test]
fn test_export_with_special_characters() {
    App::test((), |mut app| async move {
        initialize_app(&mut app);

        let workflow_id = SyncId::ServerId(WorkflowId::from(123).into());
        let workflow = Workflow::new("Prefix: Some/workflow", "echo hello world");
        add_workflow(workflow_id, workflow, &mut app);

        let exporter = ExportTest::new(&mut app);
        let (id, export) = exporter.start_export(
            CloudObjectTypeAndId::from_id_and_type(workflow_id, ObjectType::Workflow),
            &mut app,
        );
        let expected_path = exporter.path("Prefix_ Some_workflow.yaml", None, &app);

        // The export should succeed, and transform the path.
        assert_eq!(
            export.await,
            Ok(ExportEvent::Completed {
                id,
                path: expected_path.clone()
            })
        );
    });
}

#[test]
fn test_safe_filename() {
    for (expected_in, expected_out) in [
        (
            "allowed $special %characters",
            "allowed $special %characters",
        ),
        ("warp:drive", "warp_drive"),
        ("a/b/c/d:e", "a_b_c_d_e"),
        ("the\0sneaky\0null", "the_sneaky_null"),
        ("ascii\x03control\x1bchars", "ascii_control_chars"),
    ] {
        assert_eq!(safe_filename(expected_in), expected_out);
    }
}

#[test]
fn test_export_multiple_objects() {
    App::test((), |mut app| async move {
        initialize_app(&mut app);

        // Create two workflows and a notebook
        let workflow_id1 = SyncId::ServerId(WorkflowId::from(123).into());
        let workflow1 = Workflow::new("Test workflow 1", "echo hello world");
        add_workflow(workflow_id1, workflow1, &mut app);

        let workflow_id2 = SyncId::ServerId(WorkflowId::from(456).into());
        let workflow2 = Workflow::new("Test workflow 2", "echo goodbye world");
        add_workflow(workflow_id2, workflow2, &mut app);

        let notebook_id = SyncId::ServerId(NotebookId::from(789).into());
        add_notebook(
            notebook_id,
            "Test notebook",
            "This is a test notebook",
            &mut app,
        );

        let exporter = ExportTest::new(&mut app);

        // Prepare export IDs for all three objects
        let export_ids = vec![
            CloudObjectTypeAndId::from_id_and_type(workflow_id1, ObjectType::Workflow),
            CloudObjectTypeAndId::from_id_and_type(workflow_id2, ObjectType::Workflow),
            CloudObjectTypeAndId::from_id_and_type(notebook_id, ObjectType::Notebook),
        ];

        // Create channels for all exports
        let mut receivers = Vec::new();
        {
            let mut pending_exports = exporter.pending_exports.lock();
            for &id in &export_ids {
                let (tx, rx) = oneshot::channel();
                pending_exports.insert(ExportId(id, Space::Personal), tx);
                receivers.push(rx);
            }
        }

        ExportManager::handle(&app).update(&mut app, |export_manager, ctx| {
            let window_id = WindowId::new();
            export_manager.export(window_id, &export_ids, ctx);

            let all_export_ids = export_ids
                .iter()
                .map(|&id| ExportId(id, Space::Personal))
                .collect::<Vec<_>>();
            export_manager.handle_files_picked(
                all_export_ids,
                Ok(vec![exporter
                    .target_dir
                    .path()
                    .to_str()
                    .expect("Path must be UTF-8")
                    .to_owned()]),
                ShellFamily::Posix,
                ctx,
            );
        });

        // Wait for all exports to complete
        for rx in receivers {
            let result = rx.await;
            assert!(
                matches!(result, Ok(ExportEvent::Completed { .. })),
                "Export failed or was canceled"
            );
        }

        // Verify the contents of each exported file
        let workflow1_path = exporter.path("Test workflow 1.yaml", Some(Space::Personal), &app);
        let workflow1_contents =
            fs::read_to_string(&workflow1_path).expect("Failed to read workflow 1");
        assert!(workflow1_contents.contains("echo hello world"));

        let workflow2_path = exporter.path("Test workflow 2.yaml", Some(Space::Personal), &app);
        let workflow2_contents =
            fs::read_to_string(&workflow2_path).expect("Failed to read workflow 2");
        assert!(workflow2_contents.contains("echo goodbye world"));

        let notebook_path = exporter.path("Test notebook.md", Some(Space::Personal), &app);
        let notebook_contents =
            fs::read_to_string(&notebook_path).expect("Failed to read notebook");
        assert!(notebook_contents.contains("This is a test notebook"));

        // Check that all files were created
        assert!(workflow1_path.exists(), "Workflow 1 file does not exist");
        assert!(workflow2_path.exists(), "Workflow 2 file does not exist");
        assert!(notebook_path.exists(), "Notebook file does not exist");
    });
}