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

Author: dconeybe

.changeset/dry-cats-lick.md

@@ -0,0 +1,5 @@
+---
+'@firebase/app': patch
+---
+
+Make the error more helpful when `getApp()` is called before `initializeApp()`.

.changeset/funny-ways-carry.md

@@ -0,0 +1,5 @@
+---
+'@firebase/app': patch
+---
+
+Catch more heartbeat read/write errors.

.changeset/grumpy-bees-shake.md

@@ -0,0 +1,6 @@
+---
+'@firebase/firestore': minor
+'firebase': minor
+---
+
+Added the ability to configure the long-polling hanging get request timeout using the new `idleHttpRequestTimeoutSeconds` setting

.changeset/olive-cycles-count.md

@@ -7,38 +7,13 @@
 #
 #######################################################################################################
 
-# ===========================================================
-#  @firebase/jssdk-global-approvers
-# ===========================================================
-#  Used for approving minor changes, large-scale refactorings, and emergency situations.
-#  (secret team to avoid review requests)
-#
-#   - @lahirumaramba
-#   - @hsubox76
-#   - @allspain
-#   - @dwyfrequency
-
-
-# ===========================================================
-#  @firebase/firestore-js-team
-# ===========================================================
-#  Used for approving firestore changes.
-#  (secret team to avoid review requests)
-#
-# - @schmidt-sebastian
-# - @thebrianchen
-# - @wu-hui
-# - @ehsannas
-# - @dconeybe
-
-
 # These owners will be the default owners for everything in the repo.
 *       @dwyfrequency @hsubox76 @firebase/jssdk-global-approvers
 
 # Database Code
-packages/database @maneesht @jsdt @IanWyszynski @firebase/jssdk-global-approvers
-packages/database-compat @maneesht @jsdt @IanWyszynski @firebase/jssdk-global-approvers
-packages/database-types @maneesht @jsdt @IanWyszynski @firebase/jssdk-global-approvers
+packages/database @maneesht @jsdt @jmwski @firebase/jssdk-global-approvers
+packages/database-compat @maneesht @jsdt @jmwski @firebase/jssdk-global-approvers
+packages/database-types @maneesht @jsdt @jmwski @firebase/jssdk-global-approvers
 
 # Firestore Code
 packages/firestore  @firebase/firestore-js-team @firebase/jssdk-global-approvers

.changeset/silent-islands-fix.md

@@ -16,9 +16,13 @@ jobs:
     steps:
     # install Chrome first, so the correct version of webdriver can be installed by chromedriver when setting up the repo
     - name: install Chrome stable
+      # Install Chrome version 110.0.5481.177-1 as some Auth tests start to fail on version 111.
+      # Temporary: Auth team will explore what's going wrong with the auth tests.
       run: |
         sudo apt-get update
-        sudo apt-get install google-chrome-stable
+        sudo apt-get install wget
+        sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_110.0.5481.177-1_amd64.deb
+        sudo apt-get install -f ./google-chrome-stable_110.0.5481.177-1_amd64.deb --allow-downgrades
     - uses: actions/checkout@v3
     - name: Set up Node (16)
       uses: actions/setup-node@v3

.changeset/sixty-dolls-report.md

@@ -15,7 +15,7 @@ jobs:
       # install Chrome first, so the correct version of webdriver can be installed by chromedriver when setting up the repo
       - name: install Chrome stable
         # Install Chrome version 110.0.5481.177-1 as test starts to fail on version 111.
-        # We will retry to use the latest, once version 112 becomes stable.
+        # Temporary: Auth team will explore what's going wrong with the auth tests.
         run: |
           sudo apt-get update
           sudo apt-get install wget

.changeset/strong-ghosts-compare.md

@@ -10,5 +10,6 @@
     "**/node_modules": true
   },
   "typescript.tsdk": "node_modules/typescript/lib",
-  "files.associations": { "*.json": "jsonc" }
+  "files.associations": { "*.json": "jsonc" },
+  "eslint.workingDirectories": [{ "mode": "auto" }]
 }

.changeset/swift-eels-change.md

