Split usage of common module (googleapis#297)

JustinBeckwith · thiyaguk09 · commit 5251604fc0d4 · 2026-05-05T14:56:27.000Z
diff --git a/handwritten/bigtable/package.json b/handwritten/bigtable/package.json
@@ -53,15 +53,16 @@
     "generate-scaffolding": "repo-tools generate all && repo-tools generate lib_samples_readme -l samples/ --config ../.cloud-repo-tools.json",
     "lint": "eslint src/ samples/ system-test/ test/",
     "prettier": "prettier --write src/*.js src/*/*.js samples/*.js samples/*/*.js test/*.js test/*/*.js system-test/*.js system-test/*/*.js",
-    "publish-module": "node ../../scripts/publish.js bigtable",
     "system-test": "mocha system-test/*.js --timeout 600000",
     "snippet-test": "mocha samples/document-snippets/test.js --timeout 600000"
   },
   "dependencies": {
     "@google-cloud/common-grpc": "^0.7.1",
+    "@google-cloud/paginator": "^0.1.0",
+    "@google-cloud/projectify": "^0.3.0",
+    "@google-cloud/promisify": "^0.3.0",
     "arrify": "^1.0.0",
     "concat-stream": "^1.5.0",
-    "create-error-class": "^3.0.2",
     "dot-prop": "^4.2.0",
     "escape-string-regexp": "^1.0.5",
     "extend": "^3.0.0",
diff --git a/handwritten/bigtable/src/app-profile.js b/handwritten/bigtable/src/app-profile.js
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-const common = require('@google-cloud/common-grpc');
+const {promisifyAll} = require('@google-cloud/promisify');
 const is = require('is');
 const snakeCase = require('lodash.snakecase');
 
@@ -400,7 +400,7 @@ Please use the format 'my-app-profile' or '${
  * All async methods (except for streams) will return a Promise in the event
  * that a callback is omitted.
  */
-common.util.promisifyAll(AppProfile);
+promisifyAll(AppProfile);
 
 /**
  * Reference to the {@link AppProfile} class.
diff --git a/handwritten/bigtable/src/chunktransformer.js b/handwritten/bigtable/src/chunktransformer.js
@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 const Mutation = require('./mutation');
-const stream = require('stream');
-const Transform = stream.Transform;
+const {Transform} = require('stream');
 
 class TransformError extends Error {
   constructor(props) {
diff --git a/handwritten/bigtable/src/cluster.js b/handwritten/bigtable/src/cluster.js
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-const common = require('@google-cloud/common-grpc');
+const {promisifyAll} = require('@google-cloud/promisify');
 const is = require('is');
 
 /**
@@ -400,7 +400,7 @@ Please use the format 'my-cluster' or '${instance.name}/clusters/my-cluster'.`
  * All async methods (except for streams) will return a Promise in the event
  * that a callback is omitted.
  */
-common.util.promisifyAll(Cluster);
+promisifyAll(Cluster);
 
 /**
  * Reference to the {@link Cluster} class.
diff --git a/handwritten/bigtable/src/family.js b/handwritten/bigtable/src/family.js
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-const common = require('@google-cloud/common-grpc');
+const {promisifyAll} = require('@google-cloud/promisify');
 const is = require('is');
 
 /**
@@ -436,7 +436,7 @@ Please use the format 'follows' or '${table.name}/columnFamilies/my-family'.`
  * All async methods (except for streams) will return a Promise in the event
  * that a callback is omitted.
  */
-common.util.promisifyAll(Family);
+promisifyAll(Family);
 
 module.exports = Family;
 module.exports.FamilyError = FamilyError;
diff --git a/handwritten/bigtable/src/index.js b/handwritten/bigtable/src/index.js
@@ -15,9 +15,10 @@
  */
 
 const arrify = require('arrify');
-const common = require('@google-cloud/common-grpc');
+const {replaceProjectIdToken} = require('@google-cloud/projectify');
+const {promisifyAll} = require('@google-cloud/promisify');
 const extend = require('extend');
-const GrpcService = require('@google-cloud/common-grpc').Service;
+const {Service} = require('@google-cloud/common-grpc');
 const {GoogleAuth} = require('google-auth-library');
 const gax = require('google-gax');
 const grpc = new gax.GrpcClient().grpc;
@@ -337,7 +338,7 @@ const v2 = require('./v2');
  */
 class Bigtable {
   constructor(options) {
-    options = common.util.normalizeArguments(this, options);
+    options = options || {};
 
     // Determine what scopes are needed.
     // It is the union of the scopes on all three clients.
@@ -654,7 +655,7 @@ class Bigtable {
         let reqOpts = extend(true, {}, config.reqOpts);
 
         if (this.shouldReplaceProjectIdToken && projectId !== '{{projectId}}') {
-          reqOpts = common.util.replaceProjectIdToken(reqOpts, projectId);
+          reqOpts = replaceProjectIdToken(reqOpts, projectId);
         }
 
         const requestFn = gaxClient[config.method].bind(
@@ -708,7 +709,7 @@ class Bigtable {
             currentRetryAttempt: 0,
             noResponseRetries: 0,
             objectMode: true,
-            shouldRetryFn: GrpcService.shouldRetryRequest_,
+            shouldRetryFn: Service.shouldRetryRequest_,
             request() {
               gaxStream = requestFn();
               return gaxStream;
@@ -762,7 +763,7 @@ class Bigtable {
  * All async methods (except for streams) will return a Promise in the event
  * that a callback is omitted.
  */
-common.util.promisifyAll(Bigtable, {
+promisifyAll(Bigtable, {
   exclude: ['instance', 'operation', 'request'],
 });
 
diff --git a/handwritten/bigtable/src/instance.js b/handwritten/bigtable/src/instance.js
@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-const common = require('@google-cloud/common-grpc');
+const {paginator} = require('@google-cloud/paginator');
+const {promisifyAll} = require('@google-cloud/promisify');
 const extend = require('extend');
 const is = require('is');
 const snakeCase = require('lodash.snakecase');
@@ -749,20 +750,20 @@ Please use the format 'my-instance' or '${
  *     this.end();
  *   });
  */
-Instance.prototype.getTablesStream = common.paginator.streamify('getTables');
+Instance.prototype.getTablesStream = paginator.streamify('getTables');
 
 /*! Developer Documentation
  *
  * These methods can be auto-paginated.
  */
-common.paginator.extend(Instance, ['getTables']);
+paginator.extend(Instance, ['getTables']);
 
 /*! Developer Documentation
  *
  * All async methods (except for streams) will return a Promise in the event
  * that a callback is omitted.
  */
-common.util.promisifyAll(Instance, {
+promisifyAll(Instance, {
   exclude: ['appProfile', 'cluster', 'table'],
 });
 
diff --git a/handwritten/bigtable/src/row.js b/handwritten/bigtable/src/row.js
@@ -15,7 +15,7 @@
  */
 
 const arrify = require('arrify');
-const common = require('@google-cloud/common-grpc');
+const {promisifyAll} = require('@google-cloud/promisify');
 const dotProp = require('dot-prop');
 const extend = require('extend');
 const flatten = require('lodash.flatten');
@@ -921,7 +921,7 @@ class Row {
  * All async methods (except for streams) will return a Promise in the event
  * that a callback is omitted.
  */
-common.util.promisifyAll(Row);
+promisifyAll(Row);
 
 module.exports = Row;
 module.exports.RowError = RowError;
diff --git a/handwritten/bigtable/src/table.js b/handwritten/bigtable/src/table.js
@@ -16,6 +16,7 @@
 
 const arrify = require('arrify');
 const common = require('@google-cloud/common-grpc');
+const {promisifyAll} = require('@google-cloud/promisify');
 const concat = require('concat-stream');
 const flatten = require('lodash.flatten');
 const is = require('is');
@@ -1513,7 +1514,7 @@ Table.VIEWS = {
  * All async methods (except for streams) will return a Promise in the event
  * that a callback is omitted.
  */
-common.util.promisifyAll(Table, {
+promisifyAll(Table, {
   exclude: ['family', 'row'],
 });
 
diff --git a/handwritten/bigtable/synth.py b/handwritten/bigtable/synth.py
@@ -6,24 +6,15 @@
 logging.basicConfig(level=logging.DEBUG)
 
 gapic = gcp.GAPICGenerator()
-common_templates = gcp.CommonTemplates()
-
 v2_library = gapic.node_library(
     'bigtable', 'v2', config_path='/google/bigtable/artman_bigtable.yaml')
-
-# Copy all files except for 'README.md' and 'package.json'
 s.copy(
     v2_library,
     excludes=['package.json', 'README.md', 'src/index.js', 'src/v2/index.js'])
 
-templates = common_templates.node_library(
-    package_name="@google-cloud/bigtable",
-    repo_name="googleapis/nodejs-bigtable")
+common_templates = gcp.CommonTemplates()
+templates = common_templates.node_library()
 s.copy(templates)
 
-#
-# Node.js specific cleanup
-#
 subprocess.run(['npm', 'install'])
 subprocess.run(['npm', 'run', 'prettier'])
-subprocess.run(['npm', 'run', 'lint'])
diff --git a/handwritten/bigtable/test/app-profile.js b/handwritten/bigtable/test/app-profile.js
@@ -19,10 +19,10 @@
 const assert = require('assert');
 const extend = require('extend');
 const proxyquire = require('proxyquire');
-const common = require('@google-cloud/common-grpc');
+const promisify = require('@google-cloud/promisify');
 
 var promisified = false;
-var fakeUtil = extend({}, common.util, {
+var fakePromisify = extend({}, promisify, {
   promisifyAll: function(Class) {
     if (Class.name === 'AppProfile') {
       promisified = true;
@@ -51,9 +51,7 @@ describe('Bigtable/AppProfile', function() {
   before(function() {
     AppProfile = proxyquire('../src/app-profile.js', {
       '../src/cluster.js': FakeCluster,
-      '@google-cloud/common-grpc': {
-        util: fakeUtil,
-      },
+      '@google-cloud/promisify': fakePromisify,
     });
   });
 
diff --git a/handwritten/bigtable/test/chunktransformer.js b/handwritten/bigtable/test/chunktransformer.js
@@ -23,7 +23,7 @@ const Mutation = require('../src/mutation.js');
 const Long = require('long');
 const ROW_ID = 'my-row';
 const CONVERTED_ROW_ID = 'my-converted-row';
-const RowStateEnum = require('../src/chunktransformer.js').RowStateEnum;
+const {RowStateEnum} = require('../src/chunktransformer.js');
 
 const FakeMutation = {
   methods: Mutation.methods,
diff --git a/handwritten/bigtable/test/cluster.js b/handwritten/bigtable/test/cluster.js
@@ -19,11 +19,10 @@
 const assert = require('assert');
 const extend = require('extend');
 const proxyquire = require('proxyquire');
-
-const common = require('@google-cloud/common-grpc');
+const promisify = require('@google-cloud/promisify');
 
 var promisified = false;
-const fakeUtil = extend({}, common.util, {
+const fakePromisify = extend({}, promisify, {
   promisifyAll: function(Class) {
     if (Class.name === 'Cluster') {
       promisified = true;
@@ -46,9 +45,7 @@ describe('Bigtable/Cluster', function() {
 
   before(function() {
     Cluster = proxyquire('../src/cluster.js', {
-      '@google-cloud/common-grpc': {
-        util: fakeUtil,
-      },
+      '@google-cloud/promisify': fakePromisify,
     });
   });
 
diff --git a/handwritten/bigtable/test/family.js b/handwritten/bigtable/test/family.js
@@ -19,10 +19,10 @@
 const assert = require('assert');
 const extend = require('extend');
 const proxyquire = require('proxyquire');
-const {util} = require('@google-cloud/common-grpc');
+const promisify = require('@google-cloud/promisify');
 
 var promisified = false;
-const fakeUtil = extend({}, util, {
+const fakePromisify = extend({}, promisify, {
   promisifyAll: function(Class) {
     if (Class.name === 'Family') {
       promisified = true;
@@ -36,8 +36,8 @@ describe('Bigtable/Family', function() {
     bigtable: {},
     id: 'my-table',
     name: 'projects/my-project/instances/my-inststance/tables/my-table',
-    getFamilies: util.noop,
-    createFamily: util.noop,
+    getFamilies: () => {},
+    createFamily: () => {},
   };
 
   const FAMILY_NAME = `${TABLE.name}/columnFamilies/${FAMILY_ID}`;
@@ -47,9 +47,7 @@ describe('Bigtable/Family', function() {
 
   before(function() {
     Family = proxyquire('../src/family.js', {
-      '@google-cloud/common-grpc': {
-        util: fakeUtil,
-      },
+      '@google-cloud/promisify': fakePromisify,
     });
 
     FamilyError = Family.FamilyError;
diff --git a/handwritten/bigtable/test/index.js b/handwritten/bigtable/test/index.js
diff --git a/handwritten/bigtable/test/instance.js b/handwritten/bigtable/test/instance.js
diff --git a/handwritten/bigtable/test/row.js b/handwritten/bigtable/test/row.js
diff --git a/handwritten/bigtable/test/table.js b/handwritten/bigtable/test/table.js
