Merge remote-tracking branch 'origin/master' into HEAD

dconeybe · dconeybe · commit 5bd614212ce3 · 2023-02-23T12:08:44.000-05:00
diff --git a/.changeset/heavy-starfishes-count.md b/.changeset/heavy-starfishes-count.md
@@ -0,0 +1,6 @@
+---
+"@firebase/firestore-compat": feat
+"@firebase/firestore": feat
+---
+
+Relaxing query validation performed by the SDK
diff --git a/.changeset/perfect-colts-scream.md b/.changeset/perfect-colts-scream.md
@@ -0,0 +1,5 @@
+---
+"@firebase/database-compat": patch
+---
+
+Solve @firebase/database-compat/standalone resolution issues with astrojs
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -96,6 +96,7 @@ packages/app-check-interop-types @hsubox76 @firebase/jssdk-global-approvers
 # Documentation Changes
 packages/firebase/index.d.ts @egilmorez @firebase/jssdk-global-approvers
 scripts/docgen/content-sources/ @egilmorez @firebase/jssdk-global-approvers
+docs-devsite/ @egilmorez @markarndt
 
 # Changeset
-.changeset @egilmorez @firebase/jssdk-changeset-approvers @firebase/firestore-js-team @firebase/jssdk-global-approvers
+.changeset @firebase/jssdk-changeset-approvers @firebase/firestore-js-team @firebase/jssdk-global-approvers
diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml
@@ -0,0 +1,28 @@
+name: Doc Change Check (Run "yarn docgen devsite" if this fails)
+
+on: pull_request
+
+jobs:
+  doc-check:
+    name: Check if reference docs have changed
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@master
+      with:
+        # get all history for the diff
+        fetch-depth: 0
+    - name: Set up Node (14)
+      uses: actions/setup-node@v2
+      with:
+        node-version: 14.x
+    - name: Yarn install
+      run: yarn
+    - name: Run doc generation (devsite docs)
+      run: yarn docgen devsite
+    - name: Check for changes in docs-devsite dir (fail if so)
+      run: git diff --exit-code docs-devsite
+    - name: Reference documentation needs to be updated. See message below.
+      if: ${{ failure() }}
+      run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen devsite\` locally to regenerate docs and add them to this PR."
diff --git a/.github/workflows/label-doc-changes.yml b/.github/workflows/label-doc-changes.yml
diff --git a/docs-devsite/firestore_.aggregatefield.md b/docs-devsite/firestore_.aggregatefield.md
@@ -22,7 +22,7 @@ export declare class AggregateField<T>
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [type](./firestore_.aggregatefield.md#aggregatefieldtype) |  | string | A type string to uniquely identify instances of this class. |
+|  [type](./firestore_.aggregatefield.md#aggregatefieldtype) |  | (not declared) | A type string to uniquely identify instances of this class. |
 
 ## AggregateField.type
 
@@ -31,5 +31,5 @@ A type string to uniquely identify instances of this class.
 <b>Signature:</b>
 
 ```typescript
-type: string;
+readonly type = "AggregateField";
 ```
diff --git a/docs-devsite/firestore_.aggregatespec.md b/docs-devsite/firestore_.aggregatespec.md
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # AggregateSpec interface
-A type whose property values are all `AggregateField` objects.
+Specifies a set of aggregations and their aliases.
 
 <b>Signature:</b>
 
diff --git a/docs-devsite/firestore_.md b/docs-devsite/firestore_.md
@@ -134,7 +134,7 @@ https://github.com/firebase/firebase-js-sdk
 
 |  Interface | Description |
 |  --- | --- |
-|  [AggregateSpec](./firestore_.aggregatespec.md#aggregatespec_interface) | A type whose property values are all <code>AggregateField</code> objects. |
+|  [AggregateSpec](./firestore_.aggregatespec.md#aggregatespec_interface) | Specifies a set of aggregations and their aliases. |
 |  [DocumentChange](./firestore_.documentchange.md#documentchange_interface) | A <code>DocumentChange</code> represents a change to the documents matching a query. It contains the document affected and the type of change that occurred. |
 |  [DocumentData](./firestore_.documentdata.md#documentdata_interface) | Document data (for use with [setDoc()](./firestore_lite.md#setdoc)<!-- -->) consists of fields mapped to values. |
 |  [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface) | Converter used by <code>withConverter()</code> to transform user objects of type <code>T</code> into Firestore data.<!-- -->Using the converter allows you to specify generic type arguments when storing and retrieving objects from Firestore. |
@@ -1946,7 +1946,7 @@ The union of all `AggregateField` types that are supported by Firestore.
 <b>Signature:</b>
 
 ```typescript
