feat: add resource header prefix

src/backup.ts

@@ -21,6 +21,7 @@ import {
   RequestCallback,
   ResourceCallback,
   NormalCallback,
+  addResourcePrefixHeader,
 } from './common';
 import {EnumKey, Spanner, RequestConfig, TranslateEnumKeys} from '.';
 import {
@@ -164,7 +165,10 @@ class Backup {
     options: CreateBackupOptions,
     callback?: CreateBackupCallback
   ): Promise<CreateBackupResponse> | void {
-    const gaxOpts = options.gaxOptions;
+    const gaxOpts = addResourcePrefixHeader(
+      options.gaxOptions!,
+      this.instanceFormattedName_
+    );
     const reqOpts: databaseAdmin.spanner.admin.database.v1.ICreateBackupRequest = {
       parent: this.instanceFormattedName_,
       backupId: this.id,
@@ -233,10 +237,12 @@ class Backup {
       typeof gaxOptionsOrCallback === 'function'
         ? (gaxOptionsOrCallback as GetMetadataCallback)
         : cb;
-    const gaxOpts =
+    const gaxOpts = addResourcePrefixHeader(
       typeof gaxOptionsOrCallback === 'object'
         ? (gaxOptionsOrCallback as CallOptions)
-        : {};
+        : {},
+      this.instanceFormattedName_
+    );
     const reqOpts: databaseAdmin.spanner.admin.database.v1.IGetBackupRequest = {
       name: this.formattedName_,
     };
@@ -401,10 +407,12 @@ class Backup {
       typeof gaxOptionsOrCallback === 'function'
         ? (gaxOptionsOrCallback as UpdateExpireTimeCallback)
         : cb;
-    const gaxOpts =
+    const gaxOpts = addResourcePrefixHeader(
       typeof gaxOptionsOrCallback === 'object'
         ? (gaxOptionsOrCallback as CallOptions)
-        : {};
+        : {},
+      this.instanceFormattedName_
+    );
     const reqOpts: databaseAdmin.spanner.admin.database.v1.IUpdateBackupRequest = {
       backup: {
         name: this.formattedName_,
@@ -454,10 +462,12 @@ class Backup {
       typeof gaxOptionsOrCallback === 'function'
         ? (gaxOptionsOrCallback as DeleteCallback)
         : cb;
-    const gaxOpts =
+    const gaxOpts = addResourcePrefixHeader(
       typeof gaxOptionsOrCallback === 'object'
         ? (gaxOptionsOrCallback as CallOptions)
-        : {};
+        : {},
+      this.instanceFormattedName_
+    );
     const reqOpts: databaseAdmin.spanner.admin.database.v1.IDeleteBackupRequest = {
       name: this.formattedName_,
     };

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 {addResourcePrefixHeader} from '../src/common';
 
 export interface TransactionIdentifier {
   session: string | Session;
@@ -152,6 +153,10 @@ class BatchTransaction extends Snapshot {
       transaction: {id: this.id},
     });
     config.reqOpts = extend({}, query);
+    config.gaxOpts = addResourcePrefixHeader(
+      config.gaxOpts,
+      (this.session.parent as Database).formattedName_
+    );
     delete query.partitionOptions;
     this.session.request(config, (err, resp) => {
       if (err) {

src/common.ts

@@ -17,6 +17,7 @@
 import {grpc, CallOptions, Operation as GaxOperation} from 'google-gax';
 import {google as instanceAdmin} from '../protos/protos';
 import {google as databaseAdmin} from '../protos/protos';
+import * as extend from 'extend';
 
 export type IOperation = instanceAdmin.longrunning.IOperation;
 
@@ -69,3 +70,24 @@ 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';
+
+/**
+ * Returns GAX call options that set the cloud resource header.
+ * @private
+ */
+export function addResourcePrefixHeader(
+  gaxOpts: CallOptions,
+  headerValue: string
+): CallOptions {
+  return extend(true, {}, gaxOpts, {
+    otherArgs: {
+      headers: {[CLOUD_RESOURCE_HEADER]: headerValue},
+    },
+  });
+}

src/database.ts

@@ -76,6 +76,7 @@ import {
   NormalCallback,
   LongRunningCallback,
   PagedOptionsWithFilter,
+  addResourcePrefixHeader,
 } from './common';
 import {Readable, Transform, Duplex} from 'stream';
 import {PreciseDate} from '@google-cloud/precise-date';
@@ -418,7 +419,10 @@ class Database extends GrpcServiceObject {
         client: 'SpannerClient',
         method: 'batchCreateSessions',
         reqOpts,
-        gaxOpts: options.gaxOptions,
+        gaxOpts: addResourcePrefixHeader(
+          options.gaxOptions!,
+          this.formattedName_
+        ),
       },
       (err, resp) => {
         if (err) {
@@ -672,7 +676,10 @@ class Database extends GrpcServiceObject {
         client: 'SpannerClient',
         method: 'createSession',
         reqOpts,
-        gaxOpts: options.gaxOptions,
+        gaxOpts: addResourcePrefixHeader(
+          options.gaxOptions!,
+          this.formattedName_
+        ),
       },
       (err, resp) => {
         if (err) {
@@ -849,6 +856,7 @@ class Database extends GrpcServiceObject {
           client: 'DatabaseAdminClient',
           method: 'dropDatabase',
           reqOpts,
+          gaxOpts: addResourcePrefixHeader({}, this.formattedName_),
         },
         callback!
       );
@@ -1051,10 +1059,12 @@ class Database extends GrpcServiceObject {
       typeof gaxOptionsOrCallback === 'function'
         ? (gaxOptionsOrCallback as GetMetadataCallback)
         : cb;
-    const gaxOpts =
+    const gaxOpts = addResourcePrefixHeader(
       typeof gaxOptionsOrCallback === 'object'
         ? (gaxOptionsOrCallback as CallOptions)
-        : {};
+        : {},
+      this.formattedName_
+    );
 
     const reqOpts: databaseAdmin.spanner.admin.database.v1.IGetDatabaseRequest = {
       name: this.formattedName_,
@@ -1185,8 +1195,10 @@ class Database extends GrpcServiceObject {
     optionsOrCallback?: CallOptions | GetSchemaCallback,
     cb?: GetSchemaCallback
   ): void | Promise<GetSchemaResponse> {
-    const gaxOpts =
-      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
+    const gaxOpts = addResourcePrefixHeader(
+      typeof optionsOrCallback === 'object' ? optionsOrCallback : {},
+      this.formattedName_
+    );
     const callback =
       typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
 
@@ -1305,26 +1317,26 @@ class Database extends GrpcServiceObject {
       typeof optionsOrCallback === 'object'
         ? optionsOrCallback
         : ({} as GetSessionsOptions);
-    const gaxOpts = extend(true, {}, options.gaxOptions);
-    let reqOpts = extend({}, options, {
-      database: this.formattedName_,
-    });
-    delete reqOpts.gaxOptions;
+    const gaxOpts = addResourcePrefixHeader(
+      options.gaxOptions!,
+      this.formattedName_
+    );
 
     // Copy over pageSize and pageToken values from gaxOptions.
     // However values set on options take precedence.
-    if (gaxOpts) {
-      reqOpts = extend(
-        {},
-        {
-          pageSize: gaxOpts.pageSize,
-          pageToken: gaxOpts.pageToken,
-        },
-        reqOpts
-      );
-      delete gaxOpts.pageSize;
-      delete gaxOpts.pageToken;
-    }
+    const reqOpts = extend(
+      {},
+      {
+        database: this.formattedName_,
+        pageSize: gaxOpts.pageSize,
+        pageToken: gaxOpts.pageToken,
+      },
+      options
+    );
+
+    delete reqOpts.gaxOptions;
+    delete gaxOpts.pageSize;
+    delete gaxOpts.pageToken;
 
     this.request<
       google.spanner.v1.ISession,
@@ -1389,27 +1401,26 @@ class Database extends GrpcServiceObject {
    *   });
    */
   getSessionsStream(options: GetSessionsOptions = {}): NodeJS.ReadableStream {
-    const gaxOpts = extend(true, {}, options.gaxOptions);
-
-    let reqOpts = extend({}, options, {
-      database: this.formattedName_,
-    });
-    delete reqOpts.gaxOptions;
+    const gaxOpts = addResourcePrefixHeader(
+      options.gaxOptions!,
+      this.formattedName_
+    );
 
     // Copy over pageSize and pageToken values from gaxOptions.
     // However values set on options take precedence.
-    if (gaxOpts) {
-      reqOpts = extend(
-        {},
-        {
-          pageSize: gaxOpts.pageSize,
-          pageToken: gaxOpts.pageToken,
-        },
-        reqOpts
-      );
-      delete gaxOpts.pageSize;
-      delete gaxOpts.pageToken;
-    }
+    const reqOpts = extend(
+      {},
+      {
+        database: this.formattedName_,
+        pageSize: gaxOpts.pageSize,
+        pageToken: gaxOpts.pageToken,
+      },
+      options
+    );
+
+    delete reqOpts.gaxOptions;
+    delete gaxOpts.pageSize;
+    delete gaxOpts.pageToken;
 
     return this.requestStream({
       client: 'SpannerClient',
@@ -1775,10 +1786,12 @@ class Database extends GrpcServiceObject {
       typeof optionsOrCallback === 'function'
         ? (optionsOrCallback as RestoreDatabaseCallback)
         : cb;
-    const gaxOpts =
+    const gaxOpts = addResourcePrefixHeader(
       typeof optionsOrCallback === 'object'
         ? (optionsOrCallback as CallOptions)
-        : {};
+        : {},
+      this.instance.formattedName_
+    );
     const reqOpts: databaseAdmin.spanner.admin.database.v1.IRestoreDatabaseRequest = {
       parent: this.instance.formattedName_,
       databaseId: this.id,
@@ -2562,8 +2575,10 @@ class Database extends GrpcServiceObject {
     optionsOrCallback?: CallOptions | UpdateSchemaCallback,
     cb?: UpdateSchemaCallback
   ): Promise<UpdateSchemaResponse> | void {
-    const gaxOpts =
-      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
+    const gaxOpts = addResourcePrefixHeader(
+      typeof optionsOrCallback === 'object' ? optionsOrCallback : {},
+      this.formattedName_
+    );
     const callback =
       typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;