@lix-js/sdk 0.6.0-preview.5 → 0.6.1

package/dist-engine-src/src/plugin/archive.rs

@@ -1,438 +0,0 @@
-use std::collections::{BTreeMap, BTreeSet};
-use std::io::{Cursor, Read};
-use std::path::{Component, Path};
-
-use serde_json::Value as JsonValue;
-use zip::read::ZipArchive;
-
-use crate::schema::{schema_key_from_definition, validate_lix_schema_definition};
-use crate::LixError;
-
-use super::{parse_plugin_manifest_json, InstalledPlugin, PluginManifest};
-
-#[derive(Debug, Clone)]
-pub(crate) struct ParsedPluginArchive {
-    pub manifest: PluginManifest,
-    pub schemas: Vec<JsonValue>,
-}
-
-pub(crate) fn parse_plugin_archive_for_install(
-    archive_bytes: &[u8],
-) -> Result<ParsedPluginArchive, LixError> {
-    let files = read_archive_files_for_install(archive_bytes)?;
-
-    let manifest_bytes = files.get("manifest.json").ok_or_else(|| LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: "Plugin archive must contain manifest.json".to_string(),
-        hint: None,
-            details: None,
-    })?;
-    let manifest_raw = std::str::from_utf8(manifest_bytes).map_err(|error| LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: format!("Plugin archive manifest.json must be UTF-8: {error}"),
-        hint: None,
-            details: None,
-    })?;
-    let validated_manifest = parse_plugin_manifest_json(manifest_raw)?;
-
-    let entry_path = normalize_archive_path_for_install(&validated_manifest.manifest.entry)?;
-    let wasm_bytes = files
-        .get(&entry_path)
-        .ok_or_else(|| LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!(
-                "Plugin archive is missing manifest entry file '{}'",
-                validated_manifest.manifest.entry
-            ),
-            hint: None,
-            details: None,
-        })?
-        .clone();
-    ensure_valid_plugin_wasm_for_install(&wasm_bytes)?;
-
-    let mut schemas = Vec::with_capacity(validated_manifest.manifest.schemas.len());
-    let mut seen_schema_keys = BTreeSet::<(String, String)>::new();
-    for schema_path in &validated_manifest.manifest.schemas {
-        let normalized_schema_path = normalize_archive_path_for_install(schema_path)?;
-        let schema_bytes = files.get(&normalized_schema_path).ok_or_else(|| LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!("Plugin archive is missing schema file '{schema_path}'"),
-            hint: None,
-            details: None,
-        })?;
-        let schema_json: JsonValue =
-            serde_json::from_slice(schema_bytes).map_err(|error| LixError {
-                code: "LIX_ERROR_UNKNOWN".to_string(),
-                message: format!(
-                    "Plugin archive schema '{schema_path}' is invalid JSON: {error}"
-                ),
-                hint: None,
-            details: None,
-            })?;
-        validate_lix_schema_definition(&schema_json)?;
-        let schema_key = schema_key_from_definition(&schema_json)?;
-        if !seen_schema_keys.insert(schema_key.schema_key.clone()) {
-            return Err(LixError {
-                code: "LIX_ERROR_UNKNOWN".to_string(),
-                message: format!(
-                    "Plugin archive declares duplicate schema '{}'",
-                    schema_key.schema_key
-                ),
-                hint: None,
-            details: None,
-            });
-        }
-        schemas.push(schema_json);
-    }
-
-    Ok(ParsedPluginArchive {
-        manifest: validated_manifest.manifest,
-        schemas,
-    })
-}
-
-pub(crate) fn load_installed_plugin_from_archive_bytes(
-    plugin_key: &str,
-    archive_path: &str,
-    archive_bytes: &[u8],
-) -> Result<InstalledPlugin, LixError> {
-    let files = read_plugin_archive_files(archive_path, archive_bytes)?;
-    let manifest_bytes = files.get("manifest.json").ok_or_else(|| LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: format!(
-            "plugin materialization: archive '{}' is missing manifest.json",
-            archive_path
-        ),
-        hint: None,
-            details: None,
-    })?;
-    let manifest_raw = std::str::from_utf8(manifest_bytes).map_err(|error| LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: format!(
-            "plugin materialization: archive '{}' manifest.json must be UTF-8: {error}",
-            archive_path
-        ),
-        hint: None,
-            details: None,
-    })?;
-    let validated_manifest = parse_plugin_manifest_json(manifest_raw)?;
-    if validated_manifest.manifest.key != plugin_key {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!(
-                "plugin materialization: archive '{}' key mismatch: path key '{}' vs manifest key '{}'",
-                archive_path, plugin_key, validated_manifest.manifest.key
-            ),
-            hint: None,
-            details: None,
-        });
-    }
-
-    let entry_path =
-        normalize_plugin_archive_path_for_materialization(&validated_manifest.manifest.entry)?;
-    let wasm = files.get(&entry_path).ok_or_else(|| LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: format!(
-            "plugin materialization: archive '{}' is missing entry file '{}'",
-            archive_path, validated_manifest.manifest.entry
-        ),
-        hint: None,
-            details: None,
-    })?;
-    ensure_valid_plugin_wasm_for_materialization(wasm)?;
-
-    let manifest = validated_manifest.manifest;
-    let content_type = manifest.file_match.content_type;
-
-    Ok(InstalledPlugin {
-        key: manifest.key,
-        runtime: manifest.runtime,
-        api_version: manifest.api_version,
-        path_glob: manifest.file_match.path_glob,
-        content_type,
-        entry: manifest.entry,
-        manifest_json: validated_manifest.normalized_json,
-        wasm: wasm.clone(),
-    })
-}
-
-fn read_archive_files_for_install(
-    archive_bytes: &[u8],
-) -> Result<BTreeMap<String, Vec<u8>>, LixError> {
-    if archive_bytes.is_empty() {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: "Plugin archive bytes must not be empty".to_string(),
-            hint: None,
-            details: None,
-        });
-    }
-
-    let mut archive = ZipArchive::new(Cursor::new(archive_bytes)).map_err(|error| LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: format!("Plugin archive is not a valid zip file: {error}"),
-        hint: None,
-            details: None,
-    })?;
-    let mut files = BTreeMap::<String, Vec<u8>>::new();
-
-    for index in 0..archive.len() {
-        let mut entry = archive.by_index(index).map_err(|error| LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!("Failed to read plugin archive entry at index {index}: {error}"),
-            hint: None,
-            details: None,
-        })?;
-        let raw_name = entry.name().to_string();
-
-        if entry.is_dir() {
-            continue;
-        }
-        if is_symlink_mode(entry.unix_mode()) {
-            return Err(LixError {
-                code: "LIX_ERROR_UNKNOWN".to_string(),
-                message: format!("Plugin archive entry '{raw_name}' must not be a symlink"),
-                hint: None,
-            details: None,
-            });
-        }
-
-        let normalized_path = normalize_archive_path_for_install(&raw_name)?;
-        let mut bytes = Vec::new();
-        entry.read_to_end(&mut bytes).map_err(|error| LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!("Failed to read plugin archive entry '{raw_name}': {error}"),
-            hint: None,
-            details: None,
-        })?;
-        if files.insert(normalized_path.clone(), bytes).is_some() {
-            return Err(LixError {
-                code: "LIX_ERROR_UNKNOWN".to_string(),
-                message: format!("Plugin archive contains duplicate entry '{normalized_path}'"),
-                hint: None,
-            details: None,
-            });
-        }
-    }
-
-    Ok(files)
-}
-
-fn read_plugin_archive_files(
-    archive_path: &str,
-    archive_bytes: &[u8],
-) -> Result<BTreeMap<String, Vec<u8>>, LixError> {
-    if archive_bytes.is_empty() {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!(
-                "plugin materialization: archive '{}' is empty",
-                archive_path
-            ),
-            hint: None,
-            details: None,
-        });
-    }
-
-    let mut archive = ZipArchive::new(Cursor::new(archive_bytes)).map_err(|error| LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: format!(
-            "plugin materialization: archive '{}' is not a valid zip file: {error}",
-            archive_path
-        ),
-        hint: None,
-            details: None,
-    })?;
-    let mut files = BTreeMap::<String, Vec<u8>>::new();
-
-    for index in 0..archive.len() {
-        let mut entry = archive.by_index(index).map_err(|error| LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!(
-                "plugin materialization: failed to read archive '{}' entry index {}: {error}",
-                archive_path, index
-            ),
-            hint: None,
-            details: None,
-        })?;
-
-        let entry_name = entry.name().to_string();
-        let normalized_path = normalize_plugin_archive_path_for_materialization(&entry_name)?;
-        if normalized_path.ends_with('/') {
-            continue;
-        }
-
-        let mut bytes = Vec::new();
-        entry.read_to_end(&mut bytes).map_err(|error| LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!(
-                "plugin materialization: failed to read archive '{}' entry '{}': {error}",
-                archive_path, entry_name
-            ),
-            hint: None,
-            details: None,
-        })?;
-        files.insert(normalized_path, bytes);
-    }
-
-    Ok(files)
-}
-
-fn normalize_archive_path_for_install(path: &str) -> Result<String, LixError> {
-    if path.is_empty() {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: "Plugin archive path must not be empty".to_string(),
-            hint: None,
-            details: None,
-        });
-    }
-    if path.starts_with('/') || path.starts_with('\\') {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!("Plugin archive path '{path}' must be relative"),
-            hint: None,
-            details: None,
-        });
-    }
-    if path.contains('\\') {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!("Plugin archive path '{path}' must use forward slash separators"),
-            hint: None,
-            details: None,
-        });
-    }
-
-    let mut segments = Vec::<String>::new();
-    for component in Path::new(path).components() {
-        match component {
-            Component::Normal(value) => {
-                let segment = value.to_str().ok_or_else(|| LixError {
-                    code: "LIX_ERROR_UNKNOWN".to_string(),
-                    message: format!(
-                        "Plugin archive path '{path}' contains non-UTF-8 components"
-                    ),
-                    hint: None,
-            details: None,
-                })?;
-                if segment.is_empty() {
-                    return Err(LixError {
-                        code: "LIX_ERROR_UNKNOWN".to_string(),
-                        message: format!("Plugin archive path '{path}' is invalid"),
-                        hint: None,
-            details: None,
-                    });
-                }
-                segments.push(segment.to_string());
-            }
-            Component::CurDir | Component::ParentDir | Component::RootDir | Component::Prefix(_) => {
-                return Err(LixError {
-                    code: "LIX_ERROR_UNKNOWN".to_string(),
-                    message: format!(
-                        "Plugin archive path '{path}' must not contain traversal or absolute components"
-                    ),
-                    hint: None,
-            details: None,
-                })
-            }
-        }
-    }
-
-    if segments.is_empty() {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!("Plugin archive path '{path}' is invalid"),
-            hint: None,
-            details: None,
-        });
-    }
-
-    Ok(segments.join("/"))
-}
-
-fn normalize_plugin_archive_path_for_materialization(path: &str) -> Result<String, LixError> {
-    let raw_path = Path::new(path);
-    if raw_path.is_absolute() {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: format!(
-                "plugin materialization: archive path '{}' must be relative",
-                path
-            ),
-            hint: None,
-            details: None,
-        });
-    }
-
-    let mut normalized = Vec::new();
-    for component in raw_path.components() {
-        match component {
-            Component::Normal(part) => normalized.push(part.to_string_lossy().to_string()),
-            Component::CurDir => {}
-            Component::ParentDir | Component::RootDir | Component::Prefix(_) => {
-                return Err(LixError {
-                    code: "LIX_ERROR_UNKNOWN".to_string(),
-                    message: format!(
-                        "plugin materialization: archive path '{}' must not escape the archive root",
-                        path
-                    ),
-                    hint: None,
-            details: None,
-                });
-            }
-        }
-    }
-
-    if normalized.is_empty() {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: "plugin materialization: archive path must not be empty".to_string(),
-            hint: None,
-            details: None,
-        });
-    }
-
-    Ok(normalized.join("/"))
-}
-
-fn ensure_valid_plugin_wasm_for_install(wasm_bytes: &[u8]) -> Result<(), LixError> {
-    if wasm_bytes.is_empty() {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: "Plugin wasm bytes must not be empty".to_string(),
-            hint: None,
-            details: None,
-        });
-    }
-    if wasm_bytes.len() < 8 || !wasm_bytes.starts_with(&[0x00, 0x61, 0x73, 0x6d]) {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: "Plugin wasm bytes must start with a valid wasm header".to_string(),
-            hint: None,
-            details: None,
-        });
-    }
-    Ok(())
-}
-
-fn ensure_valid_plugin_wasm_for_materialization(bytes: &[u8]) -> Result<(), LixError> {
-    const WASM_MAGIC: &[u8; 4] = b"\0asm";
-    if bytes.len() < WASM_MAGIC.len() || &bytes[..WASM_MAGIC.len()] != WASM_MAGIC {
-        return Err(LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: "plugin materialization: entry file must be a valid WebAssembly module"
-                .to_string(),
-            hint: None,
-            details: None,
-        });
-    }
-
-    Ok(())
-}
-
-fn is_symlink_mode(mode: Option<u32>) -> bool {
-    const MODE_FILE_TYPE_MASK: u32 = 0o170000;
-    const MODE_SYMLINK: u32 = 0o120000;
-    mode.is_some_and(|value| (value & MODE_FILE_TYPE_MASK) == MODE_SYMLINK)
-}

