dynamic-record - npm Package Compare versions

Comparing version 0.5.3 to 0.5.4

build/DynamicCollection.js

@@ -63,14 +63,9 @@ "use strict";
      */
-    // NOTE: parallel save of collection with auto incrementing index failing (write lock)
+    // CONSIDER: Saving in series thus slow. Can consider assigning a block of counters at once
     saveAll() {
-        const promises = [];
-        _.each(this, (model) => {
+        return Promise.each(this, (model) => {
             if (model.save) {
-                // Consider doing bulk write
-                promises.push(model.save());
+                return model.save();
             }
         });
-        return Promise.all(promises).then(() => {
-            return Promise.resolve(this);
-        });
     }
@@ -77,0 +72,0 @@ /**

build/DynamicRecord.js

@@ -9,3 +9,2 @@ "use strict";
 // Let's get mongodb working first
-// NOTE: making too many connections, each instance create one connection
 const connect = require("./mongoConnection.js");
@@ -81,2 +80,7 @@ const schemaValidator = new (require("./schemaValidation.js"))(connect);
          *
+         * If you have a series of models of the same schema, it is recommended
+         * to put them in a DynamicCollection and calling `saveAll()` on it
+         * instead of attempting to save them all in parallel. This applies to
+         * schemas with auto incrementing counters.
+         *
          * @method save
@@ -89,3 +93,2 @@ * @memberOf DynamicRecord.Model
             // NOTE: need some way to modify counters (?) or bypass schema check if none exist
-            // NOTE: parallel save of collection with auto incrementing index failing (write lock)
             return _ready.then((col) => {
@@ -92,0 +95,0 @@ if (this._original) {

build/DynamicSchema.js

@@ -268,5 +268,5 @@ "use strict";
     }
-    //renameIndex(columnName, newColumnName){
-    // Maybe drop index then recreate but do consider why you need to do this
-    //}
+    // renameIndex(columnName, newColumnName){
+    // 	Maybe drop index then recreate but do consider why you need to do this
+    // }
     /**
@@ -273,0 +273,0 @@ * Remove an index to the table's schema

build/mongoConnection.js

 require("dotenv").config();
-const f = require("util").format;
 const MongoClient = require("mongodb").MongoClient;
-const mongoURL = f("mongodb://%s:%s@%s/%s", process.env.mongo_user, process.env.mongo_pass, process.env.mongo_server, process.env.mongo_db_name);
+const mongoURL = `mongodb://${process.env.mongo_user}:${process.env.mongo_pass}@${process.env.mongo_server}/${process.env.mongo_db_name}`;
 const client = new MongoClient(mongoURL, {
@@ -14,6 +13,1 @@ poolSize: 10,
 });
-// module.exports = function(databaseAddress, databaseName, username, password){
-// 	const mongoURL = f("mongodb://%s:%s@%s/%s", username, password, databaseAddress, databaseName);
-// 	const connection = MongoClient.connect(mongoURL, {poolSize: 10});
-// 	return connection;
-// };

package.json

 {
   "name": "dynamic-record",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "A bare minimum Javascript implementation of the Active Record pattern",
@@ -40,5 +40,5 @@ "keywords": [
     "bluebird": "^3.5.1",
-    "commander": "^2.20.0",
-    "dotenv": "^5.0.1",
-    "inquirer": "^6.3.1",
+    "commander": "^4.0.0",
+    "dotenv": "^8.2.0",
+    "inquirer": "^7.0.0",
     "lodash": "^4.17.15",
@@ -49,11 +49,13 @@ "moment": "^2.22.2",
   "devDependencies": {
-    "@types/node": "^10.12.2",
-    "chai": "^4.1.2",
-    "eslint": "^4.18.2",
+    "@types/node": "^12.12.7",
+    "@typescript-eslint/eslint-plugin": "^2.6.1",
+    "@typescript-eslint/parser": "^2.6.1",
+    "chai": "^4.2.0",
+    "eslint": "^6.6.0",
     "jsdoc": "^3.6.3",
-    "mocha": "^5.0.4",
-    "surge": "^0.20.5",
+    "mocha": "^6.2.2",
+    "surge": "^0.21.3",
     "tui-jsdoc-template": "^1.2.2",
-    "typescript": "^3.1.6"
+    "typescript": "^3.7.2"
   }
 }

src/DynamicCollection.ts

@@ -48,3 +48,3 @@ import _ = require("lodash");
 	 */
-	 // Not sure if this is necessary as we can just destructure array
+	// Not sure if this is necessary as we can just destructure array
 	static fromArray(arr, Model){
@@ -67,15 +67,9 @@ const result = _.reduce(arr, (acc, el, i) => {
 	 */
-	// NOTE: parallel save of collection with auto incrementing index failing (write lock)
+	// CONSIDER: Saving in series thus slow. Can consider assigning a block of counters at once
 	saveAll(){
-		const promises = [];
-		_.each(this, (model) => {
+		return Promise.each(this, (model) => {
 			if(model.save){
-				// Consider doing bulk write
-				promises.push(model.save());
+				return model.save();
 			}
 		});
-
-		return Promise.all(promises).then(() => {
-			return Promise.resolve(this);
-		});
 	}
@@ -82,0 +76,0 @@

src/DynamicRecord.ts

@@ -8,3 +8,2 @@ require("dotenv").config();
 // Let's get mongodb working first
-// NOTE: making too many connections, each instance create one connection
 const connect = require("./mongoConnection.js");
@@ -99,2 +98,7 @@ const schemaValidator = new (require("./schemaValidation.js"))(connect);
 		 *
+		 * If you have a series of models of the same schema, it is recommended
+		 * to put them in a DynamicCollection and calling `saveAll()` on it
+		 * instead of attempting to save them all in parallel. This applies to
+		 * schemas with auto incrementing counters.
+		 *
 		 * @method save
@@ -107,3 +111,2 @@ * @memberOf DynamicRecord.Model
 			// NOTE: need some way to modify counters (?) or bypass schema check if none exist
-			// NOTE: parallel save of collection with auto incrementing index failing (write lock)
 			return _ready.then((col) => {
@@ -284,3 +287,3 @@ if(this._original){
 				_.each(results, (result) => {
-					result._original = _.cloneDeep(result.data)
+					result._original = _.cloneDeep(result.data);
 				});
@@ -312,3 +315,3 @@
 				_.each(results, (result) => {
-					result._original = _.cloneDeep(result.data)
+					result._original = _.cloneDeep(result.data);
 				});
@@ -315,0 +318,0 @@

src/DynamicSchema.ts

@@ -330,5 +330,5 @@ require("dotenv").config();
 
-	//renameIndex(columnName, newColumnName){
-		// Maybe drop index then recreate but do consider why you need to do this
-	//}
+	// renameIndex(columnName, newColumnName){
+	// 	Maybe drop index then recreate but do consider why you need to do this
+	// }
 
@@ -457,3 +457,3 @@ /**
 			type: type
-		}
+		};
 
@@ -675,6 +675,6 @@ return this._writeSchema().then(() => {
 
-	//private _validate(){
-		// Validate database schema with this.definition
-		// Return boolean
-	//}
+	// private _validate(){
+	// 	Validate database schema with this.definition
+	// 	Return boolean
+	// }
 }
@@ -681,0 +681,0 @@

src/mongoConnection.ts

 require("dotenv").config();
-const f = require("util").format;
 const MongoClient = require("mongodb").MongoClient;
 
-const mongoURL = f("mongodb://%s:%s@%s/%s", process.env.mongo_user, process.env.mongo_pass, process.env.mongo_server, process.env.mongo_db_name);
+const mongoURL = `mongodb://${process.env.mongo_user}:${process.env.mongo_pass}@${process.env.mongo_server}/${process.env.mongo_db_name}`;
 const client = new MongoClient(mongoURL, {
@@ -14,8 +13,2 @@ poolSize: 10,
 	return Promise.resolve({db, client});
-});
-
-// module.exports = function(databaseAddress, databaseName, username, password){
-// 	const mongoURL = f("mongodb://%s:%s@%s/%s", username, password, databaseAddress, databaseName);
-// 	const connection = MongoClient.connect(mongoURL, {poolSize: 10});
-// 	return connection;
-// };
+});

test/DynamicCollection.js

 // For setup and clean ups
 require("dotenv").config();
-const f = require("util").format;
 const Promise = require("bluebird");
 const _ = require("lodash");
 const MongoClient = require("mongodb").MongoClient;
-const mongoURL = f("mongodb://%s:%s@%s/%s", process.env.mongo_user, process.env.mongo_pass, process.env.mongo_server, process.env.mongo_db_name);
+const mongoURL = `mongodb://${process.env.mongo_user}:${process.env.mongo_pass}@${process.env.mongo_server}/${process.env.mongo_db_name}`;
 const connect = MongoClient.connect(mongoURL, {useUnifiedTopology: true});
@@ -133,3 +132,41 @@
 
-		it("should set the autoincrementing index correctly");
+		describe("autoIncrement", function(){
+			beforeEach(function(){
+				return connect.then((client) => {
+					const db = client.db();
+					return db.collection("_counters").insertOne({
+						"_$id": testSchema.$id,
+						sequences: {
+							int: 0
+						}
+					});
+				});
+			});
+
+			afterEach(function(){
+				return connect.then((client) => {
+					const db = client.db();
+					return db.collection("_counters").deleteOne({"_$id": testSchema.$id});
+				});
+			});
+
+			it("should set the autoincrementing index correctly", function(){
+				col.forEach((model) => {
+					delete model.data.int;
+				});
+				return col.saveAll().then((res) => {
+					return connect.then((client) => {
+						const db = client.db();
+						return db.collection(testSchema.$id).find().toArray();
+					});
+				}).then((res) => {
+					for(let i=0; i<res.length; i++){
+						assert.equal(res[i].int, i+1, `database entry has auto increment value ${i+1}`);
+					}
+					for(let i=0; i<col.length; i++){
+						assert.equal(col[i].data.int, i+1, `collection entry has auto increment value ${i+1}`);
+					}
+				});
+			});
+		});
 	});
@@ -136,0 +173,0 @@

test/DynamicRecord.js

 // For setup and clean ups
 require("dotenv").config();
-const f = require("util").format;
 const Promise = require("bluebird");
 const _ = require("lodash");
 const MongoClient = require("mongodb").MongoClient;
-const mongoURL = f("mongodb://%s:%s@%s/%s", process.env.mongo_user, process.env.mongo_pass, process.env.mongo_server, process.env.mongo_db_name);
+const mongoURL = `mongodb://${process.env.mongo_user}:${process.env.mongo_pass}@${process.env.mongo_server}/${process.env.mongo_db_name}`;
 const connect = MongoClient.connect(mongoURL, {useUnifiedTopology: true});
@@ -9,0 +8,0 @@

test/DynamicRecordModel.js

 // For setup and clean ups
 require("dotenv").config();
-const f = require("util").format;
 const Promise = require("bluebird");
 const _ = require("lodash");
 const MongoClient = require("mongodb").MongoClient;
-const mongoURL = f("mongodb://%s:%s@%s/%s", process.env.mongo_user, process.env.mongo_pass, process.env.mongo_server, process.env.mongo_db_name);
+const mongoURL = `mongodb://${process.env.mongo_user}:${process.env.mongo_pass}@${process.env.mongo_server}/${process.env.mongo_db_name}`;
 const connect = MongoClient.connect(mongoURL, {useUnifiedTopology: true});
@@ -9,0 +8,0 @@

test/DynamicSchema.js

 // For setup and clean ups
 require("dotenv").config();
-const f = require("util").format;
 const Promise = require("bluebird");
 const _ = require("lodash");
 const MongoClient = require("mongodb").MongoClient;
-const mongoURL = f("mongodb://%s:%s@%s/%s", process.env.mongo_user, process.env.mongo_pass, process.env.mongo_server, process.env.mongo_db_name);
+const mongoURL = `mongodb://${process.env.mongo_user}:${process.env.mongo_pass}@${process.env.mongo_server}/${process.env.mongo_db_name}`;
 const connect = MongoClient.connect(mongoURL, {useUnifiedTopology: true});
@@ -9,0 +8,0 @@

test/random_table.schema.json

@@ -28,3 +28,3 @@ {
 	},
-	"required": ["string", "int", "float"]
+	"required": ["string", "float"]
 }

No alert changes

Improved metrics

Total package byte prevSize

150226

increased by0.24%

Lines of code

4217

increased by0.38%

Worsened metrics

Dev dependency count

10

increased by25%

Dependency changes

• + Addedansi-escapes@4.3.2(transitive)

• + Addedansi-regex@5.0.1(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedchalk@4.1.2(transitive)

• + Addedcli-cursor@3.1.0(transitive)

• + Addedcli-width@3.0.0(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedcommander@4.1.1(transitive)

• + Addeddotenv@8.6.0(transitive)

• + Addedemoji-regex@8.0.0(transitive)

• + Addedfigures@3.2.0(transitive)

• + Addedhas-flag@4.0.0(transitive)

• + Addedinquirer@7.3.3(transitive)

• + Addedis-fullwidth-code-point@3.0.0(transitive)

• + Addedmimic-fn@2.1.0(transitive)

• + Addedmute-stream@0.0.8(transitive)

• + Addedonetime@5.1.2(transitive)

• + Addedrestore-cursor@3.1.0(transitive)

• + Addedstring-width@4.2.3(transitive)

• + Addedstrip-ansi@6.0.1(transitive)

• + Addedsupports-color@7.2.0(transitive)

• + Addedtype-fest@0.21.3(transitive)

• - Removedansi-escapes@3.2.0(transitive)

• - Removedansi-regex@3.0.14.1.1(transitive)

• - Removedansi-styles@3.2.1(transitive)

• - Removedchalk@2.4.2(transitive)

• - Removedcli-cursor@2.1.0(transitive)

• - Removedcli-width@2.2.1(transitive)

• - Removedcolor-convert@1.9.3(transitive)

• - Removedcolor-name@1.1.3(transitive)

• - Removedcommander@2.20.3(transitive)

• - Removeddotenv@5.0.1(transitive)

• - Removedfigures@2.0.0(transitive)

• - Removedhas-flag@3.0.0(transitive)

• - Removedinquirer@6.5.2(transitive)

• - Removedis-fullwidth-code-point@2.0.0(transitive)

• - Removedmimic-fn@1.2.0(transitive)

• - Removedmute-stream@0.0.7(transitive)

• - Removedonetime@2.0.1(transitive)

• - Removedrestore-cursor@2.0.0(transitive)

• - Removedstring-width@2.1.1(transitive)

• - Removedstrip-ansi@4.0.05.2.0(transitive)

• - Removedsupports-color@5.5.0(transitive)

• Updatedcommander@^4.0.0

• Updateddotenv@^8.2.0

• Updatedinquirer@^7.0.0