@@ -29,7 +29,7 @@ Please see [Environment Support](https://firebase.google.com/support/guides/envi
 #### Node.js
 
 Before you can start working on the Firebase JS SDK, you need to have Node.js
-installed on your machine. The currently supported versions are `10.15.0` or greater.
+installed on your machine. The currently supported versions are `10.15.0` through `16.6.0`.
 
 To download Node.js visit https://nodejs.org/en/download/.
 
@@ -43,9 +43,14 @@ In addition to Node.js we use `yarn` to facilitate multi package development.
 To install `yarn` follow the instructions listed on their website:
 https://yarnpkg.com/en/docs/install
 
+This repo currently supports building with yarn `1.x`. For instance, after installating yarn, run
+```bash
+$ yarn set version 1.22.11`
+```
+
 #### Java
 
-The closure compiler requires a modern Java installation. Java 8+ should be installed: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+The closure compiler requires a modern Java installation. Java 11+ should be installed: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
 
 #### Verify Prerequisites
 
@@ -57,8 +62,8 @@ $ yarn -v
 $ java -version
 ```
 
-Your Node.js version should be `10.15.0` or greater, your `yarn` version should
-be `1.0.0` or greater, and your `java` version should be `1.8.0` or greater.
+Your `node` version should be between `10.15.0` and `16.6.0`, your `yarn` version should
+be between `1.0.0` and `1.22.11`, and your `java` version should be `11.0` or greater.
 
 _NOTE: We will update the documentation as new versions are required, however
 for continuing development on the SDK, staying up to date on the stable versions
@@ -109,7 +114,7 @@ will be overwritten below.
 
 Visit the "Realtime Database" section of the console and create a realtime
 database. When prompted to select the set of initial security rules, select
-any option (e.g. "Start in Production Mode") since these permission settings
+any option (e.g. "Start in Locked Mode") since these permission settings
 will be overwritten below.
 
 #### Storage Setup
@@ -127,8 +132,10 @@ order to run the tests, you will need to update your bucket's CORS rules.
     }
 ]
 ```
-2. Install `gsutil` from https://cloud.google.com/storage/docs/gsutil_install
-3. Run `gsutil cors set cors.json gs://<your-cloud-storage-bucket>`
+1. Install `gsutil` from https://cloud.google.com/storage/docs/gsutil_install
+1. You will need to login if this is your first time using `gsutil`. Run `gcloud auth login`
+and follow the instructions to login.
+1. Run `gsutil cors set cors.json gs://<your-cloud-storage-bucket>`
 
 For more information, visit https://firebase.google.com/docs/storage/web/download-files#cors_configuration
 

.changeset/wicked-tomatoes-smoke.md

@@ -20,7 +20,7 @@ export interface ActionCodeInfo {
         multiFactorInfo?: MultiFactorInfo | null;
         previousEmail?: string | null;
     };
-    operation: typeof ActionCodeOperation[keyof typeof ActionCodeOperation];
+    operation: (typeof ActionCodeOperation)[keyof typeof ActionCodeOperation];
 }
 
 // @public
@@ -456,21 +456,21 @@ export function multiFactor(user: User): MultiFactorUser;
 
 // @public
 export interface MultiFactorAssertion {
-    readonly factorId: typeof FactorId[keyof typeof FactorId];
+    readonly factorId: (typeof FactorId)[keyof typeof FactorId];
 }
 
 // @public
 export interface MultiFactorError extends AuthError {
     readonly customData: AuthError['customData'] & {
-        readonly operationType: typeof OperationType[keyof typeof OperationType];
+        readonly operationType: (typeof OperationType)[keyof typeof OperationType];
     };
 }
 
 // @public
 export interface MultiFactorInfo {
     readonly displayName?: string | null;
     readonly enrollmentTime: string;
-    readonly factorId: typeof FactorId[keyof typeof FactorId];
+    readonly factorId: (typeof FactorId)[keyof typeof FactorId];
     readonly uid: string;
 }
 
