Skip to content

Fix plugin issues #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jordonbc merged 5 commits into from
Mar 23, 2026
Merged

Fix plugin issues #197

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bdeb2e1
Fix plugin issues
Jordonbc Mar 23, 2026
93a362a
Update Git
Jordonbc Mar 23, 2026
b8ab6b9
Fixed issues
Jordonbc Mar 23, 2026
b1cb6f4
Merge branch 'Dev' into Fix-plugin-issues
Jordonbc Mar 23, 2026
7b28d20
Update Cargo.lock
Jordonbc Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Backend/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ serde_json = "1.0"
time = { version = "0.3", features = ["local-offset"] }
zip = "7.2"
tar = "0.4"
xz2 = "0.1"
flate2 = "1"
shlex = "1.2"
sha2 = "0.10"
hex = "0.4"
Expand Down
2 changes: 1 addition & 1 deletion Backend/built-in-plugins/Git
Open in desktop
Submodule Git updated 2 files
+9 −14 package-lock.json
+3 −1 package.json
41 changes: 3 additions & 38 deletions Backend/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
//! plugin discovery, and startup behavior.

use log::warn;
use std::path::PathBuf;
use std::sync::Arc;
use tauri::path::BaseDirectory;
use tauri::WindowEvent;
Expand Down Expand Up @@ -107,36 +106,6 @@ fn try_reopen_last_repo<R: tauri::Runtime>(app_handle: &tauri::AppHandle<R>) {
}
}

/// Resolves a development fallback path for the bundled Node runtime.
///
/// In `cargo tauri dev`, the generated runtime is placed under
/// `target/openvcs/node-runtime`, while Tauri resource resolution can point at
/// `target/debug/node-runtime`. This helper probes the generated location.
///
/// # Returns
/// - `Some(PathBuf)` when the dev bundled node binary exists.
/// - `None` when the path cannot be derived or does not exist.
fn resolve_dev_bundled_node_fallback() -> Option<PathBuf> {
let exe = std::env::current_exe().ok()?;
let exe_dir = exe.parent()?;
let target_dir = exe_dir.parent()?;
let node_name = if cfg!(windows) { "node.exe" } else { "node" };
let candidate = target_dir
.join("openvcs")
.join("node-runtime")
.join(node_name);
if candidate.is_file() {
return Some(candidate);
}
let nested = exe_dir
.join("_up_")
.join("target")
.join("openvcs")
.join("node-runtime")
.join(node_name);
nested.is_file().then_some(nested)
}

