Merge pull request #27 from cloudflare/fix/missing-nodes

Fix missing node errors when importing annotations

recapnc/src/generator.rs

@@ -13,9 +13,8 @@ use recapn::ptr::{ElementSize, StructSize, UnwrapErrors};
 use recapn::{any, data, text, ReaderOf};
 use syn::punctuated::Punctuated;
 use syn::PathSegment;
-use thiserror::Error;
 
-use crate::Result;
+use crate::{Error, Result};
 use crate::quotes::{
     FieldDescriptor, GeneratedConst, GeneratedEnum, GeneratedField, GeneratedFile, GeneratedItem,
     GeneratedRootFile, GeneratedStruct, GeneratedVariant, GeneratedWhich,
@@ -211,7 +210,7 @@ impl fmt::Display for NameContext {
     }
 }
 
-#[derive(Debug, Error)]
+#[derive(Debug, thiserror::Error)]
 pub enum GeneratorError {
     #[error("name for {context} is not valid UTF8: {error}")]
     InvalidName {
@@ -253,7 +252,14 @@ fn validate_file(
     });
 
     for nested in schema.nested_items() {
-        validate_item(nested?, nodes, identifiers, &mut scope)?;
+        let nested = match nested {
+            Ok(n) => n,
+            // Unreferenced nodes from files not requested can be missing, so we just continue.
+            // If it turns out we needed it, an error will come up later.
+            Err(Error::Schema(SchemaError::MissingNode(_))) => continue,
+            res @ Err(_) => res?,
+        };
+        validate_item(nested, nodes, identifiers, &mut scope)?;
     }
 
     Ok(())

tests/build.rs

@@ -1,9 +1,23 @@
+use std::env;
+use std::path::PathBuf;
+
 fn main() {
     println!("cargo::rerun-if-changed=schemas");
 
-    recapnc::CapnpCommand::new()
-        .src_prefix("schemas")
-        .file("schemas/build.capnp")
-        .file("schemas/bar.capnp")
-        .write_to_out_dir();
+    let out_dir = PathBuf::from(env::var_os("OUT_DIR").unwrap());
+
+    macro_rules! run {
+        ($base:literal: $($path:literal),*) => {
+            recapnc::CapnpCommand::new()
+                .src_prefix(concat!("schemas/", $base))
+                $(.file(concat!("schemas/", $base, "/", $path)))*
+                .write_to(out_dir.join($base))
+        };
+    }
+
+    // Simple test with imports
+    run!("build_rs": "build.capnp", "bar.capnp");
+
+    // Test that we ignore missing nodes when generating
+    run!("missing_annotation": "foo.capnp");
 }

tests/schemas/missing_annotation/annotate.capnp

@@ -0,0 +1,5 @@
+@0xb8db38b1a3d69f76;
+
+annotation test(file) :Text;
+
+annotation unused(file) :Text;

tests/schemas/missing_annotation/foo.capnp

@@ -0,0 +1,8 @@
+@0xb782057765b9e46e;
+
+# Add a test annotation, but don't use the "unused" annotation. It should be missing in the
+# CodeGeneratorRequest and originally caused an error to occur in the code generator.
+$import "annotate.capnp".test("hi!");
+
+struct Foo {}
+

tests/src/lib.rs

@@ -4,7 +4,7 @@
 pub mod gen;
 
 pub mod build_gen {
-    include!(concat!(env!("OUT_DIR"), "/mod.rs"));
+    include!(concat!(env!("OUT_DIR"), "/build_rs/mod.rs"));
 }
 
 use gen::capnp_test_capnp::{TestAllTypes, TestEnum};