@@ -844,7 +844,7 @@ export interface User extends UserInfo {
 
 // @public
 export interface UserCredential {
-    operationType: typeof OperationType[keyof typeof OperationType];
+    operationType: (typeof OperationType)[keyof typeof OperationType];
     providerId: string | null;
     user: User;
 }

.changeset/witty-wasps-play.md

@@ -184,6 +184,11 @@ export function endBefore(snapshot: DocumentSnapshot<unknown>): QueryEndAtConstr
 // @public
 export function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;
 
+// @public
+export interface ExperimentalLongPollingOptions {
+    timeoutSeconds?: number;
+}
+
 // @public
 export class FieldPath {
     constructor(...fieldNames: string[]);
@@ -227,6 +232,7 @@ export interface FirestoreSettings {
     cacheSizeBytes?: number;
     experimentalAutoDetectLongPolling?: boolean;
     experimentalForceLongPolling?: boolean;
+    experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
     host?: string;
     ignoreUndefinedProperties?: boolean;
     localCache?: FirestoreLocalCache;

.github/CODEOWNERS

@@ -304,7 +304,7 @@ export interface StorageReference {
 }
 
 // @public
-export type StringFormat = typeof StringFormat[keyof typeof StringFormat];
+export type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
 
 // @public
 export const StringFormat: {
@@ -329,7 +329,7 @@ export const _TaskEvent: {
 export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
 
 // @internal
-export type _TaskState = typeof _TaskState[keyof typeof _TaskState];
+export type _TaskState = (typeof _TaskState)[keyof typeof _TaskState];
 
 // @internal
 export const _TaskState: {

.github/workflows/test-all.yml

@@ -23,7 +23,7 @@ export interface ActionCodeInfo
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [data](./auth.actioncodeinfo.md#actioncodeinfodata) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth.multifactorinfo.md#multifactorinfo_interface) \| null; previousEmail?: string \| null; } | The data associated with the action code. |
-|  [operation](./auth.actioncodeinfo.md#actioncodeinfooperation) | typeof [ActionCodeOperationMap](./auth.md#actioncodeoperation)<!-- -->\[keyof typeof [ActionCodeOperationMap](./auth.md#actioncodeoperation)<!-- -->\] | The type of operation that generated the action code. |
+|  [operation](./auth.actioncodeinfo.md#actioncodeinfooperation) | (typeof [ActionCodeOperationMap](./auth.md#actioncodeoperation)<!-- -->)\[keyof typeof [ActionCodeOperationMap](./auth.md#actioncodeoperation)<!-- -->\] | The type of operation that generated the action code. |
 
 ## ActionCodeInfo.data
 
@@ -54,5 +54,5 @@ The type of operation that generated the action code.
 <b>Signature:</b>
 
 ```typescript
-operation: typeof ActionCodeOperationMap[keyof typeof ActionCodeOperationMap];
+operation: (typeof ActionCodeOperationMap)[keyof typeof ActionCodeOperationMap];
 ```

.github/workflows/test-changed-auth.yml

@@ -41,7 +41,7 @@ export interface Auth
 |  [onAuthStateChanged(nextOrObserver, error, completed)](./auth.auth.md#authonauthstatechanged) | Adds an observer for changes to the user's sign-in state. |
 |  [onIdTokenChanged(nextOrObserver, error, completed)](./auth.auth.md#authonidtokenchanged) | Adds an observer for changes to the signed-in user's ID token. |
 |  [setPersistence(persistence)](./auth.auth.md#authsetpersistence) | Changes the type of persistence on the <code>Auth</code> instance. |
-|  [signOut()](./auth.auth.md#authsignout) | Signs out the current user. |
+|  [signOut()](./auth.auth.md#authsignout) | Signs out the current user. This does not automatically revoke the user's ID token. |
 |  [updateCurrentUser(user)](./auth.auth.md#authupdatecurrentuser) | Asynchronously sets the provided user as [Auth.currentUser](./auth.auth.md#authcurrentuser) on the [Auth](./auth.auth.md#auth_interface) instance. |
 |  [useDeviceLanguage()](./auth.auth.md#authusedevicelanguage) | Sets the current language to the default device/browser preference. |
 
@@ -247,7 +247,7 @@ auth.setPersistence(browserSessionPersistence);
 
 ## Auth.signOut()
 
-Signs out the current user.
+Signs out the current user. This does not automatically revoke the user's ID token.
 
 <b>Signature:</b>
 

.vscode/settings.json

@@ -55,7 +55,7 @@ Firebase Authentication
 |  <b>function(user...)</b> |
 |  [deleteUser(user)](./auth.md#deleteuser) | Deletes and signs out the user. |
 |  [getIdToken(user, forceRefresh)](./auth.md#getidtoken) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. |
-|  [getIdTokenResult(user, forceRefresh)](./auth.md#getidtokenresult) | Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. |
+|  [getIdTokenResult(user, forceRefresh)](./auth.md#getidtokenresult) | Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service. |
 |  [linkWithCredential(user, credential)](./auth.md#linkwithcredential) | Links the user account with the given credentials. |
 |  [linkWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.md#linkwithphonenumber) | Links the user account with the given phone number. |
 |  [linkWithPopup(user, provider, resolver)](./auth.md#linkwithpopup) | Links the authenticated provider to the user account using a pop-up based OAuth flow. |
@@ -1156,7 +1156,7 @@ Promise&lt;string&gt;
 
 ## getIdTokenResult()
 
-Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service.
+Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service.
 
 Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one.
 

README.md

@@ -24,7 +24,7 @@ export interface MultiFactorAssertion
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [factorId](./auth.multifactorassertion.md#multifactorassertionfactorid) | typeof [FactorIdMap](./auth.md#factorid)<!-- -->\[keyof typeof [FactorIdMap](./auth.md#factorid)<!-- -->\] | The identifier of the second factor. |
+|  [factorId](./auth.multifactorassertion.md#multifactorassertionfactorid) | (typeof [FactorIdMap](./auth.md#factorid)<!-- -->)\[keyof typeof [FactorIdMap](./auth.md#factorid)<!-- -->\] | The identifier of the second factor. |
 
 ## MultiFactorAssertion.factorId
 
@@ -33,5 +33,5 @@ The identifier of the second factor.
 <b>Signature:</b>
 
 ```typescript
-readonly factorId: typeof FactorIdMap[keyof typeof FactorIdMap];
+readonly factorId: (typeof FactorIdMap)[keyof typeof FactorIdMap];
 ```

common/api-review/auth.api.md

@@ -25,7 +25,7 @@ export interface MultiFactorError extends AuthError
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [customData](./auth.multifactorerror.md#multifactorerrorcustomdata) | [AuthError](./auth.autherror.md#autherror_interface)<!-- -->\['customData'\] &amp; { readonly operationType: typeof [OperationTypeMap](./auth.md#operationtype)<!-- -->\[keyof typeof [OperationTypeMap](./auth.md#operationtype)<!-- -->\]; } | Details about the MultiFactorError. |
+|  [customData](./auth.multifactorerror.md#multifactorerrorcustomdata) | [AuthError](./auth.autherror.md#autherror_interface)<!-- -->\['customData'\] &amp; { readonly operationType: (typeof [OperationTypeMap](./auth.md#operationtype)<!-- -->)\[keyof typeof [OperationTypeMap](./auth.md#operationtype)<!-- -->\]; } | Details about the MultiFactorError. |
 
 ## MultiFactorError.customData
 
@@ -35,7 +35,7 @@ Details about the MultiFactorError.
 
 ```typescript
 readonly customData: AuthError['customData'] & {
-        readonly operationType: typeof OperationTypeMap[keyof typeof OperationTypeMap];
+        readonly operationType: (typeof OperationTypeMap)[keyof typeof OperationTypeMap];
     };
 ```
 

common/api-review/firestore.api.md

@@ -24,7 +24,7 @@ export interface MultiFactorInfo
 |  --- | --- | --- |
 |  [displayName](./auth.multifactorinfo.md#multifactorinfodisplayname) | string \| null | The user friendly name of the current second factor. |
 |  [enrollmentTime](./auth.multifactorinfo.md#multifactorinfoenrollmenttime) | string | The enrollment date of the second factor formatted as a UTC string. |
-|  [factorId](./auth.multifactorinfo.md#multifactorinfofactorid) | typeof [FactorIdMap](./auth.md#factorid)<!-- -->\[keyof typeof [FactorIdMap](./auth.md#factorid)<!-- -->\] | The identifier of the second factor. |
+|  [factorId](./auth.multifactorinfo.md#multifactorinfofactorid) | (typeof [FactorIdMap](./auth.md#factorid)<!-- -->)\[keyof typeof [FactorIdMap](./auth.md#factorid)<!-- -->\] | The identifier of the second factor. |
 |  [uid](./auth.multifactorinfo.md#multifactorinfouid) | string | The multi-factor enrollment ID. |
 
 ## MultiFactorInfo.displayName
@@ -54,7 +54,7 @@ The identifier of the second factor.
 <b>Signature:</b>
 
 ```typescript
-readonly factorId: typeof FactorIdMap[keyof typeof FactorIdMap];
+readonly factorId: (typeof FactorIdMap)[keyof typeof FactorIdMap];
 ```
 
 ## MultiFactorInfo.uid