test(spanner): adopt runtime-agnostic test runner and Bun compatibility

bin/proxyquire-bun-shim.cjs

@@ -222,7 +222,7 @@ if (
       } catch {
         real = undefined;
       }
-      if (real && typeof real === 'object') {
+      if (real && (typeof real === 'object' || typeof real === 'function')) {
         for (const k of Object.keys(real)) {
           if (!(k in stub)) stub[k] = real[k];
         }

handwritten/spanner/observability-test/batch-transaction.ts

@@ -19,7 +19,7 @@
 import {util} from '@google-cloud/common';
 import * as pfy from '@google-cloud/promisify';
 import * as assert from 'assert';
-import {before, beforeEach, afterEach, describe, it} from 'mocha';
+import {before, after, beforeEach, afterEach, describe, it} from 'mocha';
 import * as extend from 'extend';
 import * as proxyquire from 'proxyquire';
 import * as sinon from 'sinon';
@@ -32,6 +32,11 @@ const {
 const {SimpleSpanProcessor} = require('@opentelemetry/sdk-trace-base');
 import {Session, Spanner} from '../src';
 import * as bt from '../src/batch-transaction';
+const {
+  AsyncLocalStorageContextManager,
+  AsyncHooksContextManager,
+} = require('@opentelemetry/context-async-hooks');
+const {setGlobalContextManager, disableContextAndManager} = require('./helper');
 
 const fakePfy = extend({}, pfy, {
   promisifyAll(klass, options) {
@@ -118,6 +123,17 @@ describe('BatchTransaction', () => {
     exporter: traceExporter,
     spanProcessors: [new SimpleSpanProcessor(traceExporter)],
   });
+  provider.register();
+
+  const contextManager = new (
+    AsyncLocalStorageContextManager || AsyncHooksContextManager
+  )();
+  setGlobalContextManager(contextManager);
+
+  after(async () => {
+    await provider.shutdown();
+    disableContextAndManager(contextManager);
+  });
 
   afterEach(() => {
     traceExporter.reset();
@@ -160,9 +176,11 @@ describe('BatchTransaction', () => {
       assert.strictEqual(spans.length, 2, 'Exactly 2 spans expected');
 
       // Sort the spans by duration.
-      spans.sort((spanA, spanB) => {
-        spanA.duration < spanB.duration;
-      });
+      spans.sort(
+        (spanA, spanB) =>
+          spanA.duration[0] - spanB.duration[0] ||
+          spanA.duration[1] - spanB.duration[1],
+      );
 
       const actualSpanNames: string[] = [];
       spans.forEach(span => {
@@ -224,9 +242,11 @@ describe('BatchTransaction', () => {
       assert.strictEqual(spans.length, 2, 'Exactly 2 spans expected');
 
       // Sort the spans by duration.
-      spans.sort((spanA, spanB) => {
-        spanA.duration < spanB.duration;
-      });
+      spans.sort(
+        (spanA, spanB) =>
+          spanA.duration[0] - spanB.duration[0] ||
+          spanA.duration[1] - spanB.duration[1],
+      );
 
       const actualSpanNames: string[] = [];
       spans.forEach(span => {

handwritten/spanner/observability-test/database.ts

@@ -96,7 +96,7 @@
 
 class FakeSession {
   calledWith_: IArguments;
   formattedName_: any;
   constructor() {
     this.calledWith_ = arguments;
   }
@@ -149,7 +149,7 @@
   setQueuedMutations(mutation) {
     this._queuedMutations = mutation;
   }
   setReadWriteTransactionOptions(options: RunTransactionOptions) {}
   commit(
     options?: CommitOptions,
     callback?: CommitCallback,
@@ -1229,7 +1229,10 @@
         assert.ok(
           errorMessage.includes(
             "Cannot read properties of null (reading 'proto')",
-          ) || errorMessage.includes("Cannot read property 'proto' of null"),
+          ) ||
+            errorMessage.includes("Cannot read property 'proto' of null") ||
+            (errorMessage.includes('null is not an object') &&
+              errorMessage.includes('proto')),
         );
 
         // We expect an exception to have been caught as well as a Session event.

handwritten/spanner/observability-test/helper.ts

@@ -43,6 +43,9 @@ export const cacheSessionEvents = ['Cache hit: has usable multiplexed session'];
  * and referring to context causes type/value collision errors.
  */
 export function setGlobalContextManager(manager: ContextManager) {
+  if (typeof manager.enable === 'function') {
+    manager.enable();
+  }
   context.setGlobalContextManager(manager);
 }
 

handwritten/spanner/observability-test/spanner.ts

@@ -47,6 +47,7 @@
   cacheSessionEvents,
 } = require('./helper');
 const {
+  AsyncLocalStorageContextManager,
   AsyncHooksContextManager,
 } = require('@opentelemetry/context-async-hooks');
 
@@ -146,12 +147,10 @@
 
 describe('EndToEnd', async () => {
   const sandbox = sinon.createSandbox();
-  const contextManager = new AsyncHooksContextManager();
+  const contextManager = new (
+    AsyncLocalStorageContextManager || AsyncHooksContextManager
+  )();
   setGlobalContextManager(contextManager);
-  afterEach(async () => {
-    disableContextAndManager(contextManager);
-  });
-
   const traceExporter = new InMemorySpanExporter();
   const sampler = new AlwaysOnSampler();
   const tracerProvider = new NodeTracerProvider({
@@ -177,6 +176,7 @@
     await spanner.close();
     await server.tryShutdown(() => {});
     sandbox.restore();
+    disableContextAndManager(contextManager);
   });
 
   afterEach(async () => {
@@ -1743,10 +1743,10 @@
         database.run(selectSql, (err, rows) => {
           assert.ifError(err);
           assert.strictEqual(rows!.length, 3);
           database
             .close()
             .then(() => done())
             .catch(err => done(err));
         });
       });
 
@@ -1763,10 +1763,10 @@
         database.run(selectSql, err => {
           assert.ok(err, 'Missing expected error');
           assert.strictEqual(err!.message, '2 UNKNOWN: Non-retryable error');
           database
             .close()
             .then(() => done())
             .catch(err => done(err));
         });
       });
 
@@ -2033,9 +2033,25 @@
   let spannerMock: mock.MockSpanner;
   let observabilityOptions: typeof ObservabilityOptions;
 
+  let provider: InstanceType<typeof NodeTracerProvider>;
+
+  before(() => {
+    const traceExporter = new InMemorySpanExporter();
+    provider = new NodeTracerProvider({
+      sampler: new AlwaysOnSampler(),
+      exporter: traceExporter,
+      spanProcessors: [new SimpleSpanProcessor(traceExporter)],
+    });
+  });
+
+  after(async () => {
+    await provider.shutdown();
+  });
+
   beforeEach(async () => {
     sandbox = sinon.createSandbox();
     observabilityOptions = {
+      tracerProvider: provider,
       enableEndToEndTracing: true,
     };
 

handwritten/spanner/observability-test/table.ts

@@ -117,9 +117,11 @@ describe('Table', () => {
     );
 
     // Sort the spans by duration.
-    spans.sort((spanA, spanB) => {
-      spanA.duration < spanB.duration;
-    });
+    spans.sort(
+      (spanA, spanB) =>
+        spanA.duration[0] - spanB.duration[0] ||
+        spanA.duration[1] - spanB.duration[1],
+    );
 
     return spans;
   }

handwritten/spanner/observability-test/transaction.ts

@@ -130,9 +130,11 @@ describe('Transaction', () => {
     const spans = traceExporter.getFinishedSpans();
 
     // Sort the spans by startTime.
-    spans.sort((spanA, spanB) => {
-      spanA.startTime < spanB.startTime;
-    });
+    spans.sort(
+      (spanA, spanB) =>
+        spanA.startTime[0] - spanB.startTime[0] ||
+        spanA.startTime[1] - spanB.startTime[1],
+    );
 
     const spanNames: string[] = [];
     const eventNames: string[] = [];

handwritten/spanner/package.json

@@ -34,10 +34,10 @@
     "docs": "jsdoc -c .jsdoc.js",
     "predocs": "pnpm run compile",
     "lint": "gts check",
-    "system-test": "mocha build/system-test --timeout 1600000",
-    "observability-test": "mocha build/observability-test --timeout 1600000",
-    "cleanup": "mocha scripts/cleanup.js --timeout 30000",
-    "test": "mocha build/test build/test/common build/observability-test",
+    "system-test": "node ../../bin/run-test.cjs build/system-test --timeout 1600000",
+    "observability-test": "node ../../bin/run-test.cjs build/observability-test --timeout 1600000",
+    "cleanup": "node ../../bin/run-test.cjs scripts/cleanup.js --timeout 30000",
+    "test": "node ../../bin/run-test.cjs build/test build/test/common build/observability-test",
     "ycsb": "node ./benchmark/ycsb.js  run -P ./benchmark/workloada -p table=usertable -p cloudspanner.instance=ycsb-instance -p operationcount=100 -p cloudspanner.database=ycsb",
     "fix": "gts fix",
     "clean": "gts clean",
@@ -48,7 +48,7 @@
     "preobservability-test": "pnpm run compile",
     "benchwrapper": "node bin/benchwrapper.js",
     "precompile": "gts clean",
-    "coverage": "c8 mocha build/test build/test/common && c8 report --check-coverage"
+    "coverage": "node ../../bin/run-test.cjs build/test build/test/common && c8 report --check-coverage"
   },
   "dependencies": {
     "@babel/core": "7.27.7",

handwritten/spanner/test/codec.ts

@@ -990,7 +990,7 @@ describe('codec', () => {
           value: music.Genre.JAZZ,
           fullName: 'examples.spanner.music.Genre',
         }).toJSON(),
-        1,
+        '1',
       );
     });
   });

handwritten/spanner/test/database.ts

@@ -975,7 +975,10 @@ describe('Database', () => {
         assert.ok(
           errorMessage.includes(
             "Cannot read properties of null (reading 'proto')",
-          ) || errorMessage.includes("Cannot read property 'proto' of null"),
+          ) ||
+            errorMessage.includes("Cannot read property 'proto' of null") ||
+            (errorMessage.includes('null is not an object') &&
+              errorMessage.includes('proto')),
         );
 
         done();

handwritten/spanner/test/helper.ts

@@ -125,7 +125,7 @@ describe('helper', () => {
 
       assert.throws(() => {
         replaceProjectIdToken(frozenObj, projectId);
-      }, /Cannot assign to read only property/);
+      }, /Cannot assign to read only property|Attempted to assign to readonly property/);
     });
 
     it('should replace more than one {{projectId}}', () => {

handwritten/spanner/test/partial-result-stream.ts

@@ -196,7 +196,10 @@ describe('PartialResultStream', () => {
         // Node 18's assert.deepStrictEqual strictly requires prototype equality,
         // which fails when comparing RowImpl (an Array subclass) with a plain Array literal.
         // Node 20+ relaxed this for Array subclasses with constructor = Array.
-        if (parseInt(process.versions.node.split('.')[0], 10) < 20) {
+        if (
+          parseInt(process.versions.node.split('.')[0], 10) < 20 ||
+          process.versions.bun
+        ) {
           assert.deepStrictEqual([...row], EXPECTED_ROW);
         } else {
           assert.deepStrictEqual(row, EXPECTED_ROW);
@@ -260,7 +263,10 @@ describe('PartialResultStream', () => {
         // Node 18's assert.deepStrictEqual strictly requires prototype equality,
         // which fails when comparing RowImpl (an Array subclass) with a plain Array literal.
         // Node 20+ relaxed this for Array subclasses with constructor = Array.
-        if (parseInt(process.versions.node.split('.')[0], 10) < 20) {
+        if (
+          parseInt(process.versions.node.split('.')[0], 10) < 20 ||
+          process.versions.bun
+        ) {
           assert.deepStrictEqual([...row], EXPECTED_ROW);
         } else {
           assert.deepStrictEqual(row, EXPECTED_ROW);