feat: refactor and deprecate databaseRole and Session Labels SessionPoolOptions

Author: surbhigarg92

src/database.ts

@@ -370,6 +370,7 @@ class Database extends common.GrpcServiceObject {
     name: string,
     poolOptions?: SessionPoolConstructor | SessionPoolOptions,
     queryOptions?: spannerClient.spanner.v1.ExecuteSqlRequest.IQueryOptions,
+    databaseRole?: string | null,
   ) {
     const methods = {
       /**
@@ -468,12 +469,15 @@ class Database extends common.GrpcServiceObject {
       },
     } as {} as ServiceObjectConfig);
 
-    if (typeof poolOptions === 'object') {
-      this.databaseRole = poolOptions.databaseRole || null;
-      this.labels = poolOptions.labels || null;
-    }
     this.formattedName_ = formattedName_;
     this.instance = instance;
+
+    const poolOpts = typeof poolOptions === 'object' ? poolOptions : null;
+    this.databaseRole =
+      databaseRole || (poolOpts && poolOpts.databaseRole) || null;
+    this.labels =
+      this._getSpanner().sessionLabels || (poolOpts && poolOpts.labels) || null;
+
     this._observabilityOptions = instance._observabilityOptions;
     this._traceConfig = {
       opts: this._observabilityOptions,
@@ -707,7 +711,7 @@ class Database extends common.GrpcServiceObject {
     }
 
     const count = options.count;
-    const labels = options.labels || {};
+    const labels = options.labels || this.labels || null;
     const databaseRole = options.databaseRole || this.databaseRole || null;
 
     const reqOpts: google.spanner.v1.IBatchCreateSessionsRequest = {

src/index.ts

@@ -167,6 +167,7 @@ export interface SpannerOptions extends GrpcClientOptions {
   observabilityOptions?: ObservabilityOptions;
   disableBuiltInMetrics?: boolean;
   interceptors?: any[];
+  sessionLabels?: {[key: string]: string};
   /**
    * The Trusted Cloud Domain (TPC) DNS of the service used to make requests.
    * Defaults to `googleapis.com`.
@@ -321,6 +322,7 @@ class Spanner extends GrpcService {
   directedReadOptions: google.spanner.v1.IDirectedReadOptions | null;
   defaultTransactionOptions: RunTransactionOptions;
   _observabilityOptions: ObservabilityOptions | undefined;
+  sessionLabels: {[key: string]: string} | null;
   private _universeDomain: string;
   private _isInSecureCredentials: boolean;
   private static _isAFEServerTimingEnabled: boolean | undefined;
@@ -493,6 +495,7 @@ class Spanner extends GrpcService {
     this.directedReadOptions = directedReadOptions;
     this.defaultTransactionOptions = defaultTransactionOptions;
     this._observabilityOptions = options.observabilityOptions;
+    this.sessionLabels = options.sessionLabels || null;
     this.commonHeaders_ = getCommonHeaders(
       this.projectFormattedName_,
       this._observabilityOptions?.enableEndToEndTracing,

src/instance.ts

@@ -962,6 +962,7 @@ class Instance extends common.GrpcServiceObject {
     name: string,
     poolOptions?: SessionPoolOptions | SessionPoolConstructor,
     queryOptions?: spannerClient.spanner.v1.ExecuteSqlRequest.IQueryOptions,
+    databaseRole?: string | null,
   ): Database {
     if (!name) {
       throw new GoogleError('A name is required to access a Database object.');
@@ -978,7 +979,13 @@ class Instance extends common.GrpcServiceObject {
     }
     const key = name.split('/').pop() + optionsKey;
     if (!this.databases_.has(key!)) {
-      const db = new Database(this, name, poolOptions, queryOptions);
+      const db = new Database(
+        this,
+        name,
+        poolOptions,
+        queryOptions,
+        databaseRole,
+      );
       db._observabilityOptions = this._observabilityOptions;
       const parent = this.parent as Spanner;
       if (parent && parent._nthClientId) {

src/session-pool.ts

@@ -152,6 +152,9 @@ export interface SessionPoolOptions {
   fail?: boolean;
   idlesAfter?: number;
   keepAlive?: number;
+  /**
+   * @deprecated Use SpannerOptions.sessionLabels instead.
+   */
   labels?: {[label: string]: string};
   max?: number;
   maxIdle?: number;
@@ -162,6 +165,9 @@ export interface SessionPoolOptions {
    */
   writes?: number;
   incStep?: number;
+  /**
+   * @deprecated Use Database constructor to pass databaseRole.
+   */
   databaseRole?: string | null;
 }
 
@@ -171,12 +177,10 @@ const DEFAULTS: SessionPoolOptions = {
   fail: false,
   idlesAfter: 10,
   keepAlive: 30,
-  labels: {},
   max: 100,
   maxIdle: 1,
   min: 25,
   incStep: 25,
-  databaseRole: null,
 };
 
 /**
@@ -667,8 +671,8 @@ export class SessionPool extends EventEmitter implements SessionPoolInterface {
    * @emits SessionPool#createError
    */
   async _createSessions(amount: number): Promise<void> {
-    const labels = this.options.labels!;
-    const databaseRole = this.options.databaseRole!;
+    const labels = this.options.labels;
+    const databaseRole = this.options.databaseRole;
 
     if (amount <= 0) {
       return;

test/database.ts

@@ -259,6 +259,7 @@ describe('Database', () => {
 
   const SPANNER = {
     routeToLeaderEnabled: true,
+    options: {},
   } as {} as Spanner;
 
   const INSTANCE = {
@@ -405,6 +406,36 @@ describe('Database', () => {
         [AFE_SERVER_TIMING_HEADER]: 'true',
       });
     });
+
+    it('should accept databaseRole in constructor', () => {
+      const databaseRole = 'child_role';
+      const database = new Database(
+        INSTANCE,
+        NAME,
+        POOL_OPTIONS,
+        undefined,
+        databaseRole,
+      );
+      assert.strictEqual(database.databaseRole, databaseRole);
+    });
+
+    it('should use sessionLabels from Spanner options', () => {
+      const sessionLabels = {env: 'test'};
+      const spanner = new Spanner({
+        sessionLabels,
+      });
+      const instanceCtx = {
+        parent: spanner,
+        _observabilityOptions: {},
+        request: util.noop,
+        requestStream: util.noop,
+        formattedName_: 'instance-name',
+        databases_: new Map(),
+      } as {} as Instance;
+
+      const database = new Database(instanceCtx, NAME);
+      assert.deepStrictEqual(database.labels, sessionLabels);
+    });
   });
 
   describe('formatName_', () => {
@@ -468,7 +499,7 @@ describe('Database', () => {
 
       const {reqOpts} = stub.lastCall.args[0];
 
-      assert.strictEqual(reqOpts.sessionTemplate.labels, labels);
+      assert.deepStrictEqual(reqOpts.sessionTemplate.labels, labels);
     });
 
     it('should accept session databaseRole', () => {
@@ -3069,6 +3100,7 @@ describe('Database', () => {
       database.parent.parent = {
         routeToLeaderEnabled: true,
         directedReadOptions: fakeDirectedReadOptions,
+        options: {},
       };
 
       database.runPartitionedUpdate(

test/session-pool.ts

@@ -219,7 +219,7 @@ describe('SessionPool', () => {
         assert.strictEqual(sessionPool.options.fail, false);
         assert.strictEqual(sessionPool.options.idlesAfter, 10);
         assert.strictEqual(sessionPool.options.keepAlive, 30);
-        assert.deepStrictEqual(sessionPool.options.labels, {});
+        assert.strictEqual(sessionPool.options.labels, undefined);
         assert.strictEqual(sessionPool.options.min, 25);
         assert.strictEqual(sessionPool.options.max, 100);
         assert.strictEqual(sessionPool.options.maxIdle, 1);