Removing the last bit of dependency injection (#317)

Author: schmidt-sebastian

src/document-change.js

@@ -0,0 +1,174 @@
+/*!
+ * Copyright 2018 Google Inc. All Rights Reserved.
+ *
+ * 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.
+ */
+
+'use strict';
+
+import * as is from 'is';
+
+/**
+ * A DocumentChange represents a change to the documents matching a query.
+ * It contains the document affected and the type of change that occurred.
+ *
+ * @class
+ */
+export class DocumentChange {
+  /**
+   * @private
+   * @hideconstructor
+   *
+   * @param {string} type - 'added' | 'removed' | 'modified'.
+   * @param {QueryDocumentSnapshot} document - The document.
+   * @param {number} oldIndex - The index in the documents array prior to this
+   * change.
+   * @param {number} newIndex - The index in the documents array after this
+   * change.
+   */
+  constructor(type, document, oldIndex, newIndex) {
+    this._type = type;
+    this._document = document;
+    this._oldIndex = oldIndex;
+    this._newIndex = newIndex;
+  }
+
+  /**
+   * The type of change ('added', 'modified', or 'removed').
+   *
+   * @type {string}
+   * @name DocumentChange#type
+   * @readonly
+   *
+   * @example
+   * let query = firestore.collection('col').where('foo', '==', 'bar');
+   * let docsArray = [];
+   *
+   * let unsubscribe = query.onSnapshot(querySnapshot => {
+   *   for (let change of querySnapshot.docChanges) {
+   *     console.log(`Type of change is ${change.type}`);
+   *   }
+   * });
+   *
+   * // Remove this listener.
+   * unsubscribe();
+   */
+  get type() {
+    return this._type;
+  }
+
+  /**
+   * The document affected by this change.
+   *
+   * @type {QueryDocumentSnapshot}
+   * @name DocumentChange#doc
+   * @readonly
+   *
+   * @example
+   * let query = firestore.collection('col').where('foo', '==', 'bar');
+   *
+   * let unsubscribe = query.onSnapshot(querySnapshot => {
+   *   for (let change of querySnapshot.docChanges) {
+   *     console.log(change.doc.data());
+   *   }
+   * });
+   *
+   * // Remove this listener.
+   * unsubscribe();
+   */
+  get doc() {
+    return this._document;
+  }
+
+  /**
+   * The index of the changed document in the result set immediately prior to
+   * this DocumentChange (i.e. supposing that all prior DocumentChange objects
+   * have been applied). Is -1 for 'added' events.
+   *
+   * @type {number}
+   * @name DocumentChange#oldIndex
+   * @readonly
+   *
+   * @example
+   * let query = firestore.collection('col').where('foo', '==', 'bar');
+   * let docsArray = [];
+   *
+   * let unsubscribe = query.onSnapshot(querySnapshot => {
+   *   for (let change of querySnapshot.docChanges) {
+   *     if (change.oldIndex !== -1) {
+   *       docsArray.splice(change.oldIndex, 1);
+   *     }
+   *     if (change.newIndex !== -1) {
+   *       docsArray.splice(change.newIndex, 0, change.doc);
+   *     }
+   *   }
+   * });
+   *
+   * // Remove this listener.
+   * unsubscribe();
+   */
+  get oldIndex() {
+    return this._oldIndex;
+  }
+
+  /**
+   * The index of the changed document in the result set immediately after
+   * this DocumentChange (i.e. supposing that all prior DocumentChange
+   * objects and the current DocumentChange object have been applied).
+   * Is -1 for 'removed' events.
+   *
+   * @type {number}
+   * @name DocumentChange#newIndex
+   * @readonly
+   *
+   * @example
+   * let query = firestore.collection('col').where('foo', '==', 'bar');
+   * let docsArray = [];
+   *
+   * let unsubscribe = query.onSnapshot(querySnapshot => {
+   *   for (let change of querySnapshot.docChanges) {
+   *     if (change.oldIndex !== -1) {
+   *       docsArray.splice(change.oldIndex, 1);
+   *     }
+   *     if (change.newIndex !== -1) {
+   *       docsArray.splice(change.newIndex, 0, change.doc);
+   *     }
+   *   }
+   * });
+   *
+   * // Remove this listener.
+   * unsubscribe();
+   */
+  get newIndex() {
+    return this._newIndex;
+  }
+
+  /**
+   * Returns true if the data in this `DocumentChange` is equal to the provided
+   * value.
+   *
+   * @param {*} other The value to compare against.
+   * @return true if this `DocumentChange` is equal to the provided value.
+   */
+  isEqual(other) {
+    if (this === other) {
+      return true;
+    }
+
+    return (
+        is.instanceof(other, DocumentChange) && this._type === other._type &&
+        this._oldIndex === other._oldIndex &&
+        this._newIndex === other._newIndex &&
+        this._document.isEqual(other._document));
+  }
+}

src/index.js

@@ -24,15 +24,16 @@ import pkgUp from 'pkg-up';
 import through2 from 'through2';
 import {replaceProjectIdToken} from '@google-cloud/projectify';
 
-import {referencePkg} from './reference';
-import {DocumentSnapshot, QueryDocumentSnapshot, validateDocumentData, validateFieldValue, validatePrecondition, validateSetOptions} from './document';
+import {CollectionReference, CollectionReference, DocumentReference, QuerySnapshot, Query, validateDocumentReference, validateComparisonOperator, validateFieldOrder} from './reference';
+import {DocumentSnapshot, QueryDocumentSnapshot, validatePrecondition, validateSetOptions} from './document';
 import {FieldTransform, FieldValue, DeleteTransform} from './field-value';
 import {Validator, customObjectError} from './validate';
 import {WriteBatch, WriteResult, validateUpdateMap} from './write-batch';
-import {transactionPkg} from './transaction';
+import {Transaction} from './transaction';
 import {Timestamp} from './timestamp';
 import {FieldPath, ResourcePath} from './path';
 import {ClientPool} from './pool';
+import {DocumentChange} from './document-change';
 import {isPlainObject, Serializer} from './serializer';
 import {GeoPoint} from './geo-point';
 import {logger, setLibVersion, setLogFunction} from './logger';
@@ -59,31 +60,11 @@ setLibVersion(libVersion);
  * @namespace google.firestore.v1beta1
  */
 
-/*!
- * @see CollectionReference
- */
-let CollectionReference;
-
-/*!
- * @see DocumentReference
- */
-let DocumentReference;
-
-/*!
- * @see Transaction
- */
-let Transaction;
-
 /*!
  * @see v1beta1
  */
 let v1beta1;  // Lazy-loaded in `_runRequest()`
 
-// Injected custom validation functions.
-let validateDocumentReference;
-let validateComparisonOperator;
-let validateFieldOrder;
-
 /*!
  * HTTP header for the resource prefix to improve routing and project isolation
  * by the backend.
@@ -1298,15 +1279,6 @@ function validateDocumentData(obj, options) {
  */
 Firestore.setLogFunction = setLogFunction;
 
-// Initializing dependencies that require that Firestore class type.
-const reference = referencePkg(Firestore);
-CollectionReference = reference.CollectionReference;
-DocumentReference = reference.DocumentReference;
-validateDocumentReference = reference.validateDocumentReference;
-validateComparisonOperator = reference.validateComparisonOperator;
-validateFieldOrder = reference.validateFieldOrder;
-Transaction = transactionPkg(Firestore);
-
 /**
  * The default export of the `@google-cloud/firestore` package is the
  * {@link Firestore} class.
@@ -1439,7 +1411,7 @@ module.exports.CollectionReference = CollectionReference;
  * @see QuerySnapshot
  * @type QuerySnapshot
  */
-module.exports.QuerySnapshot = reference.QuerySnapshot;
+module.exports.QuerySnapshot = QuerySnapshot;
 
 /**
  * {@link DocumentChange} class.
@@ -1448,7 +1420,7 @@ module.exports.QuerySnapshot = reference.QuerySnapshot;
  * @see DocumentChange
  * @type DocumentChange
  */
-module.exports.DocumentChange = reference.DocumentChange;
+module.exports.DocumentChange = DocumentChange;
 
 /**
  * {@link Query} class.
@@ -1457,7 +1429,7 @@ module.exports.DocumentChange = reference.DocumentChange;
  * @see Query
  * @type Query
  */
-module.exports.Query = reference.Query;
+module.exports.Query = Query;
 
 /**
  * {@link FieldValue} class.