/
better.js
1929 lines (1704 loc) · 60.7 KB
/
better.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// better.js preffix - begining of the better.js bundle
var BetterJS = (function(){
// ...
//////////////////////////////////////////////////////////////////////////////////
// Implement queuable getter setter //
//////////////////////////////////////////////////////////////////////////////////
/**
* by default __defineGetter__ support only one function. Same for __defineSetter
* This is a annoying limitation. This little library declares 2 functions
* Object.__defineQGetter__ and Object.__defineQGetter__.
* They behave the same as their native sibling but support multiple functions.
* Those functions are called in the same order they got registered.
*
* (I have no idea of the reasoning behind this limitation to one function. It seems
* useless to me. This remind me of onclick of the DOM instead of a proper .addEventListener)
*/
/**
* Class to implement queueable getter/setter
* @param {Object} baseObject The base object on which we operate
* @param {String} property The string of property
*/
var QGetterSetter = {};
/**
* Define a getter/setter for a property
*
* @param {Object} baseObject the base object which is used
* @param {String} property the name of the property
*/
QGetterSetter._Property = function(baseObject, property){
// sanity check
console.assert( typeof(baseObject) === 'object' || typeof(baseObject) === 'function' );
console.assert( typeof(property) === 'string' );
// backup the initial value
var originValue = baseObject[property];
// init some local variables
var _this = this;
this._getters = [];
this._setters = [];
// the storage value
Object.defineProperty(baseObject, '__' + property, {
enumerable : false,
writable : true,
value : baseObject[property],
})
// the accessed value
Object.defineProperty(baseObject, property, {
enumerable : true,
get : function getterHandler(){
var value = baseObject['__'+property];
for(var i = 0; i < _this._getters.length; i++){
value = _this._getters[i](value, getterHandler.caller, property)
}
return value;
},
set : function setterHandler(value){
for(var i = 0; i < _this._setters.length; i++){
value = _this._setters[i](value, setterHandler.caller, property)
}
baseObject['__'+property] = value;
},
})
};
// export the class in node.js - if running in node.js
if( typeof(window) === 'undefined' ) module.exports = QGetterSetter;
/**
* init baseObject to be able to ahndle qGetterSetter
* @param {Object} baseObject the base object to modify
* @param {String} property the property which is handled
* @return {String} the created property name
*/
QGetterSetter._initObjectIfNeeded = function(baseObject, property){
var name = "__bjsGetSet_" + property;
// define the property to store all the getters/setter
if( baseObject[name] === undefined ){
Object.defineProperty(baseObject, name, {
enumerable : false,
value : new QGetterSetter._Property(baseObject, property)
});
}
return name
}
/**
* define a getter
*
* @param {Obejct} baseObject the object containing the property
* @param {string} property the property name which gonna get the getter
* @param {Function} getterFn function which handle the getter
*/
QGetterSetter.defineGetter = function(baseObject, property, getterFn){
// init QGetterSetter on this property if needed
var name = QGetterSetter._initObjectIfNeeded(baseObject, property)
// setup the new getter
baseObject[name]._getters.push(getterFn)
}
/**
* define a setter
*
* @param {Object} baseObject the object containing the property
* @param {string} property the property name which gonna get the setter
* @param {Function} setterFn function which handle the setter
*/
QGetterSetter.defineSetter = function(baseObject, property, setterFn){
// init QGetterSetter on this property if needed
var name = QGetterSetter._initObjectIfNeeded(baseObject, property)
// setup the new setter
baseObject[name]._setters.push(setterFn)
}
//////////////////////////////////////////////////////////////////////////////////
// .overloadObjectPrototype() //
//////////////////////////////////////////////////////////////////////////////////
/**
* overload the Object.prototype with .__defineQGetter__ and .__defineQSetter__
*
* TODO put that in example/js ?
*/
QGetterSetter.overloadObjectPrototype = function(){
Object.prototype.__defineQGetter__ = function(property, getterFn){
QGetterSetter.defineGetter(this, property, getterFn);
};
Object.prototype.__defineQSetter__ = function(property, setterFn){
QGetterSetter.defineSetter(this, property, setterFn);
};
}
/**
* @namespace
*/
var Stacktrace = {};
// export the class in node.js - if running in node.js
if( typeof(window) === 'undefined' ) module.exports = Stacktrace;
//////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////
// //
// Stacktrace.parse() //
// //
//////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////
/**
* parse the stacktrace of an Error.
* @param {Number} nShift
* @param {Error|undefined} error - optional error to parse. if not provided, generate one.
* @return {Array.<Object>} parsed stacktrace
*/
Stacktrace.parse = function(nShift, error){
// handle polymorphism
nShift = nShift !== undefined ? nShift : 0;
// get error if not provided
// error = error || new Error();
if( error === undefined ){
// new Error().stack dont work in PhantomJS
try {
i.dont.exist+=0; //doesn't exist- that's the point
} catch( exception ) {
error = exception;
}
}
// sanity check
console.assert(error instanceof Error);
// call the proper parser depending on the usage
if( typeof(window) === 'undefined' ){
var stacktrace = _parserV8(error)
}else if( navigator.userAgent.match('Chrome/') ){
var stacktrace = _parserV8(error)
}else if( navigator.userAgent.match('Firefox/') ){
var stacktrace = _parserFirefox(error)
}else if( navigator.userAgent.match('PhantomJS/') ){
var stacktrace = _parserPhantomJS(error)
}else{
console.assert(false, 'Stacktrace.parse() not yet implemented for', navigator.userAgent)
return [];
}
// add one to remove the parser() function
nShift += 1;
console.assert(stacktrace.length >= nShift, 'stacktrace length not large enougth to shift '+nShift)
return stacktrace.slice(nShift);
//////////////////////////////////////////////////////////////////////////
// //
//////////////////////////////////////////////////////////////////////////
/**
* parse stacktrace for v8 - works in node.js and chrome
*
* Official definition of v8 stackformat
* https://code.google.com/p/v8-wiki/wiki/JavaScriptStackTraceApi#Appendix:_Stack_trace_format
*/
function _parserV8(error){
// start parse the error stack string
var lines = error.stack.split("\n").slice(1);
var stacktrace = [];
lines.forEach(function(line){
if( line.match(/\(native\)$/) ){
var matches = line.match(/^\s*at (.+) \(native\)/);
stacktrace.push(new Stacktrace.Frame({
fct : matches[1],
url : 'native',
line : 1,
column : 1
}));
}else if( line.match(/\)$/) ){
var matches = line.match(/^\s*at (.+) \((.+):(\d+):(\d+)\)/);
stacktrace.push(new Stacktrace.Frame({
fct : matches[1],
url : matches[2],
line : parseInt(matches[3], 10),
column : parseInt(matches[4], 10)
}));
}else{
var matches = line.match(/^\s*at (.+):(\d+):(\d+)/);
stacktrace.push(new Stacktrace.Frame({
url : matches[1],
fct : '<anonymous>',
line : parseInt(matches[2], 10),
column : parseInt(matches[3], 10)
}));
}
});
return stacktrace;
};
/**
* parse the stacktrace from firefox
*/
function _parserFirefox(error){
// start parse the error stack string
var lines = error.stack.split("\n").slice(0, -1);
var stacktrace = [];
lines.forEach(function(line){
var matches = line.match(/^(.*)@(.+):(\d+)$/);
stacktrace.push(new Stacktrace.Frame({
fct : matches[1] === '' ? '<anonymous>' : matches[1],
url : matches[2],
line : parseInt(matches[3], 10),
column : 1
}));
});
return stacktrace;
};
/**
* parse the stacktrace from phantomJS
*/
function _parserPhantomJS(error){
// start parse the error stack string
var lines = error.stack.split("\n").slice(1);
var stacktrace = [];
lines.forEach(function(line){
if( line.match(/\(native\)$/) ){
var matches = line.match(/^\s*at (.+) \(native\)/);
stacktrace.push(new Stacktrace.Frame({
fct : matches[1],
url : 'native',
line : 1,
column : 1
}));
}else if( line.match(/\)$/) ){
var matches = line.match(/^\s*at (.+) \((.+):(\d+)\)/);
stacktrace.push(new Stacktrace.Frame({
fct : matches[1],
url : matches[2],
line : parseInt(matches[3], 10),
column : 1
}));
}else{
var matches = line.match(/^\s*at (.+):(\d+)/);
stacktrace.push(new Stacktrace.Frame({
url : matches[1],
fct : '<anonymous>',
line : parseInt(matches[2], 10),
column : 1
}));
}
});
return stacktrace;
};
}
//////////////////////////////////////////////////////////////////////////////////
// Stacktrace.Frame //
//////////////////////////////////////////////////////////////////////////////////
/**
* handle stack frame
*
* TODO do a .fromOriginId()
*/
Stacktrace.Frame = function(opts){
this.url = opts.url;
this.fct = opts.fct;
this.line = opts.line;
this.column = opts.column;
};
/**
* return the origin String
* @return {String} the origin of the stackframe
*/
Stacktrace.Frame.prototype.originId = function(){
var str = this.fct + '@' + this.url + ':' + this.line + ':' + this.column;
return str;
};
/**
* return a String for this object
* @return {String} the human readable string
*/
Stacktrace.Frame.prototype.toString = function(){
return this.originId();
};
/**
* get the basename of the url
* @return {string}
*/
Stacktrace.Frame.prototype.basename = function(){
return this.url.match(/([^/]*)$/)[1] || ".";
};
//////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////
// //
// Stacktrace.Track //
// //
//////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////
/**
* Tracker of stacktrace
*/
Stacktrace.Tracker = function(){
this._klasses = {};
}
/**
* record an allocation of a class
* @param {String} className The class name under which this record is made
*/
Stacktrace.Tracker.prototype.record = function(className, stackLevel){
stackLevel = stackLevel !== undefined ? stackLevel : 0;
// init variable
var at = Stacktrace.Track;
var stackFrame = Stacktrace.parse()[stackLevel+2];
// init Stacktrace.Track._klasses entry if needed
this._klasses[className]= this._klasses[className] || {
counter : 0,
perOrigins : {}
}
// increase the counter
var klass = this._klasses[className];
klass.counter += 1;
// build the originId from stackFrame
var originId = stackFrame.fct + '@' + stackFrame.url + ':' + stackFrame.line;
// update counters for this originId
var perOrigins = klass.perOrigins;
perOrigins[originId] = perOrigins[originId] !== undefined ? perOrigins[originId] : 0;
perOrigins[originId] += 1;
}
/**
* reset all counters kepts by Stacktrace.Track
*/
Stacktrace.Tracker.prototype.reset = function(){
this._klasses = {};
}
/**
* getter for the results
*/
Stacktrace.Tracker.prototype.klasses = function(){
return this._klasses;
}
//////////////////////////////////////////////////////////////////////////////////
// //
//////////////////////////////////////////////////////////////////////////////////
/**
* Dump current state of the tracker in console.log().
*
* @see Stacktrace.Tracker.reportString()
*/
Stacktrace.Tracker.prototype.dump = function(){
var report = this.reportString.apply(this, arguments)
console.log(report);
}
/**
* Reporter in a String
*
* @param {RegExp} classNameRegExp regexp of the classname to keep
* @param {Number} maxNOrigin nb origin to display per class
*/
Stacktrace.Tracker.prototype.reportString = function(classNameRegExp, maxNOrigin){
// handle polymorphism
classNameRegExp = classNameRegExp || /./;
maxNOrigin = maxNOrigin !== undefined ? maxNOrigin : 3;
// define local variable
var output = [];
var classNames = Object.keys(this._klasses);
// sort classes by descending .counter
classNames.sort(function(a, b){
return this._klasses[b].counter - this._klasses[a].counter;
}.bind(this));
// filter by classname
classNames = classNames.filter(function(className){
return className.match(classNameRegExp) ? true : false
});
// display the rest
classNames.forEach(function(className){
var klass = this._klasses[className];
output.push(className+': total '+klass.counter+' times');
var perOrigins = klass.perOrigins;
var ranks = Object.keys(perOrigins);
ranks.sort(function(a, b){
return perOrigins[b] - perOrigins[a];
});
//console.dir(aClass._newCounters)
//console.log('ranks', ranks)
ranks.slice(0, maxNOrigin).forEach(function(originId){
var perOrigin = perOrigins[originId];
output.push('\t'+originId+' - '+perOrigin+' times')
//console.log(counters[origin], "new aClass at ", origin);
});
}.bind(this));
return output.join('\n');
};
/**
* assert which actually try to stop the excecution
* if debug.assert.useDebugger is falsy, throw an exception. else trigger the
* debugger. It default to false. unclear how usefull it is for node.js
* to overload console.assert just do ```console.assert = assertWhichStop;```.
* Based on https://gist.github.com/2651899 done with jensarps.
*
* @param {Boolean} condition the condition which is asserted
* @param {String} message the message which is display is condition is falsy
* @param {Boolean} [useDebugger] if true, a failled assert will trigger js debugger
*/
var assertWhichStop = function(condition, message, useDebugger){
if( condition ) return
if( assertWhichStop.useDebugger || useDebugger ) debugger;
throw new Error(message || "Assert Failed");
}
/**
* if true, a fail assert will trigger js debugger
*
* @type {Boolean}
*/
assertWhichStop.useDebugger = false;
// export the class in node.js - if running in node.js - unclear how usefull it is in node.js
if( typeof(window) === 'undefined' ) module.exports = assertWhichStop;
/**
* Little helper to overload console.assert
* @api public
* @todo a .offConsoleAPI() or noConflict() which restore it
*/
assertWhichStop.overloadConsole = function(){
console.assert = assertWhichStop;
}
/**
* @fileOverview implementation of a log layer on top of console.*
*/
var Stacktrace = Stacktrace || require('./stacktrace.js');
/**
* @namespace logger compatible with console.* calls
*/
var ConsoleLogger = {};
/**
* the previous instance of console object
*/
ConsoleLogger._origConsole = {
console : console,
log : console.log,
warn : console.warn,
error : console.error
};
// export the class in node.js - if running in node.js
if( typeof(window) === 'undefined' ) module.exports = ConsoleLogger;
/**
* Des ription of the various level of severity
* @type {Object}
*/
ConsoleLogger.Severity = {
'all' : 0,
'log' : 1,
'warn' : 2,
'error' : 3,
'nothing' : 99
};
/**
* default level of severity when no filter matches
*
* @type {Number}
*/
ConsoleLogger.Severity.dfl = ConsoleLogger.Severity.all;
//////////////////////////////////////////////////////////////////////////////////
// handle formatters //
//////////////////////////////////////////////////////////////////////////////////
/**
* formater which doesnt change anything
*
* @param {Array} args the ```arguments``` of the logger funciton
* @param {Stacktrace.Frame} stackFrame the stackframe of the origin
* @param {string} severity severity of the message
* @return {Array} the formated args
*/
ConsoleLogger.formatterIdentity = function(args, stackFrame, severity){
return args;
}
/**
* formater which add a timestamp as prefix to the message - with color if in node
*
* @param {Array} args the ```arguments``` of the logger funciton
* @param {Stacktrace.Frame} stackFrame the stackframe of the origin
* @param {string} severity severity of the message
* @return {Array} the formated args
*/
ConsoleLogger.formatterTimeStamp = function(args, stackFrame, severity){
// build prefix with time
var present = new Date();
var prefixColor = ConsoleLogger._formatterSeverityColor(severity);
var prefix = prefixColor + pad(present.getHours(),2)
+ ':'
+ pad(present.getMinutes(),2)
+ ':'
+ pad(present.getSeconds(),2)
+ ConsoleLogger._formatterColor.reset;
// convert arguments into actual Array
args = Array.prototype.slice.call(args, 0);
// prepend the prefix
args.unshift(prefix);
// return the result
return args;
function pad(val, len) {
val = String(val);
while(val.length < len) val = "0" + val;
return val;
};
};
/**
* formater which add the origin as prefix to the message - with color if in node
*
* @param {Array} args the ```arguments``` of the logger funciton
* @param {Stacktrace.Frame} stackFrame the stackframe of the origin
* @param {string} severity severity of the message
* @return {Array} the formated args
*/
ConsoleLogger.formatterOrigin = function(args, stackFrame, severity)
{
// compute prefix
var prefixColor = ConsoleLogger._formatterSeverityColor(severity);
var prefix = prefixColor + stackFrame.originId() + ConsoleLogger._formatterColor.reset;
// convert arguments into actual Array
args = Array.prototype.slice.call(args, 0);
// prepend the prefix
args.unshift(prefix);
// return the result
return args;
}
/**
* flag to know if it is running in node.js or browser
* @type {Boolean}
*/
ConsoleLogger._inNode = typeof(window) === 'undefined' ? true : false;
/**
* Color code for ansi tty
* @type {String}
*/
ConsoleLogger._formatterColor = {
black : ConsoleLogger._inNode === false ? '' : '\033[30m',
red : ConsoleLogger._inNode === false ? '' : '\033[31m',
green : ConsoleLogger._inNode === false ? '' : '\033[32m',
yellow : ConsoleLogger._inNode === false ? '' : '\033[33m',
blue : ConsoleLogger._inNode === false ? '' : '\033[34m',
purple : ConsoleLogger._inNode === false ? '' : '\033[35m',
cyan : ConsoleLogger._inNode === false ? '' : '\033[36m',
white : ConsoleLogger._inNode === false ? '' : '\033[37m',
reset : ConsoleLogger._inNode === false ? '' : '\033[0m'
};
/**
* return ainsi color per intensity
* @param {String} severity the severity of the message
* @return {String} ansi color string
*/
ConsoleLogger._formatterSeverityColor = function(severity){
var color = ConsoleLogger._formatterColor;
if( severity === 'log' ) return color.red;
if( severity === 'warn' ) return color.purple;
return color.green;
}
/**
* Current message formatter
*/
ConsoleLogger.formatter = ConsoleLogger.formatterIdentity;
//////////////////////////////////////////////////////////////////////////////////
// handle filters //
//////////////////////////////////////////////////////////////////////////////////
/**
* Store all the filters
* @type {Array}
*/
ConsoleLogger._filters = [];
/**
* push a new filter - stackFrame
*
* @param {Function(stackFrame)} validFor function which determine which stackFrame is valid
* @param {[type]} severity [description]
* @return {[type]} [description]
*/
ConsoleLogger.pushFilter = function(validFor, severity){
// handle polymorphism
if( typeof(validFor) === 'string' ){
var path = validFor;
return ConsoleLogger.pushFilter(function(stackFrame, severity){
return stackFrame.url.lastIndexOf(path) === stackFrame.url.length - path.length ? true : false;
}, severity);
}else if( validFor instanceof RegExp ){
var regexp = validFor;
return ConsoleLogger.pushFilter(function(stackFrame, severity){
return stackFrame.url.match(regexp) ? true : false
}, severity);
}
// sanity check - sanity level MUST be defined
console.assert(Object.keys(ConsoleLogger.Severity).indexOf(severity) !== -1, 'unknown severity level');
console.assert(validFor instanceof Function);
// push new level
ConsoleLogger._filters.push({
validFor : validFor,
severity : ConsoleLogger.Severity[severity]
});
};
/**
* test if a given instance of severity and stackframe is valid for ConsoleLogger
* @param {string} severity Severity to test
* @param {Object} stackFrame stackframe to test (in stacktrace.js format)
* @return {Boolean} true if the filter is valid, false otherwise
*/
ConsoleLogger.filter = function(severity, stackFrame){
stackFrame = stackFrame || Stacktrace.parse()[2];
// sanity check - sanity level MUST be defined
console.assert(Object.keys(ConsoleLogger.Severity).indexOf(severity) !== -1, 'unknown severity level');
// go thru all the filters
var filters = ConsoleLogger._filters;
for(var i = 0; i < filters.length; i++){
var filter = filters[i];
if( filter.validFor(stackFrame) === false ) continue;
return ConsoleLogger.Severity[severity] >= filter.severity ? true : false;
}
// if this point is reach, check with Severity.dfl
return ConsoleLogger.Severity[severity] >= ConsoleLogger.Severity.dfl ? true : false;
}
//////////////////////////////////////////////////////////////////////////////////
// handle log functions //
//////////////////////////////////////////////////////////////////////////////////
ConsoleLogger._print = function(severity, args){
var stackFrame = Stacktrace.parse()[2];
if( ConsoleLogger.filter(severity, stackFrame) === false ) return;
var args = ConsoleLogger.formatter(args, stackFrame, severity);
var _console = ConsoleLogger._origConsole;
if( severity === 'log' ){
_console.log.apply(_console.console, args);
}else if( severity === 'warn' ){
_console.warn.apply(_console.console, args);
}else if( severity === 'error' ){
_console.error.apply(_console.console, args);
}else console.assert(false, 'invalid severity: '+severity)
};
/**
* log with a severity of 'log'
*/
ConsoleLogger.log = function(/* ... */){
ConsoleLogger._print('log', arguments);
}
/**
* log with a severity of 'warn'
*/
ConsoleLogger.warn = function(/* ... */){
ConsoleLogger._print('warn', arguments);
}
/**
* log with a severity of 'error'
*/
ConsoleLogger.error = function(/* ... */){
ConsoleLogger._print('error', arguments);
}
//////////////////////////////////////////////////////////////////////////////////
// Helpers //
//////////////////////////////////////////////////////////////////////////////////
/**
* Overload console.log/warn/error function
*
* @todo provide a noConflict
*/
ConsoleLogger.overloadConsole = function(){
console.log = ConsoleLogger.log;
console.warn = ConsoleLogger.warn;
console.error = ConsoleLogger.error;
}
/**
* detect gabarge collector occurance. Require v8 for now, so chrome or node.js.
* typical usage: <code>new GcMonitor().start();</code>
*
* @class monitor gabage collector activities
*
* see details in http://buildnewgames.com/garbage-collector-friendly-code/
*/
var GcMonitor = function(){
// init a timer
var _this = this;
var timerid = null;
// define function to return used heap size
var inNode = typeof(window) === 'undefined' ? true : false;
var usedHeapSize= inNode ? function(){
return process.memoryUsage().heapUsed;
} : function(){
if( !window.performance || !window.performance.memory ) return 0;
return window.performance.memory.usedJSHeapSize;
};
// sanity check - if not available, output a warning
if( GcMonitor.isAvailable() === false ){
// open -a "/Applications/Google Chrome.app" --args --enable-memory-info
console.warn('memory info are unavailable... for chrome, use --enable-memory-info. Other browsers dont have this feature.')
}
/**
* Start monitoring periodically
*
* @param {Function|undefined} onChange optional function to notify when gc occurs
* @param {Number|undefined} period period of the check. default to 50ms
*/
this.start = function(onChange, period){
period = period || 1000/60;
onChange= onChange || function(delta){
function bytesToSize(bytes, nFractDigit) {
var sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB'];
if (bytes == 0) return '0';
nFractDigit = nFractDigit !== undefined ? nFractDigit : 2;
var precision = Math.pow(10, nFractDigit);
var i = Math.floor(Math.log(bytes) / Math.log(1024));
return Math.round(bytes*precision / Math.pow(1024, i))/precision + ' ' + sizes[i];
};
console.warn(new Date + " -- GC occured! saved", bytesToSize(delta), 'consuming at', bytesToSize(burnRate), 'per second')
}
timerid = setInterval(function(){
_this.check(onChange);
}, period);
return this; // for chained api
};
/**
* Stop monitoring periodically
*/
this.stop = function(){
cancelInterval(timerid);
};
var lastUsedHeap = null;
var lastTimestamp = null;
var burnRate = null;
/**
* Check if currently used memory is less than previous check. If so it
* is assume a GC occured
*
* @param {Function|undefined} onChange callback notified synchronously if gc occured
*/
this.check = function(onChange){
// parameter polymorphism
onChange = onChange || function(property){}
var present = Date.now();//console.log('present', (present - lastTimestamp)/1000)
var currUsedSize= usedHeapSize();
if( lastUsedHeap === null ){
lastUsedHeap = currUsedSize;
lastTimestamp = present;
return;
}
// check if the heap size in this cycle is LESS than what we had last
// cycle; if so, then the garbage collector has kicked in
var deltaMem = currUsedSize - lastUsedHeap;
if( deltaMem < 0 ){
onChange(-deltaMem, burnRate);
}else{
var deltaTime = present - lastTimestamp
var newBurnrate = deltaMem / (deltaTime/1000);
if( burnRate === null ) burnRate = newBurnrate;
var friction = 0.99;
burnRate = burnRate * friction + newBurnrate * (1-friction);
}
lastUsedHeap = currUsedSize;
lastTimestamp = present;
}
/**
* getter for the burnRate
* @type {Number}
*/
this.burnRate = function(){
if( burnRate === null ) return 0;
return burnRate;
}
/**
* getter for the usedHeapSize
* @return {Number} used heap size in byte
*/
this.usedHeapSize = function(){
return usedHeapSize();
}
}
/**
* check if it is available on the plateform it runs on
*
* @return {Boolean} true if it is available, false otherwise
*/
GcMonitor.isAvailable = function(){
var inNode = typeof(window) === 'undefined' ? true : false;
if( inNode ) return true;
if( !window.performance ) return false;
if( !window.performance.memory) return false;
return true;
}
// export the class in node.js - if running in node.js
if( typeof(window) === 'undefined' ) module.exports = GcMonitor;
/**
* Used to detect globals. works in node.js and browser
*
* from http://stackoverflow.com/questions/5088203/how-to-detect-creation-of-new-global-variables
*
* @class detect globals
*/
var GlobalDetector = function(){
// take the namespace for global
var inBrowser = typeof(window) !== 'undefined' ? true : false
var _global = inBrowser ? window : global;
// sanity check - a global namespace MUST be found
console.assert( _global, 'failed to find a global namespace! bailing out!' );
// init initialGlobals
var initialGlobals = {};
// loop on _global object
for(var propname in _global){
initialGlobals[propname] = true;
}
// init foundGlobals
var foundGlobals= {};
// init a timer
var _this = this;
var timerid = null;
/**
* Start periodically monitoring
* @param {Function+} onChange optional callback called when a new global is found
* @param {Number+} period period at which it is checked
*/
this.start = function(onChange, period){
period = period || 1000;
onChange= onChange || function(newProperty){
var str = new Date + " -- Warning Global Detected!!! "
str += (inBrowser ? 'window': 'global');
str += "['"+newProperty+"'] === " + _global[newProperty];
console.warn(str)
};
timerid = setInterval(function(){
_this.check(onChange);
}, period);
return this; // for chained API
};
/**
* Stop periodically monitoring
*/
this.stop = function(){
cancelInterval(_timerid);
};
/**
* Check if any new global has been declared
* @param {Function+} onChange optional callback called synchronously if a new global is found
* @return {Boolean} true if some new globals have been detected, false otherwise
*/
this.check = function(onChange){
var newGlobal = false;
// parameter polymorphism
onChange = onChange || function(property){}
// new loop on _global object
for(var property in _global){
// if it is in the initialGlobals, goto the next
if( initialGlobals[property] ) continue;
// if this is already in the ignoreList, goto the next
if( GlobalDetector.ignoreList.indexOf(property) !== -1 ) continue;
// if it already found, goto the next
if( foundGlobals[property] ) continue;
// mark this property as init
foundGlobals[property] = true;
// mark newGlobal
newGlobal = true;
// notify callback
onChange(property);
}
return newGlobal;
};
/**
* getter for the foundGlobals up to now
* @return {Object} object with keys as property names
*/
this.foundGlobals = function(){
return foundGlobals;
};
};
/**
* list of variables name to ignore. populated at constructor() time
* @type {String[]}
*/
GlobalDetector.ignoreList = [];
// export the class in node.js - if running in node.js
if( typeof(window) === 'undefined' ) module.exports = GlobalDetector;
/**
* ensure private property/method stays private
*
* @namespace Strong typing for javascript
*/
var Privatize = {};
// include dependancies
var Stacktrace = Stacktrace || require('./stacktrace.js');
var QGetterSetter = QGetterSetter|| require('./qgettersetter.js')
// export the namespace in node.js - if running in node.js
if( typeof(window) === 'undefined' ) module.exports = Privatize;
//////////////////////////////////////////////////////////////////////////////////
// Handle PrivateOKFn //
//////////////////////////////////////////////////////////////////////////////////
/**
* determine which function is considered private for klass
*
* @param {function} klass the constructor of the class
* @param {function} privateFn private function to add