Refactor native APIs (#159)

Author: jasongin

.editorconfig

@@ -156,6 +156,16 @@ csharp_space_between_square_brackets = false
 dotnet_diagnostic.CA1510.severity = none
 dotnet_diagnostic.CA1513.severity = none
 
+dotnet_diagnostic.IDE0290.severity = none # Use primary constructor
+dotnet_diagnostic.IDE0065.severity = none # Using directives must be placed outside of namespace
+
+# Collection initialization can be simplified.
+# This relies on implicit conversions in ways that are sometimes undesirable.
+dotnet_diagnostic.IDE0028.severity = none # new Dictionary<K,V>() => []  (and other collections)
+dotnet_diagnostic.IDE0300.severity = none # new[] { a, b } -> [a, b]  (breaks some attributes)
+dotnet_diagnostic.IDE0302.severity = none # stackalloc T[N] { a, b } -> [a, b]
+dotnet_diagnostic.IDE0305.severity = none # collection.ToArray() -> [..collection]
+
 # License header
 file_header_template = Copyright (c) Microsoft Corporation.\nLicensed under the MIT License.
 

Directory.Build.props

@@ -3,7 +3,7 @@
     <TargetFrameworks Condition=" '$(TargetFrameworks)' == '' and ! $([MSBuild]::IsOsPlatform('Windows')) ">net8.0;net6.0</TargetFrameworks>
     <TargetFrameworks Condition=" '$(TargetFrameworks)' == '' and $([MSBuild]::IsOsPlatform('Windows')) ">net8.0;net6.0;net472</TargetFrameworks>
     <TargetFrameworks Condition=" '$(PublishAot)' == 'true' ">net8.0</TargetFrameworks>
-    <LangVersion>10</LangVersion>
+    <LangVersion>12</LangVersion>
     <Nullable>enable</Nullable>
     <Configuration Condition="'$(Configuration)'==''">Debug</Configuration>
     <BaseOutputPath>$(MSBuildThisFileDirectory)out/</BaseOutputPath>

bench/Benchmarks.cs

@@ -9,8 +9,8 @@
 using BenchmarkDotNet.Running;
 using Microsoft.JavaScript.NodeApi.DotNetHost;
 using Microsoft.JavaScript.NodeApi.Interop;
-using Microsoft.JavaScript.NodeApi.Runtimes;
-using static Microsoft.JavaScript.NodeApi.JSNativeApi.Interop;
+using Microsoft.JavaScript.NodeApi.Runtime;
+using static Microsoft.JavaScript.NodeApi.Runtime.JSRuntime;
 using static Microsoft.JavaScript.NodeApi.Test.TestUtils;
 
 namespace Microsoft.JavaScript.NodeApi.Bench;
@@ -87,10 +87,11 @@ protected void Setup()
 
         // This setup avoids using NodejsEnvironment so benchmarks can run on the same thread.
         // NodejsEnvironment creates a separate thread that would slow down the micro-benchmarks.
-        _env = JSNativeApi.CreateEnvironment(platform, (error) => Console.WriteLine(error), null);
+        platform.Runtime.CreateEnvironment(platform, Console.WriteLine, null, out _env)
+            .ThrowIfFailed();
 
         // The new scope instance saves itself as the thread-local JSValueScope.Current.
-        JSValueScope scope = new(JSValueScopeType.Root, _env);
+        JSValueScope scope = new(JSValueScopeType.Root, _env, platform.Runtime);
 
         // Create some JS values that will be used by the benchmarks.
 

examples/hermes-engine/HermesApi.Interop.cs

@@ -6,18 +6,19 @@
 using System.Runtime.InteropServices;
 using System.Security;
 using Microsoft.JavaScript.NodeApi;
+using Microsoft.JavaScript.NodeApi.Runtime;
 using static Hermes.Example.HermesApi.Interop;
-using static Microsoft.JavaScript.NodeApi.JSNativeApi.Interop;
+using static Microsoft.JavaScript.NodeApi.Runtime.JSRuntime;
 
 namespace Hermes.Example;
 
 public static class HermesApi
 {
-    public static void Load(string hermesEnginePath)
+    public static JSRuntime Load(string hermesEnginePath)
     {
         nint hermesLib = NativeLibrary.Load(hermesEnginePath);
         Interop.Initialize(hermesLib);
-        JSNativeApi.Interop.Initialize(hermesLib);
+        return new NodejsRuntime(hermesLib);
     }
 
     public static void ThrowIfFailed(

examples/hermes-engine/HermesRuntime.cs

@@ -3,8 +3,9 @@
 
 using Microsoft.JavaScript.NodeApi;
 using Microsoft.JavaScript.NodeApi.Interop;
+using Microsoft.JavaScript.NodeApi.Runtime;
 using static Hermes.Example.HermesApi.Interop;
-using static Microsoft.JavaScript.NodeApi.JSNativeApi.Interop;
+using static Microsoft.JavaScript.NodeApi.Runtime.JSRuntime;
 
 namespace Hermes.Example;
 
@@ -26,10 +27,10 @@ public sealed class HermesRuntime : IDisposable
     private HermesRuntime(JSDispatcherQueue dispatcherQueue)
     {
         _dispatcherQueue = dispatcherQueue;
-        HermesApi.Load("hermes.dll");
+        JSRuntime runtime = HermesApi.Load("hermes.dll");
         using HermesConfig tempConfig = new();
         hermes_create_runtime((hermes_config)tempConfig, out _runtime).ThrowIfFailed();
-        _rootScope = new JSValueScope(JSValueScopeType.Root, (napi_env)this);
+        _rootScope = new JSValueScope(JSValueScopeType.Root, (napi_env)this, runtime);
         CreatePolyfills();
     }
 
@@ -103,37 +104,37 @@ private void CreatePolyfills()
         JSValue global = JSValue.Global;
         global["global"] = global;
 
-        global["setImmediate"] = (JSCallback)(args =>
+        global["setImmediate"] = new JSFunction("setImmediate", args =>
         {
             JSValue immediateCallback = AsFunction(args, 0);
             int taskId = AddImmediateTask(immediateCallback);
             return taskId;
         });
 
-        global["clearImmediate"] = (JSCallback)(args =>
+        global["clearImmediate"] = new JSFunction("clearImmediate", args =>
         {
             int taskId = AsInt32(args, 0);
             RemoveImmediateTask(taskId);
             return default;
         });
 
-        global["setTimeout"] = (JSCallback)(args =>
+        global["setTimeout"] = new JSFunction("setTimeout", args =>
         {
             JSValue timeoutCallback = AsFunction(args, 0);
             int delayInMs = AsInt32(args, 1);
             int taskId = AddTimerTask(timeoutCallback, delayInMs);
             return taskId;
         });
 
-        global["clearTimeout"] = (JSCallback)(args =>
+        global["clearTimeout"] = new JSFunction("clearTimeout", args =>
         {
             int taskId = AsInt32(args, 0);
             RemoveTimerTask(taskId);
             return default;
         });
 
         var console = new JSObject();
-        console["log"] = (JSCallback)(args =>
+        console["log"] = new JSFunction("log", args =>
         {
             Console.WriteLine((string)args[0].CoerceToString());
             return default;

examples/hermes-engine/hermes-engine.csproj

@@ -11,7 +11,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.2.*-*" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" PrivateAssets="all" />
     <PackageReference Include="Microsoft.JavaScript.Hermes" Version="0.1.6" PrivateAssets="all" />
   </ItemGroup>
 

examples/winui-fluid/App.xaml.cs

@@ -4,7 +4,7 @@
 using System;
 using System.Diagnostics;
 using System.IO;
-using Microsoft.JavaScript.NodeApi.Runtimes;
+using Microsoft.JavaScript.NodeApi.Runtime;
 
 namespace Microsoft.JavaScript.NodeApi.Examples;
 

examples/winui-fluid/CollabEditBox.xaml.cs

@@ -16,7 +16,7 @@
 using Microsoft.UI.Xaml.Controls;
 using Microsoft.UI.Xaml.Media;
 using Microsoft.UI.Xaml.Shapes;
-using Microsoft.JavaScript.NodeApi.Runtimes;
+using Microsoft.JavaScript.NodeApi.Runtime;
 
 namespace Microsoft.JavaScript.NodeApi.Examples;
 

examples/winui-fluid/Properties/PublishProfiles/win10-arm64.pubxml

@@ -6,7 +6,7 @@ https://go.microsoft.com/fwlink/?LinkID=208121.
   <PropertyGroup>
     <PublishProtocol>FileSystem</PublishProtocol>
     <Platform>arm64</Platform>
-    <RuntimeIdentifier>win10-arm64</RuntimeIdentifier>
+    <RuntimeIdentifier>win-arm64</RuntimeIdentifier>
     <PublishDir>bin\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\publish\</PublishDir>
     <SelfContained>true</SelfContained>
     <PublishSingleFile>False</PublishSingleFile>

examples/winui-fluid/Properties/PublishProfiles/win10-x64.pubxml

@@ -6,7 +6,7 @@ https://go.microsoft.com/fwlink/?LinkID=208121.
   <PropertyGroup>
     <PublishProtocol>FileSystem</PublishProtocol>
     <Platform>x64</Platform>
-    <RuntimeIdentifier>win10-x64</RuntimeIdentifier>
+    <RuntimeIdentifier>win-x64</RuntimeIdentifier>
     <PublishDir>bin\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\publish\</PublishDir>
     <SelfContained>true</SelfContained>
     <PublishSingleFile>False</PublishSingleFile>