Fix e-oj#46: gen.utils.js uses require("mongoose") instead of the mongoose from Fawn.init; move all functions that depend on mongoose from gen utils to db utils; update all references accordingly

Author: jake-billings

lib/roller.js

@@ -22,13 +22,13 @@ var FILE_SAVE = constants.FILE_SAVE;
 
 //gen utils
 var updateState = utils.updateState;
-var getCollection = utils.getCollection;
 
 // db utils
 var mongoose;
 var TaskMdl;
 var dbUtils;
 var getModel;
+var getCollectionForStep;
 
 /**
  * Initializes variables and gets the roller.
@@ -44,6 +44,7 @@ var RollerProvider = function(_mongoose, _TaskMdl) {
   TaskMdl = _TaskMdl;
   dbUtils = require("./utils/db.utils")(mongoose);
   getModel = dbUtils.getModel;
+  getCollectionForStep = dbUtils.getCollectionForStep;
 
   return Roller;
 };
@@ -132,7 +133,7 @@ function getRollbackFunc(step) {
  * @returns {Promise|*}
  */
 function rollbackSave(db, save, task) {
-  var collection = getCollection(db, save);
+  var collection = getCollectionForStep(db, save);
   var _id = save.dataStore[0]._id;
 
   return collection.deleteOne({_id: _id}).then(function(){
@@ -150,7 +151,7 @@ function rollbackSave(db, save, task) {
  * @returns {Promise|*}
  */
 function rollbackRemoveOrUpdate(db, step, task) {
-  var collection = getCollection(db, step);
+  var collection = getCollectionForStep(db, step);
   var chain = Promise.resolve();
 
   step.dataStore.forEach(function(data) {

lib/task.js

@@ -6,7 +6,7 @@ var fs = require("fs");
 
 var constants = require("./constants");
 var utils = require("./utils/gen.utils");
-var native = require("./task_core/native");
+var native = require("./task_core/native"); //set db utils when we get them
 var goose = require("./task_core/goose");
 
 // general utility functions
@@ -54,6 +54,7 @@ var TaskProvider = function (_mongoose, _TaskMdl) {
   TaskMdl = _TaskMdl;
   Roller = require("./roller")(mongoose, _TaskMdl);
   dbUtils = require("./utils/db.utils")(mongoose);
+  native.setDbUtils(dbUtils);
   modelCache = dbUtils.modelCache;
   setModel = dbUtils.setModel;
   getModel = dbUtils.getModel;
@@ -406,7 +407,7 @@ function performFileSave(step, task, results) {
   var options = step.options ? xcode(step.options, true) : {};
 
   resolveFuture(options, results);
-  options._id = options._id || utils.generateId();
+  options._id = options._id || dbUtils.generateId();
 
   step.options = options;
   step.dataStore = [{_id: options._id}];
@@ -488,7 +489,7 @@ function storeOldFile(task, step) {
       if (!file) return resolve(false);
 
       var collection = task.constructor.collection;
-      step.dataStore = [{removed: file._id, shadow: utils.generateId()}];
+      step.dataStore = [{removed: file._id, shadow: dbUtils.generateId()}];
 
       collection.updateOne({_id: task._id}, task.toObject()).then(function(){
         var writeStream = gfs.createWriteStream({

lib/task_core/goose.js

@@ -8,12 +8,12 @@ var dbUtils;
 
 // gen utility functions
 var resolveFuture = utils.resolveFuture;
-var storeOldData = utils.storeOldData;
 var updateState = utils.updateState;
 var xcode = utils.xcode;
 
 // db utility functions
 var getModel;
+var storeOldData;
 
 // constants
 var PENDING = constants.PENDING;
@@ -22,6 +22,7 @@ var DONE = constants.DONE;
 exports.setDbUtils = function (_dbUtils) {
   dbUtils = _dbUtils;
   getModel = dbUtils.getModel;
+  storeOldData = dbUtils.storeOldData;
 };
 
 /**
@@ -82,7 +83,7 @@ exports.performSave = function performSave(step, task, results) {
   var doc = new Collection(data);
   var dataStore = [];
 
-  doc._id = doc._id || utils.generateId();
+  doc._id = doc._id || dbUtils.generateId();
   dataStore.push({_id: doc._id});
 
   step.dataStore = dataStore;

lib/task_core/native.js

@@ -6,9 +6,15 @@
 var constants = require("../constants");
 var utils = require("../utils/gen.utils");
 
+var dbUtils;
+var storeOldData;
+exports.setDbUtils = function (_dbUtils) {
+    dbUtils = _dbUtils;
+    storeOldData = _dbUtils.storeOldData;
+};
+
 // utility functions
 var resolveFuture = utils.resolveFuture;
-var storeOldData = utils.storeOldData;
 var updateState = utils.updateState;
 var xcode = utils.xcode;
 
@@ -70,7 +76,7 @@ exports.nativeSave = function(db, step, task, results){
 
   resolveFuture(doc, results);
 
-  doc._id = doc._id || utils.generateId();
+  doc._id = doc._id || dbUtils.generateId();
   step.dataStore = [{_id: doc._id}];
 
   return updateState(task, step.index, PENDING).then(function(){

lib/utils/db.utils.js

@@ -159,6 +159,51 @@ module.exports = function(_mongoose) {
     return removeChain;
   }
 
+    /**
+     * generates a MongoDB ObjectId
+     */
+    function generateId(id) {
+        return new mongoose.Types.ObjectId(id);
+    }
+
+    /**
+     * Gets the collection for a step
+     *
+     * @param db native db
+     * @param step the step in question
+     *
+     * @returns native collection
+     */
+    function getCollectionForStep(db, step){
+        return step.useMongoose
+            ? mongoose.model(step.name).collection
+            : db.collection(step.name)
+    }
+
+    /**
+     * This function stores data that's about to be
+     * changed by a step, for rollback purposes
+     *
+     * @param db native db
+     * @param step the step
+     * @param condition literal obj rep of the step's condition
+     *
+     * @returns {Promise|*}
+     */
+    function storeOldData(db, step, condition){
+        var Collection = getCollectionForStep(db, step);
+        var options = step.options
+            ? utils.xcode(step.options)
+            : step.type === constants.REMOVE ? {multi: true} : null;
+        var query = Collection.find(condition);
+        var searchQuery = options && options.multi === true
+            ? query
+            : query.limit(1);
+
+        return searchQuery.toArray().then(function(result){
+            step.dataStore = result;
+        });
+    }
   return {
     setModel: setModel
     , getModel: getModel
@@ -168,5 +213,9 @@ module.exports = function(_mongoose) {
     , removeFile: removeFile
     , fileExists: fileExists
     , makeRemoveChain: makeRemoveChain
+    , generateId: generateId
+    , getCollection: getCollection
+    , getCollectionForStep: getCollectionForStep
+    , storeOldData: storeOldData
   };
 };

lib/utils/gen.utils.js

@@ -5,35 +5,9 @@
 
 var constants = require("../constants");
 var Promise = require("bluebird");
-var mongoose = require("mongoose");
 var $ = constants.$PREFIX;
 var DOT = constants.DOT_PREFIX;
 
-/**
- * This function stores data that's about to be
- * changed by a step, for rollback purposes
- *
- * @param db native db
- * @param step the step
- * @param condition literal obj rep of the step's condition
- *
- * @returns {Promise|*}
- */
-exports.storeOldData = function(db, step, condition){
-  var Collection = getCollection(db, step);
-  var options = step.options
-    ? xcode(step.options)
-    : step.type === constants.REMOVE ? {multi: true} : null;
-  var query = Collection.find(condition);
-  var searchQuery = options && options.multi === true
-    ? query
-    : query.limit(1);
-
-  return searchQuery.toArray().then(function(result){
-    step.dataStore = result;
-  });
-};
-
 /**
  * Updates the state of a task's step.
  *
@@ -249,25 +223,4 @@ exports.formatData = function(data){
   return formatted;
 };
 
-/**
- * generates a MongoDB ObjectId
- */
-exports.generateId = function(id) {
-  return new mongoose.Types.ObjectId(id);
-};
-
-/**
- * Gets the collection for a step
- *
- * @param db native db
- * @param step the step in question
- *
- * @returns native collection
- */
-var getCollection = exports.getCollection = function getCollection(db, step){
-  return step.useMongoose
-    ? mongoose.model(step.name).collection
-    : db.collection(step.name)
-};
-
 

tests/all.tests.js

@@ -28,7 +28,7 @@ global.TEST_COLLECTION_C = config.TEST_COLLECTION_C;
 global.TEST_FILE_PATH = config.TEST_FILE_PATH;
 global.TEST_FILE_TEXT = config.TEST_FILE_TEXT;
 global.TEST_FILE_NAME = "FAWN_TEST.oj";
-global.TEST_FILE_ID = utils.generateId();
+global.TEST_FILE_ID = global.dbUtils.generateId();
 
 describe("ALL TESTS", function(){
   before(function(){

tests/roller.tests.js

@@ -79,7 +79,7 @@ module.exports = describe("Roller", function(){
 
     it("should rollback file save", function () {
       var gfs = Grid(mongoose.connection.db);
-      var id = utils.generateId();
+      var id = dbUtils.generateId();
 
       return task.saveFile(TEST_FILE_PATH, {_id: id})
         .save(TestMdlA, {_id: ["fail"]}, {name: "fail"})
@@ -92,7 +92,7 @@ module.exports = describe("Roller", function(){
 
     it("should rollback file remove", function (done) {
       var gfs = Grid(mongoose.connection.db);
-      var id = utils.generateId();
+      var id = dbUtils.generateId();
       var writeStream = gfs.createWriteStream({_id: id});
 
       writeStream.on("close", function () {

tests/task.tests.js

@@ -333,7 +333,7 @@ module.exports = describe("Task", function(){
   describe("Results Array", function () {
     it("Should have the results of all operations", function () {
       var gabe = new TestMdlB({name: "Gabe", age: 34});
-      var id = utils.generateId();
+      var id = dbUtils.generateId();
 
       return expect(
         task.save(gabe)