From ab0194f91bfd01b1d57b26112c8d7c263cd7f9a4 Mon Sep 17 00:00:00 2001
From: Rain <rain@oxide.computer>
Date: Sat, 12 Oct 2024 11:02:59 -0700
Subject: [PATCH] [dropshot_endpoint] add allow(dead_code) to output trait

In general, we should treat the fact that our macro was invoked on the trait as
enough of a use.
---
 dropshot_endpoint/src/api_trait.rs            | 21 ++++++++++++++++++-
 .../tests/output/api_trait_basic.rs           |  1 +
 .../tests/output/api_trait_no_endpoints.rs    |  1 +
 .../tests/output/api_trait_operation_id.rs    |  4 ++--
 4 files changed, 24 insertions(+), 3 deletions(-)

diff --git a/dropshot_endpoint/src/api_trait.rs b/dropshot_endpoint/src/api_trait.rs
index 9fffac94..02ed6b17 100644
--- a/dropshot_endpoint/src/api_trait.rs
+++ b/dropshot_endpoint/src/api_trait.rs
@@ -365,8 +365,27 @@ impl<'ast> ApiParser<'ast> {
         let mut supertraits = item_trait.supertraits.clone();
         supertraits.push(parse_quote!('static));
 
+        // Also add dead_code if the visibility is not `pub`. (If it is `pub`,
+        // then it is expected to be exported, and so the dead code warning
+        // won't fire.)
+        //
+        // Why check for non-`pub` visibility? Because there is a downside to
+        // allow(dead_code): it also applies to any items defined within the
+        // trait. For example, if a provided method on the trait defines an
+        // unused function inside of it, then allow(dead_code) would suppress
+        // that.
+        //
+        // It would be ideal if there were a way to say "allow(dead_code), but
+        // don't propagate this to child items", but sadly there isn't as of
+        // Rust 1.81.
+        let mut attrs = item_trait.attrs.clone();
+        if !matches!(item_trait.vis, syn::Visibility::Public(_)) {
+            attrs.push(parse_quote!(#[allow(dead_code)]));
+        }
+
         // Everything else about the trait stays the same -- just the items change.
         let out_trait = ItemTraitPartParsed {
+            attrs,
             supertraits,
             items: out_items.collect(),
             ..item_trait.clone()
@@ -1765,7 +1784,7 @@ mod tests {
         let (item, errors) = do_trait(
             quote! {},
             quote! {
-                trait MyTrait {
+                pub trait MyTrait {
                     type Context;
 
                     #[endpoint {
diff --git a/dropshot_endpoint/tests/output/api_trait_basic.rs b/dropshot_endpoint/tests/output/api_trait_basic.rs
index 3229ce06..726ae913 100644
--- a/dropshot_endpoint/tests/output/api_trait_basic.rs
+++ b/dropshot_endpoint/tests/output/api_trait_basic.rs
@@ -1,3 +1,4 @@
+#[allow(dead_code)]
 trait MyTrait: 'static {
     type Context: dropshot::ServerContext;
     fn handler_xyz(
diff --git a/dropshot_endpoint/tests/output/api_trait_no_endpoints.rs b/dropshot_endpoint/tests/output/api_trait_no_endpoints.rs
index 31a007f2..66566b0d 100644
--- a/dropshot_endpoint/tests/output/api_trait_no_endpoints.rs
+++ b/dropshot_endpoint/tests/output/api_trait_no_endpoints.rs
@@ -1,3 +1,4 @@
+#[allow(dead_code)]
 pub(crate) trait MyTrait: 'static {
     type Context: dropshot::ServerContext;
 }
diff --git a/dropshot_endpoint/tests/output/api_trait_operation_id.rs b/dropshot_endpoint/tests/output/api_trait_operation_id.rs
index 52a2fc87..9309b7f0 100644
--- a/dropshot_endpoint/tests/output/api_trait_operation_id.rs
+++ b/dropshot_endpoint/tests/output/api_trait_operation_id.rs
@@ -1,4 +1,4 @@
-trait MyTrait: 'static {
+pub trait MyTrait: 'static {
     type Context: dropshot::ServerContext;
     fn handler_xyz(
         rqctx: RequestContext<Self::Context>,
@@ -12,7 +12,7 @@ trait MyTrait: 'static {
 }
 /// Support module for the Dropshot API trait [`MyTrait`](MyTrait).
 #[automatically_derived]
-mod my_trait_mod {
+pub mod my_trait_mod {
     use super::*;
     const _: fn() = || {
         trait TypeEq {