Firestore: Add ability to configure long polling timeout

[dconeybe]

Add a new setting for Firestore: experimentalLongPollingOptions.timeoutSeconds. This new option can be used to configure the SDK’s underlying network transport (WebChannel) when long-polling is used, such as when experimentalAutoDetectLongPolling or experimentalForceLongPolling is set to true.

For convenience, here is the documentation for the new experimentalLongPollingOptions.timeoutSeconds property, copied from this PR's code:

The desired maximum timeout interval, in seconds, to complete a long-polling GET response. Valid values are between 5 and 30, inclusive. Floating point values are allowed and will be rounded to the nearest millisecond.

By default, when long-polling is used the "hanging GET" request sent by the client times out after 30 seconds. To request a different timeout from the server, set this setting with the desired timeout.

Changing the default timeout may be useful, for example, if the buffering proxy that necessitated enabling long-polling in the first place has a shorter timeout for hanging GET requests, in which case setting the long-polling timeout to a shorter value, such as 25 seconds, may fix prematurely-closed hanging GET requests.

Below is an example that changes the long-polling "hanging get" timeout from the default (30 seconds) to 25 seconds:

const db = initializeFirestore(app, {
  experimentalAutoDetectLongPolling: true,
  experimentalLongPollingOptions: {
    timeoutSeconds: 25
  }
});

Googlers see b/266868871

Fixes: #6987

[changeset-bot]

🦋 Changeset detected

Latest commit: 3bd125d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@firebase/firestore	Minor
firebase	Minor
@firebase/firestore-compat	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[google-oss-bot]

Size Report ¹

Affected Products

• @firebase/firestore

  Type	Base (5a2ceb0)	Merge (057eafd)	Diff
  browser	285 kB	286 kB	+1.01 kB (+0.4%)
  esm5	354 kB	355 kB	+1.03 kB (+0.3%)
  main	567 kB	568 kB	+1.48 kB (+0.3%)
  module	285 kB	286 kB	+1.01 kB (+0.4%)
  react-native	285 kB	286 kB	+1.01 kB (+0.4%)

• @firebase/firestore-lite

  Type	Base (5a2ceb0)	Merge (057eafd)	Diff
  browser	87.5 kB	88.3 kB	+817 B (+0.9%)
  esm5	105 kB	106 kB	+842 B (+0.8%)
  main	149 kB	151 kB	+1.48 kB (+1.0%)
  module	87.5 kB	88.3 kB	+817 B (+0.9%)
  react-native	87.7 kB	88.5 kB	+817 B (+0.9%)

• @firebase/webchannel-wrapper

  Type	Base (5a2ceb0)	Merge (057eafd)	Diff
  esm5	55.2 kB	55.4 kB	+239 B (+0.4%)
  main	65.1 kB	65.4 kB	+258 B (+0.4%)
  module	52.9 kB	53.1 kB	+147 B (+0.3%)

• bundle

  12 size changes

  Type	Base (5a2ceb0)	Merge (057eafd)	Diff
  firestore (Persistence)	298 kB	300 kB	+1.17 kB (+0.4%)
  firestore (Query Cursors)	237 kB	238 kB	+1.17 kB (+0.5%)
  firestore (Query)	234 kB	235 kB	+1.17 kB (+0.5%)
  firestore (Read data once)	222 kB	223 kB	+1.17 kB (+0.5%)
  firestore (Realtime updates)	224 kB	225 kB	+1.17 kB (+0.5%)
  firestore (Transaction)	201 kB	202 kB	+1.17 kB (+0.6%)
  firestore (Write data)	201 kB	202 kB	+1.17 kB (+0.6%)
  firestore-lite (Query Cursors)	81.7 kB	82.5 kB	+823 B (+1.0%)
  firestore-lite (Query)	77.9 kB	78.7 kB	+823 B (+1.1%)
  firestore-lite (Read data once)	60.0 kB	60.8 kB	+823 B (+1.4%)
  firestore-lite (Transaction)	84.8 kB	85.6 kB	+823 B (+1.0%)
  firestore-lite (Write data)	69.6 kB	70.4 kB	+823 B (+1.2%)

• firebase

  Type	Base (5a2ceb0)	Merge (057eafd)	Diff
  firebase-compat.js	772 kB	773 kB	+1.15 kB (+0.1%)
  firebase-firestore-compat.js	338 kB	339 kB	+1.14 kB (+0.3%)
  firebase-firestore-lite.js	94.2 kB	95.0 kB	+817 B (+0.9%)
  firebase-firestore.js	344 kB	345 kB	+1.16 kB (+0.3%)

Test Logs

• Base (5a2ceb0): https://github.com/firebase/firebase-js-sdk/actions/runs/4833296220
• Merge (057eafd): https://github.com/firebase/firebase-js-sdk/actions/runs/4834287927

1. https://storage.googleapis.com/firebase-sdk-metric-reports/oqJyVp0fbr.html

[google-oss-bot]

Size Analysis Report ¹

This report is too large (542,285 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.

Test Logs

• Base (5a2ceb0): https://github.com/firebase/firebase-js-sdk/actions/runs/4833296220
• Merge (057eafd): https://github.com/firebase/firebase-js-sdk/actions/runs/4834287927

1. https://storage.googleapis.com/firebase-sdk-metric-reports/a209gKbaKT.html

[ehsannas]

Tom was right! ;-P

[hsubox76]

Can you add a changeset?

[dconeybe]

Can you add a changeset?

Done. Thanks for pointing that out.