feat: support apiEndpoint override (#713)

Author: JustinBeckwith

package.json

@@ -48,7 +48,7 @@
     "predocs-test": "npm run docs"
   },
   "dependencies": {
-    "@google-cloud/common": "^1.0.0",
+    "@google-cloud/common": "^2.0.0",
     "@sindresorhus/is": "^0.17.1",
     "acorn": "^6.0.0",
     "coffeescript": "^2.0.0",

src/agent/controller.ts

@@ -29,9 +29,6 @@ import {Debug} from '../client/stackdriver/debug';
 import {Debuggee} from '../debuggee';
 import * as stackdriver from '../types/stackdriver';
 
-/** @const {string} Cloud Debug API endpoint */
-const API = 'https://clouddebugger.googleapis.com/v2/controller';
-
 export class Controller extends ServiceObject {
   private nextWaitToken: string | null;
 
@@ -47,10 +44,10 @@ export class Controller extends ServiceObject {
     /** @private {string} */
     this.nextWaitToken = null;
 
-    this.apiUrl = API;
+    this.apiUrl = `https://${debug.apiEndpoint}/v2/controller`;
 
     if (config && config.apiUrl) {
-      this.apiUrl = config.apiUrl + new URL(API).pathname;
+      this.apiUrl = config.apiUrl + new URL(this.apiUrl).pathname;
     }
   }
 

src/client/stackdriver/debug.ts

@@ -21,8 +21,16 @@ export interface PackageInfo {
   version: string;
 }
 
+export interface DebugOptions extends GoogleAuthOptions {
+  /**
+   * The API endpoint of the service used to make requests.
+   * Defaults to `clouddebugger.googleapis.com`.
+   */
+  apiEndpoint?: string;
+}
+
 export class Debug extends Service {
-  options!: GoogleAuthOptions;
+  options!: DebugOptions;
   packageInfo!: PackageInfo;
 
   /**
@@ -49,7 +57,7 @@ export class Debug extends Service {
    * @param options - [Authentication options](#/docs)
    */
   constructor(
-    options: GoogleAuthOptions,
+    options: DebugOptions = {},
     packageJson: {
       name: string;
       version: string;
@@ -58,10 +66,11 @@ export class Debug extends Service {
     if (new.target !== Debug) {
       return new Debug(options, packageJson);
     }
-
+    options.apiEndpoint = options.apiEndpoint || 'clouddebugger.googleapis.com';
     const config = {
       projectIdRequired: false,
-      baseUrl: 'https://clouddebugger.googleapis.com/v2',
+      apiEndpoint: options.apiEndpoint,
+      baseUrl: `https://${options.apiEndpoint}/v2`,
       scopes: ['https://www.googleapis.com/auth/cloud_debugger'],
       packageJson,
     };

test/test-controller.ts

@@ -30,6 +30,7 @@ delete process.env.GCLOUD_PROJECT;
 import {Controller} from '../src/agent/controller';
 // TODO: Fix fakeDebug to actually implement Debug.
 const fakeDebug = ({
+  apiEndpoint: `clouddebugger.googleapis.com`,
   request: (options: r.Options, cb: r.RequestCallback) => {
     teenyRequest(options, (err, r) => {
       cb(err, r ? r.body : undefined, r);