Port Compat tests to v9 API #5844

schmidt-sebastian · 2021-12-30T21:20:29Z

We currently use the Compat API to test v9. This works because every API in v9 is also available in Compat. As we are adding new APIs, this will stop working though. This PR migrates both the Firestore integration tests and the minified tests to use the v9 API.

There is another PR pending that re-adds the Compat tests: #5870

changeset-bot · 2021-12-30T21:20:31Z

⚠️ No Changeset found

Latest commit: 53d5a73

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

google-oss-bot · 2021-12-30T21:41:48Z

Size Report ¹

Affected Products

@firebase/firestore
Type Base (d0c8bfe) Merge (fff74fb) Diff
browser 228 kB 228 kB -80 B (-0.0%)
esm5 285 kB 285 kB -80 B (-0.0%)
main 427 kB 426 kB -83 B (-0.0%)
module 228 kB 228 kB -80 B (-0.0%)
react-native 228 kB 228 kB -80 B (-0.0%)

`@firebase/firestore-lite`

Type	Base (`d0c8bfe`)	Merge (`fff74fb`)	Diff
browser	72.6 kB	72.5 kB	-80 B (-0.1%)
esm5	85.9 kB	85.8 kB	-80 B (-0.1%)
main	125 kB	125 kB	-83 B (-0.1%)
module	72.6 kB	72.5 kB	-80 B (-0.1%)
react-native	72.8 kB	72.7 kB	-80 B (-0.1%)

@firebase/messaging
Type Base (d0c8bfe) Merge (fff74fb) Diff
browser 20.8 kB 20.8 kB -2 B (-0.0%)
esm5 26.1 kB 26.1 kB -2 B (-0.0%)
main 26.8 kB 26.8 kB -2 B (-0.0%)
module 20.8 kB 20.8 kB -2 B (-0.0%)
@firebase/messaging-sw
Type Base (d0c8bfe) Merge (fff74fb) Diff
module 22.8 kB 22.8 kB -6 B (-0.0%)

`bundle`

Type	Base (`d0c8bfe`)	Merge (`fff74fb`)	Diff
firestore (Query Cursors)	189 kB	189 kB	-20 B (-0.0%)
firestore (Query)	190 kB	190 kB	-50 B (-0.0%)
firestore (Transaction)	163 kB	163 kB	-10 B (-0.0%)
firestore (Write data)	162 kB	162 kB	-10 B (-0.0%)
firestore-lite (Query Cursors)	56.4 kB	56.4 kB	-20 B (-0.0%)
firestore-lite (Query)	59.5 kB	59.5 kB	-50 B (-0.1%)
firestore-lite (Transaction)	61.4 kB	61.3 kB	-10 B (-0.0%)
firestore-lite (Write data)	46.9 kB	46.9 kB	-10 B (-0.0%)
messaging (send + receive)	37.8 kB	37.8 kB	-2 B (-0.0%)

`firebase`

