feat: Add proto header to generated code

tottoto · tottoto · commit 7916212af32b · 2025-03-25T06:56:27.000+09:00
diff --git a/codegen/src/main.rs b/codegen/src/main.rs
@@ -113,7 +113,22 @@ fn codegen(
 fn write_fds(fds: &FileDescriptorSet, path: &Path) {
     const GENERATED_COMMENT: &str = "// This file is @generated by codegen.";
 
+    let mut file_header = String::new();
+
     let mut fds = fds.clone();
+
+    for fd in fds.file.iter() {
+        let Some(source_code_info) = &fd.source_code_info else {
+            continue;
+        };
+
+        for location in &source_code_info.location {
+            for comment in &location.leading_detached_comments {
+                file_header += comment;
+            }
+        }
+    }
+
     for fd in fds.file.iter_mut() {
         fd.source_code_info = None;
     }
@@ -126,8 +141,23 @@ fn write_fds(fds: &FileDescriptorSet, path: &Path) {
     let ast = syn::parse2(tokens).unwrap();
     let formatted = prettyplease::unparse(&ast);
 
-    let content = format!("{GENERATED_COMMENT}\n{formatted}");
-
     let mut writer = BufWriter::new(File::create(path).unwrap());
-    writer.write_all(content.as_bytes()).unwrap();
+
+    writer.write_all(GENERATED_COMMENT.as_bytes()).unwrap();
+    writer.write_all(b"\n").unwrap();
+
+    if !file_header.is_empty() {
+        let file_header = comment_out(&file_header);
+        writer.write_all(file_header.as_bytes()).unwrap();
+        writer.write_all(b"\n").unwrap();
+    }
+
+    writer.write_all(formatted.as_bytes()).unwrap()
+}
+
+fn comment_out(s: &str) -> String {
+    s.split('\n')
+        .map(|line| format!("// {line}"))
+        .collect::<Vec<String>>()
+        .join("\n")
 }
diff --git a/tonic-health/src/generated/grpc_health_v1_fds.rs b/tonic-health/src/generated/grpc_health_v1_fds.rs
@@ -1,4 +1,20 @@
 // This file is @generated by codegen.
+//  Copyright 2015 The gRPC Authors
+// 
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+// 
+//      http://www.apache.org/licenses/LICENSE-2.0
+// 
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//  The canonical version of this proto can be found at
+//  https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto
+// 
 /// Byte encoded FILE_DESCRIPTOR_SET.
 pub const FILE_DESCRIPTOR_SET: &[u8] = &[
     10u8, 158u8, 4u8, 10u8, 12u8, 104u8, 101u8, 97u8, 108u8, 116u8, 104u8, 46u8, 112u8,
diff --git a/tonic-reflection/src/generated/reflection_v1_fds.rs b/tonic-reflection/src/generated/reflection_v1_fds.rs
@@ -1,4 +1,24 @@
 // This file is @generated by codegen.
+//  Copyright 2016 The gRPC Authors
+// 
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+// 
+//      http://www.apache.org/licenses/LICENSE-2.0
+// 
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//  Service exported by server reflection.  A more complete description of how
+//  server reflection works can be found at
+//  https://github.com/grpc/grpc/blob/master/doc/server-reflection.md
+// 
+//  The canonical version of this proto can be found at
+//  https://github.com/grpc/grpc-proto/blob/master/grpc/reflection/v1/reflection.proto
+// 
 /// Byte encoded FILE_DESCRIPTOR_SET.
 pub const FILE_DESCRIPTOR_SET: &[u8] = &[
     10u8, 192u8, 13u8, 10u8, 19u8, 114u8, 101u8, 102u8, 108u8, 101u8, 99u8, 116u8, 105u8,
diff --git a/tonic-reflection/src/generated/reflection_v1alpha1_fds.rs b/tonic-reflection/src/generated/reflection_v1alpha1_fds.rs
@@ -1,4 +1,19 @@
 // This file is @generated by codegen.
+//  Copyright 2016 gRPC authors.
+// 
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+// 
+//      http://www.apache.org/licenses/LICENSE-2.0
+// 
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//  Service exported by server reflection
+// 
 /// Byte encoded FILE_DESCRIPTOR_SET.
 pub const FILE_DESCRIPTOR_SET: &[u8] = &[
     10u8, 143u8, 13u8, 10u8, 24u8, 114u8, 101u8, 102u8, 108u8, 101u8, 99u8, 116u8, 105u8,
diff --git a/tonic-types/src/generated/types_fds.rs b/tonic-types/src/generated/types_fds.rs
@@ -1,4 +1,89 @@
 // This file is @generated by codegen.
+//  Protocol Buffers - Google's data interchange format
+//  Copyright 2008 Google Inc.  All rights reserved.
+//  https://developers.google.com/protocol-buffers/
+// 
+//  Redistribution and use in source and binary forms, with or without
+//  modification, are permitted provided that the following conditions are
+//  met:
+// 
+//      * Redistributions of source code must retain the above copyright
+//  notice, this list of conditions and the following disclaimer.
+//      * Redistributions in binary form must reproduce the above
+//  copyright notice, this list of conditions and the following disclaimer
+//  in the documentation and/or other materials provided with the
+//  distribution.
+//      * Neither the name of Google Inc. nor the names of its
+//  contributors may be used to endorse or promote products derived from
+//  this software without specific prior written permission.
+// 
+//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+//  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+//  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+//  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+//  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+//  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+//  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+//  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+//  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+//  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//  Copyright 2020 Google LLC
+// 
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+// 
+//      http://www.apache.org/licenses/LICENSE-2.0
+// 
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//  Protocol Buffers - Google's data interchange format
+//  Copyright 2008 Google Inc.  All rights reserved.
+//  https://developers.google.com/protocol-buffers/
+// 
+//  Redistribution and use in source and binary forms, with or without
+//  modification, are permitted provided that the following conditions are
+//  met:
+// 
+//      * Redistributions of source code must retain the above copyright
+//  notice, this list of conditions and the following disclaimer.
+//      * Redistributions in binary form must reproduce the above
+//  copyright notice, this list of conditions and the following disclaimer
+//  in the documentation and/or other materials provided with the
+//  distribution.
+//      * Neither the name of Google Inc. nor the names of its
+//  contributors may be used to endorse or promote products derived from
+//  this software without specific prior written permission.
+// 
+//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+//  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+//  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+//  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+//  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+//  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+//  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+//  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+//  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+//  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//  Copyright 2020 Google LLC
+// 
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+// 
+//      http://www.apache.org/licenses/LICENSE-2.0
+// 
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+// 
 /// Byte encoded FILE_DESCRIPTOR_SET.
 pub const FILE_DESCRIPTOR_SET: &[u8] = &[
     10u8, 228u8, 1u8, 10u8, 25u8, 103u8, 111u8, 111u8, 103u8, 108u8, 101u8, 47u8, 112u8,
