From 77db9ea2d168f1c19136abdfc766b52702d450bf Mon Sep 17 00:00:00 2001 From: tottoto Date: Tue, 10 Jan 2023 03:21:06 +0900 Subject: [PATCH] feat: Rename api related to protobuf --- tonic-health/src/lib.rs | 18 +++++++++--------- tonic-health/src/server.rs | 16 ++++++++-------- tonic-reflection/src/lib.rs | 3 ++- tonic-reflection/src/server.rs | 10 +++++----- tonic-reflection/tests/server.rs | 2 +- 5 files changed, 25 insertions(+), 24 deletions(-) diff --git a/tonic-health/src/lib.rs b/tonic-health/src/lib.rs index d8ef43f67..ae6161dd1 100644 --- a/tonic-health/src/lib.rs +++ b/tonic-health/src/lib.rs @@ -24,22 +24,22 @@ use std::fmt::{Display, Formatter}; /// Generated protobuf types from the `grpc.health.v1` package. -pub mod proto { +pub mod pb { #![allow(unreachable_pub)] #![allow(missing_docs)] include!("generated/grpc.health.v1.rs"); - pub const GRPC_HEALTH_V1_FILE_DESCRIPTOR_SET: &[u8] = - include_bytes!("generated/grpc_health_v1.bin"); + /// Byte encoded FILE_DESCRIPTOR_SET. + pub const FILE_DESCRIPTOR_SET: &[u8] = include_bytes!("generated/grpc_health_v1.bin"); #[cfg(test)] mod tests { - use super::GRPC_HEALTH_V1_FILE_DESCRIPTOR_SET; + use super::FILE_DESCRIPTOR_SET; use prost::Message as _; #[test] fn file_descriptor_set_is_valid() { - prost_types::FileDescriptorSet::decode(GRPC_HEALTH_V1_FILE_DESCRIPTOR_SET).unwrap(); + prost_types::FileDescriptorSet::decode(FILE_DESCRIPTOR_SET).unwrap(); } } } @@ -67,12 +67,12 @@ impl Display for ServingStatus { } } -impl From for proto::health_check_response::ServingStatus { +impl From for pb::health_check_response::ServingStatus { fn from(s: ServingStatus) -> Self { match s { - ServingStatus::Unknown => proto::health_check_response::ServingStatus::Unknown, - ServingStatus::Serving => proto::health_check_response::ServingStatus::Serving, - ServingStatus::NotServing => proto::health_check_response::ServingStatus::NotServing, + ServingStatus::Unknown => pb::health_check_response::ServingStatus::Unknown, + ServingStatus::Serving => pb::health_check_response::ServingStatus::Serving, + ServingStatus::NotServing => pb::health_check_response::ServingStatus::NotServing, } } } diff --git a/tonic-health/src/server.rs b/tonic-health/src/server.rs index 10ec38a0e..0bdc7911c 100644 --- a/tonic-health/src/server.rs +++ b/tonic-health/src/server.rs @@ -1,7 +1,7 @@ //! Contains all healthcheck based server utilities. -use crate::proto::health_server::{Health, HealthServer}; -use crate::proto::{HealthCheckRequest, HealthCheckResponse}; +use crate::pb::health_server::{Health, HealthServer}; +use crate::pb::{HealthCheckRequest, HealthCheckResponse}; use crate::ServingStatus; use std::collections::HashMap; use std::pin::Pin; @@ -132,7 +132,7 @@ impl Health for HealthService { match status { None => Err(Status::not_found("service not registered")), Some(status) => Ok(Response::new(HealthCheckResponse { - status: crate::proto::health_check_response::ServingStatus::from(status) as i32, + status: crate::pb::health_check_response::ServingStatus::from(status) as i32, })), } } @@ -152,11 +152,11 @@ impl Health for HealthService { let output = async_stream::try_stream! { // yield the current value - let status = crate::proto::health_check_response::ServingStatus::from(*status_rx.borrow()) as i32; + let status = crate::pb::health_check_response::ServingStatus::from(*status_rx.borrow()) as i32; yield HealthCheckResponse { status }; while let Ok(_) = status_rx.changed().await { - let status = crate::proto::health_check_response::ServingStatus::from(*status_rx.borrow()) as i32; + let status = crate::pb::health_check_response::ServingStatus::from(*status_rx.borrow()) as i32; yield HealthCheckResponse { status }; } }; @@ -167,8 +167,8 @@ impl Health for HealthService { #[cfg(test)] mod tests { - use crate::proto::health_server::Health; - use crate::proto::HealthCheckRequest; + use crate::pb::health_server::Health; + use crate::pb::HealthCheckRequest; use crate::server::{HealthReporter, HealthService}; use crate::ServingStatus; use tokio::sync::watch; @@ -176,7 +176,7 @@ mod tests { use tonic::{Code, Request, Status}; fn assert_serving_status(wire: i32, expected: ServingStatus) { - let expected = crate::proto::health_check_response::ServingStatus::from(expected) as i32; + let expected = crate::pb::health_check_response::ServingStatus::from(expected) as i32; assert_eq!(wire, expected); } diff --git a/tonic-reflection/src/lib.rs b/tonic-reflection/src/lib.rs index a7938b595..d8c75326f 100644 --- a/tonic-reflection/src/lib.rs +++ b/tonic-reflection/src/lib.rs @@ -16,12 +16,13 @@ #![cfg_attr(docsrs, feature(doc_cfg))] /// Generated protobuf types from the `grpc.reflection.v1alpha` package. -pub mod proto { +pub mod pb { #![allow(unreachable_pub)] #![allow(missing_docs)] #![allow(rustdoc::invalid_html_tags)] include!("generated/grpc.reflection.v1alpha.rs"); + /// Byte encoded FILE_DESCRIPTOR_SET. pub const FILE_DESCRIPTOR_SET: &[u8] = include_bytes!("generated/reflection_v1alpha1.bin"); #[cfg(test)] diff --git a/tonic-reflection/src/server.rs b/tonic-reflection/src/server.rs index 0fad5a158..a28380451 100644 --- a/tonic-reflection/src/server.rs +++ b/tonic-reflection/src/server.rs @@ -1,7 +1,7 @@ -use crate::proto::server_reflection_request::MessageRequest; -use crate::proto::server_reflection_response::MessageResponse; -pub use crate::proto::server_reflection_server::{ServerReflection, ServerReflectionServer}; -use crate::proto::{ +use crate::pb::server_reflection_request::MessageRequest; +use crate::pb::server_reflection_response::MessageResponse; +pub use crate::pb::server_reflection_server::{ServerReflection, ServerReflectionServer}; +use crate::pb::{ ExtensionNumberResponse, FileDescriptorResponse, ListServiceResponse, ServerReflectionRequest, ServerReflectionResponse, ServiceResponse, }; @@ -109,7 +109,7 @@ impl<'b> Builder<'b> { /// Build a gRPC Reflection Service to be served via Tonic. pub fn build(mut self) -> Result, Error> { if self.include_reflection_service { - self = self.register_encoded_file_descriptor_set(crate::proto::FILE_DESCRIPTOR_SET); + self = self.register_encoded_file_descriptor_set(crate::pb::FILE_DESCRIPTOR_SET); } for encoded in &self.encoded_file_descriptor_sets { diff --git a/tonic-reflection/tests/server.rs b/tonic-reflection/tests/server.rs index 193a87cd1..7ecd747bc 100644 --- a/tonic-reflection/tests/server.rs +++ b/tonic-reflection/tests/server.rs @@ -6,7 +6,7 @@ use tokio::sync::oneshot; use tokio_stream::{wrappers::TcpListenerStream, StreamExt}; use tonic::{transport::Server, Request}; use tonic_reflection::{ - proto::{ + pb::{ server_reflection_client::ServerReflectionClient, server_reflection_request::MessageRequest, server_reflection_response::MessageResponse, ServerReflectionRequest, ServiceResponse, FILE_DESCRIPTOR_SET,