-export declare type AggregateFieldType = AggregateField<number>;
+export declare type AggregateFieldType = AggregateField<number | null>;
 ```
 
 ## AggregateSpecData
diff --git a/docs-devsite/firestore_lite.aggregatefield.md b/docs-devsite/firestore_lite.aggregatefield.md
@@ -22,7 +22,7 @@ export declare class AggregateField<T>
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [type](./firestore_lite.aggregatefield.md#aggregatefieldtype) |  | string | A type string to uniquely identify instances of this class. |
+|  [type](./firestore_lite.aggregatefield.md#aggregatefieldtype) |  | (not declared) | A type string to uniquely identify instances of this class. |
 
 ## AggregateField.type
 
@@ -31,5 +31,5 @@ A type string to uniquely identify instances of this class.
 <b>Signature:</b>
 
 ```typescript
-type: string;
+readonly type = "AggregateField";
 ```
diff --git a/docs-devsite/firestore_lite.aggregatespec.md b/docs-devsite/firestore_lite.aggregatespec.md
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # AggregateSpec interface
-A type whose property values are all `AggregateField` objects.
+Specifies a set of aggregations and their aliases.
 
 <b>Signature:</b>
 
diff --git a/docs-devsite/firestore_lite.md b/docs-devsite/firestore_lite.md
@@ -108,7 +108,7 @@ https://github.com/firebase/firebase-js-sdk
 
 |  Interface | Description |
 |  --- | --- |
-|  [AggregateSpec](./firestore_lite.aggregatespec.md#aggregatespec_interface) | A type whose property values are all <code>AggregateField</code> objects. |
+|  [AggregateSpec](./firestore_lite.aggregatespec.md#aggregatespec_interface) | Specifies a set of aggregations and their aliases. |
 |  [DocumentData](./firestore_lite.documentdata.md#documentdata_interface) | Document data (for use with [setDoc()](./firestore_lite.md#setdoc)<!-- -->) consists of fields mapped to values. |
 |  [FirestoreDataConverter](./firestore_lite.firestoredataconverter.md#firestoredataconverter_interface) | Converter used by <code>withConverter()</code> to transform user objects of type <code>T</code> into Firestore data.<!-- -->Using the converter allows you to specify generic type arguments when storing and retrieving objects from Firestore. |
 |  [Settings](./firestore_lite.settings.md#settings_interface) | Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods. |
@@ -1277,7 +1277,7 @@ The union of all `AggregateField` types that are supported by Firestore.
 <b>Signature:</b>
 
 ```typescript
