oak-gpui/crates/extension/src/extension_store_test.rs

use crate::{
    ExtensionIndex, ExtensionIndexEntry, ExtensionIndexLanguageEntry, ExtensionManifest,
    ExtensionStore, GrammarManifestEntry,
};
use async_compression::futures::bufread::GzipEncoder;
use collections::BTreeMap;
use fs::{FakeFs, Fs};
use futures::{io::BufReader, AsyncReadExt, StreamExt};
use gpui::{Context, TestAppContext};
use language::{
    Language, LanguageConfig, LanguageMatcher, LanguageRegistry, LanguageServerBinaryStatus,
    LanguageServerName,
};
use node_runtime::FakeNodeRuntime;
use project::Project;
use serde_json::json;
use settings::SettingsStore;
use std::{
    ffi::OsString,
    path::{Path, PathBuf},
    sync::Arc,
};
use theme::ThemeRegistry;
use util::http::{FakeHttpClient, Response};

#[gpui::test]
async fn test_extension_store(cx: &mut TestAppContext) {
    cx.update(|cx| {
        let store = SettingsStore::test(cx);
        cx.set_global(store);
        theme::init(theme::LoadThemes::JustBase, cx);
    });

    let fs = FakeFs::new(cx.executor());
    let http_client = FakeHttpClient::with_200_response();

    fs.insert_tree(
        "/the-extension-dir",
        json!({
            "installed": {
                "zed-monokai": {
                    "extension.json": r#"{
                        "id": "zed-monokai",
                        "name": "Zed Monokai",
                        "version": "2.0.0",
                        "themes": {
                            "Monokai Dark": "themes/monokai.json",
                            "Monokai Light": "themes/monokai.json",
                            "Monokai Pro Dark": "themes/monokai-pro.json",
                            "Monokai Pro Light": "themes/monokai-pro.json"
                        }
                    }"#,
                    "themes": {
                        "monokai.json": r#"{
                            "name": "Monokai",
                            "author": "Someone",
                            "themes": [
                                {
                                    "name": "Monokai Dark",
                                    "appearance": "dark",
                                    "style": {}
                                },
                                {
                                    "name": "Monokai Light",
                                    "appearance": "light",
                                    "style": {}
                                }
                            ]
                        }"#,
                        "monokai-pro.json": r#"{
                            "name": "Monokai Pro",
                            "author": "Someone",
                            "themes": [
                                {
                                    "name": "Monokai Pro Dark",
                                    "appearance": "dark",
                                    "style": {}
                                },
                                {
                                    "name": "Monokai Pro Light",
                                    "appearance": "light",
                                    "style": {}
                                }
                            ]
                        }"#,
                    }
                },
                "zed-ruby": {
                    "extension.json": r#"{
                        "id": "zed-ruby",
                        "name": "Zed Ruby",
                        "version": "1.0.0",
                        "grammars": {
                            "ruby": "grammars/ruby.wasm",
                            "embedded_template": "grammars/embedded_template.wasm"
                        },
                        "languages": {
                            "ruby": "languages/ruby",
                            "erb": "languages/erb"
                        }
                    }"#,
                    "grammars": {
                        "ruby.wasm": "",
                        "embedded_template.wasm": "",
                    },
                    "languages": {
                        "ruby": {
                            "config.toml": r#"
                                name = "Ruby"
                                grammar = "ruby"
                                path_suffixes = ["rb"]
                            "#,
                            "highlights.scm": "",
                        },
                        "erb": {
                            "config.toml": r#"
                                name = "ERB"
                                grammar = "embedded_template"
                                path_suffixes = ["erb"]
                            "#,
                            "highlights.scm": "",
                        }
                    },
                }
            }
        }),
    )
    .await;

    let mut expected_index = ExtensionIndex {
        extensions: [
            (
                "zed-ruby".into(),
                ExtensionManifest {
                    id: "zed-ruby".into(),
                    name: "Zed Ruby".into(),
                    version: "1.0.0".into(),
                    description: None,
                    authors: Vec::new(),
                    repository: None,
                    themes: Default::default(),
                    lib: Default::default(),
                    languages: vec!["languages/erb".into(), "languages/ruby".into()],
                    grammars: [
                        ("embedded_template".into(), GrammarManifestEntry::default()),
                        ("ruby".into(), GrammarManifestEntry::default()),
                    ]
                    .into_iter()
                    .collect(),
                    language_servers: BTreeMap::default(),
                }
                .into(),
            ),
            (
                "zed-monokai".into(),
                ExtensionManifest {
                    id: "zed-monokai".into(),
                    name: "Zed Monokai".into(),
                    version: "2.0.0".into(),
                    description: None,
                    authors: vec![],
                    repository: None,
                    themes: vec![
                        "themes/monokai-pro.json".into(),
                        "themes/monokai.json".into(),
                    ],
                    lib: Default::default(),
                    languages: Default::default(),
                    grammars: BTreeMap::default(),
                    language_servers: BTreeMap::default(),
                }
                .into(),
            ),
        ]
        .into_iter()
        .collect(),
        languages: [
            (
                "ERB".into(),
                ExtensionIndexLanguageEntry {
                    extension: "zed-ruby".into(),
                    path: "languages/erb".into(),
                    grammar: Some("embedded_template".into()),
                    matcher: LanguageMatcher {
                        path_suffixes: vec!["erb".into()],
                        first_line_pattern: None,
                    },
                },
            ),
            (
                "Ruby".into(),
                ExtensionIndexLanguageEntry {
                    extension: "zed-ruby".into(),
                    path: "languages/ruby".into(),
                    grammar: Some("ruby".into()),
                    matcher: LanguageMatcher {
                        path_suffixes: vec!["rb".into()],
                        first_line_pattern: None,
                    },
                },
            ),
        ]
        .into_iter()
        .collect(),
        themes: [
            (
                "Monokai Dark".into(),
                ExtensionIndexEntry {
                    extension: "zed-monokai".into(),
                    path: "themes/monokai.json".into(),
                },
            ),
            (
                "Monokai Light".into(),
                ExtensionIndexEntry {
                    extension: "zed-monokai".into(),
                    path: "themes/monokai.json".into(),
                },
            ),
            (
                "Monokai Pro Dark".into(),
                ExtensionIndexEntry {
                    extension: "zed-monokai".into(),
                    path: "themes/monokai-pro.json".into(),
                },
            ),
            (
                "Monokai Pro Light".into(),
                ExtensionIndexEntry {
                    extension: "zed-monokai".into(),
                    path: "themes/monokai-pro.json".into(),
                },
            ),
        ]
        .into_iter()
        .collect(),
    };

    let language_registry = Arc::new(LanguageRegistry::test());
    let theme_registry = Arc::new(ThemeRegistry::new(Box::new(())));
    let node_runtime = FakeNodeRuntime::new();

    let store = cx.new_model(|cx| {
        ExtensionStore::new(
            PathBuf::from("/the-extension-dir"),
            fs.clone(),
            http_client.clone(),
            node_runtime.clone(),
            language_registry.clone(),
            theme_registry.clone(),
            cx,
        )
    });

    cx.executor().run_until_parked();
    store.read_with(cx, |store, _| {
        let index = &store.extension_index;
        assert_eq!(index.extensions, expected_index.extensions);
        assert_eq!(index.languages, expected_index.languages);
        assert_eq!(index.themes, expected_index.themes);

        assert_eq!(
            language_registry.language_names(),
            ["ERB", "Plain Text", "Ruby"]
        );
        assert_eq!(
            theme_registry.list_names(false),
            [
                "Monokai Dark",
                "Monokai Light",
                "Monokai Pro Dark",
                "Monokai Pro Light",
                "One Dark",
            ]
        );
    });

    fs.insert_tree(
        "/the-extension-dir/installed/zed-gruvbox",
        json!({
            "extension.json": r#"{
                "id": "zed-gruvbox",
                "name": "Zed Gruvbox",
                "version": "1.0.0",
                "themes": {
                    "Gruvbox": "themes/gruvbox.json"
                }
            }"#,
            "themes": {
                "gruvbox.json": r#"{
                    "name": "Gruvbox",
                    "author": "Someone Else",
                    "themes": [
                        {
                            "name": "Gruvbox",
                            "appearance": "dark",
                            "style": {}
                        }
                    ]
                }"#,
            }
        }),
    )
    .await;

    expected_index.extensions.insert(
        "zed-gruvbox".into(),
        ExtensionManifest {
            id: "zed-gruvbox".into(),
            name: "Zed Gruvbox".into(),
            version: "1.0.0".into(),
            description: None,
            authors: vec![],
            repository: None,
            themes: vec!["themes/gruvbox.json".into()],
            lib: Default::default(),
            languages: Default::default(),
            grammars: BTreeMap::default(),
            language_servers: BTreeMap::default(),
        }
        .into(),
    );
    expected_index.themes.insert(
        "Gruvbox".into(),
        ExtensionIndexEntry {
            extension: "zed-gruvbox".into(),
            path: "themes/gruvbox.json".into(),
        },
    );

    store.update(cx, |store, cx| store.reload(cx));

    cx.executor().run_until_parked();
    store.read_with(cx, |store, _| {
        let index = &store.extension_index;
        assert_eq!(index.extensions, expected_index.extensions);
        assert_eq!(index.languages, expected_index.languages);
        assert_eq!(index.themes, expected_index.themes);

        assert_eq!(
            theme_registry.list_names(false),
            [
                "Gruvbox",
                "Monokai Dark",
                "Monokai Light",
                "Monokai Pro Dark",
                "Monokai Pro Light",
                "One Dark",
            ]
        );
    });

    let prev_fs_metadata_call_count = fs.metadata_call_count();
    let prev_fs_read_dir_call_count = fs.read_dir_call_count();

    // Create new extension store, as if Zed were restarting.
    drop(store);
    let store = cx.new_model(|cx| {
        ExtensionStore::new(
            PathBuf::from("/the-extension-dir"),
            fs.clone(),
            http_client.clone(),
            node_runtime.clone(),
            language_registry.clone(),
            theme_registry.clone(),
            cx,
        )
    });

    cx.executor().run_until_parked();
    store.read_with(cx, |store, _| {
        assert_eq!(store.extension_index, expected_index);
        assert_eq!(
            language_registry.language_names(),
            ["ERB", "Plain Text", "Ruby"]
        );
        assert_eq!(
            language_registry.grammar_names(),
            ["embedded_template".into(), "ruby".into()]
        );
        assert_eq!(
            theme_registry.list_names(false),
            [
                "Gruvbox",
                "Monokai Dark",
                "Monokai Light",
                "Monokai Pro Dark",
                "Monokai Pro Light",
                "One Dark",
            ]
        );

        // The on-disk manifest limits the number of FS calls that need to be made
        // on startup.
        assert_eq!(fs.read_dir_call_count(), prev_fs_read_dir_call_count);
        assert_eq!(fs.metadata_call_count(), prev_fs_metadata_call_count + 2);
    });

    store.update(cx, |store, cx| {
        store.uninstall_extension("zed-ruby".into(), cx)
    });

    cx.executor().run_until_parked();
    expected_index.extensions.remove("zed-ruby");
    expected_index.languages.remove("Ruby");
    expected_index.languages.remove("ERB");

    store.read_with(cx, |store, _| {
        assert_eq!(store.extension_index, expected_index);
        assert_eq!(language_registry.language_names(), ["Plain Text"]);
        assert_eq!(language_registry.grammar_names(), []);
    });
}

