vfox 2026.8.17

Interface to vfox plugins
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

use crate::Plugin;
use crate::error::Result;
use crate::sdk_info::SdkInfo;
use indexmap::IndexMap;
use mlua::{IntoLua, Lua, LuaSerdeExt, Value};
use std::collections::BTreeMap;
use std::path::PathBuf;

impl Plugin {
    pub async fn post_install(&self, ctx: PostInstallContext) -> Result<()> {
        debug!("[vfox:{}] post_install", self.name);
        self.exec_async(chunk! {
            require "hooks/post_install"
            PLUGIN:PostInstall($ctx)
        })
        .await
    }
}

pub struct PostInstallContext {
    pub root_path: PathBuf,
    pub runtime_version: String,
    pub sdk_info: BTreeMap<String, SdkInfo>,
    pub options: IndexMap<String, toml::Value>,
}

impl IntoLua for PostInstallContext {
    fn into_lua(self, lua: &Lua) -> mlua::Result<Value> {
        let table = lua.create_table()?;
        table.set("rootPath", self.root_path.to_string_lossy().to_string())?;
        table.set("runtimeVersion", self.runtime_version)?;
        table.set("sdkInfo", self.sdk_info)?;
        table.set("options", lua.to_value(&self.options)?)?;
        Ok(Value::Table(table))
    }
}

#[cfg(test)]
mod tests {
    use crate::{Plugin, embedded_plugins};
    use tokio::test;

    use super::*;

    #[test]
    async fn dummy() {
        // A temp dir, not a relative path: the dummy plugin's PostInstall writes a VERSION file
        // and a bin/ directory under rootPath, which would otherwise land in the crate directory.
        //
        // The apostrophe is deliberate. PostInstall builds a shell command to create the
        // directory, so a path like this is what breaks naive quoting.
        let tmp = tempfile::tempdir().unwrap();
        let root = tmp.path().join("O'Brien");
        let p = Plugin::test("dummy");
        let ctx = PostInstallContext {
            root_path: root.clone(),
            runtime_version: "runtime_version".to_string(),
            sdk_info: BTreeMap::new(),
            options: Default::default(),
        };
        p.post_install(ctx).await.unwrap();
        assert_eq!(
            std::fs::read_to_string(root.join("VERSION")).unwrap(),
            "runtime_version"
        );
        assert!(root.join("bin").join("dummy").exists());
    }

    #[test]
    async fn embedded_chromedriver() {
        let tmp = tempfile::tempdir().unwrap();
        let root = tmp.path().join("O'Brien");
        std::fs::create_dir_all(&root).unwrap();
        let binary_name = if cfg!(windows) {
            "chromedriver.exe"
        } else {
            "chromedriver"
        };
        std::fs::write(root.join(binary_name), "chromedriver").unwrap();

        let embedded = embedded_plugins::get_embedded_plugin("chromedriver").unwrap();
        let plugin = Plugin::from_embedded("chromedriver", embedded).unwrap();
        let sdk_info = SdkInfo::new(
            "chromedriver".to_string(),
            "153.0.8009.0".to_string(),
            root.clone(),
        );
        let ctx = PostInstallContext {
            root_path: root.clone(),
            runtime_version: "153.0.8009.0".to_string(),
            sdk_info: BTreeMap::from([("chromedriver".to_string(), sdk_info)]),
            options: Default::default(),
        };

        plugin.post_install(ctx).await.unwrap();

        assert_eq!(
            std::fs::read_to_string(root.join("bin").join(binary_name)).unwrap(),
            "chromedriver"
        );
    }
}