Add Node Library

.github/workflows/build.yml

@@ -30,7 +30,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [x64, x86, arm64]
-        variant: [shared, jni]
+        variant: [shared, jni, node]
     steps:
       - uses: actions/checkout@v3
         with:
@@ -63,7 +63,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [x64, x86, arm, arm64]
-        variant: [shared, jni]
+        variant: [shared, jni, node]
     steps:
       - uses: actions/checkout@v3
         with:
@@ -130,7 +130,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [x64, arm64]
-        variant: [shared, jni]
+        variant: [shared, jni, node]
     steps:
       - uses: actions/checkout@v3
         with:
@@ -190,7 +190,7 @@ jobs:
 #
 # Libraries
   dotnet:
-    runs-on: windows-latest
+    runs-on: ubuntu-latest
     needs: [windows-alphaskia, linux-alphaskia, android-alphaskia, macos-alphaskia, ios-alphaskia]
     steps:
     - uses: actions/checkout@v3
@@ -219,3 +219,18 @@ jobs:
         name: Jars
         path: |
           lib/java/*/build/libs/*.jar
+
+  node:
+    runs-on: ubuntu-latest
+    needs: [windows-alphaskia, linux-alphaskia, macos-alphaskia]
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/download-artifact@v3
+      with:
+        path: dist
+    - run: ./build.cmd Node
+    - uses: actions/upload-artifact@v3
+      with:
+        name: NodeTars
+        path: |
+          lib/node/*/*.tgz

.gitignore

@@ -713,4 +713,6 @@ fabric.properties
 
 !/build
 !/lib
