Prevent users from passing arbitrary parser options to Jint (#1831)

* Reduce parsing options for end users (replace ParserOptions with Script/ModuleParseOptions in the public API)
* Enforce that pre-parsed scripts can be passed to Jint only if they were created using Engine.PrepareScript/PrepareModule
* Avoid copying beefy ExecutionContext struct where possible
* Propagate ParserOptions via ExecutionContext
* Introduce alias for Esprima.Ast.Module

Author: adams85

Directory.Build.props

@@ -32,6 +32,7 @@
     <Using Include="Esprima.Utils" />
 
     <Using Include="Esprima.Ast.BindingPattern" Alias="DestructuringPattern" />
+    <Using Include="Esprima.Ast.Module" Alias="AstModule" />
     <Using Include="Esprima.Ast.Nodes" Alias="NodeType" />
     <Using Include="Esprima.JavaScriptParser" Alias="Parser" />
     <Using Include="Esprima.Location" Alias="SourceLocation" />

Directory.Packages.props

@@ -6,7 +6,7 @@
   <ItemGroup>
     <PackageVersion Include="BenchmarkDotNet" Version="0.13.12" />
     <PackageVersion Include="BenchmarkDotNet.TestAdapter" Version="0.13.12" />
-    <PackageVersion Include="Esprima" Version="3.0.4" />
+    <PackageVersion Include="Esprima" Version="3.0.5" />
     <PackageVersion Include="FluentAssertions" Version="6.12.0" />
     <PackageVersion Include="Flurl.Http.Signed" Version="3.2.4" />
     <PackageVersion Include="Jurassic" Version="3.2.7" />

Jint.Benchmark/DromaeoBenchmark.cs

@@ -15,7 +15,7 @@ public class DromaeoBenchmark
         {"dromaeo-string-base64", null}
     };
 
-    private readonly Dictionary<string, Script> _prepared = new();
+    private readonly Dictionary<string, Prepared<Script>> _prepared = new();
 
     private Engine engine;
 

Jint.Benchmark/EngineComparisonBenchmark.cs

@@ -12,7 +12,7 @@ namespace Jint.Benchmark;
 [BenchmarkCategory("EngineComparison")]
 public class EngineComparisonBenchmark
 {
-    private static readonly Dictionary<string, Script> _parsedScripts = new();
+    private static readonly Dictionary<string, Prepared<Script>> _parsedScripts = new();
 
     private static readonly Dictionary<string, string> _files = new()
     {
@@ -38,7 +38,6 @@ public class EngineComparisonBenchmark
     [GlobalSetup]
     public void Setup()
     {
-        var parser = new Parser();
         foreach (var fileName in _files.Keys.ToList())
         {
             var script = File.ReadAllText($"Scripts/{fileName}.js");
@@ -47,7 +46,7 @@ public void Setup()
                 script = _dromaeoHelpers + Environment.NewLine + Environment.NewLine + script;
             }
             _files[fileName] = script;
-            _parsedScripts[fileName] = parser.ParseScript(script, strict: true);
+            _parsedScripts[fileName] = Engine.PrepareScript(script, strict: true);
         }
     }
 

Jint.Benchmark/EngineConstructionBenchmark.cs

@@ -6,15 +6,14 @@ namespace Jint.Benchmark;
 [MemoryDiagnoser]
 public class EngineConstructionBenchmark
 {
-    private Script _program;
-    private Script _simple;
+    private Prepared<Script> _program;
+    private Prepared<Script> _simple;
 
     [GlobalSetup]
     public void GlobalSetup()
     {
-        var parser = new Parser();
-        _program = parser.ParseScript("([].length + ''.length)");
-        _simple = parser.ParseScript("1");
+        _program = Engine.PrepareScript("([].length + ''.length)");
+        _simple = Engine.PrepareScript("1");
         new Engine().Evaluate(_program);
     }
 

Jint.Benchmark/ObjectAccessBenchmark.cs

@@ -5,7 +5,7 @@ namespace Jint.Benchmark;
 [MemoryDiagnoser]
 public class ObjectAccessBenchmark
 {
-    private readonly Script _script;
+    private readonly Prepared<Script> _script;
 
     public ObjectAccessBenchmark()
     {

Jint.Benchmark/ShadowRealmBenchmark.cs

@@ -11,7 +11,7 @@ public class ShadowRealmBenchmark
 ";
 
     private Engine engine;
-    private Script parsedScript;
+    private Prepared<Script> parsedScript;
 
     [GlobalSetup]
     public void Setup()

Jint.Benchmark/SingleScriptBenchmark.cs

@@ -6,7 +6,7 @@ namespace Jint.Benchmark;
 public abstract class SingleScriptBenchmark
 {
     private string _script;
-    private Script _parsedScript;
+    private Prepared<Script> _parsedScript;
 
     protected abstract string FileName { get; }
 

Jint.Repl/Program.cs

@@ -40,10 +40,10 @@
 Console.WriteLine();
 
 var defaultColor = Console.ForegroundColor;
-var parserOptions = new ParserOptions
+var parsingOptions = new ScriptParsingOptions
 {
     Tolerant = true,
-    RegExpParseMode = RegExpParseMode.AdaptToInterpreted
+    CompileRegex = false,
 };
 
 var serializer = new JsonSerializer(engine);
@@ -60,7 +60,7 @@
 
     try
     {
-        var result = engine.Evaluate(input, parserOptions);
+        var result = engine.Evaluate(input, parsingOptions);
         JsValue str = result;
         if (!result.IsPrimitive() && result is not IJsPrimitive)
         {

Jint.Tests.CommonScripts/ConcurrencyTest.cs

@@ -4,14 +4,10 @@ namespace Jint.Tests.CommonScripts;
 public class ConcurrencyTest
 {
     [Test]
-    [TestCase(true)]
-    [TestCase(false)]
-    public void ConcurrentEnginesCanUseSameAst(bool prepared)
+    public void ConcurrentEnginesCanUseSameAst()
     {
         var scriptContents = SunSpiderTests.GetEmbeddedFile("babel-standalone.js");
-        var script = prepared
-            ? Engine.PrepareScript(scriptContents)
-            : new Parser().ParseScript(scriptContents);
+        var script = Engine.PrepareScript(scriptContents);
 
         Parallel.ForEach(Enumerable.Range(0, 3), x =>
         {