Get all the tests passing

rickerbh · rickerbh · commit b1f78a5a6106 · 2018-06-04T10:34:28.000+10:00
- Fix issues with concurrency tests
- Update readme
- Support limit, skip, sort
- Fix minor typos in tests
- Support upsert
- Base64 decode the key to get past bash expansion issues in Travis config
- Add firestore to read and write tests
- Implement the clearAll function
diff --git a/.travis.yml b/.travis.yml
@@ -13,6 +13,7 @@ before_install:
   - tar -xzf /tmp/dynamodb_local_latest.tar.gz -C /tmp
   - java -Djava.library.path=/tmp/DynamoDBLocal_lib -jar /tmp/DynamoDBLocal.jar -inMemory &
   - sleep 2
+  - echo $BASE64_GOOGLE_KEY | base64 --decode > /tmp/firestore-node-viewmodel-key.json
 
 services:
   - mongodb
@@ -40,3 +41,4 @@ env:
     - AWS_SECRET_ACCESS_KEY=SECRET
     - AWS_REGION=us-east-1
     - AWS_DYNAMODB_ENDPOINT=http://localhost:8000
+    - GOOGLE_APPLICATION_CREDENTIALS=/tmp/firestore-node-viewmodel-key.json
diff --git a/README.md b/README.md
@@ -340,8 +340,11 @@ Simple (equality comparison) find queries are supported by passing javascript ob
     });
 ```
 
-The queryOptions parameter is also ignored.
+The queryOptions parameter supports limit, skip, and sort, in a mongoDb-like syntax.
 
+### Testing Setup
+
+To provide the authentication file to tests, the `GOOGLE_APPLICATION_CREDENTIALS` environment setting should point to the file so it can be loaded by firestore. To inject the file in TravisCI, create a new environment variable called `BASE64_GOOGLE_KEY` in the Travis GUI, and set the value of this to be the Base64 encoded content of the file. The .travis.yml file contains configuration to decode this setting and write it out to a known location for the CI settings to pickup.
 
 # [Release notes](https://github.com/adrai/node-viewmodel/blob/master/releasenotes.md)
 
diff --git a/lib/databases/firestore.js b/lib/databases/firestore.js
@@ -1,5 +1,6 @@
 var util = require('util'),
     _ = require('lodash'),
+    async = require('async'),
     ConcurrencyError = require('../concurrencyError'),
     gcFirestore = require('@google-cloud/firestore'),
     Repository = require('../base'),
@@ -37,6 +38,59 @@ function firestoreQueryParser(collectionRef, queryParams) {
   return _.reduce(params, function(acc, q) {
     return acc.where.apply(acc, q);
   }, collectionRef);
+};
+
+function emptyCollection(db, collection, callback) {
+  var collectionRef = db.collection(collection);
+  var query = collectionRef.get().then(function (querySnapshot) {
+    var writeBatch = db.batch();
+    querySnapshot.forEach(function (documentSnapshot) {
+      var documentPath = collection + '/' + documentSnapshot.id;
+      var documentRef = db.doc(documentPath);
+      writeBatch.delete(documentRef);
+    });
+    writeBatch.commit().then(function () {
+      if (callback) callback(null);
+    });
+  });
+};
+
+function getPrecondition(vm) {
+  var precondition = {};
+  if (!_.isUndefined(vm.get('_updateTime'))) {
+    const time = vm.get('_updateTime');
+    if (_.isDate(time)) {
+      precondition['lastUpdateTime'] = time.toISOString();
+    } else if (_.isString(time)) {
+      precondition['lastUpdateTime'] = time;
+    }
+  }
+  return precondition;
+}
+
+function enrichVMWithTimestamps(vm, documentSnapshot) {
+  _.isUndefined(documentSnapshot.readTime) ? false : vm.set('_readTime', documentSnapshot.readTime);
+  _.isUndefined(documentSnapshot.createTime) ? false : vm.set('_createTime', documentSnapshot.createTime);
+  _.isUndefined(documentSnapshot.updateTime) ? false : vm.set('_updateTime', documentSnapshot.updateTime);
+  return vm;
+};
+
+function applyQueryOptions(query, options) {
+  if (!_.isUndefined(options)) {
+    // Apply supported queryOptions
+    if (_.has(options, 'limit')) {
+      query = query.limit(options.limit);
+    }
+    if (_.has(options, 'skip')) {
+      query = query.offset(options.skip);
+    }
+    if (_.has(options, 'sort')) {
+      var sortKey = options.sort.keys[0];
+      var direction = options.sort.keys[sortKey] == 1 ? 'asc' : 'desc';
+      query = query.orderBy(sortKey, direction);
+    }
+  }
+  return query;
 }
 
 _.extend(Firestore.prototype, {
@@ -82,6 +136,7 @@ _.extend(Firestore.prototype, {
 
     documentRef.get().then(function (documentSnapshot) {
       var vm = new ViewModel(documentSnapshot.data() || { id }, self);
+      vm = enrichVMWithTimestamps(vm, documentSnapshot);
       if (documentSnapshot.exists) {
         vm.actionOnCommit = 'update';
       } else {
@@ -92,17 +147,18 @@ _.extend(Firestore.prototype, {
   },
 
   find: function (queryParams, queryOptions, callback) {
-    // NOTE: queryOptions is ignored
-
     this.checkConnection();
 
     var self = this;
     var collectionRef = this.db.collection(this.collection);
 
     var query = firestoreQueryParser(collectionRef, queryParams);
+    query = applyQueryOptions(query, queryOptions);
+
     query.get().then(function (querySnapshot) {
       var vms = _.map(querySnapshot.docs, function(documentSnapshot) {
         var vm = new ViewModel(documentSnapshot.data(), self);
+        vm = enrichVMWithTimestamps(vm, documentSnapshot);
         vm.actionOnCommit = 'update';
         return vm;
       });
@@ -118,12 +174,15 @@ _.extend(Firestore.prototype, {
     var collectionRef = this.db.collection(this.collection);
 
     var query = firestoreQueryParser(collectionRef, queryParams);
+    _.unset(queryOptions, 'limit');
+    query = applyQueryOptions(query, queryOptions);
     query.limit(1).get().then(function (querySnapshot) {
       if (querySnapshot.size == 0) {
         callback(null, null);
       }
       querySnapshot.forEach(function (documentSnapshot) {
         var vm = new ViewModel(documentSnapshot.data(), self);
+        vm = enrichVMWithTimestamps(vm, documentSnapshot);
         vm.actionOnCommit = 'update';
         callback(null, vm);
       });
@@ -135,12 +194,17 @@ _.extend(Firestore.prototype, {
 
       if (!vm.actionOnCommit) return callback(new Error('actionOnCommit is not defined!'));
 
+      var self = this;
+
       switch(vm.actionOnCommit) {
       case 'delete':
         var documentPath = this.collection + '/' + vm.id;
         var documentRef = this.db.doc(documentPath);
-        documentRef.delete().then(function () {
+        var precondition = getPrecondition(vm);
+        documentRef.delete(precondition).then(function () {
           callback(null);
+        }).catch(function (err) {
+            return callback(new ConcurrencyError());
         });
         break;
       case 'create':
@@ -161,12 +225,23 @@ _.extend(Firestore.prototype, {
         var documentRef = this.db.doc(documentPath);
         documentRef.get().then(function (documentSnapshot) {
           if (!documentSnapshot.exists) {
-            return callback(new ConcurrencyError());
+            documentRef.set(vm.attributes).then(function () {
+              vm.actionOnCommit = 'update';
+              callback(null, vm);
+            });
+          } else {
+            if (!_.isUndefined(documentSnapshot.updateTime) &&
+                 _.isUndefined(vm.get('_updateTime'))) {
+              return callback(new ConcurrencyError());
+            }
+
+            var precondition = getPrecondition(vm);
+            documentRef.update(vm.attributes, precondition).then(function () {
+              self.get(vm.id, callback);
+            }, function (err) {
+              return callback(new ConcurrencyError());
+            });
           }
-          documentRef.update(vm.attributes).then(function () {
-            vm.actionOnCommit = 'update';
-            callback(null, vm);
-          });
         });
         break;
       default:
@@ -196,27 +271,14 @@ _.extend(Firestore.prototype, {
       return;
     }
 
-    var collectionRef = this.db.collection(this.collection);
-    var query = collectionRef.get().then(function (querySnapshot) {
-      var writeBatch = self.db.batch();
-      querySnapshot.forEach(function (documentSnapshot) {
-        var documentPath = self.collection + '/' + documentSnapshot.id;
-        var documentRef = self.db.doc(documentPath);
-        writeBatch.delete(documentRef);
-      });
-      writeBatch.commit().then(function () {
-        if (callback) callback(null);
-      });
-    });
+    emptyCollection(this.db, this.collection, callback);
   },
 
-  /**
-   * NEVER USE THIS FUNCTION!!! ONLY FOR TESTS!
-   * clears the complete store...
-   * @param {Function} callback the function that will be called when this action has finished [optional]
-   */
   clearAll: function (callback) {
-    implementError(callback);
+    var self = this;
+    async.each(collections, function (col, callback) {
+      emptyCollection(self.db, col, callback);
+    }, callback);
   },
 
 });
diff --git a/test/repositoryReadTest.js b/test/repositoryReadTest.js
@@ -77,7 +77,7 @@ describe('Repository read', function() {
 
     describe('with options containing a type property with the value of', function() {
 
-      var types = ['inmemory', 'mongodb', 'tingodb', 'couchdb', 'redis', 'elasticsearch6', 'dynamodb'/*, 'elasticsearch', 'documentdb', 'azuretable'*/];
+      var types = ['inmemory', 'mongodb', 'tingodb', 'couchdb', 'redis', 'elasticsearch6', 'dynamodb' /*, 'elasticsearch', 'documentdb', 'azuretable', 'firestore' */];
 
       types.forEach(function(type) {
 
@@ -490,7 +490,7 @@ describe('Repository read', function() {
 
                       });
 
-                      var noQueryArray = ['azuretable', 'documentdb', 'dynamodb'];
+                      var noQueryArray = ['azuretable', 'documentdb', 'dynamodb', 'firestore'];
 
                       if (!_.includes(noQueryArray, type)) {
 
@@ -781,7 +781,7 @@ describe('Repository read', function() {
 
                       });
 
-                      var noQueryArray = ['azuretable', 'documentdb', 'dynamodb'];
+                      var noQueryArray = ['azuretable', 'documentdb', 'dynamodb', 'firestore'];
 
                       if (!_.includes(noQueryArray, type)) {
 
diff --git a/test/repositoryWriteTest.js b/test/repositoryWriteTest.js
@@ -76,7 +76,7 @@ describe.only('Repository write', function() {
 
     describe('with options containing a type property with the value of', function() {
 
-      var types = ['inmemory', 'mongodb', 'tingodb', 'couchdb', 'redis', 'elasticsearch6', 'dynamodb'/*, 'elasticsearch', 'documentdb', 'azuretable'*/];
+      var types = ['inmemory', 'mongodb', 'tingodb', 'couchdb', 'redis', 'elasticsearch6', 'dynamodb' /*, 'elasticsearch', 'documentdb', 'azuretable', 'firestore'*/];
 
       types.forEach(function(type) {
 
@@ -482,7 +482,7 @@ describe.only('Repository write', function() {
 
                       });
 
-                      var noQueryArray = ['azuretable', 'documentdb', 'dynamodb'];
+                      var noQueryArray = ['azuretable', 'documentdb', 'dynamodb', 'firestore'];
 
                       if (!_.includes(noQueryArray, type)) {
 
@@ -1247,7 +1247,7 @@ describe.only('Repository write', function() {
 
                       });
 
-                      var noQueryArray = ['azuretable', 'documentdb', 'dynamodb'];
+                      var noQueryArray = ['azuretable', 'documentdb', 'dynamodb', 'firestore'];
 
                       if (!_.includes(noQueryArray, type)) {
 
@@ -1510,7 +1510,7 @@ describe.only('Repository write', function() {
 
                         });
 
-                        describe('but beeing updated by someone else in the meantime', function() {
+                        describe('but being updated by someone else in the meantime', function() {
 
                           it('it should callback with a concurrency error', function(done) {
 
@@ -1536,7 +1536,7 @@ describe.only('Repository write', function() {
 
                         });
 
-                        describe('but beeing updated by someone else in the meantime and creating with the same id', function() {
+                        describe('but being updated by someone else in the meantime and creating with the same id', function() {
 
                           it('it should callback with a concurrency error', function(done) {
 
@@ -1605,7 +1605,7 @@ describe.only('Repository write', function() {
 
                         });
 
-                        describe('but beeing updated by someone else in the meantime', function() {
+                        describe('but being updated by someone else in the meantime', function() {
 
                           it('it should callback with a concurrency error', function(done) {
 
