Add extension point for custom Function.toString() logic (#2043)

Author: lahma

Jint.Tests.PublicInterface/FunctionToStringTest.cs

@@ -0,0 +1,26 @@
+using FluentAssertions;
+
+namespace Jint.Tests.PublicInterface;
+
+public class FunctionToStringTest
+{
+    [Fact]
+    public void CanRegisterCustomFunctionToString()
+    {
+        const string Code = "var x = 1; var y = 3; function testFunction() { return 'Something'; }; testFunction.toString(); var z = x + y;";
+
+        // we can rewrite back with AST to get custom formatting
+        var engine = new Engine(options =>
+            options.Host.FunctionToStringHandler = (function, node) => node.ToJavaScript(KnRJavaScriptTextFormatterOptions.Default)
+        );
+
+        engine.Evaluate(Code).AsString().Should().Be($"function testFunction() {{{Environment.NewLine}  return 'Something';{Environment.NewLine}}}");
+
+        // or we can brute force the original input when we use node's location information
+        engine = new Engine(options =>
+            options.Host.FunctionToStringHandler = (function, node) => Code.Substring(node.Start, node.End - node.Start)
+        );
+
+        engine.Evaluate(Code).AsString().Should().Be("function testFunction() { return 'Something'; }");
+    }
+}

Jint/Native/Function/Function.cs

@@ -368,7 +368,11 @@ internal void SetFunctionLength(JsNumber length)
 
     public override string ToString()
     {
-        // TODO no way to extract SourceText from Esprima at the moment, just returning native code
+        if (_functionDefinition?.Function is Node node && _engine.Options.Host.FunctionToStringHandler(this, node) is { } s)
+        {
+            return s;
+        }
+
         var nameValue = _nameDescriptor != null ? UnwrapJsValue(_nameDescriptor) : JsString.Empty;
         var name = "";
         if (!nameValue.IsUndefined())
@@ -378,7 +382,7 @@ public override string ToString()
 
         name = name.TrimStart(_functionNameTrimStartChars);
 
-        return "function " + name + "() { [native code] }";
+        return $"function {name}() {{ [native code] }}";
     }
 
     private sealed class ObjectInstanceWithConstructor : ObjectInstance

Jint/Options.Extensions.cs

@@ -106,7 +106,7 @@ public static Options LocalTimeZone(this Options options, TimeZoneInfo timeZoneI
     /// </summary>
     public static Options DisableStringCompilation(this Options options, bool disable = true)
     {
-        options.StringCompilationAllowed = !disable;
+        options.Host.StringCompilationAllowed = !disable;
         return options;
     }
 
@@ -295,4 +295,4 @@ public static Options EnableModules(this Options options, IModuleLoader moduleLo
         options.Modules.ModuleLoader = moduleLoader;
         return options;
     }
-}
+}

Jint/Options.cs

@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Reflection;
 using Jint.Native;
+using Jint.Native.Function;
 using Jint.Native.Object;
 using Jint.Runtime;
 using Jint.Runtime.Interop;
@@ -47,7 +48,7 @@ public class Options
     /// <summary>
     /// Host options.
     /// </summary>
-    internal HostOptions Host { get; } = new();
+    public HostOptions Host { get; } = new();
 
     /// <summary>
     /// Module options
@@ -64,7 +65,6 @@ public class Options
     /// </summary>
     public CultureInfo Culture { get; set; } = _defaultCulture;
 
-
     /// <summary>
     /// Configures a time system to use. Defaults to DefaultTimeSystem using local time.
     /// </summary>
@@ -94,7 +94,12 @@ public ITimeSystem TimeSystem
     /// <remarks>
     /// https://tc39.es/ecma262/#sec-hostensurecancompilestrings
     /// </remarks>
-    public bool StringCompilationAllowed { get; set; } = true;
+    [Obsolete("Use Options.Host.StringCompilationAllowed")]
+    public bool StringCompilationAllowed
+    {
+        get => Host.StringCompilationAllowed;
+        set => Host.StringCompilationAllowed = value;
+    }
 
     /// <summary>
     /// Options for the built-in JSON (de)serializer which
@@ -436,6 +441,21 @@ public class ConstraintOptions
     public class HostOptions
     {
         internal Func<Engine, Host> Factory { get; set; } = _ => new Host();
+
+        /// <summary>
+        /// Whether calling 'eval' with custom code and function constructors taking function code as string is allowed.
+        /// Defaults to true.
+        /// </summary>
+        /// <remarks>
+        /// https://tc39.es/ecma262/#sec-hostensurecancompilestrings
+        /// </remarks>
+        public bool StringCompilationAllowed { get; set; } = true;
+
+        /// <summary>
+        /// Possibility to override Jint's default function() { [native code] } format for functions using AST Node.
+        /// If callback return null, Jint will use its own default logic.
+        /// </summary>
+        public Func<Function, Node, string?> FunctionToStringHandler { get; set; } = (_, _) => null;
     }
 
     /// <summary>

Jint/Runtime/Host.cs

@@ -110,7 +110,7 @@ protected virtual void CreateIntrinsics(Realm realmRec)
     /// </summary>
     public virtual void EnsureCanCompileStrings(Realm callerRealm, Realm evalRealm)
     {
-        if (!Engine.Options.StringCompilationAllowed)
+        if (!Engine.Options.Host.StringCompilationAllowed)
         {
             ExceptionHelper.ThrowJavaScriptException(callerRealm.Intrinsics.TypeError, "String compilation has been disabled in engine options");
         }
@@ -219,4 +219,4 @@ internal virtual List<string> GetSupportedImportAttributes()
     }
 }
 
-internal sealed record JobCallback(ICallable Callback, object? HostDefined);
+internal sealed record JobCallback(ICallable Callback, object? HostDefined);