Type	Base (`d0c8bfe`)	Merge (`fff74fb`)	Diff
firebase-compat.js	753 kB	753 kB	-88 B (-0.0%)
firebase-firestore-compat.js	281 kB	281 kB	-80 B (-0.0%)
firebase-firestore-lite.js	249 kB	249 kB	-86 B (-0.0%)
firebase-firestore.js	770 kB	770 kB	-119 B (-0.0%)
firebase-messaging-compat.js	38.0 kB	37.9 kB	-8 B (-0.0%)
firebase-messaging-sw.js	102 kB	102 kB	-6 B (-0.0%)
firebase-messaging.js	101 kB	101 kB	-2 B (-0.0%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/9uCrskjXgN.html

google-oss-bot · 2021-12-30T21:54:30Z

Size Analysis Report ¹

This report is too large (322,844 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

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

ehsannas

13 / 45 files reviewed so far...

ehsannas · 2022-01-10T21:09:41Z

integration/firestore/gulpfile.js

-         } else {
-           process.env.INCLUDE_FIRESTORE_PERSISTENCE = '${isPersistenceEnabled()}';
-         }`
+if (typeof process === 'undefined') {


is this indentation change intentional?

Yeah, the output looks much better. This is a search/replace thing and the output shouldn't be indented. It doesn't really matter though since no one should see this, but I like to go above and beyond :)

ehsannas · 2022-01-10T21:16:03Z

packages/firestore/test/integration/api/array_transforms.test.ts

        { includeMetadataChanges: true },
        accumulator.storeEvent
      );

      // wait for initial null snapshot to avoid potential races.
      const snapshot = await accumulator.awaitRemoteEvent();
-      expect(snapshot.exists).to.be.false;
+      expect(snapshot.exists()).to.be.false;


Ouch. Nothing about this PR, but this is such an easy thing to miss. @cherylEnkidu spent a lot of time debugging her code as she had used snapshot.exists while using v9 :-)

TAT People use exists in v8 but exists() in v9

We changed it to a method so we could use a typeguard:

exists(): this is QueryDocumentSnapshot<T>;

If exists() returns true then TS knows .data is not undefined.

packages/firestore/test/integration/api/database.test.ts

ehsannas

25 / 45 ...

packages/firestore/test/integration/api/smoke.test.ts

ehsannas · 2022-01-11T05:23:11Z

packages/firestore/test/integration/api_internal/idle_timeout.test.ts

 import { apiDescribe, withTestDb } from '../util/helpers';
 import { asyncQueue } from '../util/internal_helpers';

 apiDescribe('Idle Timeout', (persistence: boolean) => {
-  it('can write document after idle timeout', () => {
+  it('can write documdent after idle timeout', () => {


google-oss-bot added the doc-changes PRs that affect docs label Dec 30, 2021

schmidt-sebastian force-pushed the mrschmidt/newtests branch 5 times, most recently from a795f0a to 44b61ee Compare January 5, 2022 04:28

schmidt-sebastian force-pushed the mrschmidt/newtests branch from 0d0aba4 to 0a53721 Compare January 10, 2022 19:03

schmidt-sebastian requested a review from ehsannas January 10, 2022 19:08

schmidt-sebastian added api: firestore and removed doc-changes PRs that affect docs labels Jan 10, 2022

schmidt-sebastian assigned ehsannas Jan 10, 2022

Migrate tests to v9 API

a4ce6f9

schmidt-sebastian force-pushed the mrschmidt/newtests branch from 0a53721 to a4ce6f9 Compare January 10, 2022 19:10

schmidt-sebastian marked this pull request as ready for review January 10, 2022 19:10

Merge branch 'master' into mrschmidt/newtests

371b067

schmidt-sebastian requested review from allspain and hsubox76 as code owners January 10, 2022 22:45

Fix dependency

c80fab0

schmidt-sebastian force-pushed the mrschmidt/newtests branch from 9a4d175 to c80fab0 Compare January 10, 2022 22:48

ehsannas reviewed Jan 10, 2022

View reviewed changes

packages/firestore/test/integration/api/database.test.ts Show resolved Hide resolved

ehsannas reviewed Jan 10, 2022

View reviewed changes

packages/firestore/test/integration/api/database.test.ts Show resolved Hide resolved

ehsannas reviewed Jan 11, 2022

View reviewed changes

Feedback

f02343b

ehsannas approved these changes Jan 11, 2022

View reviewed changes

ehsannas assigned schmidt-sebastian and unassigned ehsannas Jan 11, 2022

schmidt-sebastian added 7 commits January 11, 2022 11:34

Fix tests

7e83b9e

Unit test fixes

314343c

More fixes

3026ea3

Merge branch 'master' into mrschmidt/newtests

af7a2df

Fix unit test

162b0dc

Make dependency

15cc188

Fix compat tests

53d5a73

schmidt-sebastian merged commit 3105541 into master Jan 12, 2022

schmidt-sebastian deleted the mrschmidt/newtests branch January 12, 2022 21:59

firebase locked and limited conversation to collaborators Feb 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port Compat tests to v9 API #5844

Port Compat tests to v9 API #5844

schmidt-sebastian commented Dec 30, 2021 •

edited

changeset-bot bot commented Dec 30, 2021 •

edited

google-oss-bot commented Dec 30, 2021 •

edited

`@firebase/firestore`

`@firebase/firestore-lite`

`@firebase/messaging`

`@firebase/messaging-sw`

`bundle`

`firebase`

google-oss-bot commented Dec 30, 2021 •

edited

ehsannas left a comment

ehsannas Jan 10, 2022

schmidt-sebastian Jan 11, 2022

ehsannas Jan 10, 2022

cherylEnkidu Jan 11, 2022

schmidt-sebastian Jan 11, 2022

ehsannas left a comment

ehsannas Jan 11, 2022

schmidt-sebastian Jan 11, 2022

Port Compat tests to v9 API #5844

Port Compat tests to v9 API #5844

Conversation

schmidt-sebastian commented Dec 30, 2021 • edited

changeset-bot bot commented Dec 30, 2021 • edited

⚠️ No Changeset found

google-oss-bot commented Dec 30, 2021 • edited

Size Report 1

Affected Products

@firebase/firestore

@firebase/firestore-lite

@firebase/messaging

@firebase/messaging-sw

bundle

firebase

Test Logs

google-oss-bot commented Dec 30, 2021 • edited

Size Analysis Report 1

Test Logs

ehsannas left a comment

Choose a reason for hiding this comment

ehsannas Jan 10, 2022

Choose a reason for hiding this comment

schmidt-sebastian Jan 11, 2022

Choose a reason for hiding this comment

ehsannas Jan 10, 2022

Choose a reason for hiding this comment

cherylEnkidu Jan 11, 2022

Choose a reason for hiding this comment

schmidt-sebastian Jan 11, 2022

Choose a reason for hiding this comment

ehsannas left a comment

Choose a reason for hiding this comment

ehsannas Jan 11, 2022

Choose a reason for hiding this comment

schmidt-sebastian Jan 11, 2022

Choose a reason for hiding this comment

schmidt-sebastian commented Dec 30, 2021 •

edited

changeset-bot bot commented Dec 30, 2021 •

edited

google-oss-bot commented Dec 30, 2021 •

edited

Size Report ¹

`@firebase/firestore`

`@firebase/firestore-lite`

`@firebase/messaging`

`@firebase/messaging-sw`

`bundle`

`firebase`

google-oss-bot commented Dec 30, 2021 •

edited

Size Analysis Report ¹