Implement transitive support for NPM dependencies

This commit implements [RFC 8], which enables transitive and transparent
dependencies on NPM. The `module` attribute, when seen and not part of a
local JS snippet, triggers detection of a `package.json` next to
`Cargo.toml`. If found it will cause the `wasm-bindgen` CLI tool to load
and parse the `package.json` within each crate and then create a merged
`package.json` at the end.

[RFC 8]: rustwasm/rfcs#8

Author: alexcrichton

.travis.yml

@@ -94,7 +94,7 @@ matrix:
       install:
         - *INSTALL_NODE_VIA_NVM
         - *INSTALL_AWS
-        - npm install
+        - mv _package.json package.json && npm install && rm package.json
         - curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh -s -- -f
       script:
         - cargo build -p wasm-bindgen-cli

package.json _package.jsonpackage.json renamed to _package.json

@@ -1,5 +1,5 @@
 use proc_macro2::{Ident, Span};
-use std::cell::RefCell;
+use std::cell::{RefCell, Cell};
 use std::collections::{HashMap, HashSet};
 use std::env;
 use std::fs;
@@ -29,6 +29,7 @@ struct Interner {
     files: RefCell<HashMap<String, LocalFile>>,
     root: PathBuf,
     crate_name: String,
+    has_package_json: Cell<bool>,
 }
 
 struct LocalFile {
@@ -45,6 +46,7 @@ impl Interner {
             files: RefCell::new(HashMap::new()),
             root: env::var_os("CARGO_MANIFEST_DIR").unwrap().into(),
             crate_name: env::var("CARGO_PKG_NAME").unwrap(),
+            has_package_json: Cell::new(false),
         }
     }
 
@@ -83,6 +85,7 @@ impl Interner {
             let msg = "relative module paths aren't supported yet";
             return Err(Diagnostic::span_error(span, msg))
         } else {
+            self.check_for_package_json();
             return Ok(self.intern_str(&id))
         };
 
@@ -98,6 +101,16 @@ impl Interner {
         drop(files);
         self.resolve_import_module(id, span)
     }
+
+    fn check_for_package_json(&self) {
+        if self.has_package_json.get() {
+            return
+        }
+        let path = self.root.join("package.json");
+        if path.exists() {
+            self.has_package_json.set(true);
+        }
+    }
 }
 
 fn shared_program<'a>(
@@ -149,6 +162,11 @@ fn shared_program<'a>(
             .iter()
             .map(|js| intern.intern_str(js))
             .collect(),
+        package_json: if intern.has_package_json.get() {
+            Some(intern.intern_str(intern.root.join("package.json").to_str().unwrap()))
+        } else {
+            None
+        },
     })
 }
 

crates/backend/src/encode.rs

@@ -16,6 +16,7 @@ base64 = "0.9"
 failure = "0.1.2"
 log = "0.4"
 rustc-demangle = "0.1.13"
+serde_json = "1.0"
 tempfile = "3.0"
 walrus = "0.4.0"
 wasm-bindgen-anyref-xform = { path = '../anyref-xform', version = '=0.2.37' }

crates/cli-support/Cargo.toml

@@ -4,6 +4,7 @@ use crate::{Bindgen, EncodeInto, OutputMode};
 use failure::{bail, Error, ResultExt};
 use std::collections::{HashMap, HashSet};
 use std::env;
+use std::fs;
 use walrus::{MemoryId, Module};
 use wasm_bindgen_wasm_interpreter::Interpreter;
 
@@ -62,6 +63,10 @@ pub struct Context<'a> {
     /// snippets. This is incremented each time a `Program` is processed.
     pub snippet_offset: usize,
 
+    /// All package.json dependencies we've learned about so far
+    pub package_json_read: HashSet<&'a str>,
+    pub npm_dependencies: HashMap<String, (&'a str, String)>,
+
     pub anyref: wasm_bindgen_anyref_xform::Context,
 }
 
@@ -1250,8 +1255,7 @@ impl<'a> Context<'a> {
                             passStringToWasm = function(arg) {{ {} }};
                         }}
                     ",
-                    use_encode_into,
-                    use_encode,
+                    use_encode_into, use_encode,
                 ));
             }
         }
@@ -2409,6 +2413,10 @@ impl<'a, 'b> SubContext<'a, 'b> {
             self.cx.typescript.push_str("\n\n");
         }
 
+        if let Some(path) = self.program.package_json {
+            self.add_package_json(path)?;
+        }
+
         Ok(())
     }
 
