fix: force import protobufjs/ext/descriptor package (#407)

* fix: lint issue

* fix: protobuf import

* fix: patch protobuf module declaration

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* fix: add more comments around protobufjs fix

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

package.json

@@ -29,6 +29,9 @@
   "dependencies": {
     "google-gax": "^4.0.3"
   },
+  "peerDependencies": {
+    "protobufjs": "^7.2.4"
+  },
   "devDependencies": {
     "@google-cloud/bigquery": "^7.0.0",
     "@types/uuid": "^9.0.1",

src/index.ts

@@ -49,3 +49,12 @@ import * as protos from '../protos/protos';
 export {protos};
 import * as adapt from './adapt';
 export {adapt};
+
+// Add extra protobufjs definitions.
+// When importing protobufjs/ext/descriptor package, it monkey patches some methods
+// that we use in this package. We need to manually declare some of those
+// methods that we use to make the Typescript compiler happy.
+// There are some open issues around that. After they are fixed, we can remove this:
+// * https://github.com/protobufjs/protobuf.js/issues/1499
+// * https://github.com/protobufjs/protobuf.js/issues/1149
+import './protobuf';

src/managedwriter/json_writer.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {protobuf} from 'google-gax';
+import * as protobuf from 'protobufjs';
 import * as protos from '../../protos/protos';
 import {PendingWrite} from './pending_write';
 import {StreamConnection, RemoveListener} from './stream_connection';
@@ -90,8 +90,7 @@ export class JSONWriter {
     const normalized = adapt.normalizeDescriptor(
       new DescriptorProto(protoDescriptor)
     );
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    this._type = (Type as any).fromDescriptor(normalized);
+    this._type = Type.fromDescriptor(normalized);
     this._writer.setProtoDescriptor(protoDescriptor);
   }
 

src/protobuf/index.ts

@@ -0,0 +1,27 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import 'protobufjs';
+import 'protobufjs/ext/descriptor';
+import * as protos from '../../protos/protos';
+
+type IDescriptorProto = protos.google.protobuf.IDescriptorProto;
+
+declare module 'protobufjs' {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace Type {
+    let toDescriptor: (protoVersion: string) => IDescriptorProto;
+    let fromDescriptor: (descriptor: IDescriptorProto) => Type;
+  }
+}

system-test/managed_writer_client_test.ts

@@ -19,7 +19,8 @@ import * as gax from 'google-gax';
 import {BigQuery, TableSchema} from '@google-cloud/bigquery';
 import * as protos from '../protos/protos';
 import * as bigquerywriter from '../src';
-import {ClientOptions, protobuf} from 'google-gax';
+import * as protobuf from 'protobufjs';
+import {ClientOptions} from 'google-gax';
 import * as customerRecordProtoJson from '../samples/customer_record.json';
 
 const {managedwriter, adapt} = bigquerywriter;
@@ -655,8 +656,8 @@ describe('managedwriter.WriterClient', () => {
         });
 
         protoDescriptor.field = protoDescriptor.field?.slice(0, 1); // leave just first field
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const invalidProto = (Type as any).fromDescriptor(
+
+        const invalidProto = Type.fromDescriptor(
           protoDescriptor
         ) as protobuf.Type;
         const row = {

test/adapt/proto.ts

@@ -14,7 +14,7 @@
 
 import * as assert from 'assert';
 import {describe, it} from 'mocha';
-import {protobuf} from 'google-gax';
+import * as protobuf from 'protobufjs';
 import * as adapt from '../../src/adapt';
 import * as messagesJSON from '../../samples/testdata/messages.json';
 import * as protos from '../../protos/protos';
@@ -59,7 +59,7 @@ describe('Adapt Protos', () => {
       if (!protoDescriptor) {
         throw Error('null proto descriptor set');
       }
-      const TestProto = (Type as any).fromDescriptor(protoDescriptor);
+      const TestProto = Type.fromDescriptor(protoDescriptor);
       const raw = {
         foo: 'name',
         bar: 42,
@@ -191,7 +191,7 @@ describe('Adapt Protos', () => {
           },
         ],
       });
-      const NestedProto = (Type as any).fromDescriptor(protoDescriptor);
+      const NestedProto = Type.fromDescriptor(protoDescriptor);
       const raw = {
         record_id: '12345',
         recordDetails: [