Merge

Author: schmidt-sebastian

packages/firestore/exp/index.d.ts

@@ -52,7 +52,13 @@ export interface SnapshotMetadata {
   isEqual(other: SnapshotMetadata): boolean;
 }
 
-export type LogLevel = 'debug' | 'error' | 'silent';
+export type LogLevel =
+  | 'debug'
+  | 'error'
+  | 'silent'
+  | 'warn'
+  | 'info'
+  | 'verbose';
 
 export function setLogLevel(logLevel: LogLevel): void;
 

packages/firestore/lite/index.d.ts

@@ -33,7 +33,13 @@ export interface Settings {
   ignoreUndefinedProperties?: boolean;
 }
 
-export type LogLevel = 'debug' | 'error' | 'silent';
+export type LogLevel =
+  | 'debug'
+  | 'error'
+  | 'silent'
+  | 'warn'
+  | 'info'
+  | 'verbose';
 
 export function setLogLevel(logLevel: LogLevel): void;
 

packages/firestore/lite/index.node.ts

@@ -38,13 +38,6 @@ export {
   getDoc
 } from './src/api/reference';
 
-export { FieldPath } from './src/api/field_path';
-
-// TOOD(firestorelite): Add tests when Queries are usable
-export { documentId } from './src/api/field_path';
-
-export { DocumentSnapshot, QueryDocumentSnapshot } from './src/api/snapshot';
-
 // TOOD(firestorelite): Add tests when setDoc() is available
 export {
   FieldValue,
@@ -55,6 +48,10 @@ export {
   serverTimestamp
 } from './src/api/field_value';
 
+export { DocumentSnapshot, QueryDocumentSnapshot } from './src/api/snapshot';
+
+export { setLogLevel } from '../src/util/log';
+
 export function registerFirestore(): void {
   _registerComponent(
     new Component(

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

@@ -17,7 +17,7 @@
 
 import * as firestore from '../../index';
 
-import { tryCast } from './util';
+import { cast } from './util';
 import {
   DOCUMENT_KEY_NAME,
   FieldPath as InternalFieldPath
@@ -54,21 +54,20 @@ export class FieldPath implements firestore.FieldPath {
       1
     );
 
-    for (let i = 0; i < fieldNames.length; ++i) {
-      if (fieldNames[i].length === 0) {
-        throw new FirestoreError(
-          Code.INVALID_ARGUMENT,
-          `Invalid field name at argument $(i + 1). ` +
-            'Field names must not be empty.'
-        );
-      }
+    const emptyElement = fieldNames.indexOf('');
+    if (emptyElement !== -1) {
+      throw new FirestoreError(
+        Code.INVALID_ARGUMENT,
+        `Invalid field name at argument $(i + 1). ` +
+          'Field names must not be empty.'
+      );
     }
 
     this._internalPath = new InternalFieldPath(fieldNames);
   }
 
   isEqual(other: firestore.FieldPath): boolean {
-    const path = tryCast(other, FieldPath);
+    const path = cast(other, FieldPath);
     return this._internalPath.isEqual(path._internalPath);
   }
 }

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

@@ -24,12 +24,16 @@ import { DocumentKeyReference } from '../../../src/api/user_data_reader';
 import { Query as InternalQuery } from '../../../src/core/query';
 import { FirebaseFirestore, FirestoreDataConverter } from '../../index';
 import { ResourcePath } from '../../../src/model/path';
-import { Code, FirestoreError } from '../../../src/util/error';
 import { AutoId } from '../../../src/util/misc';
-import { tryCast } from './util';
 import { DocumentSnapshot } from './snapshot';
 import { invokeBatchGetDocumentsRpc } from '../../../src/remote/datastore';
 import { hardAssert } from '../../../src/util/assert';
+import { cast } from './util';
+import {
+  validateArgType,
+  validateCollectionPath,
+  validateDocumentPath
+} from '../../../src/util/input_validation';
 
 /**
  * A reference to a particular document in a collection in the database.
@@ -170,31 +174,15 @@ export function collection(
   parent: firestore.FirebaseFirestore | firestore.DocumentReference<unknown>,
   relativePath: string
 ): CollectionReference<firestore.DocumentData> {
-  if (relativePath.length === 0) {
-    throw new FirestoreError(
-      Code.INVALID_ARGUMENT,
-      `Invalid path (${relativePath}). Empty paths are not supported.`
-    );
-  }
-
+  validateArgType('doc', 'non-empty string', 2, relativePath);
   const path = ResourcePath.fromString(relativePath);
   if (parent instanceof Firestore) {
-    if (DocumentKey.isDocumentKey(path)) {
-      throw new FirestoreError(
-        Code.INVALID_ARGUMENT,
-        `Invalid path (${path}). Path points to a document.`
-      );
-    }
+    validateCollectionPath(path);
     return new CollectionReference(parent, path);
   } else {
-    const doc = tryCast(parent, DocumentReference);
+    const doc = cast(parent, DocumentReference);
     const absolutePath = doc._key.path.child(path);
-    if (DocumentKey.isDocumentKey(absolutePath)) {
-      throw new FirestoreError(
-        Code.INVALID_ARGUMENT,
-        `Invalid path (${absolutePath}). Path points to a document.`
-      );
-    }
+    validateCollectionPath(absolutePath);
     return new CollectionReference(doc.firestore, absolutePath);
   }
 }
@@ -216,32 +204,15 @@ export function doc<T>(
   if (arguments.length === 1) {
     relativePath = AutoId.newId();
   }
-
-  if (!relativePath) {
-    throw new FirestoreError(
-      Code.INVALID_ARGUMENT,
-      `Invalid path (${relativePath}). Empty paths are not supported.`
-    );
-  }
-
-  const path = ResourcePath.fromString(relativePath);
+  validateArgType('doc', 'non-empty string', 2, relativePath);
+  const path = ResourcePath.fromString(relativePath!);
   if (parent instanceof Firestore) {
-    if (!DocumentKey.isDocumentKey(path)) {
-      throw new FirestoreError(
-        Code.INVALID_ARGUMENT,
-        `Invalid path (${path}). Path points to a collection.`
-      );
-    }
+    validateDocumentPath(path);
     return new DocumentReference(parent, new DocumentKey(path));
   } else {
-    const coll = tryCast(parent, CollectionReference);
+    const coll = cast(parent, CollectionReference);
     const absolutePath = coll._path.child(path);
-    if (!DocumentKey.isDocumentKey(absolutePath)) {
-      throw new FirestoreError(
-        Code.INVALID_ARGUMENT,
-        `Invalid path (${absolutePath}). Path points to a collection.`
-      );
-    }
+    validateDocumentPath(absolutePath);
     return new DocumentReference(
       coll.firestore,
       new DocumentKey(absolutePath),
@@ -270,7 +241,7 @@ export function parent<T>(
       );
     }
   } else {
-    const doc = tryCast(child, DocumentReference) as DocumentReference<T>;
+    const doc = cast<DocumentReference<T>>(child, DocumentReference);
     return new CollectionReference<T>(
       doc.firestore,
       doc._key.path.popLast(),
@@ -282,7 +253,7 @@ export function parent<T>(
 export function getDoc<T>(
   reference: firestore.DocumentReference<T>
 ): Promise<firestore.DocumentSnapshot<T>> {
-  const ref = tryCast(reference, DocumentReference) as DocumentReference<T>;
+  const ref = cast(reference, DocumentReference) as DocumentReference<T>;
   return ref.firestore._ensureClientConfigured().then(async datastore => {
     const result = await invokeBatchGetDocumentsRpc(datastore, [ref._key]);
     hardAssert(result.length === 1, 'Expected a single document result');

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

@@ -20,7 +20,7 @@ import * as firestore from '../../index';
 import { Firestore } from './database';
 import { DocumentReference } from './reference';
 import { FieldPath } from './field_path';
-import { tryCast } from './util';
+import { cast } from './util';
 import { DocumentKey } from '../../../src/model/document_key';
 import { Document } from '../../../src/model/document';
 import { UserDataWriter } from '../../../src/api/user_data_writer';
@@ -60,25 +60,23 @@ export class DocumentSnapshot<T = firestore.DocumentData>
   data(): T | undefined {
     if (!this._document) {
       return undefined;
-    } else {
+    } else if (this._converter) {
       // We only want to use the converter and create a new DocumentSnapshot
       // if a converter has been provided.
-      if (this._converter) {
-        const snapshot = new QueryDocumentSnapshot(
-          this._firestore,
-          this._key,
-          this._document
-        );
-        return this._converter.fromFirestore(snapshot);
-      } else {
-        const userDataWriter = new UserDataWriter(
-          this._firestore._databaseId,
-          /* timestampsInSnapshots= */ false,
-          /* serverTimestampBehavior=*/ 'none',
-          key => new DocumentReference(this._firestore, key)
-        );
-        return userDataWriter.convertValue(this._document.toProto()) as T;
-      }
+      const snapshot = new QueryDocumentSnapshot(
+        this._firestore,
+        this._key,
+        this._document
+      );
+      return this._converter.fromFirestore(snapshot);
+    } else {
+      const userDataWriter = new UserDataWriter(
+        this._firestore._databaseId,
+        /* timestampsInSnapshots= */ false,
+        /* serverTimestampBehavior=*/ 'none',
+        key => new DocumentReference(this._firestore, key)
+      );
+      return userDataWriter.convertValue(this._document.toProto()) as T;
     }
   }
 
