Fixing circular dependency errors in the build.

Author: MarkDuckworth

packages/firestore/src/api/snapshot.ts

@@ -31,10 +31,12 @@ import {
 import { LiteUserDataWriter } from '../lite-api/reference_impl';
 import {
   DocumentSnapshot as LiteDocumentSnapshot,
-  fieldPathFromArgument,
   FirestoreDataConverter as LiteFirestoreDataConverter
 } from '../lite-api/snapshot';
-import { UntypedFirestoreDataConverter } from '../lite-api/user_data_reader';
+import {
+  fieldPathFromArgument,
+  UntypedFirestoreDataConverter
+} from '../lite-api/user_data_reader';
 import { AbstractUserDataWriter } from '../lite-api/user_data_writer';
 import { fromBundledQuery } from '../local/local_serializer';
 import { documentKeySet } from '../model/collections';

packages/firestore/src/lite-api/expressions.ts

@@ -7272,3 +7272,48 @@ export class Ordering implements ProtoValueSerializable, UserData {
 
   _protoValueType: 'ProtoValue' = 'ProtoValue';
 }
+
+export function isSelectable(val: unknown): val is Selectable {
+  const candidate = val as Selectable;
+  return (
+    candidate.selectable && isString(candidate.alias) && isExpr(candidate.expr)
+  );
+}
+
+export function isOrdering(val: unknown): val is Ordering {
+  const candidate = val as Ordering;
+  return (
+    isExpr(candidate.expr) &&
+    (candidate.direction === 'ascending' ||
+      candidate.direction === 'descending')
+  );
+}
+
+export function isAliasedAggregate(val: unknown): val is AggregateWithAlias {
+  const candidate = val as AggregateWithAlias;
+  return (
+    isString(candidate.alias) &&
+    candidate.aggregate instanceof AggregateFunction
+  );
+}
+
+export function isExpr(val: unknown): val is Expression {
+  return val instanceof Expression;
+}
+
+export function isBooleanExpr(val: unknown): val is BooleanExpression {
+  return val instanceof BooleanExpression;
+}
+
+export function isField(val: unknown): val is Field {
+  return val instanceof Field;
+}
+
+export function toField(value: string | Field): Field {
+  if (isString(value)) {
+    const result = field(value);
+    return result;
+  } else {
+    return value as Field;
+  }
+}

packages/firestore/src/lite-api/pipeline-result.ts

@@ -18,12 +18,12 @@
 import { ObjectValue } from '../model/object_value';
 import { isOptionalEqual } from '../util/misc';
 
-import { Field } from './expressions';
+import { Field, isField } from './expressions';
 import { FieldPath } from './field_path';
 import { Pipeline } from './pipeline';
 import { DocumentData, DocumentReference, refEqual } from './reference';
-import { fieldPathFromArgument } from './snapshot';
 import { Timestamp } from './timestamp';
+import { fieldPathFromArgument } from './user_data_reader';
 import { AbstractUserDataWriter } from './user_data_writer';
 
 export class PipelineSnapshot {
@@ -200,6 +200,9 @@ export class PipelineResult<AppModelType = DocumentData> {
     if (this._fields === undefined) {
       return undefined;
     }
+    if (isField(fieldPath)) {
+      fieldPath = fieldPath.fieldName;
+    }
 
     const value = this._fields.field(
       fieldPathFromArgument('DocumentSnapshot.get', fieldPath)

packages/firestore/src/lite-api/pipeline-source.ts

@@ -18,10 +18,15 @@
 import { DatabaseId } from '../core/database_info';
 import { toPipeline } from '../core/pipeline-util';
 import { Code, FirestoreError } from '../util/error';
-import { isCollectionReference, isString } from '../util/types';
+import { isString } from '../util/types';
 
 import { Pipeline } from './pipeline';
-import { CollectionReference, DocumentReference, Query } from './reference';
+import {
+  CollectionReference,
+  DocumentReference,
+  isCollectionReference,
+  Query
+} from './reference';
 import {
   CollectionGroupSource,
   CollectionSource,

packages/firestore/src/lite-api/pipeline.ts

@@ -29,17 +29,7 @@ import {
   selectablesToMap,
   vectorToExpr
 } from '../util/pipeline_util';
-import {
-  isAliasedAggregate,
-  isBooleanExpr,
-  isExpr,
-  isField,
-  isLitePipeline,
-  isOrdering,
-  isSelectable,
-  isString,
-  toField
-} from '../util/types';
+import { isString } from '../util/types';
 
 import { Firestore } from './database';
 import {
@@ -53,7 +43,14 @@ import {
   field,
   Ordering,
   Selectable,
-  _field
+  _field,
+  isSelectable,
+  isField,
+  isBooleanExpr,
+  isAliasedAggregate,
+  toField,
+  isOrdering,
+  isExpr
 } from './expressions';
 import {
   AddFields,
@@ -1214,7 +1211,7 @@ export class Pipeline implements ProtoSerializable<ProtoPipeline> {
     // Process argument union(s) from method overloads
     let options: {};
     let otherPipeline: Pipeline;
-    if (isLitePipeline(otherOrOptions)) {
+    if (isPipeline(otherOrOptions)) {
       options = {};
       otherPipeline = otherOrOptions;
     } else {
@@ -1437,3 +1434,7 @@ export class Pipeline implements ProtoSerializable<ProtoPipeline> {
     return new Pipeline(db, userDataReader, userDataWriter, stages);
   }
 }
+
+export function isPipeline(val: unknown): val is Pipeline {
+  return val instanceof Pipeline;
+}

packages/firestore/src/lite-api/query.ts

@@ -52,8 +52,9 @@ import {
 
 import { FieldPath } from './field_path';
 import { DocumentData, DocumentReference, Query } from './reference';
-import { DocumentSnapshot, fieldPathFromArgument } from './snapshot';
+import { DocumentSnapshot } from './snapshot';
 import {
+  fieldPathFromArgument,
   newUserDataReader,
   parseQueryValue,
   UserDataReader

packages/firestore/src/lite-api/reference.ts

@@ -440,6 +440,12 @@ export class CollectionReference<
   }
 }
 
+export function isCollectionReference(
+  val: unknown
+): val is CollectionReference {
+  return val instanceof CollectionReference;
+}
+
 /**
  * Gets a `CollectionReference` instance that refers to the collection at
  * the specified absolute path.

packages/firestore/src/lite-api/snapshot.ts

@@ -15,15 +15,13 @@
  * limitations under the License.
  */
 
-import { Compat, getModularInstance } from '@firebase/util';
+import { getModularInstance } from '@firebase/util';
 
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
-import { FieldPath as InternalFieldPath } from '../model/path';
 import { arrayEquals } from '../util/misc';
 
 import { Firestore } from './database';
-import { Field } from './expressions';
 import { FieldPath } from './field_path';
 import {
   DocumentData,
@@ -35,7 +33,7 @@ import {
   WithFieldValue
 } from './reference';
 import {
-  fieldPathFromDotSeparatedString,
+  fieldPathFromArgument,
   UntypedFirestoreDataConverter
 } from './user_data_reader';
 import { AbstractUserDataWriter } from './user_data_writer';
@@ -510,21 +508,3 @@ export function snapshotEqual<AppModelType, DbModelType extends DocumentData>(
 
   return false;
 }
-
-/**
- * Helper that calls `fromDotSeparatedString()` but wraps any error thrown.
- */
-export function fieldPathFromArgument(
-  methodName: string,
-  arg: string | FieldPath | Compat<FieldPath> | Field
-): InternalFieldPath {
-  if (typeof arg === 'string') {
-    return fieldPathFromDotSeparatedString(methodName, arg);
-  } else if (arg instanceof FieldPath) {
-    return arg._internalPath;
-  } else if (arg instanceof Field) {
-    return fieldPathFromDotSeparatedString(methodName, arg.fieldName);
-  } else {
-    return arg._delegate._internalPath;
-  }
-}

packages/firestore/src/util/types.ts

@@ -15,19 +15,6 @@
  * limitations under the License.
  */
 
-import { CollectionReference } from '../api';
-import {
-  AggregateFunction,
-  AggregateWithAlias,
-  BooleanExpression,
-  Expression,
-  field,
-  Field,
-  Ordering,
-  Selectable
-} from '../lite-api/expressions';
-import { Pipeline as LitePipeline } from '../lite-api/pipeline';
-
 /** Sentinel value that sorts before any Mutation Batch ID. */
 export const BATCHID_UNKNOWN = -1;
 
@@ -97,58 +84,3 @@ export type OneOf<T> = {
     [P in Exclude<keyof T, K>]?: undefined;
   };
 }[keyof T];
-
-export function isSelectable(val: unknown): val is Selectable {
-  const candidate = val as Selectable;
-  return (
-    candidate.selectable && isString(candidate.alias) && isExpr(candidate.expr)
-  );
-}
-
-export function isOrdering(val: unknown): val is Ordering {
-  const candidate = val as Ordering;
-  return (
-    isExpr(candidate.expr) &&
-    (candidate.direction === 'ascending' ||
-      candidate.direction === 'descending')
-  );
-}
-
-export function isAliasedAggregate(val: unknown): val is AggregateWithAlias {
-  const candidate = val as AggregateWithAlias;
-  return (
-    isString(candidate.alias) &&
-    candidate.aggregate instanceof AggregateFunction
-  );
-}
-
-export function isExpr(val: unknown): val is Expression {
-  return val instanceof Expression;
-}
-
-export function isBooleanExpr(val: unknown): val is BooleanExpression {
-  return val instanceof BooleanExpression;
-}
-
-export function isField(val: unknown): val is Field {
-  return val instanceof Field;
-}
-
-export function isLitePipeline(val: unknown): val is LitePipeline {
-  return val instanceof LitePipeline;
-}
-
-export function isCollectionReference(
-  val: unknown
-): val is CollectionReference {
-  return val instanceof CollectionReference;
-}
-
-export function toField(value: string | Field): Field {
-  if (isString(value)) {
-    const result = field(value);
-    return result;
-  } else {
-    return value as Field;
-  }
-}