Merge pull request #45 from rylev/clearer-binary-error

Provide a clearer error message when package is not component

Author: peterhuene

crates/wac-parser/src/resolution/package.rs

@@ -62,6 +62,9 @@ impl Package {
         version: Option<&Version>,
         bytes: Arc<Vec<u8>>,
     ) -> Result<Self> {
+        if !has_magic_header(&bytes) {
+            bail!("package `{name}` is expected to be a binary WebAssembly component binary but is not");
+        }
         let mut parser = Parser::new(0);
         let mut parsers = Vec::new();
         let mut validator = Validator::new_with_features(WasmFeatures {
@@ -182,6 +185,11 @@ impl Package {
     }
 }
 
+/// Whether the given bytes have a magic header indicating a WebAssembly binary.
+fn has_magic_header(bytes: &[u8]) -> bool {
+    bytes.starts_with(b"\0asm")
+}
+
 impl fmt::Debug for Package {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         f.debug_struct("Package")

crates/wac-parser/tests/resolution/fail/package-not-wasm.wac.result

@@ -1,17 +1,7 @@
 failed to resolve document
 
   × failed to parse package `foo:bar`
-  ╰─▶ magic header not detected: bad magic number - expected=[
-          0x0,
-          0x61,
-          0x73,
-          0x6d,
-      ] actual=[
-          0x74,
-          0x68,
-          0x69,
-          0x73,
-      ] (at offset 0x0)
+  ╰─▶ package `foo:bar` is expected to be a binary WebAssembly component binary but is not
    ╭─[tests/resolution/fail/package-not-wasm.wac:3:13]
  2 │ 
  3 │ import foo: foo:bar/qux;