From 153b668c8b43adde4d98cb0022a2e4a263926853 Mon Sep 17 00:00:00 2001
From: Martin Kustermann <kustermann@google.com>
Date: Tue, 11 Jun 2024 12:21:11 +0000
Subject: [PATCH] [stable] [dart2wasm] Make `dart compile wasm` compiled apps
 disable `dart.library.ffi`

This is a follow-up to [0]. That CL changed dart2wasm's modular
transformer to issue an error if `dart:ffi` is imported.

Users of packages that have specialized code for the VM (which supports
FFI) use conditional imports based on `dart.library.ffi`. We don't want
the VM-specific code to be used for web in dart2wasm (as dart2wasm
doesn't support the entirety of `dart:ffi`).

As a result we're going to make `dart.library.ffi` be false in
coditional imports (as well as in
`const bool.fromEnvironment('dart.library.ffi')`).

[0] https://dart-review.googlesource.com/c/sdk/+/368568

Bug: https://github.com/dart-lang/sdk/issues/55948
Bug: https://github.com/flutter/flutter/issues/149984

Cherry-pick: https://dart-review.googlesource.com/c/sdk/+/370580
Cherry-pick-request: https://github.com/dart-lang/sdk/issues/55979
Change-Id: Ia968bacf92566d421606fc026c7f016fe5abff01
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/370880
Reviewed-by: Slava Egorov <vegorov@google.com>
---
 CHANGELOG.md                                   | 10 ++++++++++
 .../lib/js_interop_checks.dart                 | 14 ++++++++++----
 pkg/dart2wasm/lib/compile.dart                 |  4 +++-
 pkg/dart2wasm/lib/dart2wasm.dart               |  3 +++
 pkg/dart2wasm/lib/target.dart                  | 18 +++++++++++++-----
 pkg/dart2wasm/lib/translator.dart              |  1 +
 pkg/dart2wasm/tool/compile_benchmark           |  5 +++++
 tests/web/wasm/ffi/disabled_helper.dart        |  5 +++++
 tests/web/wasm/ffi/disabled_test.dart          | 12 ++++++++++++
 tests/web/wasm/ffi/enabled_helper.dart         |  8 ++++++++
 tests/web/wasm/ffi/enabled_test.dart           | 14 ++++++++++++++
 tests/web/wasm/{ => ffi}/ffi_native_test.dart  |  1 +
 .../wasm/{ => ffi}/ffi_native_test_module.c    |  0
 utils/dart2wasm/BUILD.gn                       |  2 +-
 14 files changed, 86 insertions(+), 11 deletions(-)
 create mode 100644 tests/web/wasm/ffi/disabled_helper.dart
 create mode 100644 tests/web/wasm/ffi/disabled_test.dart
 create mode 100644 tests/web/wasm/ffi/enabled_helper.dart
 create mode 100644 tests/web/wasm/ffi/enabled_test.dart
 rename tests/web/wasm/{ => ffi}/ffi_native_test.dart (98%)
 rename tests/web/wasm/{ => ffi}/ffi_native_test_module.c (100%)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3057ceccd84b..d3d19966fdfd 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,13 @@
+## 3.4.4
+
+This is a patch release that:
+
+- Fixes an issue where `const bool.fromEnvironment('dart.library.ffi')` is true
+  and conditional import condition `dart.library.ffi` is true in dart2wasm.
+  (issue [#55948]).
+
+[#55948]: https://github.com/dart-lang/sdk/issues/55948
+
 ## 3.4.3 - 2024-06-05
 
 This is a patch release that:
diff --git a/pkg/_js_interop_checks/lib/js_interop_checks.dart b/pkg/_js_interop_checks/lib/js_interop_checks.dart
index 4cbd3363659d..33bfdd891c3b 100644
--- a/pkg/_js_interop_checks/lib/js_interop_checks.dart
+++ b/pkg/_js_interop_checks/lib/js_interop_checks.dart
@@ -85,6 +85,8 @@ class JsInteropChecks extends RecursiveVisitor {
   final ExportChecker exportChecker;
   final bool isDart2Wasm;
 
+  final List<String> _disallowedInteropLibrariesInDart2Wasm;
+
   /// Native tests to exclude from checks on external.
   // TODO(rileyporter): Use ExternalName from CFE to exclude native tests.
   static final List<Pattern> _allowedNativeTestPatterns = [
@@ -107,7 +109,7 @@ class JsInteropChecks extends RecursiveVisitor {
     // Negative lookahead to test the violation.
     RegExp(
         r'(?<!generated_)tests/lib/js/static_interop_test(?!/disallowed_interop_libraries_test.dart)'),
-    RegExp(r'(?<!generated_)tests/web/wasm'),
+    RegExp(r'(?<!generated_)tests/web/wasm/(?!ffi/).*'),
     // Flutter tests.
     RegExp(r'flutter/lib/web_ui/test'),
   ];
@@ -131,7 +133,7 @@ class JsInteropChecks extends RecursiveVisitor {
   ];
 
   /// Interop libraries that cannot be used in dart2wasm.
-  static const _disallowedInteropLibrariesInDart2Wasm = [
+  static const _disallowedInteropLibrariesInDart2WasmByDefault = [
     'package:js/js.dart',
     'package:js/js_util.dart',
     'dart:js_util',
@@ -163,12 +165,16 @@ class JsInteropChecks extends RecursiveVisitor {
 
   JsInteropChecks(this._coreTypes, ClassHierarchy hierarchy, this._reporter,
       this._nativeClasses,
-      {this.isDart2Wasm = false})
+      {this.isDart2Wasm = false, bool enableExperimentalFfi = false})
       : exportChecker = ExportChecker(_reporter, _coreTypes.objectClass),
         _functionToJSTarget = _coreTypes.index.getTopLevelProcedure(
             'dart:js_interop', 'FunctionToJSExportedDartFunction|get#toJS'),
         _staticTypeContext = StatefulStaticTypeContext.stacked(
-            TypeEnvironment(_coreTypes, hierarchy)) {
+            TypeEnvironment(_coreTypes, hierarchy)),
+        _disallowedInteropLibrariesInDart2Wasm = [
+          for (final entry in _disallowedInteropLibrariesInDart2WasmByDefault)
+            if (!(entry == 'dart:ffi' && enableExperimentalFfi)) entry
+        ] {
     extensionIndex =
         ExtensionIndex(_coreTypes, _staticTypeContext.typeEnvironment);
   }
diff --git a/pkg/dart2wasm/lib/compile.dart b/pkg/dart2wasm/lib/compile.dart
index 9a3496e93369..49739d95b7a9 100644
--- a/pkg/dart2wasm/lib/compile.dart
+++ b/pkg/dart2wasm/lib/compile.dart
@@ -81,7 +81,9 @@ Future<CompilerOutput?> compileToModule(compiler.WasmCompilerOptions options,
     mode = wasm.Mode.regular;
   }
   final WasmTarget target = WasmTarget(
-      removeAsserts: !options.translatorOptions.enableAsserts, mode: mode);
+      enableExperimentalFfi: options.translatorOptions.enableExperimentalFfi,
+      removeAsserts: !options.translatorOptions.enableAsserts,
+      mode: mode);
   CompilerOptions compilerOptions = CompilerOptions()
     ..target = target
     ..sdkRoot = options.sdkPath
diff --git a/pkg/dart2wasm/lib/dart2wasm.dart b/pkg/dart2wasm/lib/dart2wasm.dart
index f4bf8141939c..06f65469d4d5 100644
--- a/pkg/dart2wasm/lib/dart2wasm.dart
+++ b/pkg/dart2wasm/lib/dart2wasm.dart
@@ -97,6 +97,9 @@ final List<Option> options = [
   StringOption(
       "dump-kernel-after-tfa", (o, value) => o.dumpKernelAfterTfa = value,
       hide: true),
+  Flag("enable-experimental-ffi",
+      (o, value) => o.translatorOptions.enableExperimentalFfi = value,
+      defaultsTo: _d.translatorOptions.enableExperimentalFfi),
 ];
 
 Map<fe.ExperimentalFlag, bool> processFeExperimentalFlags(
diff --git a/pkg/dart2wasm/lib/target.dart b/pkg/dart2wasm/lib/target.dart
index a73b64411df7..80ec55fd7bba 100644
--- a/pkg/dart2wasm/lib/target.dart
+++ b/pkg/dart2wasm/lib/target.dart
@@ -89,10 +89,14 @@ class ConstantResolver extends Transformer {
 }
 
 class WasmTarget extends Target {
-  WasmTarget({this.removeAsserts = true, this.mode = Mode.regular});
-
-  bool removeAsserts;
-  Mode mode;
+  WasmTarget(
+      {this.enableExperimentalFfi = true,
+      this.removeAsserts = true,
+      this.mode = Mode.regular});
+
+  final bool removeAsserts;
+  final Mode mode;
+  final bool enableExperimentalFfi;
   Class? _growableList;
   Class? _immutableList;
   Class? _wasmDefaultMap;
@@ -206,7 +210,7 @@ class WasmTarget extends Target {
         diagnosticReporter as DiagnosticReporter<Message, LocatedMessage>);
     final jsInteropChecks = JsInteropChecks(
         coreTypes, hierarchy, jsInteropReporter, _nativeClasses!,
-        isDart2Wasm: true);
+        isDart2Wasm: true, enableExperimentalFfi: enableExperimentalFfi);
     // Process and validate first before doing anything with exports.
     for (Library library in interopDependentLibraries) {
       jsInteropChecks.visitLibrary(library);
@@ -497,6 +501,10 @@ class WasmTarget extends Target {
   @override
   Class concreteDoubleLiteralClass(CoreTypes coreTypes, double value) =>
       _boxedDouble ??= coreTypes.index.getClass("dart:core", "_BoxedDouble");
+
+  @override
+  DartLibrarySupport get dartLibrarySupport => CustomizedDartLibrarySupport(
+      unsupported: {if (!enableExperimentalFfi) 'ffi'});
 }
 
 class WasmVerification extends Verification {
diff --git a/pkg/dart2wasm/lib/translator.dart b/pkg/dart2wasm/lib/translator.dart
index a6b127061864..1268003c8198 100644
--- a/pkg/dart2wasm/lib/translator.dart
+++ b/pkg/dart2wasm/lib/translator.dart
@@ -42,6 +42,7 @@ class TranslatorOptions {
   bool minify = false;
   bool verifyTypeChecks = false;
   bool verbose = false;
+  bool enableExperimentalFfi = false;
   int inliningLimit = 0;
   int? sharedMemoryMaxPages;
   List<int> watchPoints = [];
diff --git a/pkg/dart2wasm/tool/compile_benchmark b/pkg/dart2wasm/tool/compile_benchmark
index 04cf0e30f293..e579037145fe 100755
--- a/pkg/dart2wasm/tool/compile_benchmark
+++ b/pkg/dart2wasm/tool/compile_benchmark
@@ -120,6 +120,11 @@ while [ $# -gt 0 ]; do
       shift
       ;;
 
+    --extra-compiler-option=*)
+      DART2WASM_ARGS+=(${1#--extra-compiler-option=})
+      shift
+      ;;
+
     --* | -*)
       DART2WASM_ARGS+=("$1")
       shift
diff --git a/tests/web/wasm/ffi/disabled_helper.dart b/tests/web/wasm/ffi/disabled_helper.dart
new file mode 100644
index 000000000000..d687007553c5
--- /dev/null
+++ b/tests/web/wasm/ffi/disabled_helper.dart
@@ -0,0 +1,5 @@
+// Copyright (c) 2024, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+String tryAccessFfi() => 'Have no dart:ffi support';
diff --git a/tests/web/wasm/ffi/disabled_test.dart b/tests/web/wasm/ffi/disabled_test.dart
new file mode 100644
index 000000000000..e5ffa67b1244
--- /dev/null
+++ b/tests/web/wasm/ffi/disabled_test.dart
@@ -0,0 +1,12 @@
+// Copyright (c) 2024, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:expect/expect.dart';
+
+import 'disabled_helper.dart' if (dart.library.ffi) 'enabled_helper.dart';
+
+void main() {
+  Expect.isFalse(const bool.fromEnvironment('dart.library.ffi'));
+  Expect.equals('Have no dart:ffi support', tryAccessFfi());
+}
diff --git a/tests/web/wasm/ffi/enabled_helper.dart b/tests/web/wasm/ffi/enabled_helper.dart
new file mode 100644
index 000000000000..09957bb10c38
--- /dev/null
+++ b/tests/web/wasm/ffi/enabled_helper.dart
@@ -0,0 +1,8 @@
+// Copyright (c) 2024, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:ffi';
+
+String tryAccessFfi() =>
+    'Have dart:ffi support (${Pointer<Int8>.fromAddress(int.parse('10')).address})';
diff --git a/tests/web/wasm/ffi/enabled_test.dart b/tests/web/wasm/ffi/enabled_test.dart
new file mode 100644
index 000000000000..15f94746a10e
--- /dev/null
+++ b/tests/web/wasm/ffi/enabled_test.dart
@@ -0,0 +1,14 @@
+// Copyright (c) 2024, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// dart2wasmOptions=--extra-compiler-option=--enable-experimental-ffi
+
+import 'package:expect/expect.dart';
+
+import 'disabled_helper.dart' if (dart.library.ffi) 'enabled_helper.dart';
+
+void main() {
+  Expect.isTrue(const bool.fromEnvironment('dart.library.ffi'));
+  Expect.equals('Have dart:ffi support (10)', tryAccessFfi());
+}
diff --git a/tests/web/wasm/ffi_native_test.dart b/tests/web/wasm/ffi/ffi_native_test.dart
similarity index 98%
rename from tests/web/wasm/ffi_native_test.dart
rename to tests/web/wasm/ffi/ffi_native_test.dart
index 6a31195c2a2b..2e958f045413 100644
--- a/tests/web/wasm/ffi_native_test.dart
+++ b/tests/web/wasm/ffi/ffi_native_test.dart
@@ -2,6 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+// dart2wasmOptions=--extra-compiler-option=--enable-experimental-ffi
 // SharedObjects=ffi_native_test_module
 
 import 'dart:ffi';
diff --git a/tests/web/wasm/ffi_native_test_module.c b/tests/web/wasm/ffi/ffi_native_test_module.c
similarity index 100%
rename from tests/web/wasm/ffi_native_test_module.c
rename to tests/web/wasm/ffi/ffi_native_test_module.c
diff --git a/utils/dart2wasm/BUILD.gn b/utils/dart2wasm/BUILD.gn
index 455e26223270..6d871989eaf2 100644
--- a/utils/dart2wasm/BUILD.gn
+++ b/utils/dart2wasm/BUILD.gn
@@ -14,7 +14,7 @@ template("wasm_module") {
       "compiled_action",
       rebase_path("//third_party/emsdk/upstream/emscripten/emcc"),
       "--no-entry",
-      rebase_path("//tests/web/wasm/${invoker.module_name}.c"),
+      rebase_path("//tests/web/wasm/ffi/${invoker.module_name}.c"),
       "-o",
       rebase_path("$root_out_dir/wasm/${invoker.module_name}.wasm"),
       "-O",