Debug and release asserts

This PR aims to differentiate between asserts that we should handle in production builds (e.g. we received invalid data) and asserts we handle only during testing (our local state is corrupt). Some of the distinctions are really obvious, and other are anything but. In a lot of cases, we actually have multiple asserts for a single condition. I opted to only  make the initial assertion a hardAssert (e.g. when we reveive mutation results, we assert multiple times that the number of results matches the mutation count).

softAssert is a temporary name that  I will rename back to assert once this is done. It is meant to make the decisions here more obvious

Author: schmidt-sebastian

packages/firestore/src/api/credentials.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
  */
 
 import { User } from '../auth/user';
-import { assert } from '../util/assert';
+import { hardAssert, softAssert } from '../util/assert';
 import { Code, FirestoreError } from '../util/error';
 import {
   FirebaseAuthInternal,
@@ -116,14 +116,14 @@ export class EmptyCredentialsProvider implements CredentialsProvider {
   invalidateToken(): void {}
 
   setChangeListener(changeListener: CredentialChangeListener): void {
-    assert(!this.changeListener, 'Can only call setChangeListener() once.');
+    softAssert(!this.changeListener, 'Can only call setChangeListener() once.');
     this.changeListener = changeListener;
     // Fire with initial user.
     changeListener(User.UNAUTHENTICATED);
   }
 
   removeChangeListener(): void {
-    assert(
+    softAssert(
       this.changeListener !== null,
       'removeChangeListener() when no listener registered'
     );
@@ -190,7 +190,7 @@ export class FirebaseCredentialsProvider implements CredentialsProvider {
   }
 
   getToken(): Promise<Token | null> {
-    assert(
+    softAssert(
       this.tokenListener != null,
       'getToken cannot be called after listener removed.'
     );
@@ -217,7 +217,7 @@ export class FirebaseCredentialsProvider implements CredentialsProvider {
         );
       } else {
         if (tokenData) {
-          assert(
+          hardAssert(
             typeof tokenData.accessToken === 'string',
             'Invalid tokenData returned from getToken():' + tokenData
           );
@@ -234,7 +234,7 @@ export class FirebaseCredentialsProvider implements CredentialsProvider {
   }
 
   setChangeListener(changeListener: CredentialChangeListener): void {
-    assert(!this.changeListener, 'Can only call setChangeListener() once.');
+    softAssert(!this.changeListener, 'Can only call setChangeListener() once.');
     this.changeListener = changeListener;
 
     // Fire the initial event
@@ -244,8 +244,11 @@ export class FirebaseCredentialsProvider implements CredentialsProvider {
   }
 
   removeChangeListener(): void {
-    assert(this.tokenListener != null, 'removeChangeListener() called twice');
-    assert(
+    softAssert(
+      this.tokenListener != null,
+      'removeChangeListener() called twice'
+    );
+    softAssert(
       this.changeListener !== null,
       'removeChangeListener() called when no listener registered'
     );
@@ -263,7 +266,7 @@ export class FirebaseCredentialsProvider implements CredentialsProvider {
   // to guarantee to get the actual user.
   private getUser(): User {
     const currentUid = this.auth && this.auth.getUid();
-    assert(
+    hardAssert(
       currentUid === null || typeof currentUid === 'string',
       'Received invalid UID: ' + currentUid
     );
@@ -342,7 +345,7 @@ export function makeCredentialsProvider(
     case 'gapi':
       const client = credentials.client as Gapi;
       // Make sure this really is a Gapi client.
-      assert(
+      hardAssert(
         !!(
           typeof client === 'object' &&
           client !== null &&

packages/firestore/src/api/database.ts

@@ -47,7 +47,7 @@ import { isServerTimestamp } from '../model/server_timestamps';
 import { refValue } from '../model/values';
 import { PlatformSupport } from '../platform/platform';
 import { makeConstructorPrivate } from '../util/api';
-import { assert, fail } from '../util/assert';
+import { softAssert, fail } from '../util/assert';
 import { AsyncObserver } from '../util/async_observer';
 import { AsyncQueue } from '../util/async_queue';
 import { Code, FirestoreError } from '../util/error';
@@ -507,9 +507,12 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     persistenceProvider: PersistenceProvider,
     persistenceSettings: PersistenceSettings
   ): Promise<void> {
-    assert(!!this._settings.host, 'FirestoreSettings.host is not set');
+    softAssert(!!this._settings.host, 'FirestoreSettings.host is not set');
 
-    assert(!this._firestoreClient, 'configureClient() called multiple times');
+    softAssert(
+      !this._firestoreClient,
+      'configureClient() called multiple times'
+    );
 
     const databaseInfo = this.makeDatabaseInfo();
 
@@ -1206,7 +1209,7 @@ export class DocumentReference<T = firestore.DocumentData>
     const asyncObserver = new AsyncObserver<ViewSnapshot>({
       next: snapshot => {
         if (observer.next) {
-          assert(
+          softAssert(
             snapshot.docs.size <= 1,
             'Too many documents returned on a document query'
           );
@@ -1451,7 +1454,7 @@ export class QueryDocumentSnapshot<T = firestore.DocumentData>
   implements firestore.QueryDocumentSnapshot<T> {
   data(options?: SnapshotOptions): T {
     const data = super.data(options);
-    assert(
+    softAssert(
       data !== undefined,
       'Document in a QueryDocumentSnapshot should exist'
     );
@@ -2533,11 +2536,11 @@ export function changesFromSnapshot<T>(
         snapshot.mutatedKeys.has(change.doc.key),
         converter
       );
-      assert(
+      softAssert(
         change.type === ChangeType.Added,
         'Invalid event type for first snapshot'
       );
-      assert(
+      softAssert(
         !lastDoc || snapshot.query.docComparator(lastDoc, change.doc) < 0,
         'Got added events in wrong order'
       );
@@ -2570,7 +2573,7 @@ export function changesFromSnapshot<T>(
         let newIndex = -1;
         if (change.type !== ChangeType.Added) {
           oldIndex = indexTracker.indexOf(change.doc.key);
-          assert(oldIndex >= 0, 'Index for document not found');
+          softAssert(oldIndex >= 0, 'Index for document not found');
           indexTracker = indexTracker.delete(change.doc.key);
         }
         if (change.type !== ChangeType.Removed) {

packages/firestore/src/api/user_data_reader.ts

@@ -32,7 +32,7 @@ import {
   TransformMutation
 } from '../model/mutation';
 import { FieldPath } from '../model/path';
-import { assert, fail } from '../util/assert';
+import { softAssert, fail } from '../util/assert';
 import { Code, FirestoreError } from '../util/error';
 import { isPlainObject, valueDescription } from '../util/input_validation';
 import { Dict, forEach, isEmpty } from '../util/obj';
@@ -494,8 +494,8 @@ export class UserDataReader {
       FieldPath.EMPTY_PATH
     );
     const parsed = this.parseData(input, context);
-    assert(parsed != null, 'Parsed data should not be null.');
-    assert(
+    softAssert(parsed != null, 'Parsed data should not be null.');
+    softAssert(
       context.fieldTransforms.length === 0,
       'Field transforms should have been disallowed.'
     );
@@ -633,7 +633,7 @@ export class UserDataReader {
         // fieldMask so it gets deleted.
         context.fieldMask.push(context.path);
       } else if (context.dataSource === UserDataSource.Update) {
-        assert(
+        softAssert(
           context.path.length > 0,
           'FieldValue.delete() at the top level should have already' +
             ' been handled.'

packages/firestore/src/api/user_data_writer.ts

@@ -35,7 +35,7 @@ import {
   getLocalWriteTime,
   getPreviousValue
 } from '../model/server_timestamps';
-import { assert, fail } from '../util/assert';
+import { fail, hardAssert } from '../util/assert';
 import { forEach } from '../util/obj';
 import { TypeOrder } from '../model/field_value';
 import { ResourcePath } from '../model/path';
@@ -130,7 +130,7 @@ export class UserDataWriter<T = firestore.DocumentData> {
 
   private convertReference(name: string): DocumentReference<T> {
     const resourcePath = ResourcePath.fromString(name);
-    assert(
+    hardAssert(
       isValidResourceName(resourcePath),
       'ReferenceValue is not valid ' + name
     );

packages/firestore/src/core/event_manager.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { assert } from '../util/assert';
+import { softAssert } from '../util/assert';
 import { EventHandler } from '../util/misc';
 import { ObjectMap } from '../util/obj_map';
 import { Query } from './query';
@@ -73,7 +73,7 @@ export class EventManager implements SyncEngineListener {
 
     // Run global snapshot listeners if a consistent snapshot has been emitted.
     const raisedEvent = listener.applyOnlineStateChange(this.onlineState);
-    assert(
+    softAssert(
       !raisedEvent,
       "applyOnlineStateChange() shouldn't raise an event for brand-new listeners."
     );
@@ -226,7 +226,7 @@ export class QueryListener {
    * indeed raised.
    */
   onViewSnapshot(snap: ViewSnapshot): boolean {
-    assert(
+    softAssert(
       snap.docChanges.length > 0 || snap.syncStateChanged,
       'We got a new snapshot with no changes?'
     );
@@ -288,7 +288,7 @@ export class QueryListener {
     snap: ViewSnapshot,
     onlineState: OnlineState
   ): boolean {
-    assert(
+    softAssert(
       !this.raisedInitialEvent,
       'Determining whether to raise first event but already had first event'
     );
@@ -304,7 +304,7 @@ export class QueryListener {
     // Don't raise the event if we're online, aren't synced yet (checked
     // above) and are waiting for a sync.
     if (this.options.waitForSyncWhenOnline && maybeOnline) {
-      assert(
+      softAssert(
         snap.fromCache,
         'Waiting for sync, but snapshot is not from cache'
       );
@@ -337,7 +337,7 @@ export class QueryListener {
   }
 
   private raiseInitialEvent(snap: ViewSnapshot): void {
-    assert(
+    softAssert(
       !this.raisedInitialEvent,
       'Trying to raise initial events for second time'
     );