@@ -119,7 +117,7 @@ export function fieldPathFromArgument(
   if (typeof arg === 'string') {
     return fieldPathFromDotSeparatedString(methodName, arg);
   } else {
-    const path = tryCast(arg, FieldPath);
+    const path = cast(arg, FieldPath);
     return path._internalPath;
   }
 }

packages/firestore/lite/src/api/util.ts

@@ -23,11 +23,11 @@ import { Code, FirestoreError } from '../../../src/util/error';
  * This cast is used in the Lite and Full SDK to verify instance types for
  * arguments passed to the public API.
  */
-export function tryCast<T>(
+export function cast<T>(
   obj: object,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   constructor: { new (...args: any[]): T }
-): T {
+): T | never {
   if (!(obj instanceof constructor)) {
     if (constructor.name === obj.constructor.name) {
       throw new FirestoreError(

packages/firestore/lite/test/integration.test.ts

@@ -82,13 +82,13 @@ describe('doc', () => {
   it('validates path', () => {
     return withTestDb(db => {
       expect(() => doc(db, 'coll')).to.throw(
-        'Invalid path (coll). Path points to a collection.'
+        'Invalid document path (coll). Path points to a collection.'
       );
       expect(() => doc(db, '')).to.throw(
-        'Invalid path (). Empty paths are not supported.'
+        'Function doc() requires its second argument to be of type non-empty string, but it was: ""'
       );
       expect(() => doc(collection(db, 'coll'), 'doc/coll')).to.throw(
-        'Invalid path (coll/doc/coll). Path points to a collection.'
+        'Invalid document path (coll/doc/coll). Path points to a collection.'
       );
       expect(() => doc(db, 'coll//doc')).to.throw(
         'Invalid path (coll//doc). Paths must not contain // in them.'
@@ -118,13 +118,15 @@ describe('collection', () => {
   it('validates path', () => {
     return withTestDb(db => {
       expect(() => collection(db, 'coll/doc')).to.throw(
-        'Invalid path (coll/doc). Path points to a document.'
+        'Invalid collection path (coll/doc). Path points to a document.'
       );
+      // TODO(firestorelite): Explore returning a more helpful message
+      // (e.g. "Empty document paths are not supported.")
       expect(() => collection(doc(db, 'coll/doc'), '')).to.throw(
-        'Invalid path (). Empty paths are not supported.'
+        'Function doc() requires its second argument to be of type non-empty string, but it was: ""'
       );
       expect(() => collection(doc(db, 'coll/doc'), 'coll/doc')).to.throw(
-        'Invalid path (coll/doc/coll/doc). Path points to a document.'
+        'Invalid collection path (coll/doc/coll/doc). Path points to a document.'
       );
     });
   });

packages/firestore/package.json

@@ -8,7 +8,9 @@
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "scripts": {
     "prebuild": "tsc -m es2015 --moduleResolution node scripts/*.ts ",
+    "prebuild:release": "yarn prebuild",
     "build": "rollup -c rollup.config.es2017.js && rollup -c rollup.config.es5.js && yarn build:lite",
+    "build:release":  "rollup -c rollup.config.es2017.js && rollup -c rollup.config.es5.js",
     "build:deps": "lerna run --scope @firebase/'{app,firestore}' --include-dependencies build",
     "build:console": "node tools/console.build.js",
     "build:exp": "rollup -c rollup.config.exp.js",
@@ -35,7 +37,7 @@
     "test:minified": "(cd ../../integration/firestore ; yarn test)",
     "pretest:lite": "yarn build:lite",
     "test:lite":  "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'lite/test/**/*.test.ts' --file lite/index.node.ts --config ../../config/mocharc.node.js",
-    "prepare": "yarn build"
+    "prepare": "yarn build:release"
   },
   "main": "dist/index.node.cjs.js",
   "main-esm2017": "dist/index.node.esm2017.js",

packages/firestore/src/util/assert.ts

@@ -79,7 +79,7 @@ export function debugCast<T>(
   obj: object,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   constructor: { new (...args: any[]): T }
-): T {
+): T | never {
   debugAssert(
     obj instanceof constructor,
     `Expected type '${constructor.name}', but was '${obj.constructor.name}'`

packages/firestore/src/util/input_validation.ts

@@ -17,6 +17,8 @@
 import { fail } from './assert';
 import { Code, FirestoreError } from './error';
 import { Dict, forEach } from './obj';
+import { DocumentKey } from '../model/document_key';
+import { ResourcePath } from '../model/path';
 
 /** Types accepted by validateType() and related methods for validation. */
 export type ValidationType =
@@ -317,6 +319,32 @@ export function validateStringEnum<T>(
   return argument as T;
 }
 
+/**
+ * Validates that `path` refers to a document (indicated by the fact it contains
+ * an even numbers of segments).
+ */
+export function validateDocumentPath(path: ResourcePath): void {
+  if (!DocumentKey.isDocumentKey(path)) {
+    throw new FirestoreError(
+      Code.INVALID_ARGUMENT,
+      `Invalid document path (${path}). Path points to a collection.`
+    );
+  }
+}
+
+/**
+ * Validates that `path` refers to a collection (indicated by the fact it
+ * contains an odd numbers of segments).
+ */
+export function validateCollectionPath(path: ResourcePath): void {
+  if (DocumentKey.isDocumentKey(path)) {
+    throw new FirestoreError(
+      Code.INVALID_ARGUMENT,
+      `Invalid collection path (${path}). Path points to a document.`
+    );
+  }
+}
+
 /** Helper to validate the type of a provided input. */
 function validateType(
   functionName: string,