Separate StackFrame dependency. Pull StackFrame in via bower for testing.

Eric Wendelin · Eric Wendelin · commit c64317f335ff · 2014-10-05T20:22:14.000-06:00
diff --git a/.gitignore b/.gitignore
@@ -11,7 +11,6 @@ pids
 logs
 results
 
-npm-debug.log
 node_modules
 bower_components
 
diff --git a/bower.json b/bower.json
@@ -1,34 +1,37 @@
 {
-  "name": "stack-parser",
-  "version": "0.1.0",
-  "main": "./stack-parser.js",
-  "homepage": "https://github.com/stacktracejs/stack-parser.js",
-  "authors": [
-    "Eric Wendelin <me@eriwen.com>"
-  ],
-  "description": "Extract meaning from JS Errors",
-  "moduleType": [
-    "amd",
-    "globals",
-    "node"
-  ],
-  "keywords": [
-    "stacktrace",
-    "stack-trace",
-    "backtrace",
-    "cross-browser",
-    "framework-agnostic",
-    "error"
-  ],
-  "license": "MIT",
-  "ignore": [
-    "**/.*",
-    "node_modules",
-    "bower_components",
-    "spec"
-  ],
-  "devDependencies": {
-    "jasmine": "~1.3.1",
-    "jasmine-jstd-adapter": "~1.1.2"
-  }
+    "name": "stack-parser",
+    "version": "0.1.0",
+    "main": "./stack-parser.js",
+    "homepage": "https://github.com/stacktracejs/stack-parser.js",
+    "authors": [
+        "Eric Wendelin <me@eriwen.com>"
+    ],
+    "description": "Extract meaning from JS Errors",
+    "dependencies": {
+        "stackframe": "0.1.0"
+    },
+    "devDependencies": {
+        "jasmine": "~1.3.1",
+        "jasmine-jstd-adapter": "~1.1.2"
+    },
+    "moduleType": [
+        "amd",
+        "globals",
+        "node"
+    ],
+    "keywords": [
+        "stacktrace",
+        "stack-trace",
+        "backtrace",
+        "cross-browser",
+        "framework-agnostic",
+        "error"
+    ],
+    "license": "MIT",
+    "ignore": [
+        "**/.*",
+        "node_modules",
+        "bower_components",
+        "spec"
+    ]
 }
diff --git a/package.json b/package.json
@@ -4,7 +4,10 @@
   "author": "Eric Wendelin <me@eriwen.com> (http://eriwen.com)",
   "version": "0.1.0",
   "keywords": ["stacktrace", "error"],
