Improving SDK interoperability

Author: schmidt-sebastian

src/document.js

@@ -1332,25 +1332,39 @@ function validateFieldValue(obj, options, depth) {
     );
   }
 
-  if (obj === FieldValue.DELETE_SENTINEL) {
-    if (!options.allowNestedDeletes && (!options.allowDeletes || depth > 1)) {
-      throw new Error(
-        'Deletes must appear at the top-level and can only be used in update() or set() with {merge:true}.'
-      );
+  if (DocumentTransform.isTransformSentinel(obj)) {
+    if (obj === FieldValue.DELETE_SENTINEL) {
+      if (!options.allowNestedDeletes && (!options.allowDeletes || depth > 1)) {
+        throw new Error(
+          'Deletes must appear at the top-level and can only be used in update() or set() with {merge:true}.'
+        );
+      }
     }
-  }
-
-  if (isPlainObject(obj)) {
+  } else if (is.array(obj)) {
+    for (let prop of obj) {
+      validateFieldValue(obj[prop], options, depth + 1);
+    }
+  } else if (isPlainObject(obj)) {
     for (let prop in obj) {
       if (obj.hasOwnProperty(prop)) {
         validateFieldValue(obj[prop], options, depth + 1);
       }
     }
-  }
-  if (is.array(obj)) {
-    for (let prop of obj) {
-      validateFieldValue(obj[prop], options, depth + 1);
+  } else if (is.object(obj)) {
+    if (is.instanceof(obj, DocumentReference)) {
+      return true;
+    } else if (is.instanceof(obj, FieldValue)) {
+      return true;
     }
+
+    validate.throwVersionMismatchErrorIfType(obj, DocumentReference);
+    validate.throwVersionMismatchErrorIfType(obj, FieldValue);
+
+    throw new Error(
+      'Cannot use type (' +
+        Object.prototype.toString.call(obj) +
+        ') as a Firestore Value'
+    );
   }
 
   return true;

src/field-value.js

@@ -20,13 +20,13 @@
  * Sentinel value for a field delete.
  *
  */
-const DELETE_SENTINEL = {};
+let DELETE_SENTINEL;
 
 /*!
  * Sentinel value for a server timestamp.
  *
  */
-const SERVER_TIMESTAMP_SENTINEL = {};
+let SERVER_TIMESTAMP_SENTINEL;
 
 /**
  * Sentinel values that can be used when writing documents with set() or
@@ -35,6 +35,7 @@ const SERVER_TIMESTAMP_SENTINEL = {};
  * @class
  */
 class FieldValue {
+  constructor() {}
   /**
    * Returns a sentinel used with update() to mark a field for deletion.
    *
@@ -76,6 +77,18 @@ class FieldValue {
   }
 }
 
+/*!
+ * Sentinel value for a field delete.
+ *
+ */
+ DELETE_SENTINEL = new FieldValue();
+
+/*!
+ * Sentinel value for a server timestamp.
+ *
+ */
+ SERVER_TIMESTAMP_SENTINEL = new FieldValue();
+
 module.exports = FieldValue;
 module.exports.DELETE_SENTINEL = DELETE_SENTINEL;
 module.exports.SERVER_TIMESTAMP_SENTINEL = SERVER_TIMESTAMP_SENTINEL;

src/index.js

@@ -1147,6 +1147,31 @@ Transaction = require('./transaction')(Firestore);
  * region_tag:firestore_quickstart
  * Full quickstart example:
  */
+
+const version = require('../package.json').version;
+
+if (!is.defined(global.__FIRESTORE_DATA)) {
+  global.__FIRESTORE_DATA = {
+    version: version,
+    path: __dirname,
+  };
+} else if (is.defined(global.__FIRESTORE_DATA)) {
+  if (global.__FIRESTORE_DATA.version !== version) {
+    console.warn(
+      `Importing multiple versions @google-cloud/firestore can cause unexpected ` +
+        `behavior. If you are using Firestore through a transitive ` +
+        `dependency (such as the Firebase Admin SDK), please ensure that your ` +
+        `dependency versions match (found ${
+          global.__FIRESTORE_DATA.version
+        } and ` +
+        `${version}). For more information, see http://goo.gl/...`
+    );
+  } else if (__dirname !== global.__FIRESTORE_DATA.path) {
+    module.exports = require(global.__FIRESTORE_DATA.path);
+    return;
+  }
+}
+
 module.exports = Firestore;
 module.exports.default = Firestore;
 module.exports.Firestore = Firestore;

src/path.js

@@ -483,6 +483,8 @@ class FieldPath extends Path {
    */
   static validateFieldPath(fieldPath) {
     if (!is.instanceof(fieldPath, FieldPath)) {
+      validate.throwVersionMismatchErrorIfType(fieldPath, FieldPath);
+
       if (!is.string(fieldPath)) {
         throw new Error(`Paths must be strings or FieldPath objects.`);
       }

src/reference.js

@@ -2089,7 +2089,11 @@ function validateComparisonOperator(str, val) {
  * @returns 'true' is value is an instance of DocumentReference.
  */
 function validateDocumentReference(value) {
-  return is.instanceof(value, DocumentReference);
+  if (is.instanceof(value, DocumentReference)) {
+    return true;
+  }
+  validate.verifyConstructorName(value, DocumentReference);
+  return false;
 }
 
 module.exports = FirestoreType => {

src/validate.js

@@ -140,5 +140,15 @@ module.exports = validators => {
     return true;
   };
 
+  exports.throwVersionMismatchErrorIfType = (obj, classType) => {
+    if (is.object(obj) && obj.constructor.name === classType.name) {
+      throw new Error(
+        `Detected an object of type '${
+          obj.constructor.name
+        }' that doesn't match the expected version for this Firestore instance. For more information, please visit: http://go...`
+      );
+    }
+  };
+
   return exports;
 };