feat(grpc): initialize default metadata, passing "rpc.method.type"

key: rpc.method.type value: unary|server|client
midwayjs · Nov 17, 2024 · 63e7dc1 · 63e7dc1
1 parent 437e92d
commit 63e7dc1
Show file tree

Hide file tree

Showing 12 changed files with 313 additions and 14 deletions.
diff --git a/packages/grpc/src/comsumer/clients.ts b/packages/grpc/src/comsumer/clients.ts
@@ -9,7 +9,7 @@ import {
   Utils,
   ILogger,
 } from '@midwayjs/core';
-import { credentials, loadPackageDefinition } from '@grpc/grpc-js';
+import { credentials, loadPackageDefinition, Metadata } from '@grpc/grpc-js';
 import {
   DefaultConfig,
   IClientOptions,
@@ -71,6 +71,15 @@ export class GRPCClients extends Map {
           connectionService[methodName] = (
             clientOptions: IClientOptions = {}
           ) => {
+            const meta = new Metadata();
+
+            if (clientOptions.metadata) {
+              meta.merge(clientOptions.metadata);
+              clientOptions.metadata = meta;
+            } else {
+              clientOptions.metadata = meta;
+            }
+
             return this.getClientRequestImpl(
               connectionService,
               originMethod,
@@ -89,35 +98,56 @@ export class GRPCClients extends Map {
     return this.get(serviceName);
   }
 
-  getClientRequestImpl(client, originalFunction, options = {}) {
+  getClientRequestImpl(client, originalFunction, options: IClientOptions = {}) {
     const genericFunctionSelector =
       (originalFunction.requestStream ? 2 : 0) |
       (originalFunction.responseStream ? 1 : 0);
 
+    const meta = new Metadata();
+    if (options.metadata) {
+      meta.merge(options.metadata);
+      options.metadata = meta;
+    } else {
+      options.metadata = meta;
+    }
+
     let genericFunctionName;
+    const rpcMethod = options.metadata.get('rpc.method.type')?.[0];
     switch (genericFunctionSelector) {
       case 0:
+        if (!rpcMethod) {
+          options.metadata.set('rpc.method.type', 'unary');
+        }
         genericFunctionName = new ClientUnaryRequest(
           client,
           originalFunction,
           options
         );
         break;
       case 1:
+        if (!rpcMethod) {
+          options.metadata.set('rpc.method.type', 'server'); // server streaming
+        }
         genericFunctionName = new ClientReadableRequest(
           client,
           originalFunction,
           options
         );
         break;
       case 2:
+        if (!rpcMethod) {
+          options.metadata.set('rpc.method.type', 'client'); // client streaming
+        }
         genericFunctionName = new ClientWritableRequest(
           client,
           originalFunction,
           options
         );
         break;
       case 3:
+        if (!rpcMethod) {
+          options.metadata.set('rpc.method.type', 'bidi'); // bidirectional streaming
+        }
         genericFunctionName = new ClientDuplexStreamRequest(
           client,
           originalFunction,

diff --git a/packages/grpc/test/fixtures/base-app-multiple-package/src/config/config.default.ts b/packages/grpc/test/fixtures/base-app-multiple-package/src/config/config.default.ts
@@ -1,6 +1,7 @@
 import { join } from 'path';
 
 export const grpcServer = {
+  url: 'localhost:6569',
   services: [
     {
       protoPath: join(__dirname, '../../../proto/hello_world.proto'),

diff --git a/packages/grpc/test/fixtures/base-app-multiple-service/src/config/config.default.ts b/packages/grpc/test/fixtures/base-app-multiple-service/src/config/config.default.ts
@@ -3,7 +3,7 @@ import { join } from 'path';
 export const grpc = {
   services: [
     {
-      url: 'localhost:6565',
+      url: 'localhost:6575',
       protoPath: join(__dirname, '../../../proto/helloworld.proto'),
       package: 'helloworld',
       clientOptions: {
@@ -14,6 +14,7 @@ export const grpc = {
 }
 
 export const grpcServer = {
+  url: 'localhost:6575',
   services: [
     {
       protoPath: join(__dirname, '../../../proto/hero.proto'),

diff --git a/packages/grpc/test/fixtures/base-app-multiple-service/src/interface.ts b/packages/grpc/test/fixtures/base-app-multiple-service/src/interface.ts
@@ -15,13 +15,6 @@ export namespace hero {
     id?: number;
     name?: string;
   }
-
-  export interface HeroService2 {
-    findOne2(data: HeroById, metadata?: Metadata): Promise<Hero>;
-  }
-  export interface HeroService2Client {
-    findOne2(options?: IClientOptions): IClientUnaryService<HeroById, Hero>;
-  }
 }
 
 export namespace helloworld {

diff --git a/packages/grpc/test/fixtures/base-app-multiple-service/src/provider/hero.ts b/packages/grpc/test/fixtures/base-app-multiple-service/src/provider/hero.ts
@@ -1,11 +1,15 @@
+import * as assert from 'assert';
 import { GrpcMethod, MSProviderType, Provider, Provide, Inject, Init } from '@midwayjs/core';
 import { helloworld, hero } from '../interface';
-import { Clients } from '../../../../../src';
+import { Clients, Context } from '../../../../../src';
 
 @Provide()
 @Provider(MSProviderType.GRPC, { package: 'hero' })
 export class HeroService implements hero.HeroService {
 
+  @Inject()
+  ctx: Context;
+
   @Inject()
   grpcClients: Clients;
 
@@ -18,6 +22,13 @@ export class HeroService implements hero.HeroService {
 
   @GrpcMethod()
   async findOne(data) {
+    assert(this.ctx, 'should get context');
+    const { metadata } = this.ctx;
+    assert(metadata, 'should get metadata');
+
+    const rpcMethodType = metadata.get('rpc.method.type');
+    assert(rpcMethodType[0] === 'unary', `should get rpc.method.type, but got "${rpcMethodType[0]}"`);
+
     const result = await this.greeterService.sayHello().sendMessage({
       name: 'harry'
     });

diff --git a/packages/grpc/test/fixtures/base-app-stream-meta/package.json b/packages/grpc/test/fixtures/base-app-stream-meta/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "ali-demo"
+}
diff --git a/packages/grpc/test/fixtures/base-app-stream-meta/src/config/config.default.ts b/packages/grpc/test/fixtures/base-app-stream-meta/src/config/config.default.ts
@@ -0,0 +1,11 @@
+import { join } from 'path';
+
+export const grpcServer = {
+  url: 'localhost:6571',
+  services: [
+    {
+      protoPath: join(__dirname, '../../../proto/math.proto'),
+      package: 'math',
+    }
+  ],
+}
diff --git a/packages/grpc/test/fixtures/base-app-stream-meta/src/configuration.ts b/packages/grpc/test/fixtures/base-app-stream-meta/src/configuration.ts
@@ -0,0 +1,14 @@
+import { Configuration } from '@midwayjs/core';
+import * as grpc from '../../../../src';
+import { join } from 'path';
+
+@Configuration({
+  imports: [
+    grpc
+  ],
+  importConfigs: [
+    join(__dirname, './config'),
+  ]
+})
+export class AutoConfiguration {
+}
diff --git a/packages/grpc/test/fixtures/base-app-stream-meta/src/interface.ts b/packages/grpc/test/fixtures/base-app-stream-meta/src/interface.ts
@@ -0,0 +1,41 @@
+import {
+  IClientDuplexStreamService,
+  IClientReadableStreamService,
+  IClientUnaryService,
+  IClientWritableStreamService
+} from '../../../../src';
+
+export namespace math {
+  export interface AddArgs {
+    id?: number;
+    num?: number;
+  }
+  export interface Num {
+    id?: number;
+    num?: number;
+  }
+
+  /**
+   * server interface
+   */
+  export interface Math {
+    add(data: AddArgs): Promise<Num>;
+    addMore(data: AddArgs): Promise<void>;
+    // 服务端推，客户端读
+    sumMany(fibArgs: AddArgs): Promise<void>
+    // 客户端端推，服务端读
+    addMany(num: AddArgs): Promise<void>;
+  }
+
+  /**
+   * client interface
+   */
+  export interface MathClient {
+    add(): IClientUnaryService<AddArgs, Num>;
+    addMore(): IClientDuplexStreamService<AddArgs, Num>;
+    // 服务端推，客户端读
+    sumMany(): IClientReadableStreamService<AddArgs, Num>;
+    // 客户端端推，服务端读
+    addMany(): IClientWritableStreamService<AddArgs, Num>;
+  }
+}
diff --git a/packages/grpc/test/fixtures/base-app-stream-meta/src/provider/math.ts b/packages/grpc/test/fixtures/base-app-stream-meta/src/provider/math.ts
@@ -0,0 +1,95 @@
+import * as assert from 'assert';
+import { GrpcMethod, GrpcStreamTypeEnum, Inject, MSProviderType, Provide, Provider } from '@midwayjs/core';
+import { Context } from '../../../../../src';
+import { math } from '../interface';
+import { Metadata } from '@grpc/grpc-js';
+
+/**
+ */
+@Provide()
+@Provider(MSProviderType.GRPC, { package: 'math' })
+export class Math implements math.Math {
+
+  @Inject()
+  ctx: Context;
+
+  sumDataList = [];
+
+  @GrpcMethod()
+  async add(data: math.AddArgs): Promise<math.Num> {
+    assert(this.ctx, 'should get context');
+    const { metadata } = this.ctx;
+    assert(metadata, 'should get metadata');
+
+    const rpcMethodType = metadata.get('rpc.method.type');
+    assert(rpcMethodType[0] === 'unary', `should get rpc.method.type, but got "${rpcMethodType[0]}"`);
+
+    return {
+      num: data.num + 2,
+    }
+  }
+
+  @GrpcMethod({type: GrpcStreamTypeEnum.DUPLEX, onEnd: 'duplexEnd' })
+  async addMore(message: math.AddArgs)  {
+    const { metadata } = this.ctx;
+    assert(metadata, 'should get metadata');
+
+    const rpcMethodType = metadata.get('rpc.method.type');
+    assert(rpcMethodType[0] === 'bidi', `should get rpc.method.type, but got "${rpcMethodType[0]}"`);
+
+    this.ctx.write({
+      id: message.id,
+      num: message.num + 10,
+    });
+  }
+
+  async duplexEnd() {
+    console.log('got client end message');
+  }
+
+  @GrpcMethod({type: GrpcStreamTypeEnum.WRITEABLE })
+  async sumMany(args: math.AddArgs) {
+    const { metadata } = this.ctx;
+    assert(metadata, 'should get metadata');
+
+    const rpcMethodType = metadata.get('rpc.method.type');
+    assert(rpcMethodType[0] === 'server', `should get rpc.method.type, but got "${rpcMethodType[0]}"`);
+
+    this.ctx.write({
+      num: 1 + args.num
+    });
+    this.ctx.write({
+      num: 2 + args.num
+    });
+    this.ctx.write({
+      num: 3 + args.num
+    });
+
+    const meta = new Metadata();
+    meta.add('xxx', 'bbb');
+
+    this.ctx.sendMetadata(meta);
+    this.ctx.end();
+  }
+
+  @GrpcMethod({type: GrpcStreamTypeEnum.READABLE, onEnd: 'sumEnd' })
+  async addMany(data: math.Num) {
+    const { metadata } = this.ctx;
+    assert(metadata, 'should get metadata');
+
+    const rpcMethodType = metadata.get('rpc.method.type');
+    assert(rpcMethodType[0] === 'client', `should get rpc.method.type, but got "${rpcMethodType[0]}"`);
+
+    this.sumDataList.push(data);
+  }
+
+  async sumEnd(): Promise<math.Num> {
+    const total = this.sumDataList.reduce((pre, cur) => {
+      return {
+        num: pre.num + cur.num,
+      }
+    });
+    return total;
+  }
+
+}
diff --git a/packages/grpc/test/fixtures/base-app-stream/src/config/config.default.ts b/packages/grpc/test/fixtures/base-app-stream/src/config/config.default.ts
@@ -1,6 +1,7 @@
 import { join } from 'path';
 
 export const grpcServer = {
+  url: 'localhost:6568',
   services: [
     {
       protoPath: join(__dirname, '../../../proto/math.proto'),