-  "homepage": "http://stacktracejs.com",
+  "homepage": "http://www.stacktracejs.com",
+  "dependencies": {
+    "stackframe": "0.1.0"
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/stacktracejs/stack-parser.git"
diff --git a/spec/SpecRunner.html b/spec/SpecRunner.html
@@ -7,11 +7,12 @@
 
     <script type="text/javascript" src="../bower_components/jasmine/lib/jasmine-core/jasmine.js"></script>
     <script type="text/javascript" src="../bower_components/jasmine/lib/jasmine-core/jasmine-html.js"></script>
-    <script type="text/javascript" src="../bower_components/jasmine/lib/jasmine-core/boot.js"></script>
+    <script type="text/javascript" src="../bower_components/stackframe/stackframe.js"></script>
 
     <script type="text/javascript" src="../stack-parser.js"></script>
 
     <script type="text/javascript" src="captured-errors.js"></script>
+    <script type="text/javascript" src="spec-helper.js"></script>
     <script type="text/javascript" src="stack-parser-spec.js"></script>
 
     <script type="text/javascript">
diff --git a/spec/jsTestDriver.conf b/spec/jsTestDriver.conf
@@ -3,9 +3,11 @@ server: http://localhost:4224
 load:
   - ../bower_components/jasmine/lib/jasmine-core/jasmine.js
   - ../bower_components/jasmine-jstd-adapter/src/JasmineAdapter.js
+  - ../bower_components/stackframe/stackframe.js
   - captured-errors.js
   - ../stack-parser.js
+  - spec-helper.js
 test:
   - stack-parser-spec.js
 
-timeout: 15
+timeout: 30
diff --git a/spec/spec-helper.js b/spec/spec-helper.js
@@ -0,0 +1,28 @@
+beforeEach(function() {
+    this.addMatchers({
+        toMatchStackFrame: function(expected) {
+            var actual = this.actual;
+            var message = '';
+            if (actual.getFunctionName() !== expected[0]) {
+                message += 'expected functionName: ' + actual.getFunctionName() + ' to equal ' + expected[0] + '\n';
+            }
+            if (actual.getArgs() !== expected[1]) {
+                message += 'expected args: ' + actual.getArgs() + ' to equal ' + expected[1] + '\n';
+            }
+            if (actual.getFileName() !== expected[2]) {
+                message += 'expected fileName: ' + actual.getFileName() + ' to equal ' + expected[2] + '\n';
+            }
+            if (actual.getLineNumber() !== expected[3]) {
+                message += 'expected lineNumber: ' + actual.getLineNumber() + ' to equal ' + expected[3] + '\n';
+            }
+            if (actual.getColumnNumber() !== expected[4]) {
+                message += 'expected columnNumber: ' + actual.getColumnNumber() + ' to equal ' + expected[4] + '\n';
+            }
+            this.message = function() { return message };
+            return message === '';
+        }
+    });
+});
+
+
+
diff --git a/spec/stack-parser-spec.js b/spec/stack-parser-spec.js
@@ -6,64 +6,64 @@ describe('StackParser', function () {
             var stackFrames = unit.parse(CapturedExceptions.SAFARI_6);
             expect(stackFrames).toBeTruthy();
             expect(stackFrames.length).toBe(3);
-            expect(stackFrames[0]).toEqual(new StackFrame('', [], 'http://path/to/file.js', '48'));
-            expect(stackFrames[1]).toEqual(new StackFrame('dumpException3', [], 'http://path/to/file.js', '52'));
-            expect(stackFrames[2]).toEqual(new StackFrame('onclick', [], 'http://path/to/file.js', '82'));
+            expect(stackFrames[0]).toMatchStackFrame([undefined, undefined, 'http://path/to/file.js', 48]);
+            expect(stackFrames[1]).toMatchStackFrame(['dumpException3', undefined, 'http://path/to/file.js', 52]);
+            expect(stackFrames[2]).toMatchStackFrame(['onclick', undefined, 'http://path/to/file.js', 82]);
         });
 
         it('should parse Safari 7 Error.stack', function () {
             var stackFrames = unit.parse(CapturedExceptions.SAFARI_7);
             expect(stackFrames).toBeTruthy();
             expect(stackFrames.length).toBe(3);
-            expect(stackFrames[0]).toEqual(new StackFrame('', [], 'http://path/to/file.js', '48', '22'));
-            expect(stackFrames[1]).toEqual(new StackFrame('foo', [], 'http://path/to/file.js', '52', '15'));
-            expect(stackFrames[2]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '108', '107'));
+            expect(stackFrames[0]).toMatchStackFrame([undefined, undefined, 'http://path/to/file.js', 48, 22]);
+            expect(stackFrames[1]).toMatchStackFrame(['foo', undefined, 'http://path/to/file.js', 52, 15]);
+            expect(stackFrames[2]).toMatchStackFrame(['bar', undefined, 'http://path/to/file.js', 108, 107]);
         });
 
         it('should parse Firefox 31 Error.stack', function () {
             var stackFrames = unit.parse(CapturedExceptions.FIREFOX_31);
             expect(stackFrames).toBeTruthy();
             expect(stackFrames.length).toBe(2);
-            expect(stackFrames[0]).toEqual(new StackFrame('foo', [], 'http://path/to/file.js', '41', '13'));
-            expect(stackFrames[1]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '1', '1'));
+            expect(stackFrames[0]).toMatchStackFrame(['foo', undefined, 'http://path/to/file.js', 41, 13]);
+            expect(stackFrames[1]).toMatchStackFrame(['bar', undefined, 'http://path/to/file.js', 1, 1]);
         });
 
         it('should parse V8 Error stacks', function () {
             var stackFrames = unit.parse(CapturedExceptions.CHROME_15);
             expect(stackFrames).toBeTruthy();
             expect(stackFrames.length).toBe(4);
-            expect(stackFrames[0]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '13', '17'));
-            expect(stackFrames[1]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '16', '5'));
-            expect(stackFrames[2]).toEqual(new StackFrame('foo', [], 'http://path/to/file.js', '20', '5'));
-            expect(stackFrames[3]).toEqual(new StackFrame('', [], 'http://path/to/file.js', '24', '4'));
+            expect(stackFrames[0]).toMatchStackFrame(['bar', undefined, 'http://path/to/file.js', 13, 17]);
+            expect(stackFrames[1]).toMatchStackFrame(['bar', undefined, 'http://path/to/file.js', 16, 5]);
+            expect(stackFrames[2]).toMatchStackFrame(['foo', undefined, 'http://path/to/file.js', 20, 5]);
+            expect(stackFrames[3]).toMatchStackFrame([undefined, undefined, 'http://path/to/file.js', 24, 4]);
         });
 
         it('should parse IE 10 Error stacks', function () {
             var stackFrames = unit.parse(CapturedExceptions.IE_10);
             expect(stackFrames).toBeTruthy();
             expect(stackFrames.length).toBe(3);
-            expect(stackFrames[0]).toEqual(new StackFrame('', [], 'http://path/to/file.js', '48', '13'));
-            expect(stackFrames[1]).toEqual(new StackFrame('foo', [], 'http://path/to/file.js', '46', '9'));
-            expect(stackFrames[2]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '82', '1'));
+            expect(stackFrames[0]).toMatchStackFrame([undefined, undefined, 'http://path/to/file.js', 48, 13]);
+            expect(stackFrames[1]).toMatchStackFrame(['foo', undefined, 'http://path/to/file.js', 46, 9]);
+            expect(stackFrames[2]).toMatchStackFrame(['bar', undefined, 'http://path/to/file.js', 82, 1]);
         });
 
         it('should parse Opera 9.27 Error messages', function () {
             var stackFrames = unit.parse(CapturedExceptions.OPERA_927);
             expect(stackFrames).toBeTruthy();
             expect(stackFrames.length).toBe(3);
-            expect(stackFrames[0]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '42'));
-            expect(stackFrames[1]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '27'));
-            expect(stackFrames[2]).toEqual(new StackFrame('foo', [], 'http://path/to/file.js', '18'));
+            expect(stackFrames[0]).toMatchStackFrame([undefined, undefined, 'http://path/to/file.js', 43]);
+            expect(stackFrames[1]).toMatchStackFrame([undefined, undefined, 'http://path/to/file.js', 31]);
+            expect(stackFrames[2]).toMatchStackFrame([undefined, undefined, 'http://path/to/file.js', 18]);
         });
 
         it('should parse Opera 11 Error messages', function () {
             var stackFrames = unit.parse(CapturedExceptions.OPERA_11);
             expect(stackFrames).toBeTruthy();
             expect(stackFrames.length).toBe(4);
-            expect(stackFrames[0]).toEqual(new StackFrame('run', [], 'http://path/to/file.js', '27'));
-            expect(stackFrames[0]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '18'));
-            expect(stackFrames[1]).toEqual(new StackFrame('bar', [], 'http://path/to/file.js', '11'));
-            expect(stackFrames[2]).toEqual(new StackFrame('', [], 'http://path/to/file.js', '15'));
+            expect(stackFrames[0]).toMatchStackFrame(['run', undefined, 'http://path/to/file.js', 27]);
+            expect(stackFrames[1]).toMatchStackFrame(['bar', undefined, 'http://path/to/file.js', 18]);
+            expect(stackFrames[2]).toMatchStackFrame(['foo', undefined, 'http://path/to/file.js', 11]);
+            expect(stackFrames[3]).toMatchStackFrame([undefined, undefined, 'http://path/to/file.js', 15]);
         });
     });
 });
