fix: throw error when GoogleAuthOptions.scopes doesn't include required scope.

PiperOrigin-RevId: 597912107

Author: yyyu-google

src/index.ts

@@ -93,25 +93,7 @@ export class VertexAI_Preview {
     readonly apiEndpoint?: string,
     readonly googleAuthOptions?: GoogleAuthOptions
   ) {
-    let opts: GoogleAuthOptions;
-    if (!googleAuthOptions) {
-      opts = {
-        scopes: 'https://www.googleapis.com/auth/cloud-platform',
-      };
-    } else {
-      if (
-        googleAuthOptions.projectId &&
-        googleAuthOptions.projectId !== project
-      ) {
-        throw new Error(
-          `inconsistent project ID values. argument project got value ${project} but googleAuthOptions.projectId got value ${googleAuthOptions.projectId}`
-        );
-      }
-      opts = googleAuthOptions;
-      if (!opts.scopes) {
-        opts.scopes = 'https://www.googleapis.com/auth/cloud-platform';
-      }
-    }
+    const opts = this.validateGoogleAuthOptions(project, googleAuthOptions);
     this.project = project;
     this.location = location;
     this.apiEndpoint = apiEndpoint;
@@ -155,6 +137,42 @@ export class VertexAI_Preview {
       modelParams.safety_settings
     );
   }
+
+  validateGoogleAuthOptions(
+    project: string,
+    googleAuthOptions?: GoogleAuthOptions
+  ): GoogleAuthOptions {
+    let opts: GoogleAuthOptions;
+    const requiredScope = 'https://www.googleapis.com/auth/cloud-platform';
+    if (!googleAuthOptions) {
+      opts = {
+        scopes: requiredScope,
+      };
+      return opts;
+    }
+    if (
+      googleAuthOptions.projectId &&
+      googleAuthOptions.projectId !== project
+    ) {
+      throw new Error(
+        `inconsistent project ID values. argument project got value ${project} but googleAuthOptions.projectId got value ${googleAuthOptions.projectId}`
+      );
+    }
+    opts = googleAuthOptions;
+    if (!opts.scopes) {
+      opts.scopes = requiredScope;
+      return opts;
+    }
+    if (
+      (typeof opts.scopes === 'string' && opts.scopes !== requiredScope) ||
+      (Array.isArray(opts.scopes) && opts.scopes.indexOf(requiredScope) < 0)
+    ) {
+      throw new GoogleAuthError(
+        `input GoogleAuthOptions.scopes ${opts.scopes} doesn't contain required scope ${requiredScope}, please include ${requiredScope} into GoogleAuthOptions.scopes or leave GoogleAuthOptions.scopes undefined`
+      );
+    }
+    return opts;
+  }
 }
 
 /**

test/index_test.ts

@@ -37,6 +37,7 @@ import {
   SafetySetting,
   StreamGenerateContentResult,
 } from '../src/types/content';
+import {GoogleAuthError} from '../src/types/errors';
 import {constants} from '../src/util';
 
 const PROJECT = 'test_project';
@@ -214,7 +215,7 @@ describe('VertexAI', () => {
 
   it('given specified google auth options, should be instantiated', () => {
     const googleAuthOptions = {
-      scopes: 'test.scopes',
+      scopes: 'https://www.googleapis.com/auth/cloud-platform',
     };
     const vetexai1 = new VertexAI({
       project: PROJECT,
@@ -241,6 +242,41 @@ describe('VertexAI', () => {
     );
   });
 
+  it('given scopes missing required scope, should throw GoogleAuthError', () => {
+    const invalidGoogleAuthOptionsStringScopes = {scopes: 'test.scopes'};
+    expect(() => {
+      new VertexAI({
+        project: PROJECT,
+        location: LOCATION,
+        googleAuthOptions: invalidGoogleAuthOptionsStringScopes,
+      });
+    }).toThrow(
+      new GoogleAuthError(
+        "input GoogleAuthOptions.scopes test.scopes doesn't contain required scope " +
+          'https://www.googleapis.com/auth/cloud-platform, ' +
+          'please include https://www.googleapis.com/auth/cloud-platform into GoogleAuthOptions.scopes ' +
+          'or leave GoogleAuthOptions.scopes undefined'
+      )
+    );
+    const invalidGoogleAuthOptionsArrayScopes = {
+      scopes: ['test1.scopes', 'test2.scopes'],
+    };
+    expect(() => {
+      new VertexAI({
+        project: PROJECT,
+        location: LOCATION,
+        googleAuthOptions: invalidGoogleAuthOptionsArrayScopes,
+      });
+    }).toThrow(
+      new GoogleAuthError(
+        "input GoogleAuthOptions.scopes test1.scopes,test2.scopes doesn't contain required scope " +
+          'https://www.googleapis.com/auth/cloud-platform, ' +
+          'please include https://www.googleapis.com/auth/cloud-platform into GoogleAuthOptions.scopes ' +
+          'or leave GoogleAuthOptions.scopes undefined'
+      )
+    );
+  });
+
   describe('generateContent', () => {
     it('returns a GenerateContentResponse', async () => {
       const req: GenerateContentRequest = {