#[gpui::test]
async fn test_extension_store_with_gleam_extension(cx: &mut TestAppContext) {
    init_test(cx);

    let gleam_extension_dir = PathBuf::from_iter([
        env!("CARGO_MANIFEST_DIR"),
        "..",
        "..",
        "extensions",
        "gleam",
    ])
    .canonicalize()
    .unwrap();

    compile_extension("zed_gleam", &gleam_extension_dir);

    let fs = FakeFs::new(cx.executor());
    fs.insert_tree("/the-extension-dir", json!({ "installed": {} }))
        .await;
    fs.insert_tree_from_real_fs("/the-extension-dir/installed/gleam", gleam_extension_dir)
        .await;

    fs.insert_tree(
        "/the-project-dir",
        json!({
            ".tool-versions": "rust 1.73.0",
            "test.gleam": ""
        }),
    )
    .await;

    let project = Project::test(fs.clone(), ["/the-project-dir".as_ref()], cx).await;

    let language_registry = project.read_with(cx, |project, _cx| project.languages().clone());
    let theme_registry = Arc::new(ThemeRegistry::new(Box::new(())));
    let node_runtime = FakeNodeRuntime::new();

    let mut status_updates = language_registry.language_server_binary_statuses();

    let http_client = FakeHttpClient::create({
        move |request| async move {
            match request.uri().to_string().as_str() {
                "https://api.github.com/repos/gleam-lang/gleam/releases" => Ok(Response::new(
                    json!([
                        {
                            "tag_name": "v1.2.3",
                            "prerelease": false,
                            "tarball_url": "",
                            "zipball_url": "",
                            "assets": [
                                {
                                    "name": "gleam-v1.2.3-aarch64-apple-darwin.tar.gz",
                                    "browser_download_url": "http://example.com/the-download"
                                }
                            ]
                        }
                    ])
                    .to_string()
                    .into(),
                )),

                "http://example.com/the-download" => {
                    let mut bytes = Vec::<u8>::new();
                    let mut archive = async_tar::Builder::new(&mut bytes);
                    let mut header = async_tar::Header::new_gnu();
                    let content = "the-gleam-binary-contents".as_bytes();
                    header.set_size(content.len() as u64);
                    archive
                        .append_data(&mut header, "gleam", content)
                        .await
                        .unwrap();
                    archive.into_inner().await.unwrap();

                    let mut gzipped_bytes = Vec::new();
                    let mut encoder = GzipEncoder::new(BufReader::new(bytes.as_slice()));
                    encoder.read_to_end(&mut gzipped_bytes).await.unwrap();

                    Ok(Response::new(gzipped_bytes.into()))
                }

                _ => Ok(Response::builder().status(404).body("not found".into())?),
            }
        }
    });

    let _store = cx.new_model(|cx| {
        ExtensionStore::new(
            PathBuf::from("/the-extension-dir"),
            fs.clone(),
            http_client.clone(),
            node_runtime,
            language_registry.clone(),
            theme_registry.clone(),
            cx,
        )
    });

    cx.executor().run_until_parked();

    let mut fake_servers = language_registry.fake_language_servers("Gleam");

    let buffer = project
        .update(cx, |project, cx| {
            project.open_local_buffer("/the-project-dir/test.gleam", cx)
        })
        .await
        .unwrap();

    project.update(cx, |project, cx| {
        project.set_language_for_buffer(
            &buffer,
            Arc::new(Language::new(
                LanguageConfig {
                    name: "Gleam".into(),
                    ..Default::default()
                },
                None,
            )),
            cx,
        )
    });

    let fake_server = fake_servers.next().await.unwrap();

    assert_eq!(
        fs.load("/the-extension-dir/work/gleam/gleam-v1.2.3/gleam".as_ref())
            .await
            .unwrap(),
        "the-gleam-binary-contents"
    );

    assert_eq!(
        fake_server.binary.path,
        PathBuf::from("/the-extension-dir/work/gleam/gleam-v1.2.3/gleam")
    );
    assert_eq!(fake_server.binary.arguments, [OsString::from("lsp")]);

    assert_eq!(
        [
            status_updates.next().await.unwrap(),
            status_updates.next().await.unwrap(),
            status_updates.next().await.unwrap(),
        ],
        [
            (
                LanguageServerName("gleam".into()),
                LanguageServerBinaryStatus::CheckingForUpdate
            ),
            (
                LanguageServerName("gleam".into()),
                LanguageServerBinaryStatus::Downloading
            ),
            (
                LanguageServerName("gleam".into()),
                LanguageServerBinaryStatus::Downloaded
            )
        ]
    );
}

fn compile_extension(name: &str, extension_dir_path: &Path) {
    let output = std::process::Command::new("cargo")
        .args(["component", "build", "--target-dir"])
        .arg(extension_dir_path.join("target"))
        .current_dir(&extension_dir_path)
        .output()
        .unwrap();

    assert!(
        output.status.success(),
        "failed to build component {}",
        String::from_utf8_lossy(&output.stderr)
    );

    let mut wasm_path = PathBuf::from(extension_dir_path);
    wasm_path.extend(["target", "wasm32-wasi", "debug", name]);
    wasm_path.set_extension("wasm");

    std::fs::rename(wasm_path, extension_dir_path.join("extension.wasm")).unwrap();
}

fn init_test(cx: &mut TestAppContext) {
    cx.update(|cx| {
        let store = SettingsStore::test(cx);
        cx.set_global(store);
        theme::init(theme::LoadThemes::JustBase, cx);
        Project::init_settings(cx);
        language::init(cx);
    });
}