fix: Client side metrics should record the version number of @google-cloud/bigtable not the customer package version

src/client-side-metrics/operation-metrics-collector.ts

@@ -50,8 +50,7 @@ export interface ITabularApiSurface {
   };
 }
 
-const packageJSON = fs.readFileSync('package.json');
-const version = JSON.parse(packageJSON.toString()).version;
+const {version} = require('../../../package.json');
 
 // MetricsCollectorState is a list of states that the metrics collector can be in.
 // Tracking the OperationMetricsCollector state is done so that the

test/metrics-collector/version/get-version-script.js

@@ -0,0 +1,85 @@
+// Copyright 2026 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.
+
+const path = require('path');
+const fs = require('fs');
+const {
+  ClientSideMetricsConfigManager,
+} = require('../../../build/src/client-side-metrics/metrics-config-manager.js'); // eslint-disable-line
+const {Bigtable} = require('../../../build/src'); // eslint-disable-line
+
+async function main() {
+  /**
+   * A test implementation of the IMetricsHandler interface.  Used for testing purposes.
+   * It logs the metrics and attributes received by the onOperationComplete and onAttemptComplete methods.
+   * Doesn't replace the name of the client like the other testing class.
+   */
+  class TestMetricsHandlerKeepName {
+    constructor() {
+      this.messages = {value: ''};
+      this.projectId = 'projectId';
+      this.requestsHandled = [];
+    }
+    /**
+     * Logs the metrics and attributes received for an operation completion.
+     * @param {OnOperationCompleteData} data Metrics related to the completed operation.
+     */
+    onOperationComplete(data) {
+      const dataWithProject = Object.assign({projectId: this.projectId}, data);
+      this.requestsHandled.push(dataWithProject);
+      this.messages.value += 'Recording parameters for onOperationComplete:\n';
+      this.messages.value += `${JSON.stringify(dataWithProject)}\n`;
+    }
+
+    /**
+     * Logs the metrics and attributes received for an attempt completion.
+     * @param {OnOperationCompleteData} data Metrics related to the completed attempt.
+     */
+    onAttemptComplete(data) {
+      const dataWithProject = Object.assign({projectId: this.projectId}, data);
+      this.requestsHandled.push(dataWithProject);
+      this.messages.value += 'Recording parameters for onAttemptComplete:\n';
+      this.messages.value += `${JSON.stringify(dataWithProject)}\n`;
+    }
+  }
+
+  const packagePath = path.join(__dirname, '../../../package.json');
+
+  // Read the file using the absolute path
+  const packageJSON = fs.readFileSync(packagePath);
+  const expectedVersion = JSON.parse(packageJSON.toString()).version;
+
+  const fakeBigtable = new Bigtable();
+  const testMetricsHandler = new TestMetricsHandlerKeepName();
+  fakeBigtable._metricsConfigManager = new ClientSideMetricsConfigManager([
+    testMetricsHandler,
+  ]);
+
+  const instance = fakeBigtable.instance('fake-instance-id');
+  const table = instance.table('fake-table-id');
+  try {
+    await table.getRows();
+  } catch (e) {
+    // Suppress the error.
+    // We just made this call so that the test metrics handler would
+    // collect grpc response data.
+  }
+  if (
+    testMetricsHandler.requestsHandled[0].client_name !==
+    `nodejs-bigtable/${expectedVersion}`
+  ) {
+    throw Error('The wrong version is being recorded');
+  }
+}
+main();

test/metrics-collector/version/package.json

@@ -0,0 +1,7 @@
+{
+  "version": "fake-version-number",
+  "private": true,
+  "engines": {
+    "node": ">=18"
+  }
+}

test/metrics-collector/version/version.ts

@@ -0,0 +1,23 @@
+// Copyright 2026 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.
+
+// eslint-disable-next-line n/no-extraneous-import
+import {describe} from 'mocha';
+import {execSync} from 'node:child_process';
+
+describe('Bigtable/CSMVersion', () => {
+  it('Fetches the right client side metrics version', async () => {
+    execSync('cd test/metrics-collector/version && node get-version-script');
+  });
+});