-export declare type AggregateFieldType = AggregateField<number>;
+export declare type AggregateFieldType = AggregateField<number | null>;
 ```
 
 ## AggregateSpecData
diff --git a/packages/database-compat/package.json b/packages/database-compat/package.json
@@ -30,7 +30,8 @@
     },
     "./standalone": {
       "types": "./dist/database-compat/src/index.standalone.d.ts",
-      "node": "./dist/index.standalone.js"
+      "node": "./dist/index.standalone.js",
+      "default": "./dist/index.standalone.js"
     },
     "./package.json": "./package.json"
   },
diff --git a/packages/firestore-compat/test/validation.test.ts b/packages/firestore-compat/test/validation.test.ts
@@ -901,47 +901,6 @@ apiDescribe('Validation:', (persistence: boolean) => {
       }
     );
 
-    validationIt(persistence, 'with multiple array filters fail', db => {
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'array-contains', 1)
-          .where('foo', 'array-contains', 2)
-      ).to.throw(
-        "Invalid query. You cannot use more than one 'array-contains' filter."
-      );
-
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'array-contains', 1)
-          .where('foo', 'array-contains-any', [2, 3])
-      ).to.throw(
-        "Invalid query. You cannot use 'array-contains-any' filters with " +
-          "'array-contains' filters."
-      );
-
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'array-contains-any', [2, 3])
-          .where('foo', 'array-contains', 1)
-      ).to.throw(
-        "Invalid query. You cannot use 'array-contains' filters with " +
-          "'array-contains-any' filters."
-      );
-
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'not-in', [2, 3])
-          .where('foo', 'array-contains', 1)
-      ).to.throw(
-        "Invalid query. You cannot use 'array-contains' filters with " +
-          "'not-in' filters."
-      );
-    });
-
     validationIt(persistence, 'with != and not-in filters fail', db => {
       expect(() =>
         db
@@ -963,13 +922,6 @@ apiDescribe('Validation:', (persistence: boolean) => {
     });
 
     validationIt(persistence, 'with multiple disjunctive filters fail', db => {
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'in', [1, 2])
-          .where('foo', 'in', [2, 3])
-      ).to.throw("Invalid query. You cannot use more than one 'in' filter.");
-
       expect(() =>
         db
           .collection('test')
@@ -979,36 +931,6 @@ apiDescribe('Validation:', (persistence: boolean) => {
         "Invalid query. You cannot use more than one 'not-in' filter."
       );
 
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'array-contains-any', [1, 2])
-          .where('foo', 'array-contains-any', [2, 3])
-      ).to.throw(
-        "Invalid query. You cannot use more than one 'array-contains-any'" +
-          ' filter.'
-      );
-
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'array-contains-any', [2, 3])
-          .where('foo', 'in', [2, 3])
-      ).to.throw(
-        "Invalid query. You cannot use 'in' filters with " +
-          "'array-contains-any' filters."
-      );
-
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'in', [2, 3])
-          .where('foo', 'array-contains-any', [2, 3])
-      ).to.throw(
-        "Invalid query. You cannot use 'array-contains-any' filters with " +
-          "'in' filters."
-      );
-
       expect(() =>
         db
           .collection('test')
@@ -1046,51 +968,6 @@ apiDescribe('Validation:', (persistence: boolean) => {
       ).to.throw(
         "Invalid query. You cannot use 'not-in' filters with 'in' filters."
       );
-
-      // This is redundant with the above tests, but makes sure our validation
-      // doesn't get confused.
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'in', [2, 3])
-          .where('foo', 'array-contains', 1)
-          .where('foo', 'array-contains-any', [2])
-      ).to.throw(
-        "Invalid query. You cannot use 'array-contains-any' filters with 'in' filters."
-      );
-
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'array-contains', 1)
-          .where('foo', 'in', [2, 3])
-          .where('foo', 'array-contains-any', [2])
-      ).to.throw(
-        "Invalid query. You cannot use 'array-contains-any' filters with " +
-          "'array-contains' filters."
-      );
-
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'not-in', [2, 3])
-          .where('foo', 'array-contains', 2)
-          .where('foo', 'array-contains-any', [2])
-      ).to.throw(
-        "Invalid query. You cannot use 'array-contains' filters with " +
-          "'not-in' filters."
-      );
-
-      expect(() =>
-        db
-          .collection('test')
-          .where('foo', 'array-contains', 2)
-          .where('foo', 'in', [2])
-          .where('foo', 'not-in', [2, 3])
-      ).to.throw(
-        "Invalid query. You cannot use 'not-in' filters with " +
-          "'array-contains' filters."
-      );
     });
 
     validationIt(
@@ -1110,24 +987,6 @@ apiDescribe('Validation:', (persistence: boolean) => {
             .where('foo', 'in', [2, 3])
             .where('foo', 'array-contains', 1)
         ).not.to.throw();
-
-        expect(() =>
-          db
-            .collection('test')
-            .where('foo', 'in', [2, 3])
-            .where('foo', 'array-contains', 1)
-            .where('foo', 'array-contains', 2)
-        ).to.throw(
-          "Invalid query. You cannot use more than one 'array-contains' filter."
-        );
-
-        expect(() =>
-          db
-            .collection('test')
-            .where('foo', 'array-contains', 1)
-            .where('foo', 'in', [2, 3])
-            .where('foo', 'in', [2, 3])
-        ).to.throw("Invalid query. You cannot use more than one 'in' filter.");
       }
     );
 
@@ -1146,29 +1005,6 @@ apiDescribe('Validation:', (persistence: boolean) => {
             "'array-contains-any' filters."
         );
 
-        expect(() =>
-          db
-            .collection('test')
-            // The 10 element max includes duplicates.
-            .where('foo', 'in', [1, 2, 3, 4, 5, 6, 7, 8, 9, 9, 9])
-        ).to.throw(
-          "Invalid Query. 'in' filters support a maximum of 10 elements in " +
-            'the value array.'
-        );
-
-        expect(() =>
-          db
-            .collection('test')
-            .where(
-              'foo',
-              'array-contains-any',
-              [1, 2, 3, 4, 5, 6, 7, 8, 9, 9, 9]
-            )
-        ).to.throw(
-          "Invalid Query. 'array-contains-any' filters support a maximum of " +
-            '10 elements in the value array.'
-        );
-
         expect(() => db.collection('test').where('foo', 'in', [])).to.throw(
           "Invalid Query. A non-empty array is required for 'in' filters."
         );
diff --git a/packages/firestore/src/core/query.ts b/packages/firestore/src/core/query.ts
diff --git a/packages/firestore/src/lite-api/query.ts b/packages/firestore/src/lite-api/query.ts
diff --git a/packages/firestore/test/integration/api/query.test.ts b/packages/firestore/test/integration/api/query.test.ts
diff --git a/packages/firestore/test/integration/api/validation.test.ts b/packages/firestore/test/integration/api/validation.test.ts
diff --git a/scripts/docgen/docgen.ts b/scripts/docgen/docgen.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@firebase/database-compat": patch
 +---
++
 +Solve @firebase/database-compat/standalone resolution issues with astrojs