fix: multi package name in grpc client (#917)

midwayjs · Mar 14, 2021 · 9e08c93 · 9e08c93
1 parent 351d5c9
commit 9e08c93
Show file tree

Hide file tree

Showing 9 changed files with 139 additions and 5 deletions.
diff --git a/packages/grpc/src/comsumer/clients.ts b/packages/grpc/src/comsumer/clients.ts
@@ -8,7 +8,7 @@ import {
 } from '@midwayjs/decorator';
 import { credentials, loadPackageDefinition } from '@grpc/grpc-js';
 import { DefaultConfig, IClientOptions } from '../interface';
-import { loadProto } from '../util';
+import { finePackageProto, loadProto } from '../util';
 import * as camelCase from 'camelcase';
 import { ILogger } from '@midwayjs/logger';
 import { ClientUnaryRequest } from './type/unary-request';
@@ -36,9 +36,8 @@ export class GRPCClients extends Map {
         loaderOptions: cfg.loaderOptions,
         protoPath: cfg.protoPath,
       });
-      const packageProto: any = loadPackageDefinition(packageDefinition)[
-        cfg.package
-      ];
+      const allProto = loadPackageDefinition(packageDefinition);
+      const packageProto: any = finePackageProto(allProto, cfg.package);
       for (const definition in packageDefinition) {
         if (!packageDefinition[definition]['format']) {
           const serviceName = definition.replace(`${cfg.package}.`, '');

diff --git a/packages/grpc/src/comsumer/configuration.ts b/packages/grpc/src/comsumer/configuration.ts
@@ -12,7 +12,7 @@ export class AutoConfiguration {
   @Logger()
   logger: ILogger;
 
-  async onReady(container: IMidwayContainer) {
+  async onReady(container: IMidwayContainer, app) {
     setLogger(this.logger);
     await container.getAsync('grpc:clients');
   }

diff --git a/packages/grpc/src/util.ts b/packages/grpc/src/util.ts
@@ -33,3 +33,14 @@ export const createGRPCConsumer = async <T>(
   await clients.initService();
   return Array.from(clients.values())[0];
 };
+
+export const finePackageProto = (allProto: any, packageName: string) => {
+  const packages = packageName.split('.');
+  let currentProto = allProto;
+  for (const pkg of packages) {
+    if (currentProto[pkg]) {
+      currentProto = currentProto[pkg];
+    }
+  }
+  return currentProto;
+};
diff --git a/packages/grpc/test/fixtures/base-app-multiple-package/package.json b/packages/grpc/test/fixtures/base-app-multiple-package/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "ali-demo"
+}
diff --git a/packages/grpc/test/fixtures/base-app-multiple-package/src/configuration.ts b/packages/grpc/test/fixtures/base-app-multiple-package/src/configuration.ts
@@ -0,0 +1,8 @@
+import { Configuration } from '@midwayjs/decorator';
+
+@Configuration({
+  imports: [
+  ],
+})
+export class AutoConfiguration {
+}
diff --git a/packages/grpc/test/fixtures/base-app-multiple-package/src/interface.ts b/packages/grpc/test/fixtures/base-app-multiple-package/src/interface.ts
@@ -0,0 +1,23 @@
+import { IClientOptions, IClientUnaryService } from '../../../../src';
+
+export namespace hello {
+  export namespace world {
+    export interface HelloRequest {
+      name: string;
+    }
+
+    export interface HelloReply {
+      message: string;
+    }
+
+    // The greeting service definition.
+    export interface Greeter {
+      // Sends a greeting
+      sayHello(data: HelloRequest): Promise<HelloReply>;
+    }
+
+    export interface GreeterClient {
+      sayHello (options?: IClientOptions): IClientUnaryService<HelloRequest, HelloReply>
+    }
+  }
+}
diff --git a/packages/grpc/test/fixtures/base-app-multiple-package/src/provider/greeter.ts b/packages/grpc/test/fixtures/base-app-multiple-package/src/provider/greeter.ts
@@ -0,0 +1,27 @@
+import { MSProviderType, Provider, Provide, Inject, GrpcMethod } from '@midwayjs/decorator';
+import { hello } from '../interface';
+import { ILogger } from '@midwayjs/logger';
+import { Context } from '../../../../../src';
+
+/**
+ * package helloworld
+ * service Greeter
+ */
+@Provide()
+@Provider(MSProviderType.GRPC, { package: 'hello.world' })
+export class Greeter implements hello.world.Greeter {
+
+  @Inject()
+  logger: ILogger;
+
+  @Inject()
+  ctx: Context;
+
+  /**
+   * Implements the SayHello RPC method.
+   */
+  @GrpcMethod()
+  async sayHello(request: hello.world.HelloRequest) {
+    return { message: 'Hello ' + request.name };
+  }
+}
diff --git a/packages/grpc/test/fixtures/proto/hello_world.proto b/packages/grpc/test/fixtures/proto/hello_world.proto
@@ -0,0 +1,38 @@
+// Copyright 2015 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.
+
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_package = "io.grpc.examples.hello.world";
+option java_outer_classname = "HelloWorldProto";
+option objc_class_prefix = "HLW";
+
+package hello.world;
+
+// The greeting service definition.
+service Greeter {
+  // Sends a greeting
+  rpc SayHello (HelloRequest) returns (HelloReply) {}
+}
+
+// The request message containing the user's name.
+message HelloRequest {
+  string name = 1;
+}
+
+// The response message containing the greetings
+message HelloReply {
+  string message = 1;
+}
diff --git a/packages/grpc/test/index.test.ts b/packages/grpc/test/index.test.ts
@@ -10,6 +10,7 @@ import {
 } from '../src';
 
 import { Metadata } from '@grpc/grpc-js';
+import { hello } from './fixtures/base-app-multiple-package/src/interface';
 
 export namespace hero {
   export interface HeroServiceClient {
@@ -239,4 +240,28 @@ describe('/test/index.test.ts', function () {
 
     await closeApp(app);
   });
+
+  it('should test multi-package service', async () => {
+    const app = await createServer('base-app-multiple-package', {
+      services: [
+        {
+          protoPath: join(__dirname, 'fixtures/proto/hello_world.proto'),
+          package: 'hello.world',
+        }
+      ],
+    });
+
+    const service = await createGRPCConsumer<hello.world.GreeterClient>({
+      package: 'hello.world',
+      protoPath: join(__dirname, 'fixtures/proto/hello_world.proto'),
+      url: 'localhost:6565'
+    });
+
+    const result = await service.sayHello().sendMessage({
+      name: 'harry'
+    });
+
+    expect(result).toEqual({ message: 'Hello harry' });
+    await closeApp(app);
+  });
 });