@@ -2869,6 +2877,67 @@ impl<'a, 'b> SubContext<'a, 'b> {
         let import = self.determine_import(import, item)?;
         Ok(self.cx.import_identifier(import))
     }
+
+    fn add_package_json(&mut self, path: &'b str) -> Result<(), Error> {
+        if !self.cx.package_json_read.insert(path) {
+            return Ok(());
+        }
+        if !self.cx.config.mode.nodejs() && !self.cx.config.mode.bundler() {
+            bail!("NPM dependencies have been specified in `{}` but \
+                   this is only compatible with the default output of \
+                   `wasm-bindgen` or the `--nodejs` flag");
+        }
+        let contents = fs::read_to_string(path).context(format!("failed to read `{}`", path))?;
+        let json: serde_json::Value = serde_json::from_str(&contents)?;
+        let object = match json.as_object() {
+            Some(s) => s,
+            None => bail!(
+                "expected `package.json` to have an JSON object in `{}`",
+                path
+            ),
+        };
+        let mut iter = object.iter();
+        let (key, value) = match iter.next() {
+            Some(pair) => pair,
+            None => return Ok(()),
+        };
+        if key != "dependencies" || iter.next().is_some() {
+            bail!(
+                "NPM manifest found at `{}` can currently only have one key, \
+                 `dependencies`, and no other fields",
+                path
+            );
+        }
+        let value = match value.as_object() {
+            Some(s) => s,
+            None => bail!("expected `dependencies` to be a JSON object in `{}`", path),
+        };
+
+        for (name, value) in value.iter() {
+            let value = match value.as_str() {
+                Some(s) => s,
+                None => bail!(
+                    "keys in `dependencies` are expected to be strings in `{}`",
+                    path
+                ),
+            };
+            if let Some((prev, _prev_version)) = self.cx.npm_dependencies.get(name) {
+                bail!(
+                    "dependency on NPM package `{}` specified in two `package.json` files, \
+                     which at the time is not allowed:\n  * {}\n  * {}",
+                    name,
+                    path,
+                    prev
+                )
+            }
+
+            self.cx
+                .npm_dependencies
+                .insert(name.to_string(), (path, value.to_string()));
+        }
+
+        Ok(())
+    }
 }
 
 #[derive(Hash, Eq, PartialEq)]

crates/cli-support/src/js/mod.rs

@@ -1,7 +1,7 @@
 #![doc(html_root_url = "https://docs.rs/wasm-bindgen-cli-support/0.2")]
 
 use failure::{bail, Error, ResultExt};
-use std::collections::BTreeSet;
+use std::collections::{BTreeSet, BTreeMap};
 use std::env;
 use std::fs;
 use std::mem;
@@ -305,6 +305,8 @@ impl Bindgen {
                 start: None,
                 anyref: Default::default(),
                 snippet_offset: 0,
+                npm_dependencies: Default::default(),
+                package_json_read: Default::default(),
             };
             cx.anyref.enabled = self.anyref;
             cx.anyref.prepare(cx.module)?;
@@ -335,6 +337,16 @@ impl Bindgen {
                     .with_context(|_| format!("failed to write `{}`", path.display()))?;
             }
 
+            if cx.npm_dependencies.len() > 0 {
+                let map = cx
+                    .npm_dependencies
+                    .iter()
+                    .map(|(k, v)| (k, &v.1))
+                    .collect::<BTreeMap<_, _>>();
+                let json = serde_json::to_string_pretty(&map)?;
+                fs::write(out_dir.join("package.json"), json)?;
+            }
+
             cx.finalize(stem)?
         };
 
@@ -630,7 +642,9 @@ fn demangle(module: &mut Module) {
 impl OutputMode {
     fn nodejs_experimental_modules(&self) -> bool {
         match self {
-            OutputMode::Node { experimental_modules } => *experimental_modules,
+            OutputMode::Node {
+                experimental_modules,
+            } => *experimental_modules,
             _ => false,
         }
     }
@@ -663,4 +677,11 @@ impl OutputMode {
             _ => false,
         }
     }
+
+    fn bundler(&self) -> bool {
+        match self {
+            OutputMode::Bundler => true,
+            _ => false,
+        }
+    }
 }

crates/cli-support/src/lib.rs

@@ -16,6 +16,7 @@ macro_rules! shared_api {
             typescript_custom_sections: Vec<&'a str>,
             local_modules: Vec<LocalModule<'a>>,
             inline_js: Vec<&'a str>,
+            package_json: Option<&'a str>,
         }
 
         struct Import<'a> {