-/lib/java/**/test-outputs
+/lib/java/**/test-outputs
+/lib/node/**/test-outputs
+/lib/node/*.tgz

.gitmodules

@@ -6,3 +6,6 @@
 	path = externals/skia
 	url = https://skia.googlesource.com/skia.git
 	branch = chrome/m117
+[submodule "externals/node-api-headers"]
+	path = externals/node-api-headers
+	url = https://github.com/nodejs/node-api-headers.git

.nuke/build.schema.json

@@ -111,13 +111,19 @@
               "DotNetPack",
               "DotNetTest",
               "Java",
+              "JavaBuild",
+              "JavaPack",
               "LibAlphaSkia",
               "LibAlphaSkiaGitSyncDeps",
               "LibAlphaSkiaPatchSkiaBuildFiles",
               "LibSkia",
               "LibSkiaGitSyncDeps",
               "LibSkiaPatchSkiaBuildFiles",
               "LibSkiaWithCache",
+              "Node",
+              "NodeBuild",
+              "NodePack",
+              "NodeTest",
               "PrepareGitHubArtifacts",
               "SetupDepotTools"
             ]
@@ -134,13 +140,19 @@
               "DotNetPack",
               "DotNetTest",
               "Java",
+              "JavaBuild",
+              "JavaPack",
               "LibAlphaSkia",
               "LibAlphaSkiaGitSyncDeps",
               "LibAlphaSkiaPatchSkiaBuildFiles",
               "LibSkia",
               "LibSkiaGitSyncDeps",
               "LibSkiaPatchSkiaBuildFiles",
               "LibSkiaWithCache",
+              "Node",
+              "NodeBuild",
+              "NodePack",
+              "NodeTest",
               "PrepareGitHubArtifacts",
               "SetupDepotTools"
             ]
@@ -164,6 +176,7 @@
           "type": "string",
           "enum": [
             "Jni",
+            "Node",
             "Shared",
             "Static"
           ]

.vscode/settings.json

@@ -117,6 +117,6 @@
         "csignal": "cpp",
         "scoped_allocator": "cpp",
         "typeindex": "cpp",
-        "__std_stream": "cpp"
+        "__std_stream": "cpp",
     }
 }

build/Build.Java.cs

@@ -14,10 +14,22 @@ partial class Build
     Tool GradlewTool => ToolResolver.GetTool(GradlewExe);
 
     public Target Java => _ => _
-        .DependsOn(PrepareGitHubArtifacts)
+        .DependsOn(JavaPack);
+
+    public Target JavaPack => _ => _
+        .DependsOn(JavaBuild)
         .Executes(() =>
         {
             GradlewTool("assemble",
                 workingDirectory: RootDirectory / "lib" / "java");
         });
+
+
+    public Target JavaBuild => _ => _
+        .DependsOn(PrepareGitHubArtifacts)
+        .Executes(() =>
+        {
+            GradlewTool("build",
+                workingDirectory: RootDirectory / "lib" / "java");
+        });
 }

build/Build.LibAlphaSkia.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Text;
@@ -69,19 +70,41 @@ partial class Build
                 config("alphaskia_public") {
                   defines = [ "_SILENCE_CXX17_CODECVT_HEADER_DEPRECATION_WARNING", "ALPHASKIA_IMPLEMENTATION=1" ]
                   include_dirs = [ "." ]
+
+
+                  if (is_shared_alphaskia) {
+                    defines += [ "ALPHASKIA_DLL" ]
+                  }
+
+                  if (is_win) {
+                    libs = [ "skia.lib", "user32.lib", "OpenGL32.lib" ]
+                  }
+
+                  if (is_linux) {
+                    libs = [ "skia", "fontconfig" ]
+                  }
+
+                  if (is_android) {
+                    libs = [ "skia" ]
+                  }
+
                   if (is_mac) {
+                    libs = [ "skia" ]
+
                     frameworks = [
                       "AppKit.framework",
                       "ApplicationServices.framework",
 
                       "OpenGL.framework",
 
                       "Metal.framework",
-                      "Foundation.framework",
-
+                      "Foundation.framework"
                     ]   
                   }
+
                   if (is_ios) {
+                    libs = [ "skia" ]
+
                     frameworks = [
                       "Foundation.framework",
                       "CoreFoundation.framework",
@@ -91,13 +114,9 @@ partial class Build
                       "MobileCoreServices.framework",
 
                       "Metal.framework",
-                      "UIKit.framework",
+                      "UIKit.framework"
                     ]
                   }
-
-                  if (is_shared_alphaskia) {
-                    defines += [ "ALPHASKIA_DLL" ]
-                  }
                 }
 
                 alphaskia_build("libalphaskia") {
@@ -116,12 +135,25 @@ partial class Build
                     "../../lib/java/jni/src/AlphaSkiaTypeface.cpp"
                   ]
                 }
+                alphaskia_build("libalphaskianode") {
+                  public_configs = [ ":alphaskia_public" ]
+                  configs += [ ":alphaskia_public" ]
+                  defines = [ "NODE_GYP_MODULE_NAME=libalphaskianode", "USING_UV_SHARED=1", "USING_V8_SHARED=1", "V8_DEPRECATION_WARNINGS=1", "BUILDING_NODE_EXTENSION" ]
+                  sources = alphaskia_wrapper_sources
+                  output_extension = "node"
+                  sources += [
+                    "../../lib/node/addon/addon.cpp"
+                  ]
+                  if( is_win ) {
+                    sources += [ "../../lib/node/addon/win_delay_load_hook.cpp"]
+                  }
+                }
             """;
             PatchSkiaFile(SkiaPath / "BUILD.gn", buildNew);
             PatchSkiaToolchain();
         });
 
-    
+
     void PatchSkiaFile(AbsolutePath file, string newText)
     {
         var existingText = file.ReadAllText();
@@ -160,7 +192,8 @@ void BuildAlphaSkia()
     {
         var gnArgs = PrepareNativeBuild(Variant);
         var staticLibPath = DistBasePath / GetLibDirectory(variant: Variant.Static);
-
+        var gnFlags = new Dictionary<string, string>();
+
         string buildTarget;
         if (Variant == Variant.Static)
         {
@@ -194,7 +227,26 @@ void BuildAlphaSkia()
                 throw new PlatformNotSupportedException();
             }
 
-            AppendToFlagList(gnArgs, "extra_cflags", $"'-I{alphaSkiaInclude}', '-I{jniInclude}', '-I{jniPlatformInclude}'");
+            AppendToFlagList(gnArgs, "extra_cflags",
+                $"'-I{alphaSkiaInclude}', '-I{jniInclude}', '-I{jniPlatformInclude}'");
+        }
+        else if (Variant == Variant.Node)
+        {
+            buildTarget = "libalphaskianode";
+
+            if (OperatingSystem.IsWindows())
+            {
+                // windows requires a lib to link against, fetch it from the node downloads
+                var nodeLibPath = DownloadNodeLib();
+                AppendToFlagList(gnArgs, "extra_ldflags",
+                    $"'/DELAYLOAD:node.exe', '/LIBPATH:{nodeLibPath}', 'node.lib', 'DelayImp.lib'");
+            }
+            else if(OperatingSystem.IsMacOS() && TargetOs == TargetOperatingSystem.MacOs)
+            {
+                // disable need of a libnode.dylib dependencies are resolve dynamically during runtime 
+                // and as the node binary has them built-in
+                AppendToFlagList(gnArgs, "extra_ldflags", "'-undefined', 'dynamic_lookup'");
+            }
         }
         else
         {
@@ -205,15 +257,11 @@ void BuildAlphaSkia()
         {
             // TODO: check if clang-cl also works with the linux flags
             AppendToFlagList(gnArgs, "extra_ldflags",
-                $"'/LIBPATH:{staticLibPath}', 'skia.lib', 'user32.lib', 'OpenGL32.lib'");
-        }
-        else if(TargetOs == TargetOperatingSystem.Linux)
-        {
-            AppendToFlagList(gnArgs, "extra_ldflags", $" '-L{staticLibPath}', '-lskia', '-lGL'");
+                $"'/LIBPATH:{staticLibPath}'");
         }
         else
         {
-            AppendToFlagList(gnArgs, "extra_ldflags", $" '-L{staticLibPath}', '-lskia'");
+            AppendToFlagList(gnArgs, "extra_ldflags", $"'-L{staticLibPath}'");
         }
 
         var libDir = GetLibDirectory(buildTarget, TargetOs, Architecture, Variant);
@@ -222,7 +270,7 @@ void BuildAlphaSkia()
         var outDir = SkiaPath / "out" / libDir;
         var libExtension = GetLibExtension(Variant);
 
-        GnNinja($"out/{libDir}", buildTarget, gnArgs, SkiaPath);
+        GnNinja($"out/{libDir}", buildTarget, gnArgs, gnFlags, SkiaPath);
 
         try
         {
@@ -249,4 +297,22 @@ void CopyBuildOutputTo(AbsolutePath path)
             throw new IOException("Copy files failed. existing files: " + string.Join(", ", fileList), e);
         }
     }
+
+    AbsolutePath DownloadNodeLib()
+    {
+        if (OperatingSystem.IsWindows() && TargetOs == TargetOperatingSystem.Windows)
+        {
+            // libs are available at urls like: 
+            // https://nodejs.org/dist/latest/win-x64/node.lib
+            // https://nodejs.org/dist/latest/win-x86/node.lib
+            // https://nodejs.org/dist/latest/win-arm64/node.lib
+            var url = $"https://nodejs.org/dist/latest/{TargetOs.RuntimeIdentifier}-{Architecture}/node.lib";
+            var libDir = TemporaryDirectory / $"libnode-{TargetOs.RuntimeIdentifier}-{Architecture}";
+            HttpTasks.HttpDownloadFile(url,
+                libDir / "node.lib");
+            return libDir;
+        }
+
+        return null;
+    }
 }

build/Build.LibSkia.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using Nuke.Common;
 using Nuke.Common.IO;
@@ -106,7 +107,7 @@ partial class Build
     void BuildSkia()
     {
         var gnArgs = PrepareNativeBuild(Variant.Static);
-
+        var gnFlags = new Dictionary<string, string>();
         var libDir = GetLibDirectory("libskia", TargetOs, Architecture, Variant.Static);
         var artifactsLibPath = IsGitHubActions ? ArtifactBasePath / libDir : null;
         var distPath = DistBasePath / libDir;
@@ -145,7 +146,7 @@ void BuildSkia()
         gnArgs["skia_enable_ganesh"] = "true";
         gnArgs["skia_use_vulkan"] = "true";
 
-        GnNinja($"out/{libDir}", "skia", gnArgs, SkiaPath);
+        GnNinja($"out/{libDir}", "skia", gnArgs, gnFlags, SkiaPath);
 
         void CopyBuildOutputTo(AbsolutePath path)
         {

build/Build.Linux.cs

@@ -60,10 +60,10 @@ void InstallDependenciesLinux()
             linuxArch = "";
         }
 
-        // skia libraries
-        var libuxArchSuffix = string.IsNullOrEmpty(linuxArch) ? "" : $":{linuxArch}";
+        // dependent libraries
+        var linuxArchSuffix = string.IsNullOrEmpty(linuxArch) ? "" : $":{linuxArch}";
         installDependencies.AppendLine("echo Installing libs");
-        installDependencies.AppendLine($"aptitude install -y libfontconfig-dev{libuxArchSuffix} libgl1-mesa-dev{libuxArchSuffix} libglu1-mesa-dev{libuxArchSuffix} freeglut3-dev{libuxArchSuffix}");
+        installDependencies.AppendLine($"aptitude install -y libfontconfig-dev{linuxArchSuffix} libgl1-mesa-dev{linuxArchSuffix} libglu1-mesa-dev{linuxArchSuffix} freeglut3-dev{linuxArchSuffix}");
 
         var scriptFile = TemporaryDirectory / "install_dependencies.sh";
         File.WriteAllText(scriptFile, installDependencies.ToString());