New way to config Firestore SDK Cache. by wu-hui · Pull Request #7015 · firebase/firebase-js-sdk

wu-hui · 2023-02-08T18:13:29Z

Manual test link (private repo): https://github.com/FirebasePrivate/firestore-team/pull/50

changeset-bot · 2023-02-08T18:13:33Z

🦋 Changeset detected

Latest commit: e6b8250

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	Patch
@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

MarkDuckworth

I like the new interface! I added a few comments for your consideration.

google-oss-bot · 2023-02-21T18:38:11Z

Size Report ¹

Affected Products

`@firebase/firestore`

Type	Base (`a2505bd`)	Merge (ffcd1c2)	Diff
browser	274 kB	278 kB	+3.90 kB (+1.4%)
esm5	341 kB	346 kB	+4.48 kB (+1.3%)
main	549 kB	554 kB	+4.44 kB (+0.8%)
module	274 kB	278 kB	+3.90 kB (+1.4%)
react-native	274 kB	278 kB	+3.90 kB (+1.4%)

`@firebase/firestore-lite`

Type	Base (`a2505bd`)	Merge (ffcd1c2)	Diff
browser	87.4 kB	87.7 kB	+268 B (+0.3%)
esm5	105 kB	106 kB	+268 B (+0.3%)
main	149 kB	149 kB	+31 B (+0.0%)
module	87.4 kB	87.7 kB	+268 B (+0.3%)
react-native	87.6 kB	87.9 kB	+268 B (+0.3%)

`bundle`

12 size changes

Type	Base (`a2505bd`)	Merge (ffcd1c2)	Diff
firestore (Persistence)	282 kB	283 kB	+1.72 kB (+0.6%)
firestore (Query Cursors)	220 kB	222 kB	+1.50 kB (+0.7%)
firestore (Query)	218 kB	219 kB	+1.50 kB (+0.7%)
firestore (Read data once)	205 kB	207 kB	+1.43 kB (+0.7%)
firestore (Realtime updates)	207 kB	209 kB	+1.43 kB (+0.7%)
firestore (Transaction)	189 kB	190 kB	+1.46 kB (+0.8%)
firestore (Write data)	188 kB	190 kB	+1.45 kB (+0.8%)
firestore-lite (Query Cursors)	81.4 kB	81.6 kB	+180 B (+0.2%)
firestore-lite (Query)	77.6 kB	77.7 kB	+180 B (+0.2%)
firestore-lite (Read data once)	59.8 kB	59.9 kB	+69 B (+0.1%)
firestore-lite (Transaction)	84.5 kB	84.7 kB	+202 B (+0.2%)
firestore-lite (Write data)	69.3 kB	69.5 kB	+177 B (+0.3%)

`firebase`

Type	Base (`a2505bd`)	Merge (ffcd1c2)	Diff
firebase-compat.js	747 kB	750 kB	+2.30 kB (+0.3%)
firebase-firestore-compat.js	321 kB	323 kB	+2.30 kB (+0.7%)
firebase-firestore-lite.js	94.2 kB	94.4 kB	+268 B (+0.3%)
firebase-firestore.js	323 kB	327 kB	+3.92 kB (+1.2%)

Test Logs

Base (a2505bd): https://github.com/firebase/firebase-js-sdk/actions/runs/4389723042
Merge (ffcd1c2): https://github.com/firebase/firebase-js-sdk/actions/runs/4406151295

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

google-oss-bot · 2023-02-21T18:52:31Z

Size Analysis Report ¹

