Skip to content

Commit 55f7fa7

Browse files
niemyjskiniemyjski
committed
Added a node error parser
We should be able to get this down to one in the future
1 parent d8ba083 commit 55f7fa7

15 files changed

+203
-102
lines changed

‎gulpfile.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ gulp.task('exceptionless.es5', ['exceptionless.es5.umd'], function() {
4545
gulp.src(files)
4646
.pipe(sourcemaps.init({ loadMaps: true }))
4747
.pipe(concat('exceptionless.es5.js'))
48-
.pipe(replace('require(\'source-map/lib/source-map/source-map-consumer\')', '{}')) // needed for node until source maps dependency is fixed
48+
.pipe(replace('require(\'source-map/lib/source-map/source-map-consumer\')', 'null')) // needed for node until source maps dependency is fixed
4949
.pipe(sourcemaps.write('.'))
5050
.pipe(gulp.dest('dist'));
5151

5252
return gulp.src(files)
5353
.pipe(sourcemaps.init({ loadMaps: true }))
5454
.pipe(concat('exceptionless.es5.min.js'))
55-
.pipe(replace('require(\'source-map/lib/source-map/source-map-consumer\')', '{}')) // needed for node until source maps dependency is fixed
55+
.pipe(replace('require(\'source-map/lib/source-map/source-map-consumer\')', 'null')) // needed for node until source maps dependency is fixed
5656
.pipe(uglify())
5757
.pipe(sourcemaps.write('.'))
5858
.pipe(gulp.dest('dist'))

‎package.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,14 @@
4141
"karma-typescript-preprocessor": "0.0.17",
4242
"rimraf": "^2.3.3",
4343
"stack-generator": "^1.0.3",
44+
"stack-trace": "0.0.9",
4445
"stackframe": "^0.2.2",
4546
"stacktrace-gps": "^2.1.2",
4647
"stacktrace-js": "git://github.com/stacktracejs/stacktrace.js.git",
4748
"tsproject": "^0.8.6",
4849
"typescript": "1.5.0-beta"
4950
},
50-
"dependencies": {}
51+
"dependencies": {
52+
"stack-trace": "0.0.9"
53+
}
5154
}

‎src/EventBuilder.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,12 @@ export class EventBuilder {
115115
}
116116

117117
public addRequestInfo(request:any) {
118-
return this.setProperty('@request', request);
118+
if (!!request) {
119+
this.pluginContextData['@request'] = request;
120+
}
121+
122+
123+
return this;
119124
}
120125