/// Starts the OpenVCS backend runtime and Tauri application.
///
/// This configures logging, plugin bundle synchronization, startup restore
Expand Down Expand Up @@ -187,17 +156,13 @@ pub fn run() {
);
}
}
let node_name = if cfg!(windows) { "node.exe" } else { "node" };
let mut node_candidates: Vec<PathBuf> = Vec::new();
if let Ok(node_runtime_dir) = app.path().resolve("node-runtime", BaseDirectory::Resource)
{
node_candidates.push(node_runtime_dir.join(node_name));
}
if let Some(dev_fallback) = resolve_dev_bundled_node_fallback() {
if !node_candidates.iter().any(|p| p == &dev_fallback) {
node_candidates.push(dev_fallback);
if let Some(parent) = node_runtime_dir.parent() {
crate::plugin_paths::set_resource_dir(parent.to_path_buf());
}
Comment thread
Jordonbc marked this conversation as resolved.
}
let node_candidates = crate::plugin_paths::bundled_node_candidate_paths();

if let Some(bundled_node) = node_candidates.iter().find(|path| path.is_file()) {
crate::plugin_paths::set_node_executable_path(bundled_node.to_path_buf());
Expand Down
110 changes: 73 additions & 37 deletions Backend/src/plugin_bundles.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,60 @@

use crate::logging::LogTimer;
use crate::plugin_paths::{built_in_plugin_dirs, ensure_dir, plugins_dir, PLUGIN_MANIFEST_NAME};
use flate2::read::GzDecoder;
use log::{debug, error, info, trace, warn};
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use std::collections::{BTreeMap, HashSet};
use std::fs;
use std::io::{Read, Write};
use std::io::{Read, Seek, SeekFrom, Write};
use std::path::{Component, Path, PathBuf};
use std::sync::OnceLock;
use xz2::read::XzDecoder;

const MODULE: &str = "plugin_bundles";
const GZIP_MAGIC: [u8; 2] = [0x1F, 0x8B];

/// Opens a plugin bundle as a decompressed tar reader.
///
/// `.ovcsp` bundles are gzip-compressed tar archives.
///
/// # Parameters
/// - `bundle_path`: Bundle file path.
///
/// # Returns
/// - `Ok(Box<dyn Read>)` with a decompressed tar stream.
/// - `Err(String)` when the bundle cannot be opened or has an unknown format.
fn open_bundle_reader(bundle_path: &Path) -> Result<Box<dyn Read>, String> {
let mut file =
fs::File::open(bundle_path).map_err(|e| format!("open {}: {e}", bundle_path.display()))?;
let mut magic = [0u8; 6];
let read = file
.read(&mut magic)
.map_err(|e| format!("read {}: {e}", bundle_path.display()))?;
file.seek(SeekFrom::Start(0))
.map_err(|e| format!("seek {}: {e}", bundle_path.display()))?;

if read >= GZIP_MAGIC.len() && magic[..GZIP_MAGIC.len()] == GZIP_MAGIC {
return Ok(Box::new(GzDecoder::new(file)));
}
Err(format!(
"unsupported bundle compression in {}",
bundle_path.display()
))
}

/// Opens a plugin bundle as a tar archive.
///
/// # Parameters
/// - `bundle_path`: Bundle file path.
///
/// # Returns
/// - `Ok(tar::Archive<...>)` when the bundle format is supported.
/// - `Err(String)` when the bundle cannot be decoded.
fn open_bundle_archive(bundle_path: &Path) -> Result<tar::Archive<Box<dyn Read>>, String> {
let reader = open_bundle_reader(bundle_path)?;
Ok(tar::Archive::new(reader))
}

/// Safety and resource limits enforced during bundle extraction.
#[derive(Debug, Clone, Copy)]
Expand Down Expand Up @@ -326,7 +369,7 @@ impl PluginBundleStore {
&bundle_sha256[..12]
);

let (manifest_bundle_path, manifest) = locate_manifest_tar_xz(bundle_path)?;
let (manifest_bundle_path, manifest) = locate_manifest_in_bundle(bundle_path)?;
let plugin_id = manifest.id.trim().to_string();
if plugin_id.is_empty() {
error!("install_ovcsp_with_limits: manifest id is empty",);
Expand Down Expand Up @@ -385,10 +428,7 @@ impl PluginBundleStore {
.map_err(|e| format!("canonicalize {}: {e}", staging_version_dir.display()))?;

// Extract all entries under `<pluginId>/...` into the staging version directory.
let f = fs::File::open(bundle_path)
.map_err(|e| format!("open {}: {e}", bundle_path.display()))?;
let decoder = XzDecoder::new(f);
let mut tar = tar::Archive::new(decoder);
let mut tar = open_bundle_archive(bundle_path)?;

for entry in tar.entries().map_err(|e| format!("read tar: {e}"))? {
let mut entry = entry.map_err(|e| format!("tar entry: {e}"))?;
Expand Down Expand Up @@ -696,7 +736,7 @@ impl PluginBundleStore {
trace!("ensure_built_in_bundle: {}", bundle_path.display());

let bundle_sha256 = sha256_hex_file(bundle_path)?;
let (_manifest_path, manifest) = locate_manifest_tar_xz(bundle_path)?;
let (_manifest_path, manifest) = locate_manifest_in_bundle(bundle_path)?;
let plugin_id = manifest.id.trim();
if plugin_id.is_empty() {
error!("ensure_built_in_bundle: bundle manifest id is empty",);
Expand Down Expand Up @@ -1171,7 +1211,7 @@ fn read_built_in_plugin_ids() -> HashSet<String> {
let mut out: HashSet<String> = HashSet::new();

for bundle_path in builtin_bundle_paths() {
let (_manifest_path, manifest) = match locate_manifest_tar_xz(&bundle_path) {
let (_manifest_path, manifest) = match locate_manifest_in_bundle(&bundle_path) {
Ok(v) => v,
Err(err) => {
warn!(
Expand Down Expand Up @@ -1240,19 +1280,16 @@ fn derive_install_version(manifest: &PluginManifest, bundle_sha256: &str) -> Str
.unwrap_or_else(|| format!("sha256-{}", &bundle_sha256[..12]))
}

/// Finds and parses `openvcs.plugin.json` from a tar.xz bundle.
/// Finds and parses `openvcs.plugin.json` from a plugin bundle archive.
///
/// # Parameters
/// - `bundle_path`: Bundle file path.
///
/// # Returns
/// - `Ok((PathBuf, PluginManifest))` manifest path inside archive and manifest payload.
/// - `Err(String)` on read/parse/validation failure.
fn locate_manifest_tar_xz(bundle_path: &Path) -> Result<(PathBuf, PluginManifest), String> {
let file =
fs::File::open(bundle_path).map_err(|e| format!("open {}: {e}", bundle_path.display()))?;
let decoder = XzDecoder::new(file);
let mut tar = tar::Archive::new(decoder);
fn locate_manifest_in_bundle(bundle_path: &Path) -> Result<(PathBuf, PluginManifest), String> {
let mut tar = open_bundle_archive(bundle_path)?;

let mut manifest_path: Option<PathBuf> = None;
let mut manifest_json: Option<Vec<u8>> = None;
Expand Down Expand Up @@ -1382,9 +1419,9 @@ fn validate_entrypoint(version_dir: &Path, exec: Option<&str>, label: &str) -> R
#[cfg(test)]
mod tests {
use super::*;
use std::io::Cursor;
use flate2::write::GzEncoder;
use flate2::Compression;
use tempfile::tempdir;
use xz2::write::XzEncoder;

/// Synthetic tar entry kind used by bundle-construction helpers.
enum TarEntryKind {
Expand All @@ -1406,16 +1443,15 @@ mod tests {
kind: TarEntryKind,
}

/// Builds a tar.xz bundle from synthetic test entries.
/// Builds a tar.gz bundle from synthetic test entries.
///
/// # Parameters
/// - `entries`: Tar entries to include.
///
/// # Returns
/// - Encoded tar.xz bytes.
fn make_tar_xz_bundle(entries: Vec<TarEntry>) -> Vec<u8> {
let cursor = Cursor::new(Vec::<u8>::new());
let encoder = XzEncoder::new(cursor, 6);
/// - Encoded tar.gz bytes.
fn make_tar_gz_bundle(entries: Vec<TarEntry>) -> Vec<u8> {
let encoder = GzEncoder::new(Vec::<u8>::new(), Compression::default());
let mut tar = tar::Builder::new(encoder);

for e in entries {
Expand Down Expand Up @@ -1446,17 +1482,17 @@ mod tests {
}

let encoder = tar.into_inner().unwrap();
encoder.finish().unwrap().into_inner()
encoder.finish().unwrap()
}

/// Builds a minimal raw tar.xz bundle from `(path, bytes)` tuples.
/// Builds a minimal raw tar.gz bundle from `(path, bytes)` tuples.
///
/// # Parameters
/// - `entries`: Raw path/data entries.
///
/// # Returns
/// - Encoded tar.xz bytes.
fn make_raw_tar_xz_bundle(entries: Vec<(String, Vec<u8>)>) -> Vec<u8> {
/// - Encoded tar.gz bytes.
fn make_raw_tar_gz_bundle(entries: Vec<(String, Vec<u8>)>) -> Vec<u8> {
/// Writes an octal tar header field.
///
/// # Parameters
Expand Down Expand Up @@ -1524,7 +1560,7 @@ mod tests {
tar_bytes.resize(tar_bytes.len() + 1024, 0u8);

let mut out = Vec::<u8>::new();
let mut enc = XzEncoder::new(&mut out, 6);
let mut enc = GzEncoder::new(&mut out, Compression::default());
enc.write_all(&tar_bytes).unwrap();
enc.finish().unwrap();
out
Expand Down Expand Up @@ -1576,7 +1612,7 @@ mod tests {
kind: TarEntryKind::File,
});
}
let bundle = make_tar_xz_bundle(entries);
let bundle = make_tar_gz_bundle(entries);

let (_tmp, bundle_path) = write_bundle_to_temp(&bundle);
let store_root = tempdir().unwrap();
Expand All @@ -1598,7 +1634,7 @@ mod tests {
/// # Returns
/// - `()`.
fn install_requires_manifest_at_expected_location() {
let bundle = make_tar_xz_bundle(vec![TarEntry {
let bundle = make_tar_gz_bundle(vec![TarEntry {
name: "test.plugin/other.json".into(),
data: b"{}".to_vec(),
unix_mode: None,
Expand All @@ -1619,7 +1655,7 @@ mod tests {
/// # Returns
/// - `()`.
fn install_validates_declared_entrypoints_exist() {
let bundle = make_tar_xz_bundle(vec![TarEntry {
let bundle = make_tar_gz_bundle(vec![TarEntry {
name: "test.plugin/openvcs.plugin.json".into(),
data: basic_manifest(
"test.plugin",
Expand All @@ -1643,7 +1679,7 @@ mod tests {
/// # Returns
/// - `()`.
fn install_rejects_functions_component() {
let bundle = make_tar_xz_bundle(vec![TarEntry {
let bundle = make_tar_gz_bundle(vec![TarEntry {
name: "test.plugin/openvcs.plugin.json".into(),
data: basic_manifest("test.plugin", ",\"functions\":{\"exec\":\"legacy.mjs\"}"),
unix_mode: None,
Expand All @@ -1662,12 +1698,12 @@ mod tests {
}

#[test]
/// Verifies installer accepts valid tar.xz bundles.
/// Verifies installer accepts valid tar.gz bundles.
///
/// # Returns
/// - `()`.
fn install_accepts_tar_xz_bundles() {
let bundle = make_tar_xz_bundle(vec![
fn install_accepts_tar_gz_bundles() {
let bundle = make_tar_gz_bundle(vec![
TarEntry {
name: "test.plugin/openvcs.plugin.json".into(),
data: basic_manifest(
Expand Down Expand Up @@ -1700,7 +1736,7 @@ mod tests {
/// # Returns
/// - `()`.
fn install_rejects_tar_zipslip_parent_dir() {
let bundle = make_raw_tar_xz_bundle(vec![
let bundle = make_raw_tar_gz_bundle(vec![
(
"test.plugin/openvcs.plugin.json".into(),
basic_manifest("test.plugin", ""),
Expand All @@ -1722,7 +1758,7 @@ mod tests {
/// # Returns
/// - `()`.
fn install_rejects_tar_symlink_entries() {
let bundle = make_tar_xz_bundle(vec![
let bundle = make_tar_gz_bundle(vec![
TarEntry {
name: "test.plugin/openvcs.plugin.json".into(),
data: basic_manifest("test.plugin", ""),
Expand Down Expand Up @@ -1754,7 +1790,7 @@ mod tests {
/// - `()`.
fn install_rejects_tar_suspicious_compression_ratio() {
let big = vec![0u8; 2 * 1024 * 1024];
let bundle = make_tar_xz_bundle(vec![
let bundle = make_tar_gz_bundle(vec![
TarEntry {
name: "test.plugin/openvcs.plugin.json".into(),
data: basic_manifest("test.plugin", ""),
Expand Down
Loading
Loading