BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-07-05 16:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Swift] Append namespace for Swift Grpc implementation (#6049)

Browse Source 
* [Swift] Append namespace for Swift Grpc implementation
* Separate ServiceName from ServiceQualifiedName.
This commit is contained in:
Liu Liu
2020-07-31 00:07:45 -07:00
committed by GitHub
parent 77c18c1d69
commit a0fb30575c
4 changed files with 52 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
grpc/src/compiler/schema_interface.h
View File

@@ -62,7 +62,9 @@ struct Method : public CommentHolder {
grpc::string *str, grpc::string generator_file_name, grpc::string *str, grpc::string generator_file_name,
bool generate_in_pb2_grpc, grpc::string import_prefix) const = 0; bool generate_in_pb2_grpc, grpc::string import_prefix) const = 0;
virtual std::vector<grpc::string> get_input_namespace_parts() const = 0;
virtual grpc::string get_input_type_name() const = 0; virtual grpc::string get_input_type_name() const = 0;
virtual std::vector<grpc::string> get_output_namespace_parts() const = 0;
virtual grpc::string get_output_type_name() const = 0; virtual grpc::string get_output_type_name() const = 0;
virtual grpc::string get_fb_builder() const = 0; virtual grpc::string get_fb_builder() const = 0;
@@ -77,6 +79,7 @@ struct Method : public CommentHolder {
struct Service : public CommentHolder { struct Service : public CommentHolder {
virtual ~Service() {} virtual ~Service() {}
virtual std::vector<grpc::string> namespace_parts() const = 0;
virtual grpc::string name() const = 0; virtual grpc::string name() const = 0;
virtual int method_count() const = 0; virtual int method_count() const = 0;

40
grpc/src/compiler/swift_generator.cc
View File

@@ -29,8 +29,15 @@
namespace grpc_swift_generator { namespace grpc_swift_generator {
grpc::string GenerateMessage(const grpc::string &name) { std::string WrapInNameSpace(const std::vector<std::string> &components, const grpc::string &name) {
return "Message<" + name + ">"; std::string qualified_name;
for (auto it = components.begin(); it != components.end(); ++it)
qualified_name += *it + "_";
return qualified_name + name;
}
grpc::string GenerateMessage(const std::vector<std::string> &components, const grpc::string &name) {
return "Message<" + WrapInNameSpace(components, name) + ">";
} }
// MARK: - Client // MARK: - Client
@@ -85,12 +92,12 @@ void GenerateClientProtocol(const grpc_generator::Service *service,
grpc_generator::Printer *printer, grpc_generator::Printer *printer,
std::map<grpc::string, grpc::string> *dictonary) { std::map<grpc::string, grpc::string> *dictonary) {
auto vars = *dictonary; auto vars = *dictonary;
printer->Print(vars, "$ACCESS$ protocol $ServiceName$Service {\n"); printer->Print(vars, "$ACCESS$ protocol $ServiceQualifiedName$Service {\n");
vars["GenAccess"] = ""; vars["GenAccess"] = "";
for (auto it = 0; it < service->method_count(); it++) { for (auto it = 0; it < service->method_count(); it++) {
auto method = service->method(it); auto method = service->method(it);
vars["Input"] = GenerateMessage(method->get_input_type_name()); vars["Input"] = GenerateMessage(method->get_input_namespace_parts(), method->get_input_type_name());
vars["Output"] = GenerateMessage(method->get_output_type_name()); vars["Output"] = GenerateMessage(method->get_output_namespace_parts(), method->get_output_type_name());
vars["MethodName"] = method->name(); vars["MethodName"] = method->name();
vars["isNil"] = ""; vars["isNil"] = "";
printer->Print("\t"); printer->Print("\t");
@@ -106,8 +113,8 @@ void GenerateClientClass(const grpc_generator::Service *service,
std::map<grpc::string, grpc::string> *dictonary) { std::map<grpc::string, grpc::string> *dictonary) {
auto vars = *dictonary; auto vars = *dictonary;
printer->Print(vars, printer->Print(vars,
"$ACCESS$ final class $ServiceName$ServiceClient: GRPCClient, " "$ACCESS$ final class $ServiceQualifiedName$ServiceClient: GRPCClient, "
"$ServiceName$Service {\n"); "$ServiceQualifiedName$Service {\n");
printer->Print(vars, "\t$ACCESS$ let channel: GRPCChannel\n"); printer->Print(vars, "\t$ACCESS$ let channel: GRPCChannel\n");
printer->Print(vars, "\t$ACCESS$ var defaultCallOptions: CallOptions\n"); printer->Print(vars, "\t$ACCESS$ var defaultCallOptions: CallOptions\n");
printer->Print("\n"); printer->Print("\n");
@@ -121,8 +128,8 @@ void GenerateClientClass(const grpc_generator::Service *service,
vars["GenAccess"] = "public"; vars["GenAccess"] = "public";
for (auto it = 0; it < service->method_count(); it++) { for (auto it = 0; it < service->method_count(); it++) {
auto method = service->method(it); auto method = service->method(it);
vars["Input"] = GenerateMessage(method->get_input_type_name()); vars["Input"] = GenerateMessage(method->get_input_namespace_parts(), method->get_input_type_name());
vars["Output"] = GenerateMessage(method->get_output_type_name()); vars["Output"] = GenerateMessage(method->get_output_namespace_parts(), method->get_output_type_name());
vars["MethodName"] = method->name(); vars["MethodName"] = method->name();
vars["isNil"] = " = nil"; vars["isNil"] = " = nil";
printer->Print("\n\t"); printer->Print("\n\t");
@@ -208,11 +215,11 @@ void GenerateServerProtocol(const grpc_generator::Service *service,
std::map<grpc::string, grpc::string> *dictonary) { std::map<grpc::string, grpc::string> *dictonary) {
auto vars = *dictonary; auto vars = *dictonary;
printer->Print( printer->Print(
vars, "$ACCESS$ protocol $ServiceName$Provider: CallHandlerProvider {\n"); vars, "$ACCESS$ protocol $ServiceQualifiedName$Provider: CallHandlerProvider {\n");
for (auto it = 0; it < service->method_count(); it++) { for (auto it = 0; it < service->method_count(); it++) {
auto method = service->method(it); auto method = service->method(it);
vars["Input"] = GenerateMessage(method->get_input_type_name()); vars["Input"] = GenerateMessage(method->get_input_namespace_parts(), method->get_input_type_name());
vars["Output"] = GenerateMessage(method->get_output_type_name()); vars["Output"] = GenerateMessage(method->get_output_namespace_parts(), method->get_output_type_name());
vars["MethodName"] = method->name(); vars["MethodName"] = method->name();
printer->Print("\t"); printer->Print("\t");
auto func = GenerateServerFuncName(method.get()); auto func = GenerateServerFuncName(method.get());
@@ -221,7 +228,7 @@ void GenerateServerProtocol(const grpc_generator::Service *service,
} }
printer->Print("}\n\n"); printer->Print("}\n\n");
printer->Print(vars, "$ACCESS$ extension $ServiceName$Provider {\n"); printer->Print(vars, "$ACCESS$ extension $ServiceQualifiedName$Provider {\n");
printer->Print(vars, printer->Print(vars,
"\tvar serviceName: String { return " "\tvar serviceName: String { return "
"\"$PATH$$ServiceName$\" }\n"); "\"$PATH$$ServiceName$\" }\n");
@@ -231,8 +238,8 @@ void GenerateServerProtocol(const grpc_generator::Service *service,
printer->Print("\t\tswitch methodName {\n"); printer->Print("\t\tswitch methodName {\n");
for (auto it = 0; it < service->method_count(); it++) { for (auto it = 0; it < service->method_count(); it++) {
auto method = service->method(it); auto method = service->method(it);
vars["Input"] = GenerateMessage(method->get_input_type_name()); vars["Input"] = GenerateMessage(method->get_input_namespace_parts(), method->get_input_type_name());
vars["Output"] = GenerateMessage(method->get_output_type_name()); vars["Output"] = GenerateMessage(method->get_output_namespace_parts(), method->get_output_type_name());
vars["MethodName"] = method->name(); vars["MethodName"] = method->name();
auto body = GenerateServerExtensionBody(method.get()); auto body = GenerateServerExtensionBody(method.get());
printer->Print(vars, body.c_str()); printer->Print(vars, body.c_str());
@@ -250,11 +257,12 @@ grpc::string Generate(grpc_generator::File *file,
std::map<grpc::string, grpc::string> vars; std::map<grpc::string, grpc::string> vars;
vars["PATH"] = file->package(); vars["PATH"] = file->package();
if (!file->package().empty()) { vars["PATH"].append("."); } if (!file->package().empty()) { vars["PATH"].append("."); }
vars["ServiceQualifiedName"] = WrapInNameSpace(service->namespace_parts(), service->name());
vars["ServiceName"] = service->name(); vars["ServiceName"] = service->name();
vars["ACCESS"] = "public"; vars["ACCESS"] = "public";
auto printer = file->CreatePrinter(&output); auto printer = file->CreatePrinter(&output);
printer->Print(vars, printer->Print(vars,
"/// Usage: instantiate $ServiceName$ServiceClient, then call " "/// Usage: instantiate $ServiceQualifiedName$ServiceClient, then call "
"methods of this protocol to make API calls.\n"); "methods of this protocol to make API calls.\n");
GenerateClientProtocol(service, &*printer, &vars); GenerateClientProtocol(service, &*printer, &vars);
GenerateClientClass(service, &*printer, &vars); GenerateClientClass(service, &*printer, &vars);

8
src/idl_gen_grpc.cpp
View File

@@ -59,12 +59,18 @@ class FlatBufMethod : public grpc_generator::Method {
std::string name() const { return method_->name; } std::string name() const { return method_->name; }
// TODO: This method need to incorporate namespace for C++ side. Other language bindings
// simply don't use this method.
std::string GRPCType(const StructDef &sd) const { std::string GRPCType(const StructDef &sd) const {
return "flatbuffers::grpc::Message<" + sd.name + ">"; return "flatbuffers::grpc::Message<" + sd.name + ">";
} }
std::vector<std::string> get_input_namespace_parts() const { return (*method_->request).defined_namespace->components; }
std::string get_input_type_name() const { return (*method_->request).name; } std::string get_input_type_name() const { return (*method_->request).name; }
std::vector<std::string> get_output_namespace_parts() const { return (*method_->response).defined_namespace->components; }
std::string get_output_type_name() const { return (*method_->response).name; } std::string get_output_type_name() const { return (*method_->response).name; }
bool get_module_and_message_path_input(grpc::string * /*str*/, bool get_module_and_message_path_input(grpc::string * /*str*/,
@@ -111,6 +117,8 @@ class FlatBufService : public grpc_generator::Service {
return service_->doc_comment; return service_->doc_comment;
} }
std::vector<grpc::string> namespace_parts() const { return service_->defined_namespace->components; }
std::string name() const { return service_->name; } std::string name() const { return service_->name; }
int method_count() const { int method_count() const {

34
tests/FlatBuffers.Test.Swift/Tests/FlatBuffers.Test.SwiftTests/monster_test.grpc.swift
View File

@@ -19,15 +19,15 @@ public extension GRPCFlatBufPayload {
} }
extension Message: GRPCFlatBufPayload {} extension Message: GRPCFlatBufPayload {}
/// Usage: instantiate MonsterStorageServiceClient, then call methods of this protocol to make API calls. /// Usage: instantiate MyGame_Example_MonsterStorageServiceClient, then call methods of this protocol to make API calls.
public protocol MonsterStorageService { public protocol MyGame_Example_MonsterStorageService {
func Store(_ request: Message<Monster>, callOptions: CallOptions?) -> UnaryCall<Message<Monster>,Message<Stat>> func Store(_ request: Message<MyGame_Example_Monster>, callOptions: CallOptions?) -> UnaryCall<Message<MyGame_Example_Monster>,Message<MyGame_Example_Stat>>
func Retrieve(_ request: Message<Stat>, callOptions: CallOptions?, handler: @escaping (Message<Monster>) -> Void) -> ServerStreamingCall<Message<Stat>, Message<Monster>> func Retrieve(_ request: Message<MyGame_Example_Stat>, callOptions: CallOptions?, handler: @escaping (Message<MyGame_Example_Monster>) -> Void) -> ServerStreamingCall<Message<MyGame_Example_Stat>, Message<MyGame_Example_Monster>>
func GetMaxHitPoint(callOptions: CallOptions?) -> ClientStreamingCall<Message<Monster>,Message<Stat>> func GetMaxHitPoint(callOptions: CallOptions?) -> ClientStreamingCall<Message<MyGame_Example_Monster>,Message<MyGame_Example_Stat>>
func GetMinMaxHitPoints(callOptions: CallOptions?, handler: @escaping (Message<Stat>) -> Void) -> BidirectionalStreamingCall<Message<Monster>, Message<Stat>> func GetMinMaxHitPoints(callOptions: CallOptions?, handler: @escaping (Message<MyGame_Example_Stat>) -> Void) -> BidirectionalStreamingCall<Message<MyGame_Example_Monster>, Message<MyGame_Example_Stat>>
} }
public final class MonsterStorageServiceClient: GRPCClient, MonsterStorageService { public final class MyGame_Example_MonsterStorageServiceClient: GRPCClient, MyGame_Example_MonsterStorageService {
public let channel: GRPCChannel public let channel: GRPCChannel
public var defaultCallOptions: CallOptions public var defaultCallOptions: CallOptions
@@ -36,31 +36,31 @@ public final class MonsterStorageServiceClient: GRPCClient, MonsterStorageServic
self.defaultCallOptions = defaultCallOptions self.defaultCallOptions = defaultCallOptions
} }
public func Store(_ request: Message<Monster>, callOptions: CallOptions? = nil) -> UnaryCall<Message<Monster>,Message<Stat>> { public func Store(_ request: Message<MyGame_Example_Monster>, callOptions: CallOptions? = nil) -> UnaryCall<Message<MyGame_Example_Monster>,Message<MyGame_Example_Stat>> {
return self.makeUnaryCall(path: "/MyGame.Example.MonsterStorage/Store", request: request, callOptions: callOptions ?? self.defaultCallOptions) return self.makeUnaryCall(path: "/MyGame.Example.MonsterStorage/Store", request: request, callOptions: callOptions ?? self.defaultCallOptions)
} }
public func Retrieve(_ request: Message<Stat>, callOptions: CallOptions? = nil, handler: @escaping (Message<Monster>) -> Void) -> ServerStreamingCall<Message<Stat>, Message<Monster>> { public func Retrieve(_ request: Message<MyGame_Example_Stat>, callOptions: CallOptions? = nil, handler: @escaping (Message<MyGame_Example_Monster>) -> Void) -> ServerStreamingCall<Message<MyGame_Example_Stat>, Message<MyGame_Example_Monster>> {
return self.makeServerStreamingCall(path: "/MyGame.Example.MonsterStorage/Retrieve", request: request, callOptions: callOptions ?? self.defaultCallOptions, handler: handler) return self.makeServerStreamingCall(path: "/MyGame.Example.MonsterStorage/Retrieve", request: request, callOptions: callOptions ?? self.defaultCallOptions, handler: handler)
} }
public func GetMaxHitPoint(callOptions: CallOptions? = nil) -> ClientStreamingCall<Message<Monster>,Message<Stat>> { public func GetMaxHitPoint(callOptions: CallOptions? = nil) -> ClientStreamingCall<Message<MyGame_Example_Monster>,Message<MyGame_Example_Stat>> {
return self.makeClientStreamingCall(path: "/MyGame.Example.MonsterStorage/GetMaxHitPoint", callOptions: callOptions ?? self.defaultCallOptions) return self.makeClientStreamingCall(path: "/MyGame.Example.MonsterStorage/GetMaxHitPoint", callOptions: callOptions ?? self.defaultCallOptions)
} }
public func GetMinMaxHitPoints(callOptions: CallOptions? = nil, handler: @escaping (Message<Stat>) -> Void) -> BidirectionalStreamingCall<Message<Monster>, Message<Stat>> { public func GetMinMaxHitPoints(callOptions: CallOptions? = nil, handler: @escaping (Message<MyGame_Example_Stat>) -> Void) -> BidirectionalStreamingCall<Message<MyGame_Example_Monster>, Message<MyGame_Example_Stat>> {
return self.makeBidirectionalStreamingCall(path: "/MyGame.Example.MonsterStorage/GetMinMaxHitPoints", callOptions: callOptions ?? self.defaultCallOptions, handler: handler) return self.makeBidirectionalStreamingCall(path: "/MyGame.Example.MonsterStorage/GetMinMaxHitPoints", callOptions: callOptions ?? self.defaultCallOptions, handler: handler)
} }
} }
public protocol MonsterStorageProvider: CallHandlerProvider { public protocol MyGame_Example_MonsterStorageProvider: CallHandlerProvider {
func Store(_ request: Message<Monster>, context: StatusOnlyCallContext) -> EventLoopFuture<Message<Stat>> func Store(_ request: Message<MyGame_Example_Monster>, context: StatusOnlyCallContext) -> EventLoopFuture<Message<MyGame_Example_Stat>>
func Retrieve(request: Message<Stat>, context: StreamingResponseCallContext<Message<Monster>>) -> EventLoopFuture<GRPCStatus> func Retrieve(request: Message<MyGame_Example_Stat>, context: StreamingResponseCallContext<Message<MyGame_Example_Monster>>) -> EventLoopFuture<GRPCStatus>
func GetMaxHitPoint(context: UnaryResponseCallContext<Message<Stat>>) -> EventLoopFuture<(StreamEvent<Message<Monster>>) -> Void> func GetMaxHitPoint(context: UnaryResponseCallContext<Message<MyGame_Example_Stat>>) -> EventLoopFuture<(StreamEvent<Message<MyGame_Example_Monster>>) -> Void>
func GetMinMaxHitPoints(context: StreamingResponseCallContext<Message<Stat>>) -> EventLoopFuture<(StreamEvent<Message<Monster>>) -> Void> func GetMinMaxHitPoints(context: StreamingResponseCallContext<Message<MyGame_Example_Stat>>) -> EventLoopFuture<(StreamEvent<Message<MyGame_Example_Monster>>) -> Void>
} }
public extension MonsterStorageProvider { public extension MyGame_Example_MonsterStorageProvider {
var serviceName: String { return "MyGame.Example.MonsterStorage" } var serviceName: String { return "MyGame.Example.MonsterStorage" }
func handleMethod(_ methodName: String, callHandlerContext: CallHandlerContext) -> GRPCCallHandler? { func handleMethod(_ methodName: String, callHandlerContext: CallHandlerContext) -> GRPCCallHandler? {
switch methodName { switch methodName {