121126
public submit(): Promise<any> {

‎src/bootstrap/NodeBootstrapper.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import { Configuration } from '../configuration/Configuration';
33
import { IConfigurationSettings } from '../configuration/IConfigurationSettings';
44
import { IError } from '../models/IError';
55
import { NodeEnvironmentInfoCollector } from '../services/NodeEnvironmentInfoCollector';
6+
import { NodeErrorParser } from '../services/NodeErrorParser';
67
import { NodeRequestInfoCollector } from '../services/NodeRequestInfoCollector';
78
import { NodeSubmissionClient } from '../submission/NodeSubmissionClient';
89
import { ExceptionlessClient } from '../ExceptionlessClient';
@@ -15,6 +16,7 @@ export class NodeBootstrapper implements IBootstrapper {
1516
}
1617

1718
Configuration.defaults.environmentInfoCollector = new NodeEnvironmentInfoCollector();
19+
Configuration.defaults.errorParser = new NodeErrorParser();
1820
Configuration.defaults.requestInfoCollector = new NodeRequestInfoCollector();
1921
Configuration.defaults.submissionClient = new NodeSubmissionClient();
2022
process.on('uncaughtException', function(error) {

‎src/bootstrap/WindowBootstrapper.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { IBootstrapper } from 'IBootstrapper';
22
import { Configuration } from '../configuration/Configuration';
33
import { IConfigurationSettings } from '../configuration/IConfigurationSettings';
44
import { IError } from '../models/IError';
5+
import { WebErrorParser } from '../services/WebErrorParser';
56
import { WebRequestInfoCollector } from '../services/WebRequestInfoCollector';
67
import { DefaultSubmissionClient } from '../submission/DefaultSubmissionClient';
78
import { ExceptionlessClient } from '../ExceptionlessClient';
@@ -19,6 +20,7 @@ export class WindowBootstrapper implements IBootstrapper {
1920
Configuration.defaults.serverUrl = settings.serverUrl;
2021
}
2122

23+
Configuration.defaults.errorParser = new WebErrorParser();
2224
Configuration.defaults.requestInfoCollector = new WebRequestInfoCollector();
2325
Configuration.defaults.submissionClient = new DefaultSubmissionClient();
2426
this.handleWindowOnError();

‎src/configuration/Configuration.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { ReferenceIdPlugin } from '../plugins/default/ReferenceIdPlugin';
1111
import { IEventQueue } from '../queue/IEventQueue';
1212
import { DefaultEventQueue } from '../queue/DefaultEventQueue';
1313
import { IEnvironmentInfoCollector } from '../services/IEnvironmentInfoCollector';
14+
import { IErrorParser } from '../services/IErrorParser';
1415
import { IRequestInfoCollector } from '../services/IRequestInfoCollector';
1516
import { IStorage } from '../storage/IStorage';
1617
import { InMemoryStorage } from '../storage/InMemoryStorage';
@@ -24,6 +25,7 @@ export class Configuration implements IConfigurationSettings {
2425
private _plugins:IEventPlugin[] = [];
2526

2627
public environmentInfoCollector:IEnvironmentInfoCollector;
28+
public errorParser:IErrorParser;
2729
public lastReferenceIdManager:ILastReferenceIdManager = new InMemoryLastReferenceIdManager();
2830
public log:ILog;
2931
public requestInfoCollector:IRequestInfoCollector;
@@ -44,6 +46,7 @@ export class Configuration implements IConfigurationSettings {
4446
this.apiKey = settings.apiKey;
4547
this.serverUrl = settings.serverUrl;
4648
this.environmentInfoCollector = inject(settings.environmentInfoCollector);
49+
this.errorParser = inject(settings.errorParser);
4750
this.lastReferenceIdManager = inject(settings.lastReferenceIdManager) || new InMemoryLastReferenceIdManager();
4851
this.log = inject(settings.log) || new NullLog();
4952
this.requestInfoCollector = inject(settings.requestInfoCollector);

‎src/configuration/IConfigurationSettings.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { ILastReferenceIdManager } from '../lastReferenceIdManager/ILastReferenc
22
import { ILog } from '../logging/ILog';
33
import { IEventQueue } from '../queue/IEventQueue';
44
import { IEnvironmentInfoCollector } from '../services/IEnvironmentInfoCollector';
5+
import { IErrorParser } from '../services/IErrorParser';
56
import { IRequestInfoCollector } from '../services/IRequestInfoCollector';
67
import { IStorage } from '../storage/IStorage';
78
import { ISubmissionClient } from '../submission/ISubmissionClient';
@@ -10,6 +11,7 @@ export interface IConfigurationSettings {
1011
apiKey?:string;
1112
serverUrl?:string;
1213
environmentInfoCollector?:IEnvironmentInfoCollector;
14+
errorParser?:IErrorParser;
1315
lastReferenceIdManager?:ILastReferenceIdManager;
1416
log?:ILog;
1517
requestInfoCollector?:IRequestInfoCollector;

‎src/exceptionless.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
// TODO: Lock configuration.
44
// TODO: Move this into an static array and dynamically call all registered bootstrappers.
55
// TODO: NODE: modules.
6+
// TODO: Filter excluded properties.
7+
// TODO: Get extra exception properties.
68

79
import { IBootstrapper } from './bootstrap/IBootstrapper';
810
import { NodeBootstrapper } from './bootstrap/NodeBootstrapper';
@@ -39,9 +41,12 @@ import { SubmissionMethodPlugin } from './plugins/default/SubmissionMethodPlugin
3941
import { DefaultEventQueue } from './queue/DefaultEventQueue';
4042
import { IEventQueue } from './queue/IEventQueue';
4143
import { IEnvironmentInfoCollector } from './services/IEnvironmentInfoCollector';
44+
import { IErrorParser } from './services/IErrorParser';
4245
import { IRequestInfoCollector } from './services/IRequestInfoCollector';
4346
import { NodeEnvironmentInfoCollector } from './services/NodeEnvironmentInfoCollector';
47+
import { NodeErrorParser } from './services/NodeErrorParser';
4448
import { NodeRequestInfoCollector } from './services/NodeRequestInfoCollector';
49+
import { WebErrorParser } from './services/WebErrorParser';
4550
import { WebRequestInfoCollector } from './services/WebRequestInfoCollector';
4651
import { InMemoryStorage } from './storage/InMemoryStorage';
4752
import { IStorage } from './storage/IStorage';

‎src/plugins/default/ErrorPlugin.ts‎

Lines changed: 5 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
import { IError } from '../../models/IError';
2-
import { IStackFrame } from '../../models/IStackFrame';
31
import { IEventPlugin } from '../IEventPlugin';
42
import { EventPluginContext } from '../EventPluginContext';
53

@@ -22,101 +20,12 @@ export class ErrorPlugin implements IEventPlugin {
2220
return Promise.resolve();
2321
}
2422

25-
return StackTrace.fromError(exception).then(
26-
(stackFrames: StackTrace.StackFrame[]) => this.processError(context, exception, stackFrames),
27-
() => this.onParseError(context)
28-
);
29-
}
30-
31-
private processError(context:EventPluginContext, exception:Error, stackFrames: StackTrace.StackFrame[]): Promise<any> {
32-
var error:IError = {
33-
message: exception.message,
34-
stack_trace: this.getStackFrames(context, stackFrames || [])
35-
};
36-
37-
context.event.data['@error'] = error;
38-
39-
return Promise.resolve();
40-
}
41-
42-
private onParseError(context:EventPluginContext): Promise<any> {
43-
context.cancel = true;
44-
return Promise.reject(new Error('Unable to parse the exceptions stack trace. This exception will be discarded.'))
45-
}
46-
47-
private getStackFrames(context:EventPluginContext, stackFrames:StackTrace.StackFrame[]): IStackFrame[] {
48-
var frames:IStackFrame[] = [];
49-
50-
for (var index = 0; index < stackFrames.length; index++) {
51-
frames.push({
52-
name: stackFrames[index].functionName,
53-
//parameters: stackFrames[index].args, // TODO: need to verify arguments.
54-
file_name: stackFrames[index].fileName,
55-
line_number: stackFrames[index].lineNumber,
56-
column: stackFrames[index].columnNumber
57-
});
23+
var parser = context.client.config.errorParser;
24+
if (!parser) {
25+
context.cancel = true;
26+
return Promise.reject(new Error('No error parser was defined. This exception will be discarded.'))
5827
}
5928

60-
return frames;
61-
}
62-
}
63-
64-
declare module StackTrace {
65-
interface StackTraceOptions {
66-
filter?: (stackFrame:StackFrame) => boolean;
67-
sourceCache?: { URL:string };
68-
offline?: boolean;
69-
}
70-
71-
interface StackFrame {
72-
constructor(functionName:string, args:any, fileName:string, lineNumber:number, columnNumber:number);
73-
74-
functionName?:string;
75-
args?:any;
76-
fileName?:string;
77-
lineNumber?:number;
78-
columnNumber?:number;
79-
toString():string;
29+
return parser.parse(context, context.event.data['@error']);
8030
}
81-
82-
/**
83-
* Get a backtrace from invocation point.
84-
* @param options Options Object
85-
* @return Array[StackFrame]
86-
*/
87-
function get(options: StackTraceOptions): Promise<StackFrame[]>;
88-
89-
/**
90-
* Given an error object, parse it.
91-
* @param error Error object
92-
* @param options Object for options
93-
* @return Array[StackFrame]
94-
*/
95-
function fromError(error:Error, options?:StackTraceOptions): Promise<StackFrame[]>;
96-
97-
/**
98-
* Use StackGenerator to generate a backtrace.
99-
* @param options Object options
100-
* @returns Array[StackFrame]
101-
*/
102-
function generateArtificially(options: StackTraceOptions): Promise<StackFrame[]>;
103-
104-
/**
105-
* Given a function, wrap it such that invocations trigger a callback that
106-
* is called with a stack trace.
107-
*
108-
* @param {Function} fn to be instrumented
109-
* @param {Function} callback function to call with a stack trace on invocation
110-
* @param {Function} errorCallback optional function to call with error if unable to get stack trace.
111-
* @param {Object} thisArg optional context object (e.g. window)
112-
*/
113-
function instrument(fn:() => void, callback:(stackFrames:StackFrame[]) => void, errorCallback:() => void, thisArg:any): void;
114-
115-
/**
116-
* Given a function that has been instrumented,
117-
* revert the function to it's original (non-instrumented) state.
118-
*
119-
* @param fn {Function}
120-
*/
121-
function deinstrument(fn:() => void): void;
12231
}

‎src/services/IErrorParser.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { IError } from '../models/IError';
2+
import { EventPluginContext } from '../plugins/EventPluginContext';
3+
4+
export interface IErrorParser {
5+
parse(context:EventPluginContext, exception:Error):Promise<IError>;
6+
}

0 commit comments

Comments
 (0)