package/dist-engine-src/src/plugin/component.rs

@@ -1,183 +0,0 @@
-use std::sync::Arc;
-
-use crate::common::LixError;
-use crate::wasm::{WasmComponentInstance, WasmLimits, WasmRuntime};
-
-use super::InstalledPlugin;
-
-#[derive(Clone)]
-pub(crate) struct CachedPluginComponent {
-    pub(crate) wasm: Vec<u8>,
-    pub(crate) instance: Arc<dyn WasmComponentInstance>,
-}
-
-const APPLY_CHANGES_EXPORTS: &[&str] = &["apply-changes", "api#apply-changes"];
-
-pub(crate) trait PluginComponentHost {
-    fn plugin_component_cache(
-        &self,
-    ) -> &std::sync::Mutex<std::collections::BTreeMap<String, CachedPluginComponent>>;
-
-    fn wasm_runtime(&self) -> &Arc<dyn WasmRuntime>;
-}
-
-pub(crate) async fn load_or_init_plugin_component(
-    host: &impl PluginComponentHost,
-    plugin: &InstalledPlugin,
-) -> Result<Arc<dyn WasmComponentInstance>, LixError> {
-    {
-        let guard = host.plugin_component_cache().lock().map_err(|_| LixError {
-            code: "LIX_ERROR_UNKNOWN".to_string(),
-            message: "plugin component cache lock poisoned".to_string(),
-            hint: None,
-            details: None,
-        })?;
-        if let Some(cached) = guard.get(&plugin.key) {
-            if cached.wasm == plugin.wasm {
-                return Ok(cached.instance.clone());
-            }
-        }
-    }
-
-    let initialized = host
-        .wasm_runtime()
-        .init_component(plugin.wasm.clone(), WasmLimits::default())
-        .await?;
-    let mut guard = host.plugin_component_cache().lock().map_err(|_| LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: "plugin component cache lock poisoned".to_string(),
-        hint: None,
-            details: None,
-    })?;
-    if let Some(cached) = guard.get(&plugin.key) {
-        if cached.wasm == plugin.wasm {
-            return Ok(cached.instance.clone());
-        }
-    }
-    guard.insert(
-        plugin.key.clone(),
-        CachedPluginComponent {
-            wasm: plugin.wasm.clone(),
-            instance: initialized.clone(),
-        },
-    );
-    Ok(initialized)
-}
-
-pub(crate) async fn apply_changes_with_plugin(
-    host: &impl PluginComponentHost,
-    plugin: &InstalledPlugin,
-    payload: &[u8],
-) -> Result<Vec<u8>, LixError> {
-    let instance = load_or_init_plugin_component(host, plugin).await?;
-    invoke_apply_changes_export(instance.as_ref(), payload).await
-}
-
-async fn invoke_apply_changes_export(
-    instance: &dyn WasmComponentInstance,
-    payload: &[u8],
-) -> Result<Vec<u8>, LixError> {
-    let mut errors = Vec::new();
-    for export in APPLY_CHANGES_EXPORTS {
-        match instance.call(export, payload).await {
-            Ok(output) => return Ok(output),
-            Err(error) => errors.push(format!("{export}: {}", error.message)),
-        }
-    }
-
-    Err(LixError {
-        code: "LIX_ERROR_UNKNOWN".to_string(),
-        message: format!(
-            "plugin materialization: failed to call apply-changes export ({})",
-            errors.join("; ")
-        ),
-        hint: None,
-            details: None,
-    })
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use crate::plugin::{InstalledPlugin, PluginRuntime};
-    use crate::wasm::WasmRuntime;
-    use async_trait::async_trait;
-    use std::sync::atomic::{AtomicUsize, Ordering};
-
-    struct TestHost {
-        wasm_runtime: Arc<dyn WasmRuntime>,
-        plugin_component_cache:
-            std::sync::Mutex<std::collections::BTreeMap<String, CachedPluginComponent>>,
-    }
-
-    impl PluginComponentHost for TestHost {
-        fn plugin_component_cache(
-            &self,
-        ) -> &std::sync::Mutex<std::collections::BTreeMap<String, CachedPluginComponent>> {
-            &self.plugin_component_cache
-        }
-
-        fn wasm_runtime(&self) -> &Arc<dyn WasmRuntime> {
-            &self.wasm_runtime
-        }
-    }
-
-    #[derive(Default)]
-    struct CountingRuntime {
-        init_calls: Arc<AtomicUsize>,
-    }
-
-    struct NoopComponent;
-
-    #[async_trait(?Send)]
-    impl WasmRuntime for CountingRuntime {
-        async fn init_component(
-            &self,
-            _bytes: Vec<u8>,
-            _limits: WasmLimits,
-        ) -> Result<Arc<dyn WasmComponentInstance>, LixError> {
-            self.init_calls.fetch_add(1, Ordering::SeqCst);
-            Ok(Arc::new(NoopComponent))
-        }
-    }
-
-    #[async_trait(?Send)]
-    impl WasmComponentInstance for NoopComponent {
-        async fn call(&self, _export: &str, _input: &[u8]) -> Result<Vec<u8>, LixError> {
-            Ok(Vec::new())
-        }
-    }
-
-    #[tokio::test]
-    async fn component_cache_reinitializes_when_same_key_wasm_changes() {
-        let runtime = Arc::new(CountingRuntime::default());
-        let host = TestHost {
-            wasm_runtime: runtime.clone(),
-            plugin_component_cache: std::sync::Mutex::new(Default::default()),
-        };
-        let mut plugin = InstalledPlugin {
-            key: "k".to_string(),
-            runtime: PluginRuntime::WasmComponentV1,
-            api_version: "0.1.0".to_string(),
-            path_glob: "*.json".to_string(),
-            content_type: None,
-            entry: "plugin.wasm".to_string(),
-            manifest_json: "{}".to_string(),
-            wasm: vec![1],
-        };
-
-        load_or_init_plugin_component(&host, &plugin)
-            .await
-            .expect("first init should succeed");
-        load_or_init_plugin_component(&host, &plugin)
-            .await
-            .expect("second lookup should reuse cache");
-        assert_eq!(runtime.init_calls.load(Ordering::SeqCst), 1);
-
-        plugin.wasm = vec![2];
-        load_or_init_plugin_component(&host, &plugin)
-            .await
-            .expect("changed wasm should reinitialize instance");
-        assert_eq!(runtime.init_calls.load(Ordering::SeqCst), 2);
-    }
-}