Add a way to pass loader options to custom grpc-loader

[eladhaim]

Is there an existing issue that is already proposing this?

• I have searched the existing issues

Is your feature request related to a problem? Please describe it

We heavily rely on protobuf and use ts-proto to generate our package definitions. To handle the generated code, we've had to create our own gRPC loader. However, while we have the option to pass a custom gRPC loader, we currently cannot pass custom gRPC options. Ideally, we'd like the loader object within GrpcOptions to be of type any or a generic type that we can override to customize the options as needed.

Describe the solution you'd like

Our problem is just a type issue, converting the loader object to any/generic with default will do the job.

Teachability, documentation, adoption, migration strategy

Today:

     ClientsModule.register([
      {
        name: 'GRPC_CLIENT_NAME',
        transport: Transport.GRPC,
        options: {
          package: 'testPackage',
          protoPath: 'proto_path',
          protoLoader: 'our custom loader',
          url: 'localhost:4001',
          loader: {
             // @ts-ignore
             newOption: 'new option'
          },
        },
      }
    ]),

After the change:

   ClientsModule.register([
   {
     name: 'GRPC_CLIENT_NAME',
     transport: Transport.GRPC,
     options: {
       package: 'testPackage',
       protoPath: 'proto_path',
       protoLoader: 'our custom loader',
       url: 'localhost:4001',
       loader: {
          newOption: 'new option'
       },
     },
   }
 ])

What is the motivation / use case for changing the behavior?

Adding more flexibility to the server/client of grpc

[wrspada02]

Do you think would be nice pass some kind of generic type to the loader object instead apply type any? Just to keep the type safe. Also, I'll figure it out and try to implement this.

[eladhaim]

yes sure i think generic type will be great, i can submit a pr if needed.

[wrspada02]

May I try to implement this? It'd be my first contribuition on the open-source world.

[eladhaim]

go ahead, i think it is a good issue to start with

[wrspada02]

Thank you. Any updates I'll let you know.

[wrspada02]

Well, I think I did what you meant. I ain't able to push a PR on this repository, however, I just did a fork and pushed it there. Could you check it out and confirm if makes sense? If so, we can request to open a PR and push this commit into this repository.

Commit link - wrspada02@dc3d1af

Thanks in advance.

[eladhaim]

👍

[wrspada02]

Hello someone at @nestjs. May we create a PR for this type feature addition? I ain't able to open a PR for this repository.

[CaioF]

@eladhaim quick question, is your custom loader able to serialize/deserialize google.protobuf types when generating with ts-proto? Because I have an issue where nestJS seems to ignore the wrappers from ts-proto and therefore I cannot use any of the well known types. stephenh/ts-proto#1106 (comment)

[kamilmysliwiec]

Let's track this here #13941