ts-proto 2.14.0 → 2.15.1

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.d.ts

@@ -42,6 +42,9 @@ declare function makeTimestampMethods(options: Options, longs: ReturnType<typeof
     fromTimestamp: ConditionalOutput;
     timestampFractionRegex: ConditionalOutput;
     fromJsonTimestamp: ConditionalOutput;
+    timestampJsonRegex: ConditionalOutput;
+    timestampFromJson: ConditionalOutput;
+    timestampToJson: ConditionalOutput;
 };
 declare function makeAnyJsonUtils(): {
     anyJsonValueTypes: ConditionalOutput;

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`;
@@ -829,7 +829,43 @@ function makeTimestampMethods(options, longs, bytes) {
           }
         }
       `);
-    return { toTimestamp, fromTimestamp, timestampFractionRegex, fromJsonTimestamp };
+    // Declared once per file, so the regex isn't compiled on each timestampFromJson call
+    const timestampJsonRegex = (0, ts_poet_1.conditionalOutput)("timestampJsonRegex", (0, ts_poet_1.code) `const timestampJsonRegex = /^.+T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$/;`);
+    // Parses the canonical JSON of a Timestamp, an RFC 3339 string
+    const timestampFromJson = (0, ts_poet_1.conditionalOutput)("timestampFromJson", (0, ts_poet_1.code) `
+      function timestampFromJson(value: string): { seconds: number; nanos: number } {
+        const match = ${timestampJsonRegex}.exec(value);
+        // Date only keeps milliseconds, so it parses the string without the fractional seconds
+        const fraction = match?.[1];
+        const millis = match
+          ? new ${bytes.globalThis}.Date(fraction === undefined ? value : value.replace(fraction, "")).getTime()
+          : NaN;
+        if (!match || ${bytes.globalThis}.Number.isNaN(millis)) {
+          throw new ${bytes.globalThis}.Error(\`Invalid timestamp: \${value}\`);
+        }
+        const nanos = fraction === undefined ? 0 : ${bytes.globalThis}.Number(fraction.slice(1, 10).padEnd(9, "0"));
+        return { seconds: millis / 1_000, nanos };
+      }
+    `);
+    // Writes the canonical JSON of a Timestamp, an RFC 3339 string
+    const timestampToJson = (0, ts_poet_1.conditionalOutput)("timestampToJson", (0, ts_poet_1.code) `
+      function timestampToJson(seconds: number, nanos: number): string {
+        const date = new ${bytes.globalThis}.Date(seconds * 1_000).toISOString().slice(0, 19);
+        if (nanos === 0) return \`\${date}Z\`;
+        const padded = nanos.toString().padStart(9, "0");
+        const len = nanos % 1_000_000 === 0 ? 3 : nanos % 1_000 === 0 ? 6 : 9;
+        return \`\${date}.\${padded.slice(0, len)}Z\`;
+      }
+    `);
+    return {
+        toTimestamp,
+        fromTimestamp,
+        timestampFractionRegex,
+        fromJsonTimestamp,
+        timestampJsonRegex,
+        timestampFromJson,
+        timestampToJson,
+    };
 }
 function makeAnyJsonUtils() {
     // Well-known types whose JSON is not an object of their fields. Packed in an Any, that
@@ -1905,10 +1941,22 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     `;
     }
     // create the basic function declaration
-    chunks.push((0, ts_poet_1.code) `
-    fromJSON(${messageDesc.field.length > 0 ? "object" : "_"}: any): ${fullName} {
-      return {
-  `);
+    if (fullTypeName === "google.protobuf.Timestamp") {
+        // The canonical JSON of a Timestamp is an RFC 3339 string; the object form is still accepted.
+        chunks.push((0, ts_poet_1.code) `
+      fromJSON(object: any): ${fullName} {
+        if (typeof object === "string") {
+          return ${fullName}.fromJSON(${utils.timestampFromJson}(object));
+        }
+        return {
+    `);
+    }
+    else {
+        chunks.push((0, ts_poet_1.code) `
+      fromJSON(${messageDesc.field.length > 0 ? "object" : "_"}: any): ${fullName} {
+        return {
+    `);
+    }
     if ((0, options_1.addTypeToMessages)(options)) {
         chunks.push((0, ts_poet_1.code) `$type: ${fullName}.$type,`);
     }
@@ -2223,7 +2271,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
-function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals, useNullAsOptional, useDuration, forceLong }) {
+function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals, useNullAsOptional, useDuration, useJsonTimestamp, forceLong }, utils) {
     if ((0, types_1.isFieldMaskTypeName)(fullProtobufTypeName)) {
         const returnType = useOptionals === "all" ? `string | ${(0, utils_1.nullOrUndefined)({ useNullAsOptional })}` : "string";
         const pathModifier = useOptionals === "all" ? "?" : "";
@@ -2269,6 +2317,16 @@ function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals,
     }
     `;
     }
+    if (fullProtobufTypeName === "google.protobuf.Timestamp" && useJsonTimestamp === options_1.JsonTimestampOption.RFC3339) {
+        const seconds = forceLong === options_1.LongOption.LONG
+            ? (0, ts_poet_1.code) `message.seconds?.toNumber() ?? 0`
+            : (0, ts_poet_1.code) `${utils.globalThis}.Number(message.seconds ?? 0)`;
+        return (0, ts_poet_1.code) `
+    toJSON(message: ${fullName}): string {
+      return ${utils.timestampToJson}(${seconds}, message.nanos ?? 0);
+    }
+    `;
+    }
     return undefined;
 }
 /** Whether `google.protobuf.Any` gets its canonical `@type` JSON form, see the `anyType` option. */
@@ -2348,7 +2406,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         chunks.push(generateCanonicalAnyToJson(ctx, fullName, messageDesc));
         return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
     }
-    const canonicalToJson = generateCanonicalToJson(fullName, fullProtobufTypeName, options);
+    const canonicalToJson = generateCanonicalToJson(fullName, fullProtobufTypeName, options, utils);
     if (canonicalToJson) {
         chunks.push(canonicalToJson);
         return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });

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.1",
   "description": "",
   "main": "build/src/plugin.js",
   "repository": "github:stephenh/ts-proto",