fix: grpc context typings (#2259)

midwayjs · Aug 20, 2022 · 9449097 · 9449097
1 parent 28b7e40
commit 9449097
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 8 deletions.
diff --git a/packages/grpc/src/interface.ts b/packages/grpc/src/interface.ts
@@ -4,12 +4,32 @@ import {
   IMidwayContext,
   NextFunction as BaseNextFunction
 } from '@midwayjs/core';
-import { Server, ServerCredentials, Metadata, ServerDuplexStream, ClientWritableStream, ClientDuplexStream, ClientReadableStream, ClientUnaryCall, ChannelOptions, ClientOptions } from '@grpc/grpc-js';
+import {
+  Server,
+  ServerCredentials,
+  Metadata,
+  ClientWritableStream,
+  ClientDuplexStream,
+  ClientReadableStream,
+  ClientUnaryCall,
+  ChannelOptions,
+  ClientOptions,
+  ServerUnaryCall,
+  ServerReadableStream,
+  ServerWritableStream,
+  ServerDuplexStream,
+} from '@grpc/grpc-js';
+
+type GrpcHandleCall<RequestType, ResponseType> =
+  Partial<ServerUnaryCall<RequestType, ResponseType> &
+    ServerReadableStream<RequestType, ResponseType> &
+    ServerWritableStream<RequestType, ResponseType> &
+    ServerDuplexStream<RequestType, ResponseType>>;
 
-export interface Context extends IMidwayContext<ServerDuplexStream<any, any>> {
-  metadata: Metadata;
+export interface Context<RequestType = unknown, ResponseType = unknown> extends IMidwayContext<GrpcHandleCall<RequestType, ResponseType>> {
   method: string;
 }
+
 export type IMidwayGRPCApplication = IMidwayApplication<Context, Server>;
 
 export type Application = IMidwayGRPCApplication;
@@ -73,23 +93,29 @@ export interface DefaultConfig extends IConfigurationOptions {
 
 export interface IClientUnaryService<reqType, resType> {
   sendMessage(reqData: reqType, handler?: (call: ClientUnaryCall) => void): Promise<resType>;
+
   sendMessageWithCallback(content: reqType, callback): ClientUnaryCall;
 }
 
 export interface IClientReadableStreamService<reqType, resType> {
   sendMessage(reqData: reqType): Promise<resType[]>;
+
   getCall(): ClientReadableStream<resType>;
 }
 
 export interface IClientWritableStreamService<reqType, resType> {
   sendMessage(reqData: reqType): IClientWritableStreamService<reqType, resType>;
+
   end(): Promise<resType>;
+
   getCall(): ClientWritableStream<reqType>;
 }
 
 export interface IClientDuplexStreamService<reqType, resType> {
   sendMessage(reqData: reqType): Promise<resType>;
+
   getCall(): ClientDuplexStream<reqType, resType>;
+
   end(): void;
 }
 

diff --git a/packages/grpc/src/provider/framework.ts b/packages/grpc/src/provider/framework.ts
@@ -2,8 +2,10 @@ import {
   sendUnaryData,
   Server,
   ServerCredentials,
-  ServerUnaryCall,
   setLogger,
+  UntypedServiceImplementation,
+  UntypedHandleCall,
+  ServerUnaryCall,
 } from '@grpc/grpc-js';
 import {
   BaseFramework,
@@ -113,7 +115,7 @@ export class MidwayGRPCFramework extends BaseFramework<
         classMetadata.serviceName || Utils.pascalCase(providerName);
 
       if (serviceClassDefinition.has(classMetadata?.package)) {
-        const serviceInstance = {};
+        const serviceInstance = {} as UntypedServiceImplementation;
         const serviceDefinition: any = serviceClassDefinition.get(
           classMetadata.package
         )[`${classMetadata?.package}.${serviceName}`];
@@ -126,11 +128,11 @@ export class MidwayGRPCFramework extends BaseFramework<
 
         for (const method in serviceDefinition) {
           serviceInstance[method] = async (
-            call: ServerUnaryCall<any, any>,
+            call: Parameters<UntypedHandleCall>[0],
             callback?: sendUnaryData<any>
           ) => {
             // merge ctx and call
-            const ctx = call as any;
+            const ctx = call as Context;
             ctx.method = method;
             this.app.createAnonymousContext(ctx);
 
@@ -178,7 +180,7 @@ export class MidwayGRPCFramework extends BaseFramework<
                 service,
                 ctx,
                 callback,
-                data: call.request,
+                data: (call as ServerUnaryCall<any, any>).request,
                 grpcMethodData,
               });
             }