This report is too large (790,994 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 (a2505bd): https://github.com/firebase/firebase-js-sdk/actions/runs/4389723042
Merge (ffcd1c2): https://github.com/firebase/firebase-js-sdk/actions/runs/4406151295

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

MarkDuckworth

LGTM. A few comments given for your consideration.

hsubox76

Can you run yarn docgen devsite to generate new files in docs-devsite? There's a message in https://github.com/firebase/firebase-js-sdk/actions/runs/4345091205/jobs/7589318276 but it's not very easy to find, sorry.

hsubox76 · 2023-03-06T16:57:17Z

 }

 /**
+ * @deprecated This function will be removed in a future major release. Instead, set


I'm not sure but I think this tag needs to go at the bottom of the comment block. You can double check when you run yarn docs devsite.

Done in the latest commit.

* New way to config Firestore SDK Cache. * fixups * Fix some test failures * Fixing dts file * Add public comments * API report * Create brown-beers-tease.md * warning messages and more tests * Addressing comments * Update API reports * Fix provider test failure for node w/o indexeddb * Fix node memory test * rename cache to localCache * Update API reports * Tech writer review * yarn docgen * auth change * Update API reports * docgen devsite * Fix changeset * Another auth change * more devsite fix * Update API reports * Rename indexeddb to persistent --------- Co-authored-by: wu-hui <wu-hui@users.noreply.github.com>

wu-hui force-pushed the wuandy/NewCacheConfig branch from 2555b58 to da41013 Compare February 8, 2023 19:50

New way to config Firestore SDK Cache.

4ed6691

wu-hui force-pushed the wuandy/NewCacheConfig branch from da41013 to 4ed6691 Compare February 8, 2023 20:00

wu-hui requested a review from MarkDuckworth February 8, 2023 20:15

wu-hui assigned MarkDuckworth Feb 8, 2023

MarkDuckworth reviewed Feb 8, 2023

View reviewed changes

Comment thread packages/firestore/src/api/cache_config.ts Outdated

MarkDuckworth reviewed Feb 8, 2023

View reviewed changes

Comment thread packages/firestore/src/api/cache_config.ts

MarkDuckworth reviewed Feb 8, 2023

View reviewed changes

Comment thread packages/firestore/src/api/cache_config.ts Outdated

MarkDuckworth reviewed Feb 8, 2023

View reviewed changes

Comment thread packages/firestore/src/core/firestore_client.ts Outdated

MarkDuckworth approved these changes Feb 8, 2023

View reviewed changes

MarkDuckworth assigned wu-hui and unassigned MarkDuckworth Feb 8, 2023

wu-hui added 2 commits February 9, 2023 11:59

fixups

48d5077

Fix some test failures

7d0b186

wu-hui force-pushed the wuandy/NewCacheConfig branch from c628e6a to 7d0b186 Compare February 9, 2023 20:19

wu-hui requested review from dwyfrequency and hsubox76 as code owners February 21, 2023 17:24

wu-hui force-pushed the wuandy/NewCacheConfig branch 3 times, most recently from 6c83a97 to 6535efa Compare February 21, 2023 18:31

Fixing dts file

d651d88

wu-hui force-pushed the wuandy/NewCacheConfig branch from 6535efa to d651d88 Compare February 21, 2023 18:41

wu-hui and others added 4 commits March 1, 2023 11:11

Add public comments

28215da

API report

36715cd

Create brown-beers-tease.md

4bbcbe1

warning messages and more tests

3d22995

MarkDuckworth reviewed Mar 1, 2023

View reviewed changes

Comment thread packages/firestore/test/integration/api/provider.test.ts

Comment thread packages/firestore/src/api/index_configuration.ts

Comment thread packages/firestore/src/api/database.ts Outdated

Comment thread packages/firestore/src/api/cache_config.ts Outdated

markarndt approved these changes Mar 3, 2023

View reviewed changes

Tech writer review

a49b8a5

hsubox76 reviewed Mar 6, 2023

View reviewed changes

yarn docgen

0c1c12e

wu-hui assigned hsubox76 and unassigned markarndt Mar 6, 2023

wu-hui and others added 2 commits March 7, 2023 12:44

auth change

bf593d6

Update API reports

07a175e

wu-hui closed this Mar 7, 2023

wu-hui reopened this Mar 7, 2023

hsubox76 reviewed Mar 8, 2023

View reviewed changes

Comment thread .changeset/brown-beers-tease.md Outdated

docgen devsite

f15bbe0

wu-hui requested a review from egilmorez as a code owner March 8, 2023 17:04

wu-hui and others added 5 commits March 8, 2023 12:05

Fix changeset

b62ced6

Another auth change

5923c28

Merge branch 'master' into wuandy/NewCacheConfig

b861758

more devsite fix

180c859

Update API reports

e4052c2

wu-hui closed this Mar 8, 2023

wu-hui reopened this Mar 8, 2023

hsubox76 approved these changes Mar 8, 2023

View reviewed changes

Rename indexeddb to persistent

e6b8250

wu-hui force-pushed the wuandy/NewCacheConfig branch from 56b199d to e6b8250 Compare March 13, 2023 14:38

wu-hui merged commit 60a730e into master Mar 15, 2023

wu-hui deleted the wuandy/NewCacheConfig branch March 15, 2023 16:49

hsubox76 mentioned this pull request Mar 20, 2023

Add "firebase" changeset #7137

Merged

google-oss-bot mentioned this pull request Mar 29, 2023

Version Packages #7166

Merged

firebase locked and limited conversation to collaborators Apr 15, 2023

Conversation

wu-hui commented Feb 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Feb 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MarkDuckworth left a comment

Choose a reason for hiding this comment

Uh oh!

google-oss-bot commented Feb 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

@firebase/firestore

@firebase/firestore-lite

bundle

firebase

Test Logs

Uh oh!

google-oss-bot commented Feb 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Analysis Report 1

Test Logs

Uh oh!

MarkDuckworth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hsubox76 left a comment

Choose a reason for hiding this comment

Uh oh!

hsubox76 Mar 6, 2023

Choose a reason for hiding this comment

Uh oh!

wu-hui Mar 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

wu-hui commented Feb 8, 2023 •

edited

Loading

changeset-bot Bot commented Feb 8, 2023 •

edited

Loading

google-oss-bot commented Feb 21, 2023 •

edited

Loading

Size Report ¹

`@firebase/firestore`

`@firebase/firestore-lite`

`bundle`

`firebase`

google-oss-bot commented Feb 21, 2023 •

edited

Loading

Size Analysis Report ¹