ts-proto 2.14.0 → 2.15.0

package/README.markdown

@@ -465,11 +465,17 @@ With `--ts_proto_opt=protoJsonFormat=false`, strict proto3 compliance is disable
 
   (Requires `nestJs=true`.)
 
+- With `--ts_proto_opt=useNestjsFqnServiceName=true`, the generated `@FooServiceControllerMethods()` decorator will pass the fully qualified service name (i.e. `package.FooService` instead of `FooService`) to the `@GrpcMethod`/`@GrpcStreamMethod` decorators of `@nestjs/microservices`.
+
+  NestJS falls back to resolving a handler by the `package.Service` segment of the gRPC method path, so the handlers are found regardless of which `package` the gRPC server was configured with, and services with the same name in different packages no longer collide. The `FOO_SERVICE_NAME` const is not affected, since `client.getService()` expects the package-relative name.
+
+  (Requires `nestJs=true`.)
+
 - With `--ts_proto_opt=nestJs=true`, the defaults will change to generate [NestJS protobuf](https://docs.nestjs.com/microservices/grpc) friendly types & service interfaces that can be used in both the client-side and server-side of NestJS protobuf implementations. See the [nestjs readme](NESTJS.markdown) for more information and implementation examples.
 
   Specifically `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` will all be false, `lowerCaseServiceMethods` will be true and `outputServices` will be ignored.
 
-  Note that `addGrpcMetadata`, `addNestjsRestParameter` and `returnObservable` will still be false.
+  Note that `addGrpcMetadata`, `addNestjsRestParameter`, `returnObservable` and `useNestjsFqnServiceName` will still be false.
 
 - With `--ts_proto_opt=useDate=false`, fields of type `google.protobuf.Timestamp` will not be mapped to type `Date` in the generated types. See [Timestamp](#timestamp) for more details.
 

package/build/src/generate-nestjs.d.ts

@@ -4,4 +4,4 @@ import SourceInfo from "./sourceInfo";
 import { Context } from "./context";
 export declare function generateNestjsServiceController(ctx: Context, fileDesc: FileDescriptorProto, sourceInfo: SourceInfo, serviceDesc: ServiceDescriptorProto): Code;
 export declare function generateNestjsServiceClient(ctx: Context, fileDesc: FileDescriptorProto, sourceInfo: SourceInfo, serviceDesc: ServiceDescriptorProto): Code;
-export declare function generateNestjsGrpcServiceMethodsDecorator(ctx: Context, serviceDesc: ServiceDescriptorProto): Code;
+export declare function generateNestjsGrpcServiceMethodsDecorator(ctx: Context, fileDesc: FileDescriptorProto, serviceDesc: ServiceDescriptorProto): Code;

package/build/src/generate-nestjs.js

@@ -118,10 +118,13 @@ function generateNestjsServiceClient(ctx, fileDesc, sourceInfo, serviceDesc) {
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n\n" });
 }
-function generateNestjsGrpcServiceMethodsDecorator(ctx, serviceDesc) {
+function generateNestjsGrpcServiceMethodsDecorator(ctx, fileDesc, serviceDesc) {
     const { options } = ctx;
     const GrpcMethod = (0, ts_poet_1.imp)("GrpcMethod@@nestjs/microservices");
     const GrpcStreamMethod = (0, ts_poet_1.imp)("GrpcStreamMethod@@nestjs/microservices");
+    const serviceName = options.useNestjsFqnServiceName
+        ? (0, utils_1.maybePrefixPackage)(fileDesc, serviceDesc.name)
+        : serviceDesc.name;
     const grpcMethods = serviceDesc.method
         .filter((m) => !m.clientStreaming)
         .map((m) => {
@@ -142,13 +145,13 @@ function generateNestjsGrpcServiceMethodsDecorator(ctx, serviceDesc) {
         const grpcMethods: string[] = [${grpcMethods.join(", ")}];
         for (const method of grpcMethods) {
           const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
-          ${GrpcMethod}('${serviceDesc.name}', method)(constructor.prototype[method], method, descriptor);
+          ${GrpcMethod}('${serviceName}', method)(constructor.prototype[method], method, descriptor);
           Object.defineProperty(constructor.prototype, method, descriptor);
         }
         const grpcStreamMethods: string[] = [${grpcStreamMethods.join(", ")}];
         for (const method of grpcStreamMethods) {
           const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
-          ${GrpcStreamMethod}('${serviceDesc.name}', method)(constructor.prototype[method], method, descriptor);
+          ${GrpcStreamMethod}('${serviceName}', method)(constructor.prototype[method], method, descriptor);
           Object.defineProperty(constructor.prototype, method, descriptor);
         }
       };

package/build/src/main.js

@@ -233,7 +233,7 @@ function generateFile(ctx, fileDesc) {
             // and the service controller interface
             chunks.push((0, generate_nestjs_1.generateNestjsServiceController)(ctx, fileDesc, sInfo, serviceDesc));
             // generate nestjs grpc service controller decorator
-            chunks.push((0, generate_nestjs_1.generateNestjsGrpcServiceMethodsDecorator)(ctx, serviceDesc));
+            chunks.push((0, generate_nestjs_1.generateNestjsGrpcServiceMethodsDecorator)(ctx, fileDesc, serviceDesc));
             let serviceConstName = `${(0, case_1.camelToSnake)(serviceDesc.name)}_NAME`;
             if (!serviceDesc.name.toLowerCase().endsWith("service")) {
                 serviceConstName = `${(0, case_1.camelToSnake)(serviceDesc.name)}_SERVICE_NAME`;

package/build/src/options.d.ts

@@ -80,6 +80,7 @@ export type Options = {
     addGrpcMetadata: boolean;
     metadataType: string | undefined;
     addNestjsRestParameter: boolean;
+    useNestjsFqnServiceName: boolean;
     returnObservable: boolean;
     lowerCaseServiceMethods: boolean;
     nestJs: boolean;

package/build/src/options.js

@@ -98,6 +98,7 @@ function defaultOptions() {
         addGrpcMetadata: false,
         metadataType: undefined,
         addNestjsRestParameter: false,
+        useNestjsFqnServiceName: false,
         nestJs: false,
         env: EnvOption.BOTH,
         unrecognizedEnum: true,
@@ -238,6 +239,10 @@ function optionsFromParameter(parameter) {
     if (options.nestJs) {
         options.initializeFieldsAsUndefined = false;
     }
+    else {
+        // useNestjsFqnServiceName requires nestJs=true
+        options.useNestjsFqnServiceName = false;
+    }
     if (options.outputIndex) {
         options.exportCommonSymbols = false;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "2.14.0",
+  "version": "2.15.0",
   "description": "",
   "main": "build/src/plugin.js",
   "repository": "github:stephenh/ts-proto",