Remove Cyclic Dependencies (#4160)

Author: schmidt-sebastian

packages/firestore/exp/index.ts

@@ -19,7 +19,7 @@ import { registerFirestore } from './register';
 
 registerFirestore();
 
-export { FieldPath, documentId } from '../lite/src/api/field_path';
+export { FieldPath, documentId } from './src/api/field_path';
 
 export {
   FirebaseFirestore,
@@ -31,11 +31,11 @@ export {
   waitForPendingWrites,
   disableNetwork,
   enableNetwork,
-  terminate,
-  Settings,
-  PersistenceSettings
+  terminate
 } from './src/api/database';
 
+export { Settings, PersistenceSettings } from './src/api/settings';
+
 export {
   DocumentChange,
   DocumentSnapshot,
@@ -44,41 +44,46 @@ export {
   snapshotEqual,
   SnapshotOptions,
   FirestoreDataConverter,
-  DocumentChangeType
+  DocumentChangeType,
+  SnapshotMetadata
 } from './src/api/snapshot';
 
-export { SnapshotMetadata } from '../src/api/database';
-
 export {
   DocumentReference,
   CollectionReference,
-  QueryConstraint,
   Query,
   doc,
   collection,
   collectionGroup,
-  startAt,
-  startAfter,
+  SetOptions,
+  DocumentData,
+  UpdateData,
+  refEqual,
+  queryEqual
+} from './src/api/reference';
+
+export {
   endAt,
   endBefore,
-  query,
+  startAt,
+  startAfter,
   limit,
   limitToLast,
   where,
   orderBy,
-  SetOptions,
+  query,
+  QueryConstraint,
   QueryConstraintType,
-  DocumentData,
-  UpdateData,
   OrderByDirection,
   WhereFilterOp
-} from '../lite/src/api/reference';
+} from './src/api/query';
 
 export { Unsubscribe } from '../src/api/observer';
 
 export { runTransaction, Transaction } from './src/api/transaction';
 
 export {
+  SnapshotListenOptions,
   getDoc,
   getDocFromCache,
   getDocFromServer,
@@ -91,33 +96,28 @@ export {
   updateDoc,
   deleteDoc,
   addDoc
-} from './src/api/reference';
+} from './src/api/reference_impl';
+
+export { FieldValue } from './src/api/field_value';
 
 export {
-  FieldValue,
-  deleteField,
   increment,
   arrayRemove,
   arrayUnion,
-  serverTimestamp
-} from '../lite/src/api/field_value';
+  serverTimestamp,
+  deleteField
+} from './src/api/field_value_impl';
 
 export { setLogLevel, LogLevelString as LogLevel } from '../src/util/log';
 
-export { Bytes } from '../lite/src/api/bytes';
+export { Bytes } from './src/api/bytes';
 
-export { writeBatch } from './src/api/write_batch';
-
-export { WriteBatch } from '../lite/src/api/write_batch';
+export { WriteBatch, writeBatch } from './src/api/write_batch';
 
 export { GeoPoint } from '../src/api/geo_point';
 
 export { Timestamp } from '../src/api/timestamp';
 
-export { refEqual, queryEqual } from '../lite/src/api/reference';
-
-export { SnapshotListenOptions } from './src/api/reference';
-
-export { CACHE_SIZE_UNLIMITED } from '../src/api/database';
+export { CACHE_SIZE_UNLIMITED } from './src/api/database';
 
 export { FirestoreErrorCode, FirestoreError } from '../src/util/error';

packages/firestore/exp/src/api/bytes.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { Bytes } from '../../../lite/src/api/bytes';

packages/firestore/exp/src/api/database.ts

@@ -28,52 +28,48 @@ import {
   setOfflineComponentProvider,
   setOnlineComponentProvider
 } from '../../../src/core/firestore_client';
-import { AsyncQueue } from '../../../src/util/async_queue';
 import {
   IndexedDbOfflineComponentProvider,
   MultiTabOfflineComponentProvider,
   OfflineComponentProvider,
   OnlineComponentProvider
 } from '../../../src/core/component_provider';
-import {
-  FirebaseFirestore as LiteFirestore,
-  Settings as LiteSettings
-} from '../../../lite/src/api/database';
+import { FirebaseFirestore as LiteFirestore } 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
-} from '../../../src/api/database';
+import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector_impl';
 import {
   indexedDbClearPersistence,
   indexedDbStoragePrefix
 } from '../../../src/local/indexeddb_persistence';
 import { cast } from '../../../src/util/input_validation';
