fix: rollback to v3 release line (#847)

Release-As: v3.2.3

Author: crwilcox

handwritten/bigtable/src/index.ts

@@ -47,11 +47,13 @@ export interface GetInstancesCallback {
   (
     err: ServiceError | null,
     result?: Instance[],
+    failedLocations?: string[],
     response?: google.bigtable.admin.v2.IListInstancesResponse
   ): void;
 }
 export type GetInstancesResponse = [
   Instance[],
+  string[],
   google.bigtable.admin.v2.IListInstancesResponse
 ];
 
@@ -607,7 +609,8 @@ export class Bigtable {
   /**
    * @typedef {array} GetInstancesResponse
    * @property {Instance[]} 0 Array of {@link Instance} instances.
-   * @property {object} 1 The full API response.
+   * @property {string[]} 1 locations from which Instance information could not be retrieved
+   * @property {object} 2 The full API response.
    *     Note: 'failedLocations' property may contain locations from which
    *     Instance information could not be retrieved.
    *     Values are of the form `projects/<project>/locations/<zone_id>`
@@ -616,6 +619,7 @@ export class Bigtable {
    * @callback GetInstancesCallback
    * @param {?Error} err Request error, if any.
    * @param {Instance[]} instances Array of {@link Instance} instances.
+   * @param {string[]} locations from which Instance information could not be retrieved
    * @param {object} apiResponse The full API response.
    *     Note: 'failedLocations' property may contain locations from which
    *     Instance information could not be retrieved.
@@ -646,7 +650,7 @@ export class Bigtable {
    * </caption>
    * bigtable.getInstances().then(function(data) {
    *   const instances = data[0];
-   *   const fullResponse = data[1];
+   *   const fullResponse = data[2];
    *
    *   if (fullResponse.failedLocations.length > 0) {
    *     // These locations contain instances which could not be retrieved.
@@ -686,7 +690,7 @@ export class Bigtable {
           instance.metadata = instanceData;
           return instance;
         });
-        callback!(null, instances, resp);
+        callback!(null, instances, resp.failedLocations, resp);
       }
     );
   }

handwritten/bigtable/system-test/bigtable.ts

@@ -103,8 +103,9 @@ describe('Bigtable', () => {
 
   describe('instances', () => {
     it('should get a list of instances', async () => {
-      const [instances] = await bigtable.getInstances();
+      const [instances, failedLocations] = await bigtable.getInstances();
       assert(instances.length > 0);
+      assert(Array.isArray(failedLocations));
     });
 
     it('should check if an instance exists', async () => {

handwritten/bigtable/test/index.ts

@@ -571,7 +571,7 @@ describe('Bigtable', () => {
       });
     });
 
-    it('should return an array of instance objects', done => {
+    it('should return an array of instance objects and failed locations', done => {
       const response = {
         instances: [
           {
@@ -581,6 +581,7 @@ describe('Bigtable', () => {
             name: 'b',
           },
         ],
+        failedLocations: ['projects/<project>/locations/<zone_id>'],
       };
       const fakeInstances = [{}, {}];
       bigtable.request = (config: {}, callback: Function) => {
@@ -593,12 +594,18 @@ describe('Bigtable', () => {
       };
 
       bigtable.getInstances(
-        (err: Error, instances: Instance[], apiResponse: {}) => {
+        (
+          err: Error,
+          instances: Instance[],
+          failedLocations: string[],
+          apiResponse: {}
+        ) => {
           assert.ifError(err);
           assert.strictEqual(instances[0], fakeInstances[0]);
           assert.strictEqual(instances[0].metadata, response.instances[0]);
           assert.strictEqual(instances[1], fakeInstances[1]);
           assert.strictEqual(instances[1].metadata, response.instances[1]);
+          assert.strictEqual(failedLocations, response.failedLocations);
           assert.strictEqual(apiResponse, response);
           done();
         }