add DEFAULT_AUTO_DETECT_LONG_POLLING and coerce to boolean

firebase · dconeybe · May 8, 2023 · Apr 20, 2023 · Apr 20, 2023 · Apr 20, 2023
commit 8e84d43a5759c50470f83d3898843e78690101d0
diff --git a/packages/firestore/src/lite-api/settings.ts b/packages/firestore/src/lite-api/settings.ts
@@ -29,6 +29,8 @@ import { validateIsNotUsedTogether } from '../util/input_validation';
 export const DEFAULT_HOST = 'firestore.googleapis.com';
 export const DEFAULT_SSL = true;
 
+const DEFAULT_AUTO_DETECT_LONG_POLLING = false;
+
 /**
  * Specifies custom configurations for your Cloud Firestore instance.
  * You must set these before invoking any other methods.
@@ -130,17 +132,18 @@ export class FirestoreSettingsImpl {
       settings.experimentalAutoDetectLongPolling
     );
 
-    if (settings.experimentalForceLongPolling) {
-      this.experimentalForceLongPolling = true;
+    this.experimentalForceLongPolling = !!settings.experimentalForceLongPolling;
+
+    if (this.experimentalForceLongPolling) {
       this.experimentalAutoDetectLongPolling = false;
+    } else if (settings.experimentalAutoDetectLongPolling !== undefined) {
+      // For backwards compatibility, coerce the value to boolean even though
+      // the TypeScript compiler has narrowed the type to boolean already.
+      // noinspection PointlessBooleanExpressionJS
+      this.experimentalAutoDetectLongPolling =
+        !!settings.experimentalAutoDetectLongPolling;
     } else {
-      this.experimentalForceLongPolling = false;
-      if (settings.experimentalAutoDetectLongPolling === undefined) {
-        this.experimentalAutoDetectLongPolling = false;
-      } else {
-        this.experimentalAutoDetectLongPolling =
-          settings.experimentalAutoDetectLongPolling;
-      }
+      this.experimentalAutoDetectLongPolling = DEFAULT_AUTO_DETECT_LONG_POLLING;
     }
 
     this.useFetchStreams = !!settings.useFetchStreams;

diff --git a/packages/firestore/test/unit/api/database.test.ts b/packages/firestore/test/unit/api/database.test.ts
@@ -359,6 +359,42 @@ describe('Settings', () => {
     expect(db._getSettings().experimentalForceLongPolling).to.be.false;
   });
 
+  it('long polling autoDetect=[something truthy] is corced to true', () => {
+    // Use a new instance of Firestore in order to configure settings.
+    const db = newTestFirestore();
+    db._setSettings({
+      experimentalAutoDetectLongPolling: 1 as any,
+    });
+    expect(db._getSettings().experimentalAutoDetectLongPolling).to.be.true;
+  });
+
+  it('long polling autoDetect=[something falsy] is corced to false', () => {
+    // Use a new instance of Firestore in order to configure settings.
+    const db = newTestFirestore();
+    db._setSettings({
+      experimentalAutoDetectLongPolling: 0 as any,
+    });
+    expect(db._getSettings().experimentalAutoDetectLongPolling).to.be.false;
+  });
+
+  it('long polling force=[something truthy] is corced to true', () => {
+    // Use a new instance of Firestore in order to configure settings.
+    const db = newTestFirestore();
+    db._setSettings({
+      experimentalForceLongPolling: "I am truthy" as any,
+    });
+    expect(db._getSettings().experimentalForceLongPolling).to.be.true;
+  });
+
+  it('long polling force=[something falsy] is corced to false', () => {
+    // Use a new instance of Firestore in order to configure settings.
+    const db = newTestFirestore();
+    db._setSettings({
+      experimentalForceLongPolling: NaN as any,
+    });
+    expect(db._getSettings().experimentalForceLongPolling).to.be.false;
+  });
+
   it('gets settings from useEmulator', () => {
     // Use a new instance of Firestore in order to configure settings.
     const db = newTestFirestore();