ts-proto 2.12.3 → 2.13.0

package/README.markdown

@@ -264,7 +264,7 @@ When ts-proto recognizes methods of this pattern, it will automatically create a
 
 This provides the client code with the illusion that it can make individual `Get<OperationName>` calls (which is generally preferable/easier when implementing the client's business logic), but the actual implementation that ts-proto provides will end up making `Batch<OperationName>` calls to the backend service.
 
-You also need to enable the `useContext=true` build-time parameter, which gives all client methods a Go-style `ctx` parameter, with a `getDataLoaders` method that lets ts-proto cache/resolve request-scoped [DataLoaders](https://github.com/graphql/dataloader), which provide the fundamental auto-batch detection/flushing behavior.
+You also need `context=true`, which adds a Go-style `ctx` parameter to every client method. Your `ctx` must implement `getDataLoader`, which ts-proto uses to cache request-scoped [DataLoaders](https://github.com/graphql/dataloader) that handle batch detection and flushing. If you want `ctx` for tracing/metadata only, pass `useContextDataloaders=false` to skip the DataLoader contract.
 
 See the `batching.proto` file and related tests for examples/more details.
 
@@ -317,6 +317,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=context=true`, the services will have a Go-style `ctx` parameter, which is useful for tracing/logging/etc. if you're not using node's `async_hooks` api due to performance reasons.
 
+  By default `Context` must extend a generated `DataLoaders` interface so ts-proto can emit DataLoader-backed wrappers around `Get*`/`Batch*` methods. Pass `useContextDataloaders=false` to drop the constraint and skip those wrappers when you only need `ctx` for tracing/metadata.
+
 - With `--ts_proto_opt=forceLong=long`, all 64-bit numbers will be parsed as instances of `Long` (using the [long](https://www.npmjs.com/package/long) library).
 
   With `--ts_proto_opt=forceLong=string`, all 64-bit numbers will be output as strings.

package/build/src/generate-nestjs.js

@@ -13,7 +13,7 @@ function generateNestjsServiceController(ctx, fileDesc, sourceInfo, serviceDesc)
     const chunks = [];
     const Metadata = (0, ts_poet_1.imp)("t:Metadata@@grpc/grpc-js");
     (0, utils_1.maybeAddComment)(options, sourceInfo, chunks, serviceDesc.options?.deprecated);
-    const t = options.context ? `<${main_1.contextTypeVar}>` : "";
+    const t = options.context ? `<${(0, main_1.contextTypeVar)(options)}>` : "";
     chunks.push((0, ts_poet_1.code) `
     export interface ${serviceDesc.name}Controller${t} {
   `);
@@ -53,7 +53,7 @@ function generateNestjsServiceController(ctx, fileDesc, sourceInfo, serviceDesc)
         chunks.push((0, ts_poet_1.code) `
       ${methodDesc.formattedName}(${(0, ts_poet_1.joinCode)(params, { on: ", " })}): ${returns};
     `);
-        if (options.context) {
+        if (options.context && options.useContextDataloaders) {
             const batchMethod = (0, types_1.detectBatchMethod)(ctx, fileDesc, serviceDesc, methodDesc);
             if (batchMethod) {
                 const maybeCtx = options.context ? "ctx: Context," : "";
@@ -74,7 +74,7 @@ function generateNestjsServiceClient(ctx, fileDesc, sourceInfo, serviceDesc) {
     const chunks = [];
     const Metadata = (0, ts_poet_1.imp)("t:Metadata@@grpc/grpc-js");
     (0, utils_1.maybeAddComment)(options, sourceInfo, chunks);
-    const t = options.context ? `<${main_1.contextTypeVar}>` : ``;
+    const t = options.context ? `<${(0, main_1.contextTypeVar)(options)}>` : ``;
     chunks.push((0, ts_poet_1.code) `
     export interface ${serviceDesc.name}Client${t} {
   `);
@@ -102,7 +102,7 @@ function generateNestjsServiceClient(ctx, fileDesc, sourceInfo, serviceDesc) {
         ${(0, ts_poet_1.joinCode)(params, { on: "," })}
       ): ${returns};
     `);
-        if (options.context) {
+        if (options.context && options.useContextDataloaders) {
             const batchMethod = (0, types_1.detectBatchMethod)(ctx, fileDesc, serviceDesc, methodDesc);
             if (batchMethod) {
                 const maybeContext = options.context ? `ctx: Context,` : "";

package/build/src/generate-services.js

@@ -24,7 +24,7 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
     const { options } = ctx;
     const chunks = [];
     (0, utils_1.maybeAddComment)(options, sourceInfo, chunks, serviceDesc.options?.deprecated);
-    const maybeTypeVar = options.context ? `<${main_1.contextTypeVar}>` : "";
+    const maybeTypeVar = options.context ? `<${(0, main_1.contextTypeVar)(options)}>` : "";
     chunks.push((0, ts_poet_1.code) `export interface ${(0, ts_poet_1.def)(serviceDesc.name)}${maybeTypeVar} {`);
     serviceDesc.method.forEach((methodDesc, index) => {
         (0, utils_1.assertInstanceOf)(methodDesc, utils_1.FormattedMethodDescriptor);
@@ -61,7 +61,7 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
         }
         chunks.push((0, ts_poet_1.code) `${methodDesc.formattedName}(${(0, ts_poet_1.joinCode)(params, { on: "," })}): ${(0, types_1.responsePromiseOrObservable)(ctx, methodDesc)};`);
         // If this is a batch method, auto-generate the singular version of it
-        if (options.context) {
+        if (options.context && options.useContextDataloaders) {
             const batchMethod = (0, types_1.detectBatchMethod)(ctx, fileDesc, serviceDesc, methodDesc);
             if (batchMethod) {
                 chunks.push((0, ts_poet_1.code) `${batchMethod.singleMethodName}(
@@ -208,7 +208,7 @@ function generateServiceClientImpl(ctx, fileDesc, serviceDesc) {
     chunks.push((0, ts_poet_1.code) `export const ${serviceNameConst} = "${serviceName}";`);
     // Define the FooServiceImpl class
     const i = options.context ? `${name}<Context>` : name;
-    const t = options.context ? `<${main_1.contextTypeVar}>` : "";
+    const t = options.context ? `<${(0, main_1.contextTypeVar)(options)}>` : "";
     chunks.push((0, ts_poet_1.code) `export class ${name}ClientImpl${t} implements ${(0, ts_poet_1.def)(i)} {`);
     // Create the constructor(rpc: Rpc)
     const rpcType = options.context ? "Rpc<Context>" : "Rpc";
@@ -226,13 +226,14 @@ function generateServiceClientImpl(ctx, fileDesc, serviceDesc) {
     // Create a method for each FooService method
     for (const methodDesc of serviceDesc.method) {
         // See if this fuzzy matches to a batchable method
-        if (options.context) {
+        if (options.context && options.useContextDataloaders) {
             const batchMethod = (0, types_1.detectBatchMethod)(ctx, fileDesc, serviceDesc, methodDesc);
             if (batchMethod) {
                 chunks.push(generateBatchingRpcMethod(ctx, batchMethod));
             }
         }
         if (options.context &&
+            options.useContextDataloaders &&
             methodDesc.name.match(/^Get[A-Z]/) &&
             !methodDesc.serverStreaming &&
             !methodDesc.clientStreaming) {

package/build/src/main.d.ts

@@ -57,5 +57,5 @@ declare function makeExtensionClass(options: Options): {
 declare function makeAssertionUtils(bytes: ReturnType<typeof makeByteUtils>): {
     fail: ConditionalOutput;
 };
-export declare const contextTypeVar = "Context extends DataLoaders";
+export declare function contextTypeVar(options: Options): string;
 export {};

package/build/src/main.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.contextTypeVar = void 0;
 exports.generateFile = generateFile;
 exports.makeUtils = makeUtils;
+exports.contextTypeVar = contextTypeVar;
 const ts_poet_1 = require("ts-poet");
 const ConditionalOutput_1 = require("ts-poet/build/ConditionalOutput");
 const ts_proto_descriptors_1 = require("ts-proto-descriptors");
@@ -153,12 +153,12 @@ function generateFile(ctx, fileDesc) {
                 staticMembers.push(generateFromPartial(ctx, fullName, message));
             }
             const structFieldNames = {
-                nullValue: (0, case_1.maybeSnakeToCamel)("null_value", ctx.options),
-                numberValue: (0, case_1.maybeSnakeToCamel)("number_value", ctx.options),
-                stringValue: (0, case_1.maybeSnakeToCamel)("string_value", ctx.options),
-                boolValue: (0, case_1.maybeSnakeToCamel)("bool_value", ctx.options),
-                structValue: (0, case_1.maybeSnakeToCamel)("struct_value", ctx.options),
-                listValue: (0, case_1.maybeSnakeToCamel)("list_value", ctx.options),
+                nullValue: (0, utils_1.getFieldName)({ name: "null_value", jsonName: (0, case_1.snakeToCamel)("null_value") }, ctx.options),
+                numberValue: (0, utils_1.getFieldName)({ name: "number_value", jsonName: (0, case_1.snakeToCamel)("number_value") }, ctx.options),
+                stringValue: (0, utils_1.getFieldName)({ name: "string_value", jsonName: (0, case_1.snakeToCamel)("string_value") }, ctx.options),
+                boolValue: (0, utils_1.getFieldName)({ name: "bool_value", jsonName: (0, case_1.snakeToCamel)("bool_value") }, ctx.options),
+                structValue: (0, utils_1.getFieldName)({ name: "struct_value", jsonName: (0, case_1.snakeToCamel)("struct_value") }, ctx.options),
+                listValue: (0, utils_1.getFieldName)({ name: "list_value", jsonName: (0, case_1.snakeToCamel)("list_value") }, ctx.options),
             };
             if (options.nestJs) {
                 staticMembers.push(...(0, generate_struct_wrappers_1.generateWrapDeep)(ctx, fullTypeName, structFieldNames));
@@ -288,7 +288,7 @@ function generateFile(ctx, fileDesc) {
             chunks.push((0, generate_grpc_web_1.addGrpcWebMisc)(ctx, hasServerStreamingMethods));
         }
     }
-    if (options.context) {
+    if (options.context && options.useContextDataloaders) {
         chunks.push((0, generate_services_1.generateDataLoaderOptionsType)());
         chunks.push((0, generate_services_1.generateDataLoadersType)());
     }
@@ -2629,7 +2629,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
-exports.contextTypeVar = "Context extends DataLoaders";
+function contextTypeVar(options) {
+    return options.useContextDataloaders ? "Context extends DataLoaders" : "Context";
+}
 function convertFromObjectKey(ctx, messageDesc, field, variableName) {
     const { keyType, keyField } = (0, types_1.detectMapType)(ctx, messageDesc, field);
     if (keyType.toCodeString([]) === "string") {

package/build/src/options.d.ts

@@ -44,6 +44,7 @@ export declare enum OutputSchemaOption {
 }
 export type Options = {
     context: boolean;
+    useContextDataloaders: boolean;
     snakeToCamel: Array<"json" | "keys">;
     protoJsonFormat: boolean;
     forceLong: LongOption;

package/build/src/options.js

@@ -59,6 +59,7 @@ var OutputSchemaOption;
 function defaultOptions() {
     return {
         context: false,
+        useContextDataloaders: true,
         snakeToCamel: ["json", "keys"],
         protoJsonFormat: true,
         emitDefaultValues: [],

package/package.json

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