ferridriver-script 0.4.0

Sandboxed QuickJS scripting engine for ferridriver. Runs JS scripts against Page/Browser/Context with bound args, per-call isolation, scoped fs, and structured errors.
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

#![allow(
  clippy::missing_errors_doc,
  clippy::missing_panics_doc,
  clippy::must_use_candidate,
  clippy::module_name_repetitions,
  clippy::cast_possible_truncation,
  clippy::cast_precision_loss,
  clippy::cast_sign_loss,
  clippy::too_many_lines,
  clippy::uninlined_format_args,
  clippy::needless_pass_by_value,
  clippy::doc_markdown,
  clippy::missing_fields_in_debug,
  // rquickjs method wrappers intentionally produce new Locator instances that
  // JS is free to discard (e.g. fluent chains like `loc.nth(0)` used directly).
  clippy::return_self_not_must_use,
  // Some web-API classes (TextEncoder, etc.) are legitimately stateless per
  // their WHATWG spec, but `#[rquickjs::methods]` instance methods must still
  // take `&self` to be callable on `new TextEncoder()` — not a fixable smell.
  clippy::unused_self
)]
//! ferridriver-script: sandboxed `QuickJS` scripting engine.
//!
//! Exposes a `ScriptEngine` that runs user-provided JS against ferridriver's
//! Page/Browser/Context API with:
//!
//! - One-shot isolation via [`ScriptEngine::run`] (fresh VM per call) or
//!   REPL-style continuity via a persistent [`Session`] whose `globalThis`
//!   survives across [`Session::execute`] calls; [`SessionTable`] owns a
//!   set of them with a warm-VM cap, idle TTL, and browser-swap
//!   invalidation.
//! - Bound args (never interpolated into source) to prevent prompt injection.
//! - Wall-clock and memory quotas enforced by the `QuickJS` runtime.
//! - Sandboxed globals: scoped `fs`, captured `console`, session `vars`.
//! - Module loader rooted at a configured `scripts/` directory with path
//!   sanitization (rejects `..`, absolute paths, symlinks escaping root).
//! - A poisoning timeout/OOM discards the session VM so the next
//!   execution transparently gets a fresh one.
//!
//! Scripting is independent of the BDD step registry — scripts drive the
//! browser through the `page` / `context` / `request` bindings directly.

pub mod bindings;
pub mod bundle;
pub mod bytecode_cache;
pub mod command_spec;
pub mod console;
pub mod discover;
pub mod engine;
pub mod error;
pub mod fs;
pub mod modules;
pub mod result;
pub mod session_procs;
pub mod session_table;
pub mod vars;

pub use bindings::{
  ArtifactsJs, BrowserContextJs, CollectedRegistry, HookArg, HttpClientJs, HttpResponseJs, JsArg, KeyboardJs,
  LocatorJs, MouseJs, PageJs, PluginBinding, PluginCommandsJs, ScenarioWorld, ScriptAttachment, StepOutcome,
  collect_registry, drain_attachments, install_plugins, invoke_hook, invoke_step, reset_world, set_scenario_world,
};
pub use bundle::{
  CompiledBundle, CompiledPlugin, bundle_and_compile, bundle_source, compile_and_extract_plugins, eval_bundle,
  is_typescript_path, source_is_es_module,
};
pub use command_spec::{CommandOutput, CommandRun, CommandSpec, ResolvedCommand, ResolvedExec};
pub use console::ConsoleCapture;
pub use discover::{SOURCE_EXTENSIONS, is_source_file, walk_source_files};
pub use engine::{
  ExtensionHost, RunContext, RunOptions, ScriptCaps, ScriptEngine, ScriptEngineConfig, Session, SessionRun,
};
pub use error::{ScriptError, ScriptErrorKind};
// Re-export so the BDD core can name the session's async context (the
// bridge it drives JS step functions through) without a duplicate
// rquickjs dependency/version.
pub use fs::PathSandbox;
pub use result::{ConsoleEntry, ConsoleLevel, Outcome, ScriptResult, ScriptSuccess};
pub use rquickjs::AsyncContext;
pub use session_procs::SessionProcs;
pub use session_table::{BrowserSession, SessionTable};
pub use vars::{InMemoryVars, VarsStore};