mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-26 20:00:16 +08:00
refactor(console): remove the console module (#5338)
* refactor(console): remove the console module Removing the console module implementation eliminates some error-prone formatting logic, and certain platform-specific checks. The implementation was also android-specific. Left a stub Console class implementation as one is necessary to avoid errors with `console` being undefined during the snapshot stage for android. The console module is replaced by a 'console' implementation in the Android Runtime. See android-runtime/PR #884 * fix(tests): update console module tests
This commit is contained in:
Peter Kanev
@ -34,11 +34,6 @@ export function pageLoaded() {
|
||||
var str = "text";
|
||||
var obj = { name: "John", age: 34 };
|
||||
var button = new buttonModule.Button();
|
||||
function Foo() {
|
||||
this.abc = "Hello";
|
||||
this.circular = this;
|
||||
}
|
||||
var foo = new Foo();
|
||||
|
||||
console.log(true);
|
||||
console.log(false);
|
||||
@ -49,17 +44,21 @@ export function pageLoaded() {
|
||||
console.log(str);
|
||||
console.log(obj);
|
||||
|
||||
console.log('number: %i', num);
|
||||
console.log('string: %s', str);
|
||||
console.log("%s %f", str, num);
|
||||
console.log(`number: ${num}`);
|
||||
console.log(`string: ${str}`);
|
||||
console.log(`${str} ${num}`);
|
||||
|
||||
console.info("info");
|
||||
console.warn("warn");
|
||||
console.error("error");
|
||||
|
||||
console.assert(false, "%d not equals %d", 0, 1);
|
||||
console.assert(false, `false == true`);
|
||||
console.assert(true, "1 equals 1");
|
||||
|
||||
console.assert("", "empty string evalutes to 'false'");
|
||||
|
||||
console.trace("console.trace() called");
|
||||
|
||||
if (app.android) {
|
||||
console.dir(true);
|
||||
console.dir(false);
|
||||
@ -70,8 +69,10 @@ export function pageLoaded() {
|
||||
console.dir(str);
|
||||
|
||||
console.dir(obj);
|
||||
console.dir(foo);
|
||||
console.log("%j", button);
|
||||
console.log(`${button}`);
|
||||
|
||||
console.log(num, str, obj);
|
||||
console.log([1, 5, 12.5, obj, str, 42]);
|
||||
}
|
||||
|
||||
console.trace();
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
Sample code:
|
||||
```
|
||||
console.time('test');
|
||||
|
||||
console.log("this is a log test");
|
||||
console.info("infoooo");
|
||||
console.error("errorrrr");
|
||||
console.log("test formatting: %.2f", 1.43234);
|
||||
console.log("test", "more", "params");
|
||||
|
||||
console.assert((2 == 1), 'assertion failed:', 'error');
|
||||
|
||||
console.warn('calling trace');
|
||||
console.trace();
|
||||
|
||||
console.timeEnd('test');
|
||||
```
|
||||
@ -1,386 +1,41 @@
|
||||
const enum MessageType {
|
||||
log = 0,
|
||||
info = 1,
|
||||
warn = 2,
|
||||
error = 3
|
||||
}
|
||||
|
||||
declare function __time(): number;
|
||||
|
||||
function __message(message: any, level: string) {
|
||||
if ((<any>global).__consoleMessage) {
|
||||
(<any>global).__consoleMessage(message, level);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This is a stub class, the console is implemented in native code
|
||||
*/
|
||||
export class Console {
|
||||
private TAG: string = "JS";
|
||||
private _timers: any;
|
||||
private _stripFirstTwoLinesRegEx: RegExp;
|
||||
|
||||
constructor() {
|
||||
this._timers = {};
|
||||
this._stripFirstTwoLinesRegEx = /^([^\n]*?\n){2}((.|\n)*)$/gmi;
|
||||
public time(reportName?: string): void {
|
||||
// console.time stub
|
||||
}
|
||||
|
||||
private sprintf(message: any) {
|
||||
// discuss at: http://phpjs.org/functions/sprintf/
|
||||
// original by: Ash Searle (http://hexmen.com/blog/)
|
||||
// improved by: Michael White (http://getsprink.com)
|
||||
// improved by: Jack
|
||||
// improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
|
||||
// improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
|
||||
// improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
|
||||
// improved by: Dj
|
||||
// improved by: Allidylls
|
||||
// input by: Paulo Freitas
|
||||
// input by: Brett Zamir (http://brett-zamir.me)
|
||||
// example 1: sprintf("%01.2f", 123.1);
|
||||
// returns 1: 123.10
|
||||
// example 2: sprintf("[%10s]", 'monkey');
|
||||
// returns 2: '[ monkey]'
|
||||
// example 3: sprintf("[%'#10s]", 'monkey');
|
||||
// returns 3: '[####monkey]'
|
||||
// example 4: sprintf("%d", 123456789012345);
|
||||
// returns 4: '123456789012345'
|
||||
// example 5: sprintf('%-03s', 'E');
|
||||
// returns 5: 'E00'
|
||||
|
||||
var regex = /%%|%(\d+\$)?([-+\'#0 ]*)(\*\d+\$|\*|\d+)?(\.(\*\d+\$|\*|\d+))?([scboxXuideEfFgGj])/g;
|
||||
var a = arguments;
|
||||
var i = 0;
|
||||
var format = a[i++];
|
||||
|
||||
// pad()
|
||||
var pad = function (str, len, chr, leftJustify) {
|
||||
if (!chr) {
|
||||
chr = ' ';
|
||||
}
|
||||
var padding = (str.length >= len) ? '' : new Array(1 + len - str.length >>> 0)
|
||||
.join(chr);
|
||||
return leftJustify ? str + padding : padding + str;
|
||||
};
|
||||
|
||||
// justify()
|
||||
var justify = function (value, prefix, leftJustify, minWidth, zeroPad, customPadChar?) {
|
||||
var diff = minWidth - value.length;
|
||||
if (diff > 0) {
|
||||
if (leftJustify || !zeroPad) {
|
||||
value = pad(value, minWidth, customPadChar, leftJustify);
|
||||
} else {
|
||||
value = value.slice(0, prefix.length) + pad('', diff, '0', true) + value.slice(prefix.length);
|
||||
}
|
||||
}
|
||||
return value;
|
||||
};
|
||||
|
||||
// formatBaseX()
|
||||
var formatBaseX = function (value, base, prefix, leftJustify, minWidth, precision, zeroPad) {
|
||||
// Note: casts negative numbers to positive ones
|
||||
var number = value >>> 0;
|
||||
prefix = prefix && number && {
|
||||
'2': '0b',
|
||||
'8': '0',
|
||||
'16': '0x'
|
||||
}[base] || '';
|
||||
value = prefix + pad(number.toString(base), precision || 0, '0', false);
|
||||
return justify(value, prefix, leftJustify, minWidth, zeroPad);
|
||||
};
|
||||
|
||||
// formatString()
|
||||
var formatString = function (value, leftJustify, minWidth, precision, zeroPad, customPadChar?) {
|
||||
if (precision != null) {
|
||||
value = value.slice(0, precision);
|
||||
}
|
||||
return justify(value, '', leftJustify, minWidth, zeroPad, customPadChar);
|
||||
};
|
||||
var that = this;
|
||||
// doFormat()
|
||||
var doFormat = function (substring, valueIndex, flags, minWidth, _, precision, type) {
|
||||
var number, prefix, method, textTransform, value;
|
||||
|
||||
if (substring === '%%') {
|
||||
return '%';
|
||||
}
|
||||
|
||||
// parse flags
|
||||
var leftJustify = false;
|
||||
var positivePrefix = '';
|
||||
var zeroPad = false;
|
||||
var prefixBaseX = false;
|
||||
var customPadChar = ' ';
|
||||
var flagsl = flags.length;
|
||||
for (var j = 0; flags && j < flagsl; j++) {
|
||||
switch (flags.charAt(j)) {
|
||||
case ' ':
|
||||
positivePrefix = ' ';
|
||||
break;
|
||||
case '+':
|
||||
positivePrefix = '+';
|
||||
break;
|
||||
case '-':
|
||||
leftJustify = true;
|
||||
break;
|
||||
case "'":
|
||||
customPadChar = flags.charAt(j + 1);
|
||||
break;
|
||||
case '0':
|
||||
zeroPad = true;
|
||||
customPadChar = '0';
|
||||
break;
|
||||
case '#':
|
||||
prefixBaseX = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// parameters may be null, undefined, empty-string or real valued
|
||||
// we want to ignore null, undefined and empty-string values
|
||||
if (!minWidth) {
|
||||
minWidth = 0;
|
||||
} else if (minWidth === '*') {
|
||||
minWidth = +a[i++];
|
||||
} else if (minWidth.charAt(0) === '*') {
|
||||
minWidth = +a[minWidth.slice(1, -1)];
|
||||
} else {
|
||||
minWidth = +minWidth;
|
||||
}
|
||||
|
||||
// Note: undocumented perl feature:
|
||||
if (minWidth < 0) {
|
||||
minWidth = -minWidth;
|
||||
leftJustify = true;
|
||||
}
|
||||
|
||||
if (!isFinite(minWidth)) {
|
||||
throw new Error('sprintf: (minimum-)width must be finite');
|
||||
}
|
||||
|
||||
if (!precision) {
|
||||
precision = 'fFeE'.indexOf(type) > -1 ? 6 : (type === 'd') ? 0 : undefined;
|
||||
} else if (precision === '*') {
|
||||
precision = +a[i++];
|
||||
} else if (precision.charAt(0) === '*') {
|
||||
precision = +a[precision.slice(1, -1)];
|
||||
} else {
|
||||
precision = +precision;
|
||||
}
|
||||
|
||||
// grab value using valueIndex if required?
|
||||
value = valueIndex ? a[valueIndex.slice(0, -1)] : a[i++];
|
||||
|
||||
switch (type) {
|
||||
case 's':
|
||||
return formatString(String(value), leftJustify, minWidth, precision, zeroPad, customPadChar);
|
||||
case 'c':
|
||||
return formatString(String.fromCharCode(+value), leftJustify, minWidth, precision, zeroPad);
|
||||
case 'b':
|
||||
return formatBaseX(value, 2, prefixBaseX, leftJustify, minWidth, precision, zeroPad);
|
||||
case 'o':
|
||||
return formatBaseX(value, 8, prefixBaseX, leftJustify, minWidth, precision, zeroPad);
|
||||
case 'x':
|
||||
return formatBaseX(value, 16, prefixBaseX, leftJustify, minWidth, precision, zeroPad);
|
||||
case 'X':
|
||||
return formatBaseX(value, 16, prefixBaseX, leftJustify, minWidth, precision, zeroPad)
|
||||
.toUpperCase();
|
||||
case 'u':
|
||||
return formatBaseX(value, 10, prefixBaseX, leftJustify, minWidth, precision, zeroPad);
|
||||
case 'i':
|
||||
case 'd':
|
||||
number = +value || 0;
|
||||
// Plain Math.round doesn't just truncate
|
||||
number = Math.round(number - number % 1);
|
||||
prefix = number < 0 ? '-' : positivePrefix;
|
||||
value = prefix + pad(String(Math.abs(number)), precision, '0', false);
|
||||
return justify(value, prefix, leftJustify, minWidth, zeroPad);
|
||||
case 'e':
|
||||
case 'E':
|
||||
case 'f': // Should handle locales (as per setlocale)
|
||||
case 'F':
|
||||
case 'g':
|
||||
case 'G':
|
||||
number = +value;
|
||||
prefix = number < 0 ? '-' : positivePrefix;
|
||||
method = ['toExponential', 'toFixed', 'toPrecision']['efg'.indexOf(type.toLowerCase())];
|
||||
textTransform = ['toString', 'toUpperCase']['eEfFgG'.indexOf(type) % 2];
|
||||
value = prefix + Math.abs(number)[method](precision);
|
||||
return justify(value, prefix, leftJustify, minWidth, zeroPad)[textTransform]();
|
||||
case 'j':
|
||||
return that.createDump(value);
|
||||
default:
|
||||
return substring;
|
||||
}
|
||||
};
|
||||
|
||||
return format.replace(regex, doFormat);
|
||||
public timeEnd(reportName?: string): void {
|
||||
// console.timeEnd stub
|
||||
}
|
||||
|
||||
private formatParams(message: any): string {
|
||||
if (arguments.length <= 1) {
|
||||
return "" + message;
|
||||
}
|
||||
var res = this.sprintf.apply(this, arguments);
|
||||
if (res === message) {
|
||||
// we have more params but no format
|
||||
var args = Array.prototype.slice.call(arguments);
|
||||
return args.join(' ');
|
||||
}
|
||||
return res;
|
||||
public assert(test: boolean, message?: string): void {
|
||||
// console.assert stub
|
||||
}
|
||||
|
||||
private timeMillis() {
|
||||
return __time(); // 1 ms = 1000000 ns
|
||||
public info(message: any): void {
|
||||
// console.info stub
|
||||
}
|
||||
|
||||
public time(reportName: string): void {
|
||||
const name = reportName ? '__' + reportName : '__internal_console_time__';
|
||||
if (this._timers[name] === undefined || this._timers.hasOwnProperty(name)) {
|
||||
this._timers[name] = this.timeMillis();
|
||||
} else {
|
||||
this.warn('invalid name for timer console.time(' + reportName + ')');
|
||||
}
|
||||
public warn(message: any): void {
|
||||
// console.warn stub
|
||||
}
|
||||
|
||||
public timeEnd(reportName: string): void {
|
||||
const name = reportName ? '__' + reportName : '__internal_console_time__';
|
||||
if (this._timers.hasOwnProperty(name)) {
|
||||
const val = this._timers[name];
|
||||
if (val) {
|
||||
var time = this.timeMillis();
|
||||
this.info('console.time(' + reportName + '): %.6f ms', (time - val));
|
||||
this._timers[name] = undefined;
|
||||
}
|
||||
else {
|
||||
this.warn('undefined console.time(' + reportName + ')');
|
||||
}
|
||||
}
|
||||
public error(message: any): void {
|
||||
// console.error stub
|
||||
}
|
||||
|
||||
public assert(test: boolean, message: string, ...formatParams: any[]): void {
|
||||
if (!test) {
|
||||
Array.prototype.shift.apply(arguments);
|
||||
let formatedMessage = this.formatParams.apply(this, arguments);
|
||||
this.error(formatedMessage, MessageType.error);
|
||||
__message(formatedMessage, "error");
|
||||
}
|
||||
}
|
||||
|
||||
public info(message: any, ...formatParams: any[]): void {
|
||||
this.logMessage(this.formatParams.apply(this, arguments), MessageType.info);
|
||||
}
|
||||
|
||||
public warn(message: any, ...formatParams: any[]): void {
|
||||
let formatedMessage = this.formatParams.apply(this, arguments);
|
||||
this.logMessage(formatedMessage, MessageType.warn);
|
||||
__message(formatedMessage, "warning");
|
||||
}
|
||||
|
||||
public error(message: any, ...formatParams: any[]): void {
|
||||
let formatedMessage = this.formatParams.apply(this, arguments);
|
||||
this.logMessage(formatedMessage, MessageType.error);
|
||||
__message(formatedMessage, "error");
|
||||
}
|
||||
|
||||
public log(message: any, ...formatParams: any[]): void {
|
||||
let formatedMessage = this.formatParams.apply(this, arguments);
|
||||
this.logMessage(formatedMessage, MessageType.log);
|
||||
__message(formatedMessage, "log");
|
||||
}
|
||||
|
||||
private logMessage(message: string, messageType: MessageType): void {
|
||||
if (!(<any>global).android) {
|
||||
// This case may be entered during heap snapshot where the global.android is not present
|
||||
return;
|
||||
}
|
||||
|
||||
const arrayToLog = [];
|
||||
if (message.length > 4000) {
|
||||
for (let i = 0; i * 4000 < message.length; i++) {
|
||||
arrayToLog.push(message.substr((i * 4000), 4000));
|
||||
}
|
||||
}
|
||||
else {
|
||||
arrayToLog.push(message);
|
||||
}
|
||||
for (let i = 0; i < arrayToLog.length; i++) {
|
||||
switch (messageType) {
|
||||
case MessageType.log: {
|
||||
android.util.Log.v(this.TAG, arrayToLog[i]);
|
||||
break;
|
||||
}
|
||||
case MessageType.warn: {
|
||||
android.util.Log.w(this.TAG, arrayToLog[i]);
|
||||
break;
|
||||
}
|
||||
case MessageType.error: {
|
||||
android.util.Log.e(this.TAG, arrayToLog[i]);
|
||||
break;
|
||||
}
|
||||
case MessageType.info: {
|
||||
android.util.Log.i(this.TAG, arrayToLog[i]);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
public log(message: any): void {
|
||||
// console.log stub
|
||||
}
|
||||
|
||||
public trace(): void {
|
||||
var stack: string;
|
||||
stack = (<any>(new Error())).stack.toString();
|
||||
stack = stack.replace(this._stripFirstTwoLinesRegEx, "$2");
|
||||
stack = "Stack Trace:\n" + stack;
|
||||
this.log(stack);
|
||||
}
|
||||
|
||||
private createDump(obj: any): string {
|
||||
var result = [];
|
||||
if (null == obj) {
|
||||
result.push("=== dump(): object is 'null' ===");
|
||||
return result.join('');
|
||||
}
|
||||
if (obj === undefined) {
|
||||
result.push("=== dump(): object is 'undefined' ===");
|
||||
return result.join('');
|
||||
}
|
||||
result.push('=== dump(): dumping members ===\n');
|
||||
var stringifyValueCache = [];
|
||||
var stringifyKeyCache = [];
|
||||
result.push(JSON.stringify(obj, function (k, v) {
|
||||
stringifyKeyCache.push(k);
|
||||
if (typeof v === 'object' && v !== null) {
|
||||
if (stringifyValueCache.indexOf(v) !== -1) {
|
||||
return "#CR:" + (v.toString ? v.toString() : v);
|
||||
}
|
||||
stringifyValueCache.push(v);
|
||||
}
|
||||
if (typeof v === 'function') {
|
||||
return k + "()" + v;
|
||||
}
|
||||
return v;
|
||||
}, 4));
|
||||
result.push('\n=== dump(): dumping function and properties names ===\n');
|
||||
for (var id in obj) {
|
||||
try {
|
||||
if (typeof (obj[id]) === 'function') {
|
||||
result.push(id + '()\n');
|
||||
}
|
||||
else {
|
||||
if (typeof (obj[id]) !== 'object' && stringifyKeyCache.indexOf(id) === -1) {
|
||||
result.push(id + ": " + (obj[id] + '\n'));
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
result.push(id + ': inaccessible');
|
||||
}
|
||||
}
|
||||
stringifyValueCache = null;
|
||||
stringifyKeyCache = null;
|
||||
result.push('=== dump(): finished ===');
|
||||
return result.join('');
|
||||
// console.trace stub
|
||||
}
|
||||
|
||||
public dir(obj: any): void {
|
||||
const dump = this.createDump(obj);
|
||||
this.log(dump);
|
||||
// console.dir stub
|
||||
}
|
||||
}
|
||||
|
||||
@ -154,7 +154,6 @@ export function install() {
|
||||
var dialogs: typeof dialogsModule = require("ui/dialogs");
|
||||
var xhr = require("xhr");
|
||||
var fetch = require("fetch");
|
||||
var consoleModule = require("console");
|
||||
|
||||
snapshotGlobals = snapshotGlobals || {
|
||||
setTimeout: timer.setTimeout,
|
||||
@ -175,10 +174,11 @@ export function install() {
|
||||
Headers: fetch.Headers,
|
||||
Request: fetch.Request,
|
||||
Response: fetch.Response,
|
||||
|
||||
console: new consoleModule.Console()
|
||||
}
|
||||
}
|
||||
var consoleModule = require("console").Console;
|
||||
// Object.assign call will fire an error when trying to write to a read-only property of an object, such as 'console'
|
||||
global.console = global.console || new consoleModule();
|
||||
Object.assign(global, snapshotGlobals);
|
||||
} else {
|
||||
registerOnGlobalContext("setTimeout", "timer");
|
||||
@ -199,15 +199,6 @@ export function install() {
|
||||
registerOnGlobalContext("Headers", "fetch");
|
||||
registerOnGlobalContext("Request", "fetch");
|
||||
registerOnGlobalContext("Response", "fetch");
|
||||
|
||||
// check whether the 'android' namespace is exposed
|
||||
// if positive - the current device is an Android
|
||||
// so a custom implementation of the global 'console' object is attached.
|
||||
// otherwise do nothing on iOS - the NS runtime provides a native 'console' functionality.
|
||||
if ((<any>global).android) {
|
||||
const consoleModule = require("console");
|
||||
(<any>global).console = new consoleModule.Console();
|
||||
}
|
||||
}
|
||||
}
|
||||
install();
|
||||
|
||||
Reference in New Issue
Block a user