Skip to content

Merge firestore bundles implementation without exposing public APIs #3594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 41 commits into from
Nov 12, 2020
Merged

Merge firestore bundles implementation without exposing public APIs #3594

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
f347dea
Add bundle.proto d.ts and introduce IDB object stores for bundles. (…
wu-hui May 21, 2020
b0c8299
Implement a bundle reader for Web (#3097)
wu-hui Jun 5, 2020
2f179bc
Enable bundle reader for Node. (#3167)
wu-hui Jun 10, 2020
d3f0ab4
Implement BundleCache for IDB and memory. (#3170)
wu-hui Jun 14, 2020
6c375b9
Merge branch 'master' into wuandy/Bundles
wu-hui Jun 24, 2020
e8b9ec2
Implement bundle features in local store. (#3200)
wu-hui Jun 25, 2020
2e73801
Merge branch 'master' into wuandy/Bundles
wu-hui Jun 26, 2020
fff6b1b
Merge branch 'master' into wuandy/Bundles
wu-hui Jun 29, 2020
3a78d7c
Fix firestore_bundle_proto rollup issue. (#3316)
wu-hui Jun 29, 2020
0bf9c73
Implement bundle loading. (#3201)
wu-hui Jul 11, 2020
2bfa185
Merge branch 'master' into wuandy/Bundles
wu-hui Jul 11, 2020
9bfb995
Bundles load from secondary tabs (#3393)
wu-hui Jul 23, 2020
a9bf16c
Merge branch 'master' into wuandy/Bundles
wu-hui Jul 24, 2020
8b8a097
Make loadBundle work with exp build (#3488)
wu-hui Jul 28, 2020
5ebf8c3
Bundle's named query resume. (#3395)
wu-hui Aug 6, 2020
8cfb471
Merge branch 'master' into wuandy/Bundles
wu-hui Aug 10, 2020
2bec6d8
Merge remote-tracking branch 'origin/wuandy/Bundles' into wuandy/Bundles
wu-hui Aug 10, 2020
0f697df
Merge with named query change.
wu-hui Aug 10, 2020
dc02c03
Add missing byte_stream_reader.ts for *_lite platforms
wu-hui Aug 10, 2020
15b96a9
Finally builds and passes
wu-hui Aug 11, 2020
b4f9936
Update query-document mapping from bundles. (#3620)
wu-hui Aug 14, 2020
ef202a1
Merge branch 'master' into wuandy/Bundles
wu-hui Aug 17, 2020
c4b0995
Introduce an umbrella target for bundled documents (#3643)
wu-hui Aug 19, 2020
4e09f58
Merge branch 'master' into wuandy/Bundles
wu-hui Oct 8, 2020
775d58a
Restore some files from master
wu-hui Oct 8, 2020
5dd5c9c
Fix build errors
wu-hui Oct 8, 2020
e53cf69
Fix lint errors
wu-hui Oct 8, 2020
4bbcdc0
Merge branch 'master' into wuandy/Bundles
wu-hui Oct 8, 2020
bd6adc6
Hide bundles from public API
wu-hui Oct 9, 2020
259160b
Fix build error.
wu-hui Oct 9, 2020
9a804fc
Add bundle proto to extern, version upgrade and make exp bundle public
wu-hui Oct 13, 2020
72fb466
Merge branch 'master' into wuandy/Bundles
wu-hui Oct 20, 2020
3b208b2
Fix lint error
wu-hui Oct 20, 2020
223bc9a
Move bundle integration tests under api/ and complete exp API (#3962)
wu-hui Oct 27, 2020
b80c880
Merge branch 'master' into wuandy/Bundles
wu-hui Oct 29, 2020
5b0526b
Bundles as free functions (#4006)
wu-hui Nov 9, 2020
089fcdd
Merge branch 'master' into wuandy/Bundles
wu-hui Nov 9, 2020
80dc41d
Address comments
wu-hui Nov 9, 2020
d4ab17f
Remove bundles from public interfaces.
wu-hui Nov 11, 2020
1b3d633
Remove bundles from public interfaces take 2.
wu-hui Nov 12, 2020
205d1c8
Merge branch 'master' into wuandy/Bundles
wu-hui Nov 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions integration/firestore/firebase_export.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,5 @@ const Timestamp = firebase.firestore.Timestamp;
const GeoPoint = firebase.firestore.GeoPoint;
const FieldValue = firebase.firestore.FieldValue;
const Blob = firebase.firestore.Blob;
const loadBundle = firebase.firestore.loadBundle;
const namedQuery = firebase.firestore.namedQuery;

export {
Firestore,
FieldValue,
FieldPath,
Timestamp,
Blob,
GeoPoint,
loadBundle,
namedQuery
};
export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint };
13 changes: 1 addition & 12 deletions integration/firestore/firebase_export_memory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,5 @@ const Timestamp = firebase.firestore.Timestamp;
const GeoPoint = firebase.firestore.GeoPoint;
const FieldValue = firebase.firestore.FieldValue;
const Blob = firebase.firestore.Blob;
const loadBundle = firebase.firestore.loadBundle;
const namedQuery = firebase.firestore.namedQuery;

export {
Firestore,
FieldValue,
FieldPath,
Timestamp,
Blob,
GeoPoint,
loadBundle,
namedQuery
};
export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint };
10 changes: 0 additions & 10 deletions packages/firestore-types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,16 +99,6 @@ export class FirebaseFirestore {
INTERNAL: { delete: () => Promise<void> };
}

export function loadBundle(
db: FirebaseFirestore,
bundleData: ArrayBuffer | ReadableStream<ArrayBuffer> | string
): LoadBundleTask;

export function namedQuery(
db: FirebaseFirestore,
name: string
): Promise<Query<DocumentData> | null>;

export interface LoadBundleTask {
onProgress(
next?: (progress: LoadBundleTaskProgress) => any,
Expand Down
3 changes: 1 addition & 2 deletions packages/firestore/exp/test/shim.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,9 @@ import {
validateSetOptions
} from '../../src/util/input_validation';
import { Compat } from '../../src/compat/compat';
import { Firestore, loadBundle, namedQuery } from '../../src/api/database';
import { Firestore } from '../../src/api/database';

export { GeoPoint, Timestamp } from '../index';
export { loadBundle, namedQuery };

/* eslint-disable @typescript-eslint/no-explicit-any */

Expand Down
2 changes: 0 additions & 2 deletions packages/firestore/register-module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ declare module '@firebase/app-types' {
Transaction: typeof types.Transaction;
WriteBatch: typeof types.WriteBatch;
setLogLevel: typeof types.setLogLevel;
loadBundle: typeof types.loadBundle;
namedQuery: typeof types.namedQuery;
};
}
interface FirebaseApp {
Expand Down
35 changes: 1 addition & 34 deletions packages/firestore/src/api/database.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ import {
firestoreClientGetDocumentViaSnapshotListener,
firestoreClientListen,
firestoreClientTransaction,
firestoreClientWrite,
firestoreClientLoadBundle,
firestoreClientGetNamedQuery
firestoreClientWrite
} from '../core/firestore_client';
import {
Bound,
Expand Down Expand Up @@ -143,7 +141,6 @@ import {
import { newUserDataReader } from '../../lite/src/api/reference';
import { makeDatabaseInfo } from '../../lite/src/api/database';
import { DEFAULT_HOST } from '../../lite/src/api/components';
import { LoadBundleTask } from './bundle';

/**
* Constant used to indicate the LRU garbage collection should be disabled.
Expand Down Expand Up @@ -427,36 +424,6 @@ export function setLogLevel(level: PublicLogLevel): void {
setClientLogLevel(level);
}

export function loadBundle(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can keep these functions as long as they are not referenced.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

db: Firestore,
bundleData: ArrayBuffer | ReadableStream<Uint8Array> | string
): LoadBundleTask {
const resultTask = new LoadBundleTask();
// eslint-disable-next-line @typescript-eslint/no-floating-promises
firestoreClientLoadBundle(
ensureFirestoreConfigured(db._delegate),
bundleData,
resultTask
);
return resultTask;
}

export function namedQuery(
db: Firestore,
name: string
): Promise<PublicQuery | null> {
return firestoreClientGetNamedQuery(
ensureFirestoreConfigured(db._delegate),
name
).then(namedQuery => {
if (!namedQuery) {
return null;
}

return new Query(namedQuery.query, db, null);
});
}

/**
* A reference to a transaction.
*/
Expand Down
4 changes: 0 additions & 4 deletions packages/firestore/src/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ import {
QuerySnapshot,
Transaction,
WriteBatch,
loadBundle,
namedQuery,
setLogLevel
} from './api/database';
import { Blob } from './api/blob';
Expand All @@ -56,8 +54,6 @@ const firestoreNamespace = {
FieldPath,
FieldValue,
setLogLevel,
loadBundle,
namedQuery,
CACHE_SIZE_UNLIMITED
};

Expand Down
Loading