snapshot listeners source from cache

[milaGGL]

Adding ListenSource enum to SnapshotListenOptions.

const enum ListenSource {
  /** Listen to both cache and server changes */
  Default,
  /** Listen to changes in cache only */
  Cache
}

tests include integration tests and spec tests on:

• listening/un-listening-relistening to query sourced from cache
• having multiple listeners from different source
• raising snapshot from cache, on local mutation, watch updates(while listening to both default and cache) and bundle loads
• mirror queries in integration test and multi-client spec tests
• transactions, network changes should not raise snapshot while listening to cache only
• can execute composite index queries.
• eager and persistence garbage collection

[changeset-bot]

🦋 Changeset detected

Latest commit: a340dd6

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/auth

  Type	Base (e60188d)	Merge (10acec4)	Diff
  browser	177 kB	177 kB	+38 B (+0.0%)
  esm5	231 kB	231 kB	+38 B (+0.0%)
  module	177 kB	177 kB	+38 B (+0.0%)

• @firebase/auth/internal

  Type	Base (e60188d)	Merge (10acec4)	Diff
  browser	188 kB	188 kB	+38 B (+0.0%)
  esm5	244 kB	244 kB	+38 B (+0.0%)
  module	188 kB	188 kB	+38 B (+0.0%)

• @firebase/firestore

  Type	Base (e60188d)	Merge (10acec4)	Diff
  browser	375 kB	376 kB	+1.29 kB (+0.3%)
  esm5	360 kB	362 kB	+1.60 kB (+0.4%)
  main	577 kB	579 kB	+2.40 kB (+0.4%)
  module	375 kB	376 kB	+1.29 kB (+0.3%)
  react-native	375 kB	376 kB	+1.29 kB (+0.3%)

• bundle

  11 size changes

  Type	Base (e60188d)	Merge (10acec4)	Diff
  auth (GoogleFBTwitterGitHubPopup)	101 kB	101 kB	+19 B (+0.0%)
  firestore (CSI Auto Indexing Disable and Delete)	268 kB	268 kB	+57 B (+0.0%)
  firestore (CSI Auto Indexing Enable)	268 kB	268 kB	+57 B (+0.0%)
  firestore (Persistence)	303 kB	303 kB	+101 B (+0.0%)
  firestore (Query Cursors)	246 kB	247 kB	+903 B (+0.4%)
  firestore (Query)	243 kB	244 kB	+936 B (+0.4%)
  firestore (Read data once)	231 kB	232 kB	+903 B (+0.4%)
  firestore (Read Write w Persistence)	321 kB	322 kB	+947 B (+0.3%)
  firestore (Realtime updates)	234 kB	235 kB	+936 B (+0.4%)
  firestore (Transaction)	211 kB	211 kB	+57 B (+0.0%)
  firestore (Write data)	211 kB	211 kB	+57 B (+0.0%)

• firebase

  Type	Base (e60188d)	Merge (10acec4)	Diff
  firebase-auth.js	147 kB	147 kB	+19 B (+0.0%)
  firebase-compat.js	780 kB	781 kB	+934 B (+0.1%)
  firebase-firestore-compat.js	341 kB	342 kB	+934 B (+0.3%)
  firebase-firestore.js	434 kB	436 kB	+1.30 kB (+0.3%)

Test Logs

• Base (e60188d): https://github.com/firebase/firebase-js-sdk/actions/runs/8086709249
• Merge (10acec4): https://github.com/firebase/firebase-js-sdk/actions/runs/8238050859

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

[google-oss-bot]

Size Analysis Report ¹

This report is too large (203,112 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 (e60188d): https://github.com/firebase/firebase-js-sdk/actions/runs/8086709249
• Merge (10acec4): https://github.com/firebase/firebase-js-sdk/actions/runs/8238050859

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

[github-actions]

Changeset File Check ✅

• No modified packages are missing from the changeset file.
• No changeset formatting errors detected.

[wu-hui]

Another round. I am half way through tests, but I think we should try to make our tests cover different query/collection combinations.

[wu-hui]

I am very happy with the thorough test coverage.

There is a comment about SnapshotInSync though, which I think is behavior is not expected. Can you investigate?

Other than this one, it should be good to go.

[wu-hui]

LGTM, really good work, and sets an example of the test coverage we should be aiming for.

Thanks for your patience to address my feedbacks and questions.

[egilmorez]

Seconding Mark's approval, thanks!

[milaGGL]

@markarndt The public interface ListenSource has been changed from enum to union type, and the documentation has been changed a bit in format. Please help re-review the changed part.