Implement sass --embedded in pure JS mode

.github/workflows/test.yml

@@ -128,24 +128,40 @@ jobs:
         working-directory: sass-spec
 
   sass_spec_js_embedded:
-    name: 'JS API Tests | Embedded | Node ${{ matrix.node-version }} | ${{ matrix.os }}'
+    name: "JS API Tests | Embedded ${{ matrix.js && 'Pure JS' || 'Dart' }} | Node ${{ matrix.node-version }} | ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}
     if: "github.event_name != 'pull_request' || !contains(github.event.pull_request.body, 'skip sass-embedded')"
 
     strategy:
       fail-fast: false
       matrix:
+        js: [true, false]
         os: [ubuntu-latest, windows-latest, macos-latest]
         node-version: ['lts/*']
         include:
           # Test older LTS versions
-          - os: ubuntu-latest
+          - js: true
+            os: ubuntu-latest
             dart_channel: stable
             node-version: lts/-1
-          - os: ubuntu-latest
+          - js: true
+            os: ubuntu-latest
             dart_channel: stable
             node-version: lts/-2
-          - os: ubuntu-latest
+          - js: true
+            os: ubuntu-latest
+            dart_channel: stable
+            node-version: lts/-3
+          - js: false
+            os: ubuntu-latest
+            dart_channel: stable
+            node-version: lts/-1
+          - js: false
+            os: ubuntu-latest
+            dart_channel: stable
+            node-version: lts/-2
+          - js: false
+            os: ubuntu-latest
             dart_channel: stable
             node-version: lts/-3
 
@@ -168,19 +184,13 @@ jobs:
       - name: Initialize embedded host
         run: |
           npm install
-          npm run init -- --compiler-path=.. --language-path=../build/language
+          npm run init -- --compiler-path=.. --language-path=../build/language ${{ matrix.js && '--compiler-js' || '' }}
           npm run compile
-          mv {`pwd`/,dist/}lib/src/vendor/dart-sass
         working-directory: embedded-host-node
 
       - name: Version info
-        run: |
-          path=embedded-host-node/dist/lib/src/vendor/dart-sass/sass
-          if [[ -f "$path.cmd" ]]; then "./$path.cmd" --version
-          elif [[ -f "$path.bat" ]]; then "./$path.bat" --version
-          elif [[ -f "$path.exe" ]]; then "./$path.exe" --version
-          else "./$path" --version
-          fi
+        run: node dist/bin/sass.js --version
+        working-directory: embedded-host-node
 
       - name: Run tests
         run: npm run js-api-spec -- --sassPackage ../embedded-host-node --sassSassRepo ../build/language

README.md

@@ -434,9 +434,7 @@ an API for users to invoke Sass and define custom functions and importers.
 * `sass --embedded --version` prints `versionResponse` with `id = 0` in JSON and
   exits.
 
-The `--embedded` command-line flag is not available when you install Dart Sass
-as an [npm package]. No other command-line flags are supported with
-`--embedded`.
+No other command-line flags are supported with `--embedded`.
 
 [npm package]: #from-npm
 

bin/sass.dart

@@ -17,10 +17,7 @@ import 'package:sass/src/importer/filesystem.dart';
 import 'package:sass/src/io.dart';
 import 'package:sass/src/stylesheet_graph.dart';
 import 'package:sass/src/utils.dart';
