Apply suggestions from code review

Co-authored-by: Darren Ackers <[email protected]>

Author: 2 people

packages/ai/__tests__/api.test.ts

@@ -40,8 +40,8 @@ const fakeAI: AI = {
   location: 'us-central1',
 };
 
-describe('Top level API', () => {
-  it('getGenerativeModel throws if no model is provided', () => {
+describe('getGenerativeModel()', () => {
+  it('should throw an error if no model is provided', () => {
     try {
       getGenerativeModel(fakeAI, {} as ModelParams);
     } catch (e) {
@@ -70,7 +70,7 @@ describe('Top level API', () => {
     }
   });
 
-  it('getGenerativeModel throws if no projectId is provided', () => {
+  it('should throw an error if no projectId is provided', () => {
     const fakeVertexNoProject = {
       ...fakeAI,
       app: { options: { apiKey: 'my-key' } },
@@ -87,7 +87,7 @@ describe('Top level API', () => {
     }
   });
 
-  it('getGenerativeModel throws if no appId is provided', () => {
+  it('should throw an error if no appId is provided', () => {
     const fakeVertexNoProject = {
       ...fakeAI,
       app: { options: { apiKey: 'my-key', projectId: 'my-projectid' } },
@@ -104,7 +104,7 @@ describe('Top level API', () => {
     }
   });
 
-  it('getGenerativeModel gets a GenerativeModel', () => {
+  it('should return an instance of GenerativeModel', () => {
     const genModel = getGenerativeModel(fakeAI, { model: 'my-model' });
     expect(genModel).toBeInstanceOf(GenerativeModel);
     expect(genModel.model).toBe('publishers/google/models/my-model');

packages/ai/__tests__/backend.test.ts

@@ -21,26 +21,26 @@ import { DEFAULT_LOCATION } from '../lib/constants';
 
 describe('Backend', () => {
   describe('GoogleAIBackend', () => {
-    it('sets backendType to GOOGLE_AI', () => {
+    it('should set backendType to GOOGLE_AI', () => {
       const backend = new GoogleAIBackend();
       expect(backend.backendType).toBe(BackendType.GOOGLE_AI);
     });
   });
 
   describe('VertexAIBackend', () => {
-    it('set backendType to VERTEX_AI', () => {
+    it('should set backendType to VERTEX_AI', () => {
       const backend = new VertexAIBackend();
       expect(backend.backendType).toBe(BackendType.VERTEX_AI);
       expect(backend.location).toBe(DEFAULT_LOCATION);
     });
 
-    it('sets custom location', () => {
+    it('should set a custom location', () => {
       const backend = new VertexAIBackend('test-location');
       expect(backend.backendType).toBe(BackendType.VERTEX_AI);
       expect(backend.location).toBe('test-location');
     });
 
-    it('uses default location if location is empty string', () => {
+    it('should use a default location if location is empty string', () => {
       const backend = new VertexAIBackend('');
       expect(backend.backendType).toBe(BackendType.VERTEX_AI);
       expect(backend.location).toBe(DEFAULT_LOCATION);

packages/vertexai/__tests__/backwards-compatbility.test.ts

@@ -47,34 +47,34 @@ const fakeAI: AI = {
 
 const fakeVertexAI: VertexAI = fakeAI;
 
-describe('backwards-compatible types', function () {
-  it('AI is backwards compatible with VertexAI', function () {
+describe('VertexAI backward compatibility', function () {
+  it('should allow VertexAI to be assignable to AI', function () {
     assertAssignable<VertexAI, AI>();
   });
 
-  it('AIError is backwards compatible with VertexAIError', function () {
+  it('should allow VertexAIError to extend AIError, function () {
     assertAssignable<typeof VertexAIError, typeof AIError>();
     const err = new VertexAIError(VertexAIErrorCode.ERROR, '');
     expect(err).toBeInstanceOf(AIError);
     expect(err).toBeInstanceOf(VertexAIError);
   });
 
-  it('AIErrorCode is backwards compatible with VertexAIErrorCode', () => {
+  it('should allow VertexAIErrorCode to be assignable to AIErrorCode', () => {
     assertAssignable<VertexAIErrorCode, AIErrorCode>();
     const errCode = AIErrorCode.ERROR;
     expect(errCode).toBe(VertexAIErrorCode.ERROR);
   });
 
-  it('AIModel is backwards compatible with VertexAIModel', () => {
+  it('should allow VertexAIModel to extend AIModel', () => {
     assertAssignable<typeof VertexAIModel, typeof AIModel>();
 
     const model = new GenerativeModel(fakeAI, { model: 'model-name' });
     expect(model).toBeInstanceOf(AIModel);
     expect(model).toBeInstanceOf(VertexAIModel);
   });
 
-  describe('backward-compatible functions', () => {
-    it('getGenerativeModel', () => {
+  describe('VertexAI functions', () => {
+    it('should return a VertexAIModel assignable to AIModel from getGenerativeModel()l', () => {
       const model = getGenerativeModel(fakeVertexAI, { model: 'model-name' });
       expect(model).toBeInstanceOf(AIModel);
       expect(model).toBeInstanceOf(VertexAIModel);