Merge branch 'main' into telemetry

Author: andrewbrook

.changeset/thin-sheep-smoke.md

@@ -0,0 +1,5 @@
+---
+'@firebase/firestore': patch
+---
+
+Fix: Corrected misleading error message when doc() is called with undefined.

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,6 +14,6 @@ Before you file this pull request, please read these guidelines:
 
 ### API Changes
 
-  * At this time we cannot accept changes that affect the public API.  If you'd like to help 
-    us make Firebase APIs better, please propose your change in an issue so that we 
-    can discuss it together.
+  * Changes that affect the public API will require internal review. Before making a
+    PR that changes the public API, we would suggest first proposing your change in an
+    issue so that we can discuss it together.

packages/ai/integration/constants.ts

@@ -94,6 +94,22 @@ export const liveTestConfigs: readonly TestConfig[] = backends.flatMap(
   }
 );
 
+/**
+ * Test configurations used for server prompt templates integration tests.
+ * Server prompt templates don't define the model name from the client, so these test configs
+ * do not define a model string.
+ * These tests should only run once per backend, rather than once per backend *per model*.
+ */
+export const promptTemplatesTestConfigs: readonly TestConfig[] =
+  backends.flatMap(backend => {
+    const ai = getAI(app, { backend });
+    return {
+      ai,
+      model: '', // Unused by prompt templates tests
+      toString: () => formatConfigAsString({ ai, model: '' }).trim()
+    };
+  });
+
 export const TINY_IMG_BASE64 =
   'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAXRSTlMAQObYZgAAAApJREFUCNdjYAAAAAIAAeIhvDMAAAAASUVORK5CYII=';
 export const IMAGE_MIME_TYPE = 'image/png';

packages/ai/integration/prompt-templates.test.ts

@@ -21,8 +21,7 @@ import {
   getTemplateGenerativeModel,
   getTemplateImagenModel
 } from '../src';
-import { testConfigs } from './constants';
-import { STAGING_URL } from '../src/constants';
+import { promptTemplatesTestConfigs } from './constants';
 
 const templateBackendSuffix = (
   backendType: BackendType
@@ -31,13 +30,11 @@ const templateBackendSuffix = (
 
 describe('Prompt templates', function () {
   this.timeout(20_000);
-  testConfigs.forEach(testConfig => {
+  promptTemplatesTestConfigs.forEach(testConfig => {
     describe(`${testConfig.toString()}`, () => {
       describe('Generative Model', () => {
         it('successfully generates content', async () => {
-          const model = getTemplateGenerativeModel(testConfig.ai, {
-            baseUrl: STAGING_URL
-          });
+          const model = getTemplateGenerativeModel(testConfig.ai);
           const { response } = await model.generateContent(
             `sassy-greeting-${templateBackendSuffix(
               testConfig.ai.backend.backendType
@@ -49,16 +46,14 @@ describe('Prompt templates', function () {
       });
       describe('Imagen model', async () => {
         it('successfully generates images', async () => {
-          const model = getTemplateImagenModel(testConfig.ai, {
-            baseUrl: STAGING_URL
-          });
+          const model = getTemplateImagenModel(testConfig.ai);
           const { images } = await model.generateImages(
             `portrait-${templateBackendSuffix(
               testConfig.ai.backend.backendType
             )}`,
             { animal: 'Rhino' }
           );
-          expect(images.length).to.equal(2); // We ask for two images in the prompt template
+          expect(images.length).to.equal(1); // The template is configured to generate one image.
         });
       });
     });

packages/firestore/src/lite-api/reference.ts

@@ -651,7 +651,7 @@ export function doc<AppModelType, DbModelType extends DocumentData>(
     ) {
       throw new FirestoreError(
         Code.INVALID_ARGUMENT,
-        'Expected first argument to collection() to be a CollectionReference, ' +
+        'Expected first argument to doc() to be a CollectionReference, ' +
           'a DocumentReference or FirebaseFirestore'
       );
     }

packages/firestore/test/lite/integration.test.ts

@@ -285,6 +285,12 @@ describe('doc', () => {
 
   it('validates path', () => {
     return withTestDb(db => {
+      expect(() =>
+        // @ts-expect-error
+        doc({}, 'coll/doc')
+      ).to.throw(
+        'Expected first argument to doc() to be a CollectionReference, a DocumentReference or FirebaseFirestore'
+      );
       expect(() => doc(db, 'coll')).to.throw(
         'Invalid document reference. Document references must have an even ' +
           'number of segments, but coll has 1.'