-import 'package:sass/src/embedded/executable.dart'
-    // Never load the embedded protocol when compiling to JS.
-    if (dart.library.js) 'package:sass/src/embedded/unavailable.dart'
-    as embedded;
+import 'package:sass/src/embedded/executable.dart' as embedded;
 
 Future<void> main(List<String> args) async {
   if (args case ['--embedded', ...var rest]) {

lib/src/embedded/README.md

@@ -1,28 +1,84 @@
 # Embedded Sass Compiler
 
 This directory contains the Dart Sass embedded compiler. This is a special mode
-of the Dart Sass command-line executable, only supported on the Dart VM, in
-which it uses stdin and stdout to communicate with another endpoint, the
-"embedded host", using a protocol buffer-based protocol. See [the embedded
+of the Dart Sass command-line executable, only supported on the Dart VM and
+Node.js, in which it uses stdin and stdout to communicate with another endpoint,
+the "embedded host", using a protocol buffer-based protocol. See [the embedded
 protocol specification] for details.
 
 [the embedded protocol specification]: https://github.com/sass/sass/blob/main/spec/embedded-protocol.md
 
 The embedded compiler has two different levels of dispatchers for handling
 incoming messages from the embedded host:
 
-1. The [`IsolateDispatcher`] is the first recipient of each packet. It decodes
+1. The [`WorkerDispatcher`] is the first recipient of each packet. It decodes
    the packets _just enough_ to determine which compilation they belong to, and
    forwards them to the appropriate compilation dispatcher. It also parses and
    handles messages that aren't compilation specific, such as `VersionRequest`.
 
-   [`IsolateDispatcher`]: isolate_dispatcher.dart
+   [`WorkerDispatcher`]: worker_dispatcher.dart
 
 2. The [`CompilationDispatcher`] fully parses and handles messages for a single
-   compilation. Each `CompilationDispatcher` runs in a separate isolate so that
+   compilation. Each `CompilationDispatcher` runs in a separate worker so that
    the embedded compiler can run multiple compilations in parallel.
 
    [`CompilationDispatcher`]: compilation_dispatcher.dart
 
-Otherwise, most of the code in this directory just wraps Dart APIs to
+Otherwise, most of the code in this directory just wraps Dart APIs or JS APIs to
 communicate with their protocol buffer equivalents.
+
+## Worker Communication and Management
+
+The way Dart VM launches lightweight isolates versus Node.js launches worker
+threads are very different.
+
+In Dart VM, the lightweight isolates share program structures like loaded
+libraries, classes, functions, etc., even including JIT optimized code. This
+allows main isolate to spawn child isolate with a reference to the entry point
+function.
+
+```
+┌─────────────────┐                                                    ┌─────────────────┐
+│ Main Isolate    │ Isolate.spawn(workerEntryPoint, mailbox, sendPort) │ Worker Isolate  │
+│                 ├───────────────────────────────────────────────────►│                 │
+│                 │                                                    │                 │
+│ ┌─────────────┐ │               Synchronous Messaging                │ ┌─────────────┐ │
+│ │ Mailbox     ├─┼────────────────────────────────────────────────────┼►│ Mailbox     │ │
+│ └─────────────┘ │                                                    │ └─────────────┘ │
+│                 │                                                    │                 │
+│ ┌─────────────┐ │               Asynchronous Messaging               │ ┌─────────────┐ │
+│ │ ReceivePort │◄┼────────────────────────────────────────────────────┼─┤ SendPort    │ │
+│ └─────────────┘ │                                                    │ └─────────────┘ │
+│                 │                                                    │                 │
+└─────────────────┘                                                    └─────────────────┘
+```
+
+In Node.JS, the worker threads do not share program structures. In order to
+launch a worker thread, it needs an entry point file, with the entry point
+function effectly hard-coded in the entry point file. While it's possible
+to have a separate entry point file for the worker threads, it requires more
+complex packaging changes with `cli_pkg`, therefore the main thread and the
+worker threads share [the same entry point file](js/executable.dart), which
+decides what to run based on `worker_threads.isMainThread`.
+
+```
+  if (worker_threads.isMainThread) {                                                                 if (worker_threads.isMainThread) {
+    mainEntryPoint();                                                                                  mainEntryPoint();
+  } else {                                                                                           } else {
+    workerEntryPoint();                new Worker(process.argv[1], {                                   workerEntryPoint();
+  }                                                                  argv: process.argv.slice(2),    }
+                                                                     workerData: channel.port2,
+┌────────────────────────────────────┐                               transferList: [channel.port2] ┌────────────────────────────────────┐
+│ Main Thread                        │                             })                              │ Worker Thread                      │
+│                                    ├────────────────────────────────────────────────────────────►│                                    │
+│                                    │                                                             │                                    │
+│ ┌────────────────────────────────┐ │               Synchronous Messaging                         │ ┌────────────────────────────────┐ │
+│ │ SyncMessagePort(channel.port1) ├─┼─────────────────────────────────────────────────────────────┼►│ SyncMessagePort(channel.port2) │ │
+│ └────────────────────────────────┘ │                                                             │ └────────────────────────────────┘ │
+│                                    │                                                             │                                    │
+│ ┌────────────────────────────────┐ │               Asynchronous Messaging                        │ ┌────────────────────────────────┐ │
+│ │ channel.port1                  │◄┼─────────────────────────────────────────────────────────────┼─┤ channel.port2                  │ │
+│ └────────────────────────────────┘ │                                                             │ └────────────────────────────────┘ │
+│                                    │                                                             │                                    │
+└────────────────────────────────────┘                                                             └────────────────────────────────────┘
+```

lib/src/embedded/compilation_dispatcher.dart

@@ -3,17 +3,17 @@
 // https://opensource.org/licenses/MIT.
 
 import 'dart:convert';
-import 'dart:io';
-import 'dart:isolate';
+import 'dart:io' if (dart.library.js) 'js/io.dart';
+import 'dart:isolate' if (dart.library.js) 'js/isolate.dart';
 import 'dart:typed_data';
 
-import 'package:native_synchronization/mailbox.dart';
 import 'package:path/path.dart' as p;
 import 'package:protobuf/protobuf.dart';
 import 'package:pub_semver/pub_semver.dart';
 import 'package:sass/sass.dart' as sass;
 import 'package:sass/src/importer/node_package.dart' as npi;
 
+import '../io.dart' show FileSystemException;
 import '../logger.dart';
 import '../value/function.dart';
 import '../value/mixin.dart';
@@ -23,6 +23,7 @@ import 'host_callable.dart';
 import 'importer/file.dart';
 import 'importer/host.dart';
 import 'logger.dart';
+import 'sync_receive_port.dart';
 import 'util/proto_extensions.dart';
 import 'utils.dart';
 
@@ -35,8 +36,8 @@ final _outboundRequestId = 0;
 /// A class that dispatches messages to and from the host for a single
 /// compilation.
 final class CompilationDispatcher {
-  /// The mailbox for receiving messages from the host.
-  final Mailbox _mailbox;
+  /// The synchronous receive port for receiving messages from the host.
+  final SyncReceivePort _receivePort;
 
   /// The send port for sending messages to the host.
   final SendPort _sendPort;
@@ -52,8 +53,8 @@ final class CompilationDispatcher {
   late Uint8List _compilationIdVarint;
 
   /// Creates a [CompilationDispatcher] that receives encoded protocol buffers
-  /// through [_mailbox] and sends them through [_sendPort].
-  CompilationDispatcher(this._mailbox, this._sendPort);
+  /// through [_receivePort] and sends them through [_sendPort].
+  CompilationDispatcher(this._receivePort, this._sendPort);
 
   /// Listens for incoming `CompileRequests` and runs their compilations.
   void listen() {
@@ -407,29 +408,33 @@ final class CompilationDispatcher {
     var protobufWriter = CodedBufferWriter();
     message.writeToCodedBufferWriter(protobufWriter);
 
-    // Add one additional byte to the beginning to indicate whether or not the
-    // compilation has finished (1) or encountered a fatal error (2), so the
-    // [IsolateDispatcher] knows whether to treat this isolate as inactive or
-    // close out entirely.
+    // Add two bytes to the beginning.
+    //
+    // The first byte indicates whether or not the compilation has finished (1)
+    // or encountered a fatal error (2), so the [WorkerDispatcher] knows
+    // whether to treat this isolate as inactive or close out entirely.
+    //
+    // The second byte is the exitCode when a fatal error occurs.
     var packet = Uint8List(
-      1 + _compilationIdVarint.length + protobufWriter.lengthInBytes,
+      2 + _compilationIdVarint.length + protobufWriter.lengthInBytes,
     );
     packet[0] = switch (message.whichMessage()) {
-      OutboundMessage_Message.compileResponse => 1,
       OutboundMessage_Message.error => 2,
-      _ => 0,
+      OutboundMessage_Message.compileResponse => 1,
+      _ => 0
     };
-    packet.setAll(1, _compilationIdVarint);
-    protobufWriter.writeTo(packet, 1 + _compilationIdVarint.length);
+    packet[1] = exitCode;
+    packet.setAll(2, _compilationIdVarint);
+    protobufWriter.writeTo(packet, 2 + _compilationIdVarint.length);
     return packet;
   }
 
   /// Receive a packet from the host.
   Uint8List _receive() {
     try {
-      return _mailbox.take();
+      return _receivePort.receive();
     } on StateError catch (_) {
-      // The [_mailbox] has been closed, exit the current isolate immediately
+      // The [SyncReceivePort] has been closed, exit the current isolate immediately
       // to avoid bubble the error up as [SassException] during [_sendRequest].
       Isolate.exit();
     }

lib/src/embedded/executable.dart

@@ -1,42 +1,5 @@
-// Copyright 2019 Google Inc. Use of this source code is governed by an
+// Copyright 2025 Google Inc. Use of this source code is governed by an
 // MIT-style license that can be found in the LICENSE file or at
 // https://opensource.org/licenses/MIT.
 
-import 'dart:io';
-import 'dart:convert';
-
-import 'package:stream_channel/stream_channel.dart';
-
-import 'isolate_dispatcher.dart';
-import 'util/length_delimited_transformer.dart';
-
-void main(List<String> args) {
-  switch (args) {
-    case ["--version", ...]:
-      var response = IsolateDispatcher.versionResponse();
-      response.id = 0;
-      stdout.writeln(
-        JsonEncoder.withIndent("  ").convert(response.toProto3Json()),
-      );
-      return;
-
-    case [_, ...]:
-      stderr.writeln(
-        "sass --embedded is not intended to be executed with additional "
-        "arguments.\n"
-        "See https://github.com/sass/dart-sass#embedded-dart-sass for "
-        "details.",
-      );
-      // USAGE error from https://bit.ly/2poTt90
-      exitCode = 64;
-      return;
-  }
-
-  IsolateDispatcher(
-    StreamChannel.withGuarantees(
-      stdin,
-      stdout,
-      allowSinkErrors: false,
-    ).transform(lengthDelimited),
-  ).listen();
-}
+export 'vm/executable.dart' if (dart.library.js) 'js/executable.dart';

lib/src/embedded/js/concurrency.dart

@@ -0,0 +1,10 @@
+// Copyright 2025 Google Inc. Use of this source code is governed by an
+// MIT-style license that can be found in the LICENSE file or at
+// https://opensource.org/licenses/MIT.
+
+import 'dart:js_interop';
+
+@JS('os.cpus')
+external JSArray _cpus();
+
+int get concurrencyLimit => _cpus().length;

lib/src/embedded/js/executable.dart

@@ -0,0 +1,27 @@
+// Copyright 2025 Google Inc. Use of this source code is governed by an
+// MIT-style license that can be found in the LICENSE file or at
+// https://opensource.org/licenses/MIT.
+
+import 'package:stream_channel/stream_channel.dart';
+
+import '../options.dart';
+import '../util/length_delimited_transformer.dart';
+import '../worker_dispatcher.dart';
+import '../worker_entrypoint.dart';
+import 'io.dart';
+import 'sync_receive_port.dart';
+import 'worker_threads.dart';
+
+void main(List<String> args) {
+  if (parseOptions(args)) {
+    if (isMainThread) {
+      WorkerDispatcher(StreamChannel.withGuarantees(stdin, stdout,
+                  allowSinkErrors: false)
+              .transform(lengthDelimited))
+          .listen();
+    } else {
+      var port = workerData! as MessagePort;
+      workerEntryPoint(JSSyncReceivePort(port), JSSendPort(port));
+    }
+  }
+}