[FEAT] Restrict Firestore Doc/QuerySnapshot toJSON on client. #9048

DellaBitta · 2025-05-15T15:54:52Z

Discussion

To reduce bundle size on clients, the toJSON methods of DocumentSnapshot and QuerySnapshot will not create bundles.

Testing

Updated the integration and unit tests to test fromJSON functionality in node environments only.

I did attempt to create pre-packaged bundles so that we can test in browser still, but unforunately the bundle includes the project name, and the project that we test against varies depending on the profile of tests that were running (prod, local, etc). If these don't match then an error is thrown.

API Changes

N/A

…e-parse

Can't easily test bundles client side. They can't be generated on the client. I tried pre-generating some but the bundle must align with the Firebase project name, and the Firebase project name varies across test targets (prod, local, etc).

changeset-bot · 2025-05-15T15:54:56Z

⚠️ No Changeset found

Latest commit: 158b491

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

github-actions · 2025-05-15T15:55:04Z

Vertex AI Mock Responses Check ⚠️

A newer major version of the mock responses for Vertex AI unit tests is available. update_vertexai_responses.sh should be updated to clone the latest version of the responses: v13.0

google-oss-bot · 2025-05-15T16:04:33Z

Size Report ¹

Affected Products

@firebase/firestore
Type Base (a49774f) Merge (517f865) Diff
browser 399 kB 395 kB -4.23 kB (-1.1%)
main 615 kB 615 kB +756 B (+0.1%)
module 399 kB 395 kB -4.23 kB (-1.1%)
react-native 399 kB 395 kB -4.23 kB (-1.1%)

`bundle`

Type	Base (`a49774f`)	Merge (`517f865`)	Diff
firestore (CSI Auto Indexing Disable and Delete)	298 kB	290 kB	-8.16 kB (-2.7%)
firestore (CSI Auto Indexing Enable)	298 kB	290 kB	-8.16 kB (-2.7%)
firestore (Persistence)	329 kB	321 kB	-7.96 kB (-2.4%)
firestore (Query Cursors)	264 kB	260 kB	-3.92 kB (-1.5%)
firestore (Query)	261 kB	258 kB	-3.92 kB (-1.5%)
firestore (Read data once)	255 kB	247 kB	-8.07 kB (-3.2%)
firestore (Read Write w Persistence)	345 kB	341 kB	-3.87 kB (-1.1%)
firestore (Realtime updates)	256 kB	248 kB	-8.07 kB (-3.2%)
firestore (Transaction)	232 kB	226 kB	-6.05 kB (-2.6%)
firestore (Write data)	233 kB	227 kB	-6.05 kB (-2.6%)

firebase
Type Base (a49774f) Merge (517f865) Diff
firebase-compat.js 810 kB 806 kB -3.83 kB (-0.5%)
firebase-firestore-compat.js 354 kB 350 kB -3.83 kB (-1.1%)
firebase-firestore.js 462 kB 458 kB -4.24 kB (-0.9%)

Test Logs

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

google-oss-bot · 2025-05-15T16:14:55Z

Size Analysis Report ¹