+import { makeDatabaseInfo } from '../../../lite/src/api/components';
+import { LRU_COLLECTION_DISABLED } from '../../../src/local/lru_garbage_collector';
+import { debugAssert } from '../../../src/util/assert';
+import { PersistenceSettings, Settings } from './settings';
+import { newAsyncQueue } from '../../../src/util/async_queue_impl';
+import { AsyncQueue } from '../../../src/util/async_queue';
 
 /** DOMException error code constants. */
 const DOM_EXCEPTION_INVALID_STATE = 11;
 const DOM_EXCEPTION_ABORTED = 20;
 const DOM_EXCEPTION_QUOTA_EXCEEDED = 22;
 
-export interface PersistenceSettings {
-  forceOwnership?: boolean;
-}
-
-export interface Settings extends LiteSettings {
-  cacheSizeBytes?: number;
-}
+/**
+ * Constant used to indicate the LRU garbage collection should be disabled.
+ * Set this value as the `cacheSizeBytes` on the settings passed to the
+ * `Firestore` instance.
+ */
+export const CACHE_SIZE_UNLIMITED = LRU_COLLECTION_DISABLED;
 
 /**
  * The Cloud Firestore service interface.
  *
  * Do not call this constructor directly. Instead, use {@link getFirestore}.
  */
 export class FirebaseFirestore extends LiteFirestore {
-  readonly _queue = new AsyncQueue();
+  readonly _queue: AsyncQueue = newAsyncQueue();
   readonly _persistenceKey: string;
 
   _firestoreClient: FirestoreClient | undefined;
@@ -146,6 +142,36 @@ export function getFirestore(app: FirebaseApp): FirebaseFirestore {
   return _getProvider(app, 'firestore-exp').getImmediate() as FirebaseFirestore;
 }
 
+export function ensureFirestoreConfigured(
+  firestore: FirebaseFirestore
+): FirestoreClient {
+  if (!firestore._firestoreClient) {
+    configureFirestore(firestore);
+  }
+  firestore._firestoreClient!.verifyNotTerminated();
+  return firestore._firestoreClient as FirestoreClient;
+}
+
+export function configureFirestore(firestore: FirebaseFirestore): void {
+  const settings = firestore._freezeSettings();
+  debugAssert(!!settings.host, 'FirestoreSettings.host is not set');
+  debugAssert(
+    !firestore._firestoreClient,
+    'configureFirestore() called multiple times'
+  );
+
+  const databaseInfo = makeDatabaseInfo(
+    firestore._databaseId,
+    firestore._persistenceKey,
+    settings
+  );
+  firestore._firestoreClient = new FirestoreClient(
+    firestore._credentials,
+    firestore._queue,
+    databaseInfo
+  );
+}
+
 /**
  * Attempts to enable persistent storage, if possible.
  *

packages/firestore/exp/src/api/field_path.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { FieldPath, documentId } from '../../../lite/src/api/field_path';

packages/firestore/exp/src/api/field_value.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { FieldValue } from '../../../lite/src/api/field_value';

packages/firestore/exp/src/api/field_value_impl.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export {
+  increment,
+  arrayRemove,
+  arrayUnion,
+  serverTimestamp,
+  deleteField
+} from '../../../lite/src/api/field_value_impl';

packages/firestore/exp/src/api/query.ts

@@ -0,0 +1,32 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export {
+  endAt,
+  endBefore,
+  startAfter,
+  startAt,
+  limitToLast,
+  limit,
+  orderBy,
+  OrderByDirection,
+  where,
+  WhereFilterOp,
+  query,
+  QueryConstraint,
+  QueryConstraintType
+} from '../../../lite/src/api/query';