feat: getAppProfilesStream emits (if there are any failed locations present) decorated error with failedLocations info (#795)

Author: AVaksman

handwritten/bigtable/src/index.ts

@@ -824,6 +824,9 @@ export class Bigtable {
           .on('error', (err: Error) => {
             stream.destroy(err);
           })
+          .on('response', response => {
+            stream.emit('response', response);
+          })
           .pipe(stream);
       });
     }

handwritten/bigtable/src/instance.ts

@@ -758,14 +758,38 @@ Please use the format 'my-instance' or '${bigtable.projectName}/instances/my-ins
       appProfile.metadata = chunk;
       callback(null, appProfile);
     };
+    let failedLocations: string[] = [];
+    const flush = (callback: Function) => {
+      if (failedLocations.length > 0) {
+        callback(
+          new Error(
+            `Resources from the following locations are currently not available\n${JSON.stringify(
+              failedLocations
+            )}`
+          )
+        );
+      } else {
+        callback();
+      }
+    };
+    const stream = this.bigtable.request({
+      client: 'BigtableInstanceAdminClient',
+      method: 'listAppProfilesStream',
+      reqOpts,
+      gaxOpts,
+    });
+    stream.on('response', apiResp => {
+      if (arrify(apiResp.failedLocations).length > 0) {
+        failedLocations = failedLocations.concat(apiResp.failedLocations);
+      }
+    });
     return pumpify.obj([
-      this.bigtable.request({
-        client: 'BigtableInstanceAdminClient',
-        method: 'listAppProfilesStream',
-        reqOpts,
-        gaxOpts,
+      stream,
+      new Transform({
+        objectMode: true,
+        transform: transformToAppProfile,
+        flush,
       }),
-      new Transform({objectMode: true, transform: transformToAppProfile}),
     ]);
   }
 

handwritten/bigtable/test/index.ts

@@ -635,12 +635,7 @@ describe('Bigtable', () => {
       gaxOpts: {},
     };
 
-    const gapicStreamingMethods = [
-      'listTablesStream',
-      'listInstancesStream',
-      'listAppProfilesStream',
-      'listClustersStream',
-    ];
+    const gapicStreamingMethods = ['listTablesStream', 'listAppProfilesStream'];
 
     beforeEach(() => {
       bigtable.getProjectId_ = (callback: Function) => {
@@ -955,6 +950,17 @@ describe('Bigtable', () => {
               done();
             });
           });
+
+          it('should emit resmonse from GAX stream', done => {
+            const response = {};
+            const requestStream = bigtable.request(config);
+            requestStream.emit('reading');
+            requestStream.on('response', (resp: {}) => {
+              assert.strictEqual(resp, response);
+              done();
+            });
+            GAX_STREAM.emit('response', response);
+          });
         });
       });
     });

handwritten/bigtable/test/instance.ts

@@ -769,7 +769,7 @@ describe('Bigtable/Instance', () => {
     });
   });
 
-  describe('getApprofilesStream', () => {
+  describe('getAppProfilesStream', () => {
     let returnStream: PassThrough;
     beforeEach(() => {
       returnStream = new PassThrough({
@@ -867,6 +867,87 @@ describe('Bigtable/Instance', () => {
       });
     });
 
+    it('should return a decorated error with failedLocations list', done => {
+      let counter = 0;
+      let failedLocations: string[] = [];
+      const pages = [
+        {
+          appProfiles: [
+            {
+              name: '/projects/p/instances/i/appProfiles/profile-a',
+            },
+            {
+              name: '/projects/p/instances/i/appProfiles/profile-b',
+            },
+          ],
+          response: {failedLocations: []},
+        },
+        {
+          appProfiles: [
+            {
+              name: '/projects/p/instances/i/appProfiles/profile-c',
+            },
+            {
+              name: '/projects/p/instances/i/appProfiles/profile-d',
+            },
+          ],
+          response: {failedLocations: ['us-east1-a']},
+        },
+
+        {
+          appProfiles: [
+            {
+              name: '/projects/p/instances/i/appProfiles/profile-e',
+            },
+            {
+              name: '/projects/p/instances/i/appProfiles/profile-f',
+            },
+          ],
+          response: {failedLocations: ['us-west1-b', 'us-west1-c']},
+        },
+      ];
+
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (instance.bigtable.request as Function) = () => {
+        return returnStream;
+      };
+
+      setImmediate(() => {
+        pages.forEach(p => {
+          failedLocations = failedLocations.concat(p.response.failedLocations);
+          returnStream.emit('response', p.response);
+          p.appProfiles.forEach(a => {
+            returnStream.push(a);
+            counter++;
+          });
+        });
+        returnStream.push(null);
+      });
+      const appProfiles: AppProfile[] = [];
+      instance
+        .getAppProfilesStream()
+        .on('error', err => {
+          assert.strictEqual(appProfiles.length, counter);
+          console.log(err.message);
+          assert.deepStrictEqual(
+            err,
+            new Error(
+              `Resources from the following locations are currently not available\n${JSON.stringify(
+                failedLocations
+              )}`
+            )
+          );
+          done();
+        })
+        .on('data', appProfile => {
+          assert(appProfile instanceof FakeAppProfile);
+          appProfiles.push(appProfile);
+        })
+        .on('end', () => {
+          done();
+        });
+    });
+
     it('should return an array of AppProfile objects', done => {
       const response = [
         {