feat: return more helpful error when authentication fails (#480)

* feat: return more helpful error when authentication fails
googleapis · Sep 11, 2019 · 98d2b7f · 98d2b7f
1 parent 59287a9
commit 98d2b7f
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 1 deletion.
diff --git a/src/util.ts b/src/util.ts
@@ -600,6 +600,7 @@ export class Util {
         err: Error | null,
         authenticatedReqOpts?: DecorateRequestOptions
       ) => {
+        const authLibraryError = err;
         const autoAuthFailed =
           err &&
           err.message.indexOf('Could not load the default credentials') > -1;
@@ -651,7 +652,17 @@ export class Util {
           activeRequest_ = util.makeRequest(
             authenticatedReqOpts!,
             reqConfig,
-            callback!
+            (apiResponseError, ...params) => {
+              if (
+                apiResponseError &&
+                (apiResponseError as ApiError).code === 401
+              ) {
+                // Re-use the "Could not load the default credentials error" if
+                // the API request failed due to missing credentials.
+                apiResponseError = authLibraryError;
+              }
+              callback!(apiResponseError, ...params);
+            }
           );
         }
       };

diff --git a/test/util.ts b/test/util.ts
@@ -925,6 +925,37 @@ describe('common/util', () => {
           });
         });
 
+        it('should block 401 API errors', done => {
+          const authClientError = new Error(
+            'Could not load the default credentials'
+          );
+          authClient.authorizeRequest = async () => {
+            throw authClientError;
+          };
+          sandbox.stub(fakeGoogleAuth, 'GoogleAuth').returns(authClient);
+
+          const makeRequestArg1 = new Error('API 401 Error.') as ApiError;
+          makeRequestArg1.code = 401;
+          const makeRequestArg2 = {};
+          const makeRequestArg3 = {};
+          stub('makeRequest', (authenticatedReqOpts, cfg, callback) => {
+            callback(makeRequestArg1, makeRequestArg2, makeRequestArg3);
+          });
+
+          const makeAuthenticatedRequest = util.makeAuthenticatedRequestFactory(
+            {}
+          );
+          makeAuthenticatedRequest(
+            {} as DecorateRequestOptions,
+            (arg1, arg2, arg3) => {
+              assert.strictEqual(arg1, authClientError);
+              assert.strictEqual(arg2, makeRequestArg2);
+              assert.strictEqual(arg3, makeRequestArg3);
+              done();
+            }
+          );
+        });
+
         it('should block decorateRequest error', done => {
           const decorateRequestError = new Error('Error.');
           sandbox.stub(fakeGoogleAuth, 'GoogleAuth').returns(authClient);