This report is too large (1,806,337 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/01mFgoykek.html

DellaBitta · 2025-05-19T13:47:50Z

packages/firestore/src/api/snapshot.ts

    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    const result: any = {};
    result['type'] = QuerySnapshot._jsonSchemaVersion;
    result['bundleSource'] = 'QuerySnapshot';
    result['bundleName'] = AutoId.newId();

-    const builder: BundleBuilder = new BundleBuilder(


The bundle code is now moved into a platform specific file so only for node environments. The other platforms produce a bundle string that simply reads NOT SUPPORTED.

MarkDuckworth

This is great!

DellaBitta added 27 commits April 18, 2025 14:47

Draft of synchronized bundle reader

fdaa937

Sync bundle reader stands alone

a888667

docsnapshot.FromJSON prototype

ab90498

Lint fixes.

5df33ec

Put more logic into bundle_impl.

7c8ef87

Templated converter DocSnapshot.fromJSON

f0d3304

Update bundleReader to be multi use utility

f80c49d

Update sync engine use of bundle loader.

be5aee8

typo fix

ad2f0ac

initial QuerySnapshot fromJSON impl

5ea4ea5

docgen

95b69f6

Merge branch 'ddb-firestore-result-serialization' into ddb-sync-bundl…

011ac37

…e-parse

QuerySnapshot jsonSchema

fccd633

Use jsonSchemas

51bc4bc

Remove need for toDocumentSnapshotData impl

019aa4d

Revised comments.

52bc217

Add QuerySnapshot.fromJSON converter variant.

90ade11

DocumentSet fix.

7ec7a0c

Unit tests.

d97009e

Non templated DocumentSnapshot.fromJSON

8a942f1

fromJSON integration tests

78626ef

remove fromJSONUsingConverter, user override.

5bf5767

DocumentReference fromJSON overload

4f27dc4

Created onSnapshotResume variant.

2840bb3

Move doc / querysnapshot fromJSON to func impl.

96a49f7

Implementation. Test fails client side.

df70734

Can't easily test bundles client side. They can't be generated on the client. I tried pre-generating some but the bundle must align with the Firebase project name, and the Firebase project name varies across test targets (prod, local, etc).

Remove tests on client side. Lint / format.

8e1e51a

DellaBitta added 5 commits May 15, 2025 13:35

converter feedback

8359b95

Test for specific exception text.

2fb5df3

format

04620bc

Merge branch 'ddb-sync-bundle-parse' into ddb-no-client-origin-bundles

fbd59e1

format

3c91ad4

Base automatically changed from ddb-sync-bundle-parse to ddb-firestore-result-serialization May 16, 2025 14:11

DellaBitta added 3 commits May 16, 2025 13:25

merge main

1615df9

format

618e3c2

merged console logging

158b491

DellaBitta commented May 19, 2025

View reviewed changes

DellaBitta requested a review from MarkDuckworth May 19, 2025 13:52

DellaBitta marked this pull request as ready for review May 19, 2025 13:52

DellaBitta requested review from a team as code owners May 19, 2025 13:52

MarkDuckworth approved these changes May 19, 2025

View reviewed changes

DellaBitta merged commit 38d8bc5 into ddb-firestore-result-serialization May 19, 2025
78 of 85 checks passed

DellaBitta deleted the ddb-no-client-origin-bundles branch May 19, 2025 18:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEAT] Restrict Firestore Doc/QuerySnapshot toJSON on client. #9048

[FEAT] Restrict Firestore Doc/QuerySnapshot toJSON on client. #9048

DellaBitta commented May 15, 2025 •

edited

Loading

changeset-bot bot commented May 15, 2025 •

edited

Loading

github-actions bot commented May 15, 2025

google-oss-bot commented May 15, 2025 •

edited

Loading

`@firebase/firestore`

`bundle`

`firebase`

google-oss-bot commented May 15, 2025 •

edited

Loading

DellaBitta May 19, 2025

MarkDuckworth left a comment

[FEAT] Restrict Firestore Doc/QuerySnapshot toJSON on client. #9048

[FEAT] Restrict Firestore Doc/QuerySnapshot toJSON on client. #9048

Conversation

DellaBitta commented May 15, 2025 • edited Loading

Discussion

Testing

API Changes

changeset-bot bot commented May 15, 2025 • edited Loading

⚠️ No Changeset found

github-actions bot commented May 15, 2025

Vertex AI Mock Responses Check ⚠️

google-oss-bot commented May 15, 2025 • edited Loading

Size Report 1

Affected Products

@firebase/firestore

bundle

firebase

Test Logs

google-oss-bot commented May 15, 2025 • edited Loading

Size Analysis Report 1

Test Logs

DellaBitta May 19, 2025

Choose a reason for hiding this comment

MarkDuckworth left a comment

Choose a reason for hiding this comment

DellaBitta commented May 15, 2025 •

edited

Loading

changeset-bot bot commented May 15, 2025 •

edited

Loading

google-oss-bot commented May 15, 2025 •

edited

Loading

Size Report ¹

`@firebase/firestore`

`bundle`

`firebase`

google-oss-bot commented May 15, 2025 •

edited

Loading

Size Analysis Report ¹