feat: add resource header prefix

src/backup.ts

@@ -21,6 +21,7 @@ import {
   RequestCallback,
   ResourceCallback,
   NormalCallback,
+  CLOUD_RESOURCE_HEADER,
 } from './common';
 import {EnumKey, Spanner, RequestConfig, TranslateEnumKeys} from '.';
 import {
@@ -100,12 +101,16 @@ class Backup {
   id: string;
   formattedName_: string;
   instanceFormattedName_: string;
+  resourceHeader_: {[k: string]: string};
   request: BackupRequest;
   constructor(instance: Instance, name: string) {
     this.request = instance.request;
     this.instanceFormattedName_ = instance.formattedName_;
     this.formattedName_ = Backup.formatName_(instance.formattedName_, name);
     this.id = this.formattedName_.split('/').pop() || '';
+    this.resourceHeader_ = {
+      [CLOUD_RESOURCE_HEADER]: this.instanceFormattedName_,
+    };
   }
 
   create(options: CreateBackupOptions): Promise<CreateBackupResponse>;
@@ -180,6 +185,7 @@ class Backup {
         method: 'createBackup',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, operation, resp) => {
         if (err) {
@@ -246,6 +252,7 @@ class Backup {
         method: 'getBackup',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, response) => {
         callback!(err, response);
@@ -420,6 +427,7 @@ class Backup {
         method: 'updateBackup',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, response) => {
         callback!(err, response);
@@ -467,6 +475,7 @@ class Backup {
         method: 'deleteBackup',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       err => {
         callback!(err);

src/batch-transaction.ts

@@ -20,7 +20,8 @@ import * as extend from 'extend';
 import * as is from 'is';
 import {Snapshot} from './transaction';
 import {google} from '../protos/protos';
-import {Session} from '.';
+import {Session, Database} from '.';
+import {CLOUD_RESOURCE_HEADER} from '../src/common';
 
 export interface TransactionIdentifier {
   session: string | Session;
@@ -155,6 +156,9 @@ class BatchTransaction extends Snapshot {
       transaction: {id: this.id},
     });
     config.reqOpts = extend({}, query);
+    config.headers = {
+      [CLOUD_RESOURCE_HEADER]: (this.session.parent as Database).formattedName_,
+    };
     delete query.partitionOptions;
     this.session.request(config, (err, resp) => {
       if (err) {

src/common.ts

@@ -69,3 +69,9 @@ export interface PagedOptions {
 export interface PagedOptionsWithFilter extends PagedOptions {
   filter?: string;
 }
+
+/*!
+ * HTTP header for the resource prefix to improve routing
+ * by the backend.
+ */
+export const CLOUD_RESOURCE_HEADER = 'google-cloud-resource-prefix';

src/database.ts

@@ -74,6 +74,7 @@ import {
   LongRunningCallback,
   NormalCallback,
   PagedOptionsWithFilter,
+  CLOUD_RESOURCE_HEADER,
   PagedResponse,
   RequestCallback,
   ResourceCallback,
@@ -248,6 +249,7 @@ class Database extends common.GrpcServiceObject {
   formattedName_: string;
   pool_: SessionPoolInterface;
   queryOptions_?: spannerClient.spanner.v1.ExecuteSqlRequest.IQueryOptions;
+  resourceHeader_: {[k: string]: string};
   request: DatabaseRequest;
   constructor(
     instance: Instance,
@@ -320,6 +322,9 @@ class Database extends common.GrpcServiceObject {
         : new SessionPool(this, poolOptions);
     this.formattedName_ = formattedName_;
     this.instance = instance;
+    this.resourceHeader_ = {
+      [CLOUD_RESOURCE_HEADER]: this.formattedName_,
+    };
     this.request = instance.request;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this.requestStream = instance.requestStream as any;
@@ -424,6 +429,7 @@ class Database extends common.GrpcServiceObject {
         method: 'batchCreateSessions',
         reqOpts,
         gaxOpts: options.gaxOptions,
+        headers: this.resourceHeader_,
       },
       (err, resp) => {
         if (err) {
@@ -679,6 +685,7 @@ class Database extends common.GrpcServiceObject {
         method: 'createSession',
         reqOpts,
         gaxOpts: options.gaxOptions,
+        headers: this.resourceHeader_,
       },
       (err, resp) => {
         if (err) {
@@ -868,6 +875,7 @@ class Database extends common.GrpcServiceObject {
           method: 'dropDatabase',
           reqOpts,
           gaxOpts,
+          headers: this.resourceHeader_,
         },
         callback!
       );
@@ -1084,6 +1092,7 @@ class Database extends common.GrpcServiceObject {
         method: 'getDatabase',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       callback!
     );
@@ -1220,6 +1229,7 @@ class Database extends common.GrpcServiceObject {
         method: 'getDatabaseDdl',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       (err, statements, ...args: any[]) => {
@@ -1354,6 +1364,7 @@ class Database extends common.GrpcServiceObject {
         method: 'listSessions',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, sessions, nextPageRequest, ...args) => {
         let sessionInstances: Session[] | null = null;
@@ -1438,6 +1449,7 @@ class Database extends common.GrpcServiceObject {
       method: 'listSessionsStream',
       reqOpts,
       gaxOpts,
+      headers: this.resourceHeader_,
     });
   }
 
@@ -1812,6 +1824,7 @@ class Database extends common.GrpcServiceObject {
         method: 'restoreDatabase',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, operation, resp) => {
         if (err) {
@@ -2627,6 +2640,7 @@ class Database extends common.GrpcServiceObject {
         method: 'updateDatabaseDdl',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       callback!
     );

src/index.ts

@@ -39,6 +39,7 @@ import {
   PagedResponse,
   PagedCallback,
   PagedOptionsWithFilter,
+  CLOUD_RESOURCE_HEADER,
 } from './common';
 import {Session} from './session';
 import {SessionPool} from './session-pool';
@@ -86,6 +87,7 @@ export interface RequestConfig {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   reqOpts: any;
   gaxOpts?: CallOptions;
+  headers: {[k: string]: string};
 }
 export interface CreateInstanceRequest {
   config?: string;
@@ -154,6 +156,8 @@ class Spanner extends GrpcService {
   auth: GoogleAuth;
   clients_: Map<string, {}>;
   instances_: Map<string, Instance>;
+  projectFormattedName_: string;
+  resourceHeader_: {[k: string]: string};
 
   /**
    * Placeholder used to auto populate a column with the commit timestamp.
@@ -254,6 +258,10 @@ class Spanner extends GrpcService {
     this.auth = new GoogleAuth(this.options);
     this.clients_ = new Map();
     this.instances_ = new Map();
+    this.projectFormattedName_ = 'projects/' + this.projectId;
+    this.resourceHeader_ = {
+      [CLOUD_RESOURCE_HEADER]: this.projectFormattedName_,
+    };
   }
 
   createInstance(
@@ -368,7 +376,7 @@ class Spanner extends GrpcService {
     const formattedName = Instance.formatName_(this.projectId, name);
     const displayName = config.displayName || formattedName.split('/').pop();
     const reqOpts = {
-      parent: 'projects/' + this.projectId,
+      parent: this.projectFormattedName_,
       instanceId: formattedName.split('/').pop(),
       instance: extend(
         {
@@ -392,6 +400,7 @@ class Spanner extends GrpcService {
         method: 'createInstance',
         reqOpts,
         gaxOpts: config.gaxOptions,
+        headers: this.resourceHeader_,
       },
       (err, operation, resp) => {
         if (err) {
@@ -523,8 +532,8 @@ class Spanner extends GrpcService {
         },
         reqOpts
       );
-      delete gaxOpts.pageSize;
       delete gaxOpts.pageToken;
+      delete gaxOpts.pageSize;
     }
 
     this.request(
@@ -533,6 +542,7 @@ class Spanner extends GrpcService {
         method: 'listInstances',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, instances, nextPageRequest, ...args) => {
         let instanceInstances: Instance[] | null = null;
@@ -614,6 +624,7 @@ class Spanner extends GrpcService {
       method: 'listInstancesStream',
       reqOpts,
       gaxOpts,
+      headers: this.resourceHeader_,
     });
   }
 
@@ -739,6 +750,7 @@ class Spanner extends GrpcService {
         method: 'listInstanceConfigs',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, instanceConfigs, nextPageRequest, ...args) => {
         const nextQuery = nextPageRequest!
@@ -812,6 +824,7 @@ class Spanner extends GrpcService {
       method: 'listInstanceConfigsStream',
       reqOpts,
       gaxOpts,
+      headers: this.resourceHeader_,
     });
   }
 
@@ -864,7 +877,12 @@ class Spanner extends GrpcService {
       const requestFn = gaxClient[config.method].bind(
         gaxClient,
         reqOpts,
-        config.gaxOpts
+        // Add headers to `gaxOpts`
+        extend(true, {}, config.gaxOpts, {
+          otherArgs: {
+            headers: config.headers,
+          },
+        })
       );
       callback(null, requestFn);
     });

src/instance.ts

@@ -31,6 +31,7 @@ import {
   NormalCallback,
   ResourceCallback,
   PagedOptionsWithFilter,
+  CLOUD_RESOURCE_HEADER,
 } from './common';
 import {Duplex} from 'stream';
 import {SessionPoolOptions, SessionPool} from './session-pool';
@@ -151,6 +152,7 @@ class Instance extends common.GrpcServiceObject {
   requestStream: (config: RequestConfig) => Duplex;
   databases_: Map<string, Database>;
   metadata?: IInstance;
+  resourceHeader_: {[k: string]: string};
   constructor(spanner: Spanner, name: string) {
     const formattedName_ = Instance.formatName_(spanner.projectId, name);
     const methods = {
@@ -221,6 +223,9 @@ class Instance extends common.GrpcServiceObject {
     this.request = spanner.request.bind(spanner);
     this.requestStream = spanner.requestStream.bind(spanner);
     this.databases_ = new Map<string, Database>();
+    this.resourceHeader_ = {
+      [CLOUD_RESOURCE_HEADER]: this.formattedName_,
+    };
   }
 
   /**
@@ -350,6 +355,7 @@ class Instance extends common.GrpcServiceObject {
         method: 'listBackups',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, backups, nextPageRequest, ...args) => {
         let backupInstances: Backup[] | null = null;
@@ -432,6 +438,7 @@ class Instance extends common.GrpcServiceObject {
       method: 'listBackupsStream',
       reqOpts,
       gaxOpts,
+      headers: this.resourceHeader_,
     });
   }
 
@@ -547,6 +554,7 @@ class Instance extends common.GrpcServiceObject {
         method: 'listBackupOperations',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, operations, nextPageRequest, ...args) => {
         const nextQuery = nextPageRequest!
@@ -671,6 +679,7 @@ class Instance extends common.GrpcServiceObject {
         method: 'listDatabaseOperations',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, operations, nextPageRequest, ...args) => {
         const nextQuery = nextPageRequest!
@@ -815,6 +824,7 @@ class Instance extends common.GrpcServiceObject {
         method: 'createDatabase',
         reqOpts,
         gaxOpts: options.gaxOptions,
+        headers: this.resourceHeader_,
       },
       (err, operation, resp) => {
         if (err) {
@@ -948,6 +958,7 @@ class Instance extends common.GrpcServiceObject {
             method: 'deleteInstance',
             reqOpts,
             gaxOpts,
+            headers: this.resourceHeader_,
           },
           (err, resp) => {
             if (!err) {
@@ -1235,6 +1246,7 @@ class Instance extends common.GrpcServiceObject {
         method: 'listDatabases',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       (err, rowDatabases, nextPageRequest, ...args) => {
         let databases: Database[] | null = null;
@@ -1319,6 +1331,7 @@ class Instance extends common.GrpcServiceObject {
       method: 'listDatabasesStream',
       reqOpts,
       gaxOpts,
+      headers: this.resourceHeader_,
     });
   }
 
@@ -1413,6 +1426,7 @@ class Instance extends common.GrpcServiceObject {
         method: 'getInstance',
         reqOpts,
         gaxOpts: options.gaxOptions,
+        headers: this.resourceHeader_,
       },
       callback!
     );
@@ -1500,6 +1514,7 @@ class Instance extends common.GrpcServiceObject {
         method: 'updateInstance',
         reqOpts,
         gaxOpts,
+        headers: this.resourceHeader_,
       },
       callback!
     );