Added a Boa runtime (#2743)

This Pull Request fixes/closes #718.

It changes the following:

- Adds a new `boa_runtime` crate, that will only include `console` for now
- Changes the `boa_cli` crate to use the new `boa_runtime` crate for the console, instead of the `console` feature of `boa_engine`
- Removes the `console` feature in `boa_engine`
- Adds a new `boa_testing` helper crate with some useful functions for testing `boa`. This part duplicates the code from `boa_engine`, but I could not make `boa_engine` work with this crate as a dependency due to circular dependencies. Maybe doing it a bit generic could work, but didn't have enough time to check it.

To be checked: wether the WASM example works as expected with the console.

Cargo.toml

@@ -11,6 +11,7 @@ members = [
     "boa_macros_tests",
     "boa_parser",
     "boa_profiler",
+    "boa_runtime",
     "boa_tester",
     "boa_unicode",
     "boa_wasm",
@@ -26,15 +27,16 @@ license = "Unlicense/MIT"
 description = "Boa is a Javascript lexer, parser and compiler written in Rust. Currently, it has support for some of the language."
 
 [workspace.dependencies]
+boa_ast = { version = "0.16.0", path = "boa_ast" }
 boa_engine = { version = "0.16.0", path = "boa_engine" }
-boa_interner = { version = "0.16.0", path = "boa_interner" }
 boa_gc = { version = "0.16.0", path = "boa_gc" }
-boa_profiler = { version = "0.16.0", path = "boa_profiler" }
-boa_unicode = { version = "0.16.0", path = "boa_unicode" }
+boa_icu_provider = { version = "0.16.0", path = "boa_icu_provider" }
+boa_interner = { version = "0.16.0", path = "boa_interner" }
 boa_macros = { version = "0.16.0", path = "boa_macros" }
-boa_ast = { version = "0.16.0", path = "boa_ast" }
 boa_parser = { version = "0.16.0", path = "boa_parser" }
-boa_icu_provider = { version = "0.16.0", path = "boa_icu_provider" }
+boa_profiler = { version = "0.16.0", path = "boa_profiler" }
+boa_runtime = { version = "0.16.0", path = "boa_runtime" }
+boa_unicode = { version = "0.16.0", path = "boa_unicode" }
 
 [workspace.metadata.workspaces]
 allow_branch = "main"

boa_ast/Cargo.toml

@@ -18,7 +18,7 @@ arbitrary = ["dep:arbitrary", "boa_interner/arbitrary", "num-bigint/arbitrary"]
 boa_interner.workspace = true
 boa_macros.workspace = true
 rustc-hash = "1.1.0"
-bitflags = "2.2.0"
+bitflags = "2.1.0"
 num-bigint = "0.4.3"
 serde = { version = "1.0.160", features = ["derive"], optional = true }
 arbitrary = { version = "1", features = ["derive"], optional = true }

boa_cli/Cargo.toml

@@ -12,11 +12,12 @@ repository.workspace = true
 rust-version.workspace = true
 
 [dependencies]
-boa_engine = { workspace = true, features = ["deser", "flowgraph", "trace", "console"] }
+boa_engine = { workspace = true, features = ["deser", "flowgraph", "trace"] }
 boa_ast = { workspace = true, features = ["serde"] }
 boa_parser.workspace = true
 boa_gc.workspace = true
 boa_interner.workspace = true
+boa_runtime.workspace = true
 rustyline = { version = "11.0.0", features = ["derive"]}
 clap = { version = "4.2.4", features = ["derive"] }
 serde_json = "1.0.96"

boa_cli/src/main.rs

@@ -66,9 +66,11 @@ use boa_engine::{
     context::ContextBuilder,
     job::{FutureJob, JobQueue, NativeJob},
     optimizer::OptimizerOptions,
+    property::Attribute,
     vm::flowgraph::{Direction, Graph},
     Context, JsResult, Source,
 };
+use boa_runtime::Console;
 use clap::{Parser, ValueEnum, ValueHint};
 use colored::{Color, Colorize};
 use debug::init_boa_debug_object;
@@ -311,6 +313,9 @@ fn main() -> Result<(), io::Error> {
     // Strict mode
     context.strict(args.strict);
 
+    // Add `console`.
+    add_runtime(&mut context);
+
     // Trace Output
     context.set_trace(args.trace);
 
@@ -404,6 +409,14 @@ fn main() -> Result<(), io::Error> {
     Ok(())
 }
 
+/// Adds the CLI runtime to the context.
+fn add_runtime(context: &mut Context<'_>) {
+    let console = Console::init(context);
+    context
+        .register_global_property(Console::NAME, console, Attribute::all())
+        .expect("the console object shouldn't exist");
+}
+
 #[derive(Default)]
 struct Jobs(RefCell<VecDeque<NativeJob>>);
 

boa_engine/Cargo.toml

@@ -42,9 +42,6 @@ flowgraph = []
 # Enable Boa's VM instruction tracing.
 trace = []
 
-# Enable Boa's WHATWG console object implementation.
-console = []
-
 # Enable Boa's additional ECMAScript features for web browsers.
 annex-b = ["boa_parser/annex-b"]
 
@@ -64,7 +61,7 @@ regress = "0.5.0"
 rustc-hash = "1.1.0"
 num-bigint = { version = "0.4.3", features = ["serde"] }
 num-integer = "0.1.45"
-bitflags = "2.2.0"
+bitflags = "2.1.0"
 indexmap = "1.9.3"
 ryu-js = "0.2.2"
 chrono = { version = "0.4.24", default-features = false, features = ["clock", "std"] }

boa_engine/src/builtins/function/tests.rs

@@ -1,5 +1,3 @@
-use indoc::indoc;
-
 use crate::{
     builtins::error::ErrorKind,
     error::JsNativeError,
@@ -9,6 +7,7 @@ use crate::{
     property::{Attribute, PropertyDescriptor},
     run_test_actions, JsValue, TestAction,
 };
+use indoc::indoc;
 
 #[allow(clippy::float_cmp)]
 #[test]