Skip to content

Compat Layer for Firestore #4003

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 6 commits into from
Nov 4, 2020
Merged

Compat Layer for Firestore #4003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8305a4f
Compat Layer for Firestore
schmidt-sebastian Nov 2, 2020
a91f02d
Address some of the feedback
schmidt-sebastian Nov 2, 2020
07dfa9f
Lint
schmidt-sebastian Nov 3, 2020
0fb56e1
Fix test build
schmidt-sebastian Nov 4, 2020
36fb4c7
Add app-compat hack (#4036)
hsubox76 Nov 4, 2020
869d59c
Add buildAppCompat flag to Firestore test workflows (#4037)
hsubox76 Nov 4, 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
2 changes: 1 addition & 1 deletion .github/workflows/test-changed-firestore-integration.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ jobs:
cp config/ci.config.json config/project.json
yarn
- name: build
run: yarn build:changed firestore-integration --buildAppExp
run: yarn build:changed firestore-integration --buildAppExp --buildAppCompat
- name: Run tests if firestore or its dependencies has changed
run: yarn test:changed firestore-integration
2 changes: 1 addition & 1 deletion .github/workflows/test-changed-firestore.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ jobs:
cp config/ci.config.json config/project.json
yarn
- name: build
run: yarn build:changed firestore --buildAppExp
run: yarn build:changed firestore --buildAppExp --buildAppCompat
- name: Run tests if firestore or its dependencies has changed
run: yarn test:changed firestore
25 changes: 13 additions & 12 deletions packages/firestore/exp/src/api/database.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ import {
FirebaseFirestore as LiteFirestore,
Settings as LiteSettings
} from '../../../lite/src/api/database';
import { DatabaseId } from '../../../src/core/database_info';
import { Code, FirestoreError } from '../../../src/util/error';
import { Deferred } from '../../../src/util/promise';
import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector';
import {
CACHE_SIZE_UNLIMITED,
configureFirestore,
ensureFirestoreConfigured,
FirestoreCompat
ensureFirestoreConfigured
} from '../../../src/api/database';
import {
indexedDbClearPersistence,
Expand All @@ -70,18 +70,19 @@ export interface Settings extends LiteSettings {
*/
export class FirebaseFirestore
extends LiteFirestore
implements _FirebaseService, FirestoreCompat {
implements _FirebaseService {
readonly _queue = new AsyncQueue();
readonly _persistenceKey: string;

_firestoreClient: FirestoreClient | undefined;

constructor(
app: FirebaseApp,
databaseIdOrApp: DatabaseId | FirebaseApp,
authProvider: Provider<FirebaseAuthInternalName>
) {
super(app, authProvider);
this._persistenceKey = app.name;
super(databaseIdOrApp, authProvider);
this._persistenceKey =
'name' in databaseIdOrApp ? databaseIdOrApp.name : '[DEFAULT]';
}

_terminate(): Promise<void> {
Expand Down Expand Up @@ -165,13 +166,13 @@ export function getFirestore(app: FirebaseApp): FirebaseFirestore {
* @return A promise that represents successfully enabling persistent storage.
*/
export function enableIndexedDbPersistence(
firestore: FirestoreCompat,
firestore: FirebaseFirestore,
persistenceSettings?: PersistenceSettings
): Promise<void> {
verifyNotInitialized(firestore);

const client = ensureFirestoreConfigured(firestore);
const settings = firestore._getSettings();
const settings = firestore._freezeSettings();

const onlineComponentProvider = new OnlineComponentProvider();
const offlineComponentProvider = new IndexedDbOfflineComponentProvider(
Expand Down Expand Up @@ -209,12 +210,12 @@ export function enableIndexedDbPersistence(
* storage.
*/
export function enableMultiTabIndexedDbPersistence(
firestore: FirestoreCompat
firestore: FirebaseFirestore
): Promise<void> {
verifyNotInitialized(firestore);

const client = ensureFirestoreConfigured(firestore);
const settings = firestore._getSettings();
const settings = firestore._freezeSettings();

const onlineComponentProvider = new OnlineComponentProvider();
const offlineComponentProvider = new MultiTabOfflineComponentProvider(
Expand Down Expand Up @@ -322,7 +323,7 @@ function canFallbackFromIndexedDbError(
* cleared. Otherwise, the promise is rejected with an error.
*/
export function clearIndexedDbPersistence(
firestore: FirestoreCompat
firestore: FirebaseFirestore
): Promise<void> {
if (firestore._initialized && !firestore._terminated) {
throw new FirestoreError(
Expand Down Expand Up @@ -420,7 +421,7 @@ export function terminate(firestore: FirebaseFirestore): Promise<void> {
return firestore._delete();
}

function verifyNotInitialized(firestore: FirestoreCompat): void {
function verifyNotInitialized(firestore: FirebaseFirestore): void {
if (firestore._initialized || firestore._terminated) {
throw new FirestoreError(
Code.FAILED_PRECONDITION,
Expand Down
Loading