Support CommonJS in protoc-gen-connect-es (#956)

connectrpc · Dec 13, 2023 · 8dde71e · 8dde71e
1 parent b3ff7c8
commit 8dde71e
Show file tree

Hide file tree

Showing 25 changed files with 2,375 additions and 892 deletions.
diff --git a/Makefile b/Makefile
@@ -144,14 +144,14 @@ $(GEN)/connect: node_modules/.bin/protoc-gen-es packages/connect/buf.gen.yaml $(
 
 $(GEN)/connect-web-test: node_modules/.bin/protoc-gen-es $(BUILD)/protoc-gen-connect-es packages/connect-web-test/buf.gen.yaml Makefile
 	rm -rf packages/connect-web-test/src/gen/*
-	npm run -w packages/connect-web-test generate https://github.com/connectrpc/conformance.git#ref=$(CONFORMANCE_VERSION),subdir=proto
+	npm run -w packages/connect-web-test generate https://github.com/connectrpc/conformance.git#tag=$(CONFORMANCE_VERSION),subdir=proto
 	npm run -w packages/connect-web-test generate buf.build/connectrpc/eliza:8bde2b90ec0a7f23df3de5824bed0b6ea2043305
 	@mkdir -p $(@D)
 	@touch $(@)
 
 $(GEN)/connect-node-test: node_modules/.bin/protoc-gen-es $(BUILD)/protoc-gen-connect-es packages/connect-node-test/buf.gen.yaml Makefile
 	rm -rf packages/connect-node-test/src/gen/*
-	npm run -w packages/connect-node-test generate https://github.com/connectrpc/conformance.git#ref=$(CONFORMANCE_VERSION),subdir=proto
+	npm run -w packages/connect-node-test generate https://github.com/connectrpc/conformance.git#tag=$(CONFORMANCE_VERSION),subdir=proto
 	@mkdir -p $(@D)
 	@touch $(@)
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/connect-conformance/package.json b/packages/connect-conformance/package.json
@@ -14,7 +14,7 @@
     "test:node:client": "./bin/connectconformance --mode client --conf conformance-node.yaml -v ./bin/conformancenodeclient"
   },
   "dependencies": {
-    "@bufbuild/protobuf": "^1.4.2",
+    "@bufbuild/protobuf": "^1.6.0",
     "@connectrpc/connect": "1.1.4",
     "@connectrpc/connect-node": "1.1.4",
     "node-forge": "^1.3.1",

diff --git a/packages/connect-conformance/src/gen/connectrpc/conformance/v1/client_compat_pb.ts b/packages/connect-conformance/src/gen/connectrpc/conformance/v1/client_compat_pb.ts
diff --git a/packages/connect-conformance/src/gen/connectrpc/conformance/v1/config_pb.ts b/packages/connect-conformance/src/gen/connectrpc/conformance/v1/config_pb.ts
diff --git a/packages/connect-conformance/src/gen/connectrpc/conformance/v1/server_compat_pb.ts b/packages/connect-conformance/src/gen/connectrpc/conformance/v1/server_compat_pb.ts
diff --git a/packages/connect-conformance/src/gen/connectrpc/conformance/v1/service_pb.ts b/packages/connect-conformance/src/gen/connectrpc/conformance/v1/service_pb.ts
diff --git a/packages/connect-conformance/src/gen/connectrpc/conformance/v1/suite_pb.ts b/packages/connect-conformance/src/gen/connectrpc/conformance/v1/suite_pb.ts
diff --git a/packages/connect-node-test/src/gen/connectrpc/conformance/v1/messages_pb.ts b/packages/connect-node-test/src/gen/connectrpc/conformance/v1/messages_pb.ts
diff --git a/packages/connect-node-test/src/gen/server/v1/server_pb.ts b/packages/connect-node-test/src/gen/server/v1/server_pb.ts
diff --git a/packages/connect-web-bench/README.md b/packages/connect-web-bench/README.md
@@ -10,5 +10,5 @@ it like a web server would usually do.
 
 | code generator | bundle size        | minified               | compressed           |
 |----------------|-------------------:|-----------------------:|---------------------:|
-| connect        | 115,808 b | 50,395 b | 13,566 b |
+| connect        | 116,769 b | 50,660 b | 13,623 b |
 | grpc-web       | 415,212 b    | 300,936 b    | 53,420 b |
diff --git a/packages/connect-web-bench/package.json b/packages/connect-web-bench/package.json
@@ -7,8 +7,8 @@
     "clean": "rm -rf README.md src/gen"
   },
   "dependencies": {
-    "@bufbuild/protobuf": "^1.4.2",
-    "@bufbuild/protoc-gen-es": "^1.4.2",
+    "@bufbuild/protobuf": "^1.6.0",
+    "@bufbuild/protoc-gen-es": "^1.6.0",
     "@connectrpc/connect-web": "1.1.4",
     "brotli": "^1.3.3",
     "esbuild": "^0.19.8",

diff --git a/packages/connect-web-bench/src/gen/connectweb/connectrpc/eliza/v1/eliza_pb.ts b/packages/connect-web-bench/src/gen/connectweb/connectrpc/eliza/v1/eliza_pb.ts
diff --git a/packages/connect-web-test/src/gen/connectrpc/conformance/v1/messages_pb.ts b/packages/connect-web-test/src/gen/connectrpc/conformance/v1/messages_pb.ts
diff --git a/packages/connect-web-test/src/gen/connectrpc/eliza/v1/eliza_pb.ts b/packages/connect-web-test/src/gen/connectrpc/eliza/v1/eliza_pb.ts
diff --git a/packages/connect-web-test/src/gen/server/v1/server_pb.ts b/packages/connect-web-test/src/gen/server/v1/server_pb.ts
diff --git a/packages/connect/package.json b/packages/connect/package.json
@@ -88,7 +88,7 @@
     "@bufbuild/protobuf": "^1.4.2"
   },
   "devDependencies": {
-    "@bufbuild/protoc-gen-es": "^1.4.2",
+    "@bufbuild/protoc-gen-es": "^1.6.0",
     "@types/jasmine": "^5.0.0",
     "jasmine": "^5.1.0",
     "undici": "^5.26.2"

diff --git a/packages/connect/src/protocol-grpc/gen/status_pb.ts b/packages/connect/src/protocol-grpc/gen/status_pb.ts
diff --git a/packages/example/package.json b/packages/example/package.json
@@ -19,7 +19,7 @@
   },
   "devDependencies": {
     "@bufbuild/buf": "^1.27.2",
-    "@bufbuild/protoc-gen-es": "^1.4.2",
+    "@bufbuild/protoc-gen-es": "^1.6.0",
     "@connectrpc/protoc-gen-connect-es": "^1.1.4",
     "@types/express": "^4.17.18",
     "esbuild": "^0.19.8",

diff --git a/packages/example/src/gen/eliza_pb.ts b/packages/example/src/gen/eliza_pb.ts
diff --git a/packages/protoc-gen-connect-es/README.md b/packages/protoc-gen-connect-es/README.md
@@ -125,6 +125,18 @@ in import paths with the given value. For example, set
 - `import_extension=none` to remove the `.js` extension
 - `import_extension=.ts` to replace the `.js` extension with `.ts`
 
+### `js_import_style`
+
+By default, [protoc-gen-connect-es](https://www.npmjs.com/package/@connectrpc/protoc-gen-connect-es)
+(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin))
+generate ECMAScript `import` and `export` statements. For use cases where
+CommonJS is difficult to avoid, this option can be used to generate CommonJS
+`require()` calls.
+
+Possible values:
+- `js_import_style=module` generate ECMAScript `import` / `export` statements -
+  the default behavior.
+- `js_import_style=legacy_commonjs` generate CommonJS `require()` calls.
 
 ### `keep_empty_files=true`
 

diff --git a/packages/protoc-gen-connect-es/package.json b/packages/protoc-gen-connect-es/package.json
@@ -20,12 +20,12 @@
   },
   "preferUnplugged": true,
   "dependencies": {
-    "@bufbuild/protobuf": "^1.4.2",
-    "@bufbuild/protoplugin": "^1.4.1"
+    "@bufbuild/protobuf": "^1.6.0",
+    "@bufbuild/protoplugin": "^1.6.0"
   },
   "peerDependencies": {
     "@connectrpc/connect": "1.1.4",
-    "@bufbuild/protoc-gen-es": "^1.3.3"
+    "@bufbuild/protoc-gen-es": "^1.6.0"
   },
   "peerDependenciesMeta": {
     "@connectrpc/connect": {

diff --git a/packages/protoc-gen-connect-es/src/declaration.ts b/packages/protoc-gen-connect-es/src/declaration.ts
@@ -15,11 +15,7 @@
 import type { DescService } from "@bufbuild/protobuf";
 import { MethodIdempotency, MethodKind } from "@bufbuild/protobuf";
 import type { GeneratedFile, Schema } from "@bufbuild/protoplugin/ecmascript";
-import {
-  literalString,
-  makeJsDoc,
-  localName,
-} from "@bufbuild/protoplugin/ecmascript";
+import { localName } from "@bufbuild/protoplugin/ecmascript";
 
 export function generateDts(schema: Schema) {
   for (const protoFile of schema.files) {
@@ -34,14 +30,14 @@ export function generateDts(schema: Schema) {
 // prettier-ignore
 function generateService(schema: Schema, f: GeneratedFile, service: DescService) {
   const { MethodKind: rtMethodKind, MethodIdempotency: rtMethodIdempotency } = schema.runtime;
-  f.print(makeJsDoc(service));
-  f.print("export declare const ", localName(service), ": {");
-  f.print(`  readonly typeName: `, literalString(service.typeName), `,`);
+  f.print(f.jsDoc(service));
+  f.print(f.exportDecl("declare const", localName(service)), ": {");
+  f.print(`  readonly typeName: `, f.string(service.typeName), `,`);
   f.print("  readonly methods: {");
   for (const method of service.methods) {
-    f.print(makeJsDoc(method, "    "));
+    f.print(f.jsDoc(method, "    "));
     f.print("    readonly ", localName(method), ": {");
-    f.print(`      readonly name: `, literalString(method.name), `,`);
+    f.print(`      readonly name: `, f.string(method.name), `,`);
     f.print("      readonly I: typeof ", method.input, ",");
     f.print("      readonly O: typeof ", method.output, ",");
     f.print("      readonly kind: ", rtMethodKind, ".", MethodKind[method.methodKind], ",");

diff --git a/packages/protoc-gen-connect-es/src/javascript.ts b/packages/protoc-gen-connect-es/src/javascript.ts
@@ -15,11 +15,7 @@
 import type { DescService } from "@bufbuild/protobuf";
 import { MethodIdempotency, MethodKind } from "@bufbuild/protobuf";
 import type { GeneratedFile, Schema } from "@bufbuild/protoplugin/ecmascript";
-import {
-  literalString,
-  makeJsDoc,
-  localName,
-} from "@bufbuild/protoplugin/ecmascript";
+import { localName } from "@bufbuild/protoplugin/ecmascript";
 
 export function generateJs(schema: Schema) {
   for (const protoFile of schema.files) {
@@ -34,14 +30,14 @@ export function generateJs(schema: Schema) {
 // prettier-ignore
 function generateService(schema: Schema, f: GeneratedFile, service: DescService) {
  const { MethodKind: rtMethodKind, MethodIdempotency: rtMethodIdempotency } = schema.runtime;
-  f.print(makeJsDoc(service));
-  f.print("export const ", localName(service), " = {");
-  f.print(`  typeName: `, literalString(service.typeName), `,`);
+  f.print(f.jsDoc(service));
+  f.print(f.exportDecl("const", localName(service)), " = {");
+  f.print(`  typeName: `, f.string(service.typeName), `,`);
   f.print("  methods: {");
   for (const method of service.methods) {
-    f.print(makeJsDoc(method, "    "));
+    f.print(f.jsDoc(method, "    "));
     f.print("    ", localName(method), ": {");
-    f.print(`      name: `, literalString(method.name), `,`);
+    f.print(`      name: `, f.string(method.name), `,`);
     f.print("      I: ", method.input, ",");
     f.print("      O: ", method.output, ",");
     f.print("      kind: ", rtMethodKind, ".", MethodKind[method.methodKind], ",");

diff --git a/packages/protoc-gen-connect-es/src/typescript.ts b/packages/protoc-gen-connect-es/src/typescript.ts
@@ -15,11 +15,7 @@
 import type { DescService } from "@bufbuild/protobuf";
 import { MethodIdempotency, MethodKind } from "@bufbuild/protobuf";
 import type { GeneratedFile, Schema } from "@bufbuild/protoplugin/ecmascript";
-import {
-  literalString,
-  makeJsDoc,
-  localName,
-} from "@bufbuild/protoplugin/ecmascript";
+import { localName } from "@bufbuild/protoplugin/ecmascript";
 
 export function generateTs(schema: Schema) {
   for (const protoFile of schema.files) {
@@ -39,14 +35,14 @@ function generateService(
 ) {
   const { MethodKind: rtMethodKind, MethodIdempotency: rtMethodIdempotency } =
     schema.runtime;
-  f.print(makeJsDoc(service));
-  f.print("export const ", localName(service), " = {");
-  f.print(`  typeName: `, literalString(service.typeName), `,`);
+  f.print(f.jsDoc(service));
+  f.print(f.exportDecl("const", localName(service)), " = {");
+  f.print(`  typeName: `, f.string(service.typeName), `,`);
   f.print("  methods: {");
   for (const method of service.methods) {
-    f.print(makeJsDoc(method, "    "));
+    f.print(f.jsDoc(method, "    "));
     f.print("    ", localName(method), ": {");
-    f.print(`      name: `, literalString(method.name), `,`);
+    f.print(`      name: `, f.string(method.name), `,`);
     f.print("      I: ", method.input, ",");
     f.print("      O: ", method.output, ",");
     f.print(