fix: add new options by generic props loader grpc client provider

wrspada02 · Aug 29, 2024 · dc3d1af · eladhaim · Sep 1, 2024 · wrspada02
1 parent 731e806
commit dc3d1af
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 26 deletions.
diff --git a/packages/microservices/interfaces/client-metadata.interface.ts b/packages/microservices/interfaces/client-metadata.interface.ts
@@ -14,11 +14,11 @@ import {
 import { Serializer } from './serializer.interface';
 import { ConnectionOptions } from 'tls';
 
-export type ClientOptions =
+export type ClientOptions<ClientProviderOverrideOptions> =
   | RedisOptions
   | NatsOptions
   | MqttOptions
-  | GrpcOptions
+  | GrpcOptions<ClientProviderOverrideOptions>
   | KafkaOptions
   | TcpClientOptions
   | RmqOptions;

diff --git a/packages/microservices/interfaces/microservice-configuration.interface.ts b/packages/microservices/interfaces/microservice-configuration.interface.ts
@@ -22,8 +22,8 @@ import { CustomTransportStrategy } from './custom-transport-strategy.interface';
 import { Deserializer } from './deserializer.interface';
 import { Serializer } from './serializer.interface';
 
-export type MicroserviceOptions =
-  | GrpcOptions
+export type MicroserviceOptions<GrpcLoaderOption> =
+  | GrpcOptions<GrpcLoaderOption>
   | TcpOptions
   | RedisOptions
   | NatsOptions
@@ -43,7 +43,7 @@ export interface CustomStrategy {
 /**
  * @publicApi
  */
-export interface GrpcOptions {
+export interface GrpcOptions<GrpcLoaderOption> {
   transport?: Transport.GRPC;
   options: {
     url?: string;
@@ -67,19 +67,21 @@ export interface GrpcOptions {
     packageDefinition?: any;
     gracefulShutdown?: boolean;
     onLoadPackageDefinition?: (pkg: any, server: any) => void;
-    loader?: {
-      keepCase?: boolean;
-      alternateCommentMode?: boolean;
-      longs?: Function;
-      enums?: Function;
-      bytes?: Function;
-      defaults?: boolean;
-      arrays?: boolean;
-      objects?: boolean;
-      oneofs?: boolean;
-      json?: boolean;
-      includeDirs?: string[];
-    };
+    loader?:
+      | GrpcLoaderOption
+      | {
+          keepCase?: boolean;
+          alternateCommentMode?: boolean;
+          longs?: Function;
+          enums?: Function;
+          bytes?: Function;
+          defaults?: boolean;
+          arrays?: boolean;
+          objects?: boolean;
+          oneofs?: boolean;
+          json?: boolean;
+          includeDirs?: string[];
+        };
   };
 }
 

diff --git a/packages/microservices/module/clients.module.ts b/packages/microservices/module/clients.module.ts
@@ -15,14 +15,17 @@ import {
 
 @Module({})
 export class ClientsModule {
-  static register(options: ClientsModuleOptions): DynamicModule {
+  static register<ClientProviderOverrideOptions>(
+    options: ClientsModuleOptions<ClientProviderOverrideOptions>,
+  ): DynamicModule {
     const clientsOptions = !Array.isArray(options) ? options.clients : options;
     const clients = (clientsOptions || []).map(item => {
       return {
         provide: item.name,
         useValue: this.assignOnAppShutdownHook(ClientProxyFactory.create(item)),
       };
     });
+
     return {
       module: ClientsModule,
       global: !Array.isArray(options) && options.isGlobal,

diff --git a/packages/microservices/module/interfaces/clients-module.interface.ts b/packages/microservices/module/interfaces/clients-module.interface.ts
@@ -1,16 +1,19 @@
 import { ClientOptions, CustomClientOptions } from '../../interfaces';
 import { Type, Provider, ModuleMetadata } from '@nestjs/common/interfaces';
 
-export type ClientProvider = ClientOptions | CustomClientOptions;
+export type ClientProvider<ClientProviderOverrideOptions = {}> =
+  | ClientOptions<ClientProviderOverrideOptions>
+  | CustomClientOptions;
 
-export type ClientProviderOptions = ClientProvider & {
-  name: string | symbol;
-};
+export type ClientProviderOptions<ClientProviderOverrideOptions> =
+  ClientProvider<ClientProviderOverrideOptions> & {
+    name: string | symbol;
+  };
 
-export type ClientsModuleOptions =
-  | Array<ClientProviderOptions>
+export type ClientsModuleOptions<ClientProviderOverrideOptions = {}> =
+  | Array<ClientProviderOptions<ClientProviderOverrideOptions>>
   | {
-      clients: Array<ClientProviderOptions>;
+      clients: Array<ClientProviderOptions<ClientProviderOverrideOptions>>;
       isGlobal?: boolean;
     };