chore: Upgrade to protobufjs 7 (#789)

Author: bergundy

package-lock.json

@@ -89,6 +89,7 @@
     "npm-run-all": "^4.1.5",
     "pidusage": "^3.0.0",
     "prettier": "^2.7.1",
+    "protobufjs-cli": "^1.0.0",
     "tail": "^2.2.4",
     "ts-prune": "^0.10.3",
     "typescript": "^4.7.4",

package.json

@@ -19,7 +19,7 @@
     "@temporalio/internal-workflow-common": "file:../internal-workflow-common",
     "@temporalio/proto": "file:../proto",
     "ms": "^2.1.3",
-    "protobufjs": "6.11.2",
+    "protobufjs": "^7.0.0",
     "uuid": "^8.3.2"
   },
   "bugs": {

packages/client/package.json

@@ -16,7 +16,7 @@
     "@temporalio/internal-workflow-common": "file:../internal-workflow-common",
     "@temporalio/proto": "file:../proto",
     "proto3-json-serializer": "^1.0.2",
-    "protobufjs": "6.11.2"
+    "protobufjs": "^7.0.0"
   },
   "bugs": {
     "url": "https://github.com/temporalio/sdk-typescript/issues"

packages/common/package.json

@@ -22,7 +22,7 @@
   "dependencies": {
     "@types/long": "^4.0.2",
     "long": "^5.2.0",
-    "protobufjs": "6.11.2"
+    "protobufjs": "^7.0.0"
   },
   "bugs": {
     "url": "https://github.com/temporalio/sdk-typescript/issues"

packages/proto/package.json

@@ -4,8 +4,8 @@ const { promisify } = require('util');
 const dedent = require('dedent');
 const glob = require('glob');
 const { statSync, mkdirSync, readFileSync, writeFileSync } = require('fs');
-const pbjs = require('protobufjs/cli/pbjs');
-const pbts = require('protobufjs/cli/pbts');
+const pbjs = require('protobufjs-cli/pbjs');
+const pbts = require('protobufjs-cli/pbts');
 
 const outputDir = resolve(__dirname, '../protos');
 const jsOutputFile = resolve(outputDir, 'json-module.js');
@@ -38,6 +38,7 @@ async function compileProtos(dtsOutputFile, ...args) {
     '--no-verify',
     '--root',
     '__temporal',
+    resolve(require.resolve('protobufjs'), '../google/protobuf/descriptor.proto'),
     coreProtoPath,
     workflowServiceProtoPath,
     operatorServiceProtoPath,

packages/proto/scripts/compile-proto.js

@@ -6,15 +6,15 @@ const { promisify } = require('util');
 const glob = require('glob');
 const { statSync, mkdirsSync } = require('fs-extra');
 const { rm } = require('fs/promises');
-const pbjs = require('protobufjs/cli/pbjs');
-const pbts = require('protobufjs/cli/pbts');
+const pbjs = require('protobufjs-cli/pbjs');
+const pbts = require('protobufjs-cli/pbts');
 
 const outputDir = resolve(__dirname, '../protos');
 const moduleOutputFile = resolve(outputDir, 'json-module.js');
 const typesOutputFile = resolve(outputDir, 'root.d.ts');
 const tempFile = resolve(outputDir, 'temp.js');
 const protoBaseDir = resolve(__dirname, '../protos');
-const protosPath = protoBaseDir + '/*.proto';
+const protoFiles = glob.sync(protoBaseDir + '/*.proto');
 
 function mtime(path) {
   try {
@@ -27,15 +27,14 @@ function mtime(path) {
   }
 }
 
-async function compileProtos(protoPath, outputFile, ...args) {
-  const pbjsArgs = [...args, '--wrap', 'commonjs', '--force-long', '--no-verify', '--out', outputFile, protoPath];
+async function compileProtos(outputFile, ...args) {
+  const pbjsArgs = [...args, '--wrap', 'commonjs', '--force-long', '--no-verify', '--out', outputFile, ...protoFiles];
   return await promisify(pbjs.main)(pbjsArgs);
 }
 
 async function main() {
   mkdirsSync(outputDir);
 
-  const protoFiles = glob.sync(resolve(protoBaseDir, '**/*.proto'));
   const protosMTime = Math.max(...protoFiles.map(mtime));
   const genMTime = Math.min(mtime(moduleOutputFile), mtime(typesOutputFile));
 
@@ -44,12 +43,12 @@ async function main() {
     return;
   }
 
-  console.log(`Creating protobuf JS definitions from ${protosPath}`);
-  await compileProtos(protosPath, moduleOutputFile, '--target', 'json-module', '--root', 'test');
+  console.log(`Creating protobuf JS definitions from ${protoFiles}`);
+  await compileProtos(moduleOutputFile, '--target', 'json-module', '--root', 'test');
 
-  console.log(`Creating protobuf TS definitions from ${protosPath}`);
+  console.log(`Creating protobuf TS definitions from ${protoFiles}`);
   try {
-    await compileProtos(protosPath, tempFile, '--target', 'static-module');
+    await compileProtos(tempFile, '--target', 'static-module');
     await promisify(pbts.main)(['--out', typesOutputFile, tempFile]);
   } finally {
     await rm(tempFile);

packages/test/scripts/compile-proto.js

@@ -27,7 +27,7 @@
     "get-port": "^6.1.2",
     "got": "^12.1.0",
     "long": "^5.2.0",
-    "protobufjs": "6.11.2",
+    "protobufjs": "^7.0.0",
     "tar-stream": "^2.2.0",
     "unzipper": "^0.10.11"
   },

packages/testing/package.json

@@ -1,12 +1,14 @@
+import { createRequire } from 'module';
 import { resolve, dirname } from 'path';
 import { fileURLToPath } from 'url';
 import { promisify } from 'util';
 import dedent from 'dedent';
 import glob from 'glob';
 import { statSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
-import pbjs from 'protobufjs/cli/pbjs.js';
-import pbts from 'protobufjs/cli/pbts.js';
+import pbjs from 'protobufjs-cli/pbjs.js';
+import pbts from 'protobufjs-cli/pbts.js';
 
+const require = createRequire(import.meta.url);
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const outputDir = resolve(__dirname, '../generated-protos');
 const outputFile = resolve(outputDir, 'index.js');
@@ -40,6 +42,7 @@ async function compileProtos(protoPath, jsOutputFile, dtsOutputFile, ...args) {
     '__temporal_testing',
     '--out',
     jsOutputFile,
+    resolve(require.resolve('protobufjs'), '../google/protobuf/descriptor.proto'),
     protoPath,
   ];
   await promisify(pbjs.main)(pbjsArgs);