Disable Automatic Activation of externref

CryZe · CryZe · commit 77ee2fd5731f · 2024-10-19T21:56:39.000+02:00
Starting with Rust 1.82 `reference-types` is always present in the
`target_features` section. The problem is that JS bundlers like Webpack
can't currently handle the `reference-types` proposal. So for now there
should not be any automatic detection of the feature and instead it
should explicitly be enabled by the user.
diff --git a/crates/cli-support/src/lib.rs b/crates/cli-support/src/lib.rs
@@ -323,11 +323,17 @@ impl Bindgen {
                 .context("failed getting Wasm module")?,
         };
 
-        // Enable reference type transformations if the module is already using it.
-        if let Ok(true) = wasm_bindgen_wasm_conventions::target_feature(&module, "reference-types")
-        {
-            self.externref = true;
-        }
+        // FIXME: Starting with Rust 1.82 `reference-types` is always present
+        // in the `target_features` section. The problem is that JS bundlers
+        // like Webpack can't currently handle the `reference-types` proposal.
+        // So for now there should not be any automatic detection of the feature
+        // and instead it should explicitly be enabled by the user.
+
+        // // Enable reference type transformations if the module is already using it.
+        // if let Ok(true) = wasm_bindgen_wasm_conventions::target_feature(&module, "reference-types")
+        // {
+        //     self.externref = true;
+        // }
 
         // Enable multivalue transformations if the module is already using it.
         if let Ok(true) = wasm_bindgen_wasm_conventions::target_feature(&module, "multivalue") {
diff --git a/crates/cli/tests/reference/add.wat b/crates/cli/tests/reference/add.wat
@@ -6,6 +6,6 @@
   (export "memory" (memory 0))
   (export "add_u32" (func $add_u32))
   (export "add_i32" (func $add_i32))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/builder.wat b/crates/cli/tests/reference/builder.wat
@@ -7,6 +7,6 @@
   (export "memory" (memory 0))
   (export "__wbg_classbuilder_free" (func $__wbg_classbuilder_free))
   (export "classbuilder_builder" (func $classbuilder_builder))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/constructor.wat b/crates/cli/tests/reference/constructor.wat
@@ -7,6 +7,6 @@
   (export "memory" (memory 0))
   (export "__wbg_classconstructor_free" (func $__wbg_classconstructor_free))
   (export "classconstructor_new" (func $classconstructor_new))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/empty.wat b/crates/cli/tests/reference/empty.wat
@@ -1,6 +1,6 @@
 (module $reference_test.wasm
   (memory (;0;) 16)
   (export "memory" (memory 0))
-  (@custom "target_features" (after export) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after export) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/enums.wat b/crates/cli/tests/reference/enums.wat
@@ -10,6 +10,6 @@
   (export "option_enum_echo" (func $option_enum_echo))
   (export "get_name" (func $get_name))
   (export "option_string_enum_echo" (func $option_string_enum_echo))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/import-catch.wat b/crates/cli/tests/reference/import-catch.wat
@@ -9,6 +9,6 @@
   (export "exported" (func $exported))
   (export "__wbindgen_exn_store" (func $__wbindgen_exn_store))
   (export "__wbindgen_add_to_stack_pointer" (func $__wbindgen_add_to_stack_pointer))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/nop.wat b/crates/cli/tests/reference/nop.wat
@@ -4,6 +4,6 @@
   (memory (;0;) 17)
   (export "memory" (memory 0))
   (export "nop" (func $nop))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/pointers.wat b/crates/cli/tests/reference/pointers.wat
@@ -6,6 +6,6 @@
   (export "memory" (memory 0))
   (export "const_pointer" (func $const_pointer))
   (export "mut_pointer" (func $mut_pointer))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/raw.wat b/crates/cli/tests/reference/raw.wat
@@ -11,6 +11,6 @@
   (export "__wbg_test_free" (func $__wbg_test_free))
   (export "test_test1" (func $test_test1))
   (export "test_test2" (func $test_test2))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/result-string.wat b/crates/cli/tests/reference/result-string.wat
@@ -10,6 +10,6 @@
   (export "exported" (func $exported))
   (export "__wbindgen_add_to_stack_pointer" (func $__wbindgen_add_to_stack_pointer))
   (export "__wbindgen_free" (func $__wbindgen_free))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/self-type.wat b/crates/cli/tests/reference/self-type.wat
@@ -20,6 +20,6 @@
   (export "test_self_Self" (func $test_self_Self))
   (export "test_self_ref_Self" (func $test_self_ref_Self))
   (export "test_self_ref_mut_Self" (func $test_self_ref_mut_Self))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/skip-jsdoc.wat b/crates/cli/tests/reference/skip-jsdoc.wat
@@ -6,6 +6,6 @@
   (export "memory" (memory 0))
   (export "docme" (func $docme))
   (export "i_has_docs" (func $i_has_docs))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/string-arg.wat b/crates/cli/tests/reference/string-arg.wat
@@ -10,6 +10,6 @@
   (export "foo" (func $foo))
   (export "__wbindgen_malloc" (func $__wbindgen_malloc))
   (export "__wbindgen_realloc" (func $__wbindgen_realloc))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 
diff --git a/crates/cli/tests/reference/web-sys.wat b/crates/cli/tests/reference/web-sys.wat
@@ -15,6 +15,6 @@
   (export "__wbindgen_exn_store" (func $__wbindgen_exn_store))
   (export "__wbindgen_malloc" (func $__wbindgen_malloc))
   (export "__wbindgen_realloc" (func $__wbindgen_realloc))
-  (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")
+  (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")
 )
 

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@`
`6`	`6`	`(export "memory" (memory 0))`
`7`	`7`	`(export "add_u32" (func $add_u32))`
`8`	`8`	`(export "add_i32" (func $add_i32))`
`9`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`9`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`10`	`10`	`)`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@`
`7`	`7`	`(export "memory" (memory 0))`
`8`	`8`	`(export "__wbg_classbuilder_free" (func $__wbg_classbuilder_free))`
`9`	`9`	`(export "classbuilder_builder" (func $classbuilder_builder))`
`10`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`10`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`11`	`11`	`)`
`12`	`12`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@`
`7`	`7`	`(export "memory" (memory 0))`
`8`	`8`	`(export "__wbg_classconstructor_free" (func $__wbg_classconstructor_free))`
`9`	`9`	`(export "classconstructor_new" (func $classconstructor_new))`
`10`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`10`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`11`	`11`	`)`
`12`	`12`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`(module $reference_test.wasm`
`2`	`2`	`(memory (;0;) 16)`
`3`	`3`	`(export "memory" (memory 0))`
`4`		`- (@custom "target_features" (after export) "\02+\0fmutable-globals+\08sign-ext")`
	`4`	`+ (@custom "target_features" (after export) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`5`	`5`	`)`
`6`	`6`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,6 @@`
`10`	`10`	`(export "option_enum_echo" (func $option_enum_echo))`
`11`	`11`	`(export "get_name" (func $get_name))`
`12`	`12`	`(export "option_string_enum_echo" (func $option_string_enum_echo))`
`13`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`13`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`14`	`14`	`)`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@`
`9`	`9`	`(export "exported" (func $exported))`
`10`	`10`	`(export "__wbindgen_exn_store" (func $__wbindgen_exn_store))`
`11`	`11`	`(export "__wbindgen_add_to_stack_pointer" (func $__wbindgen_add_to_stack_pointer))`
`12`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`12`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`13`	`13`	`)`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@`
`4`	`4`	`(memory (;0;) 17)`
`5`	`5`	`(export "memory" (memory 0))`
`6`	`6`	`(export "nop" (func $nop))`
`7`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`7`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`8`	`8`	`)`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@`
`6`	`6`	`(export "memory" (memory 0))`
`7`	`7`	`(export "const_pointer" (func $const_pointer))`
`8`	`8`	`(export "mut_pointer" (func $mut_pointer))`
`9`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`9`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`10`	`10`	`)`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,6 @@`
`11`	`11`	`(export "__wbg_test_free" (func $__wbg_test_free))`
`12`	`12`	`(export "test_test1" (func $test_test1))`
`13`	`13`	`(export "test_test2" (func $test_test2))`
`14`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`14`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`15`	`15`	`)`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,6 @@`
`20`	`20`	`(export "test_self_Self" (func $test_self_Self))`
`21`	`21`	`(export "test_self_ref_Self" (func $test_self_ref_Self))`
`22`	`22`	`(export "test_self_ref_mut_Self" (func $test_self_ref_mut_Self))`
`23`		`- (@custom "target_features" (after code) "\02+\0fmutable-globals+\08sign-ext")`
	`23`	`+ (@custom "target_features" (after code) "\04+\0amultivalue+\0fmutable-globals+\0freference-types+\08sign-ext")`
`24`	`24`	`)`
`25`	`25`