diff --git a/stack-parser.js b/stack-parser.js
@@ -1,32 +1,16 @@
-// TODO: split into new module
+/* global StackFrame: false */
 (function (root, factory) {
+    'use strict';
+    // Universal Module Definition (UMD) to support AMD, CommonJS/Node.js, Rhino, and browsers.
     if (typeof define === 'function' && define.amd) {
-        define([], factory);
+        define(['stackframe'], factory);
     } else if (typeof exports === 'object') {
-        module.exports = factory();
+        module.exports = factory(require('stackframe'));
     } else {
-        root.StackFrame = factory();
-    }
-}(this, function () {
-    return function StackFrame(functionName, args, srcUrl, lineNumber, columnNumber) {
-        this.fn = functionName;
-        this.args = args;
-        this.src = srcUrl;
-        this.line = lineNumber;
-        this.column = columnNumber;
-    }
-}));
-
-// TODO?: Error.prototype.parseError = function parseError(e) {};
-(function (root, factory) {
-    if (typeof define === 'function' && define.amd) {
-        define([], factory);
-    } else if (typeof exports === 'object') {
-        module.exports = factory();
-    } else {
-        root.StackParser = factory();
+        root.StackParser = factory(root.StackFrame);
     }
 }(this, function () {
+    'use strict';
     return function StackParser() {
         this.firefoxSafariStackEntryRegExp = /\S+\:\d+/;
         this.chromeIEStackEntryRegExp = /\s+at /;
@@ -37,7 +21,7 @@
          * @return Array[StackFrame]
          */
         this.parse = function parse(error) {
-            if (typeof error.stacktrace === 'string') {
+            if (typeof error.stacktrace !== 'undefined' || typeof error['opera#sourceloc'] !== 'undefined') {
                 return this.parseOpera(error);
             } else if (error.stack.match(this.chromeIEStackEntryRegExp)) {
                 return this.parseV8OrIE(error);
@@ -49,38 +33,28 @@
         };
 
         this.parseV8OrIE = function parseV8OrIE(error) {
-            /* stack: "TypeError: Object #<Object> has no method 'undef'\n" +
-             "    at Object.bar (http://path/to/stacktrace.js:42:18)\n" +
-             "    at foo (http://path/to/file.js:20:5)\n" +
-             "    at http://path/to/file.js:24:4"*/
-
             return error.stack.split('\n').splice(1).map(function (line) {
                 var tokens = line.split(/\s+/).splice(2);
                 var location = tokens.pop().replace(/[\(\)\s]/g, '').split(':');
-                var functionName = (!tokens[0] || tokens[0] === 'Anonymous') ? '' : tokens[0];
-                return new StackFrame(functionName, [], location[0] + ':' + location[1], location[2], location[3]);
+                var functionName = (!tokens[0] || tokens[0] === 'Anonymous') ? undefined : tokens[0];
+                return new StackFrame(functionName, undefined, location[0] + ':' + location[1], location[2], location[3]);
             });
         };
 
         this.parseFFOrSafari = function parseFFOrSafari(error) {
-            /* stack: "@http://path/to/file.js:48\n" +
-             "bar@http://path/to/file.js:52\n" +
-             "foo@http://path/to/file.js:82\n" +
-             "[native code]" */
-
             return error.stack.split('\n').filter(function (line) {
                 return !!line.match(this.firefoxSafariStackEntryRegExp);
             }.bind(this)).map(function (line) {
                 var tokens = line.split('@');
                 var location = tokens.pop().split(':');
-                var functionName = tokens.shift() || '';
-                return new StackFrame(functionName, [], location[0] + ':' + location[1], location[2], location[3]);
+                var functionName = tokens.shift() || undefined;
+                return new StackFrame(functionName, undefined, location[0] + ':' + location[1], location[2], location[3]);
             });
         };
 
         this.parseOpera = function parseOpera(e) {
-            if (!e.stacktrace || (e.message.indexOf('\n') > -1
-                && e.message.split('\n').length > e.stacktrace.split('\n').length)) {
+            if (!e.stacktrace || (e.message.indexOf('\n') > -1 &&
+                    e.message.split('\n').length > e.stacktrace.split('\n').length)) {
                 return this.parseOpera9(e);
             } else if (!e.stack) {
                 return this.parseOpera10a(e);
@@ -92,25 +66,21 @@
         };
 
         this.parseOpera9 = function parseOpera9(e) {
-            // "  Line 43 of linked script http://path/to.js\n"
-            // "  Line 7 of inline#1 script in http://path/to.js\n"
             var lineRE = /Line (\d+).*script (?:in )?(\S+)/i;
             var lines = e.message.split('\n');
             var result = [];
 
             for (var i = 2, len = lines.length; i < len; i += 2) {
                 var match = lineRE.exec(lines[i]);
                 if (match) {
-                    result.push(new StackFrame('', [], match[2], match[1]));
+                    result.push(new StackFrame(undefined, undefined, match[2], match[1]));
                 }
             }
 
             return result;
         };
 
         this.parseOpera10a = function parseOpera10a(e) {
-            // "  Line 27 of linked script http://path/to.js\n"
-            // "  Line 11 of inline#1 script in http://path/to.js: In function foo\n"
             var ANON = '{anonymous}', lineRE = /Line (\d+).*script (?:in )?(\S+)(?:: In function (\S+))?$/i;
             var lines = e.stacktrace.split('\n'), result = [];
 
@@ -133,11 +103,12 @@
                 var tokens = line.split('@');
                 var location = tokens.pop().split(':');
                 var functionCall = (tokens.shift() || '');
-                var functionName = functionCall.replace(/<anonymous function: (\S+)(\([^\(]*\))?>/, '$1');
-                var args = functionCall.replace(/^[^\(]+\(([^\)]*)\)$/, '$1').replace('arguments not available', '').split(',');
+                var functionName = functionCall.replace(/<anonymous function: (\w+)>/, '$1').replace(/\([^\)]*\)/, '') || undefined;
+                var argsRaw = functionCall.replace(/^[^\(]+\(([^\)]*)\)$/, '$1') || undefined;
+                var args = (argsRaw === undefined || argsRaw === '[arguments not available]') ? undefined : argsRaw.split(',');
                 return new StackFrame(functionName, args, location[0] + ':' + location[1], location[2], location[3]);
             });
-        }
-    }
+        };
+    };
 }));
 
