extracting utils functions from main code into its own module + tests

Author: goenning

README.md

@@ -21,9 +21,9 @@ Things to do:
 - remove dependency from express and connect
 - storing of client timings on first result postback (there's a todo in the `results` function about where to do this)
 - document more things
-- tests for everything
-- add examples for every frameworks
+- better unit test code coverage for everything
+- add examples for every web frameworks
 - add examples for every provider
 - add more providers (mongodb, mysql, redis)
-- remove old ids from global storage
+- remove old ids from global storage (when?)
 - add eslint to travis

examples/express/server.js

@@ -17,8 +17,8 @@ app.get('/', function (req, res) {
 
 app.get('/multi-query', function (req, res) {
 	pg.connect(connString, function (err, client, done) {
-		client.query('SELECT pg_sleep(1)', [], function (err, result) {
-			client.query('SELECT $1::int AS number', ['2'], function (err, result) {
+		client.query('SELECT pg_sleep(1)', [], function (err) {
+			client.query('SELECT $1::int AS number', ['2'], function (err) {
 				done();
 				res.render('multi-query');
 			});

lib/miniprofiler.js

@@ -14,6 +14,8 @@ var os = require('os');
 var path = require('path');
 var qs = require('querystring');
 var url = require('url');
+var utils = require('./utils.js');
+var uuid = require('node-uuid');
 
 _.templateSettings = {
 	interpolate: /\{(.+?)\}/g
@@ -122,13 +124,6 @@ var includes = {
 	share: _.template(fs.readFileSync(path.join(includesDir, 'share.html')).toString())
 };
 
-// FUNCTIONS
-if (typeof String.prototype.startsWith != 'function') {
-	String.prototype.startsWith = function (str){
-		return this.slice(0, str.length) == str;
-	};
-}
-
 function middleware(f) {
 	if(!f) f = function() { return true; };
 	return function(req, res, next) {
@@ -227,7 +222,7 @@ function addProfilingInstrumentation(toInstrument) {
 		throw new Error('toInstrument must be set');
 	}
 
-	if(!isObject(toInstrument)) {
+	if(!utils.isObject(toInstrument)) {
 		throw new Error('toInstrument must be an object');
 	}
 
@@ -254,7 +249,7 @@ function startProfiling(request, enabled) {
 		currentRequestExtension.startTime = process.hrtime();
 		currentRequestExtension.stopTime = null;
 		currentRequestExtension.stepGraph = makeStep(request.path, currentRequestExtension.startTime, null);
-		currentRequestExtension.id = makeGuid();
+		currentRequestExtension.id = uuid.v4();
 		currentRequestExtension.customTimings = {};
 	}
 	currentRequestExtension.timeQuery = function() {
@@ -363,9 +358,9 @@ function timeQuery(extension, type, query, executeFunction) {
 	}
 
 	var customTiming = {
-		id: makeGuid(),
+		id: uuid.v4(),
 		executeType: type,
-		commandString: htmlEscape(query),
+		commandString: utils.htmlEscape(query),
 		startTime: time,
 		startDate: startDate,
 		callStack: new Error().stack
@@ -374,7 +369,7 @@ function timeQuery(extension, type, query, executeFunction) {
 
 	for(var i = 0; i < params.length; i++){
 		var param = params[i];
-		if(isFunction(params[i])){
+		if(utils.isFunction(params[i])){
 			params[i] = function() {
 				customTiming.stopTime = process.hrtime();
 
@@ -390,15 +385,6 @@ function timeQuery(extension, type, query, executeFunction) {
 	return ret;
 }
 
-function htmlEscape(str) {
-	return String(str)
-			.replace(/&/g, '&amp;')
-			.replace(/"/g, '&quot;')
-			.replace(/'/g, '&#39;')
-			.replace(/</g, '&lt;')
-			.replace(/>/g, '&gt;');
-}
-
 function unstep(name, request, failed) {
 	var time = process.hrtime();
 
@@ -415,14 +401,6 @@ function unstep(name, request, failed) {
 	extension.stepGraph = extension.stepGraph.parent;
 }
 
-function makeGuid() {
-	// http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript
-	return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
-				var r = Math.random()*16|0, v = c == 'x' ? r : (r&0x3|0x8);
-				return v.toString(16);
-			});
-}
-
 function describePerformance(root, request) {
 	var ret = {};
 
@@ -461,7 +439,7 @@ function callStack(stack) {
 }
 
 function describeTimings(timing, root){
-	var id = makeGuid();
+	var id = uuid.v4();
 	var name = timing.name;
 	var elapsedMs = diff(timing.startTime, timing.stopTime);
 	var sinceRootMs = diff(root.startTime, timing.startTime);
@@ -513,15 +491,6 @@ function makeStep(name, time, parent){
 	return { name: name, startTime: time, stopTime: null, parent: parent, steps: [], customTimings: {} };
 }
 
-function isObject(val) {
-	return Function.prototype.call.bind(Object.prototype.toString)(val) == '[object Object]';
-}
-
-function isFunction(func) {
-	var getType = {};
-	return getType.toString.call(func) === '[object Function]';
-}
-
 function instrument(func, defaultName) {
 	var name = func.name || defaultName || 'Unnamed';
 
@@ -533,7 +502,7 @@ function instrument(func, defaultName) {
 		if(args) {
 			for(var i = 0; i < args.length; i++){
 				var arg = args[i];
-				if(arg && isFunction(arg)){
+				if(arg && utils.isFunction(arg)){
 					args[i] = instrument(arg, name+' arg #'+i);
 				}
 			}
@@ -579,13 +548,13 @@ function addProfilingImpl(toInstrument) {
 			continue;
 		}
 
-		if(isObject(toWrap)) {
+		if(utils.isObject(toWrap)) {
 			addProfilingImpl(toWrap);
 
 			continue;
 		}
 
-		if(isFunction(toWrap)) {
+		if(utils.isFunction(toWrap)) {
 			var wrappedFunc = instrument(toWrap, prop);
 
 			toInstrument[prop] = wrappedFunc;

lib/utils.js

@@ -0,0 +1,27 @@
+if (typeof String.prototype.startsWith != 'function') {
+	String.prototype.startsWith = function (str){
+		return this.slice(0, str.length) == str;
+	};
+}
+
+module.exports = {
+
+	isObject: function(val) {
+		return Function.prototype.call.bind(Object.prototype.toString)(val) == '[object Object]';
+	},
+
+	isFunction: function(func) {
+		var getType = {};
+		return getType.toString.call(func) === '[object Function]';
+	},
+
+	htmlEscape: function(str) {
+		return String(str)
+				.replace(/&/g, '&')
+				.replace(/"/g, '"')
+				.replace(/'/g, ''')
+				.replace(/</g, '&lt;')
+				.replace(/>/g, '&gt;');
+	}
+
+};

package.json

@@ -16,6 +16,7 @@
   "license": "Apache-2.0",
   "readmeFilename": "README.md",
   "dependencies": {
+    "node-uuid": "^1.4.7",
     "underscore": "1.5.2"
   },
   "devDependencies": {

tests/static-assets-test.js

@@ -10,7 +10,7 @@ describe('MiniProfiler Static Assets Tests', function() {
     'includes.css',
     'includes.tmpl',
     'includes.js'
-  ]
+  ];
 
   files.forEach((file) => {
     it(`Should return ${file} file`, function(done) {

tests/utils-test.js

@@ -0,0 +1,33 @@
+var expect = require('chai').expect;
+var utils = require('../lib/utils.js');
+
+describe('Utils Tests', function() {
+  [
+    [ 'apple', 'ap' ],
+    [ 'Apple', 'Ap' ]
+  ].forEach((testCase) => {
+    it(`${testCase[0]} should start with ${testCase[1]}`, function() {
+      expect(testCase[0].startsWith(testCase[1])).to.be.true;
+    });
+  });
+
+  [
+    [ 'Apple', 'ap' ],
+    [ 'apple', 'at' ]
+  ].forEach((testCase) => {
+    it(`${testCase[0]} should not start with ${testCase[1]}`, function() {
+      expect(testCase[0].startsWith(testCase[1])).to.be.false;
+    });
+  });
+
+  [
+    [ 'a=1&b=2', 'a=1&b=2' ],
+    [ '"Hello"', '"Hello"' ],
+    [ `'World'`, ''World'' ],
+    [ '<title/>', '&lt;title/&gt;' ]
+  ].forEach((testCase) => {
+    it(`${testCase[0]} should escape to ${testCase[1]}`, function() {
+      expect(utils.htmlEscape(testCase[0])).to.be.equal(testCase[1]);
+    });
+  });
+});