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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const EXPORTED_SYMBOLS = ["pprint", "truncate"];
const { XPCOMUtils } = ChromeUtils.import(
"resource://gre/modules/XPCOMUtils.jsm"
);
XPCOMUtils.defineLazyModuleGetters(this, {
Log: "chrome://marionette/content/log.js",
MarionettePrefs: "chrome://marionette/content/prefs.js",
});
XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
const ELEMENT_NODE = 1;
const MAX_STRING_LENGTH = 250;
/**
* Pretty-print values passed to template strings.
*
* Usage::
*
* const { pprint } = Cu.import(
* "chrome://marionette/content/format.js", {}
* );
*
* let bool = {value: true};
* pprint`Expected boolean, got ${bool}`;
* => 'Expected boolean, got [object Object] {"value": true}'
*
* let htmlElement = document.querySelector("input#foo");
* pprint`Expected element ${htmlElement}`;
* => 'Expected element <input id="foo" class="bar baz" type="input">'
*
* pprint`Current window: ${window}`;
* => '[object Window https://www.mozilla.org/]'
*/
function pprint(ss, ...values) {
function pretty(val) {
let proto = Object.prototype.toString.call(val);
if (
typeof val == "object" &&
val !== null &&
"nodeType" in val &&
val.nodeType === ELEMENT_NODE
) {
return prettyElement(val);
} else if (["[object Window]", "[object ChromeWindow]"].includes(proto)) {
return prettyWindowGlobal(val);
} else if (proto == "[object Attr]") {
return prettyAttr(val);
}
return prettyObject(val);
}
function prettyElement(el) {
let attrs = ["id", "class", "href", "name", "src", "type"];
let idents = "";
for (let attr of attrs) {
if (el.hasAttribute(attr)) {
idents += ` ${attr}="${el.getAttribute(attr)}"`;
}
}
return `<${el.localName}${idents}>`;
}
function prettyWindowGlobal(win) {
let proto = Object.prototype.toString.call(win);
return `[${proto.substring(1, proto.length - 1)} ${win.location}]`;
}
function prettyAttr(obj) {
return `[object Attr ${obj.name}="${obj.value}"]`;
}
function prettyObject(obj) {
let proto = Object.prototype.toString.call(obj);
let s = "";
try {
s = JSON.stringify(obj);
} catch (e) {
if (e instanceof TypeError) {
s = `<${e.message}>`;
} else {
throw e;
}
}
return `${proto} ${s}`;
}
let res = [];
for (let i = 0; i < ss.length; i++) {
res.push(ss[i]);
if (i < values.length) {
let s;
try {
s = pretty(values[i]);
} catch (e) {
logger.warn("Problem pretty printing:", e);
s = typeof values[i];
}
res.push(s);
}
}
return res.join("");
}
this.pprint = pprint;
/**
* Template literal that truncates string values in arbitrary objects.
*
* Given any object, the template will walk the object and truncate
* any strings it comes across to a reasonable limit. This is suitable
* when you have arbitrary data and data integrity is not important.
*
* The strings are truncated in the middle so that the beginning and
* the end is preserved. This will make a long, truncated string look
* like "X <...> Y", where X and Y are half the number of characters
* of the maximum string length from either side of the string.
*
* If the `marionette.log.truncate` preference is false, this
* function acts as a no-op.
*
* Usage::
*
* truncate`Hello ${"x".repeat(260)}!`;
* // Hello xxx ... xxx!
*
* Functions named `toJSON` or `toString` on objects will be called.
*/
function truncate(strings, ...values) {
function walk(obj) {
const typ = Object.prototype.toString.call(obj);
switch (typ) {
case "[object Undefined]":
case "[object Null]":
case "[object Boolean]":
case "[object Number]":
return obj;
case "[object String]":
if (MarionettePrefs.truncateLog) {
if (obj.length > MAX_STRING_LENGTH) {
let s1 = obj.substring(0, MAX_STRING_LENGTH / 2);
let s2 = obj.substring(obj.length - MAX_STRING_LENGTH / 2);
return `${s1} ... ${s2}`;
}
}
return obj;
case "[object Array]":
return obj.map(walk);
// arbitrary object
default:
if (
Object.getOwnPropertyNames(obj).includes("toString") &&
typeof obj.toString == "function"
) {
return walk(obj.toString());
}
let rv = {};
for (let prop in obj) {
rv[prop] = walk(obj[prop]);
}
return rv;
}
}
let res = [];
for (let i = 0; i < strings.length; ++i) {
res.push(strings[i]);
if (i < values.length) {
let obj = walk(values[i]);
let t = Object.prototype.toString.call(obj);
if (t == "[object Array]" || t == "[object Object]") {
res.push(JSON.stringify(obj));
} else {
res.push(obj);
}
}
}
return res.join("");
}
this.truncate = truncate;
|
