-
Notifications
You must be signed in to change notification settings - Fork 71
/
assert.js
583 lines (538 loc) · 17.6 KB
/
assert.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
// Copyright (C) 2019 Agoric, under Apache License 2.0
// @ts-check
// To ensure that this module operates without special privilege, it should
// not reference the free variable `console` except for its own internal
// debugging purposes in the declaration of `internalDebugConsole`, which is
// normally commented out.
// This module however has top level mutable state which is observable to code
// given access to the `loggedErrorHandler`, such as the causal console
// of `console.js`. However, for code that does not have such access, this
// module should not be observably impure.
import {
RangeError,
TypeError,
WeakMap,
arrayJoin,
arrayMap,
arrayPop,
arrayPush,
assign,
freeze,
defineProperty,
globalThis,
is,
isError,
regexpTest,
stringIndexOf,
stringReplace,
stringSlice,
stringStartsWith,
weakmapDelete,
weakmapGet,
weakmapHas,
weakmapSet,
AggregateError,
getOwnPropertyDescriptors,
ownKeys,
create,
objectPrototype,
objectHasOwnProperty,
} from '../commons.js';
import { an, bestEffortStringify } from './stringify-utils.js';
import './types.js';
import './internal-types.js';
import { makeNoteLogArgsArrayKit } from './note-log-args.js';
/**
* @import {BaseAssert, Assert, AssertionFunctions, AssertionUtilities, StringablePayload, DetailsToken, MakeAssert} from '../../types.js'
*/
// For our internal debugging purposes, uncomment
// const internalDebugConsole = console;
// /////////////////////////////////////////////////////////////////////////////
/** @type {WeakMap<StringablePayload, any>} */
const declassifiers = new WeakMap();
/** @type {AssertionUtilities['quote']} */
const quote = (payload, spaces = undefined) => {
const result = freeze({
toString: freeze(() => bestEffortStringify(payload, spaces)),
});
weakmapSet(declassifiers, result, payload);
return result;
};
freeze(quote);
const canBeBare = freeze(/^[\w:-]( ?[\w:-])*$/);
/**
* @type {AssertionUtilities['bare']}
*/
const bare = (payload, spaces = undefined) => {
if (typeof payload !== 'string' || !regexpTest(canBeBare, payload)) {
return quote(payload, spaces);
}
const result = freeze({
toString: freeze(() => payload),
});
weakmapSet(declassifiers, result, payload);
return result;
};
freeze(bare);
// /////////////////////////////////////////////////////////////////////////////
/**
* @typedef {object} HiddenDetails
*
* Captures the arguments passed to the `details` template string tag.
*
* @property {TemplateStringsArray | string[]} template
* @property {any[]} args
*/
/**
* @type {WeakMap<DetailsToken, HiddenDetails>}
*
* Maps from a details token which a `details` template literal returned
* to a record of the contents of that template literal expression.
*/
const hiddenDetailsMap = new WeakMap();
/**
* @param {HiddenDetails} hiddenDetails
* @returns {string}
*/
const getMessageString = ({ template, args }) => {
const parts = [template[0]];
for (let i = 0; i < args.length; i += 1) {
const arg = args[i];
let argStr;
if (weakmapHas(declassifiers, arg)) {
argStr = `${arg}`;
} else if (isError(arg)) {
argStr = `(${an(arg.name)})`;
} else {
argStr = `(${an(typeof arg)})`;
}
arrayPush(parts, argStr, template[i + 1]);
}
return arrayJoin(parts, '');
};
/**
* Give detailsTokens a toString behavior. To minimize the overhead of
* creating new detailsTokens, we do this with an
* inherited `this` sensitive `toString` method, even though we normally
* avoid `this` sensitivity. To protect the method from inappropriate
* `this` application, it does something interesting only for objects
* registered in `redactedDetails`, which should be exactly the detailsTokens.
*
* The printing behavior must not reveal anything redacted, so we just use
* the same `getMessageString` we use to construct the redacted message
* string for a thrown assertion error.
*/
const DetailsTokenProto = freeze({
toString() {
const hiddenDetails = weakmapGet(hiddenDetailsMap, this);
if (hiddenDetails === undefined) {
return '[Not a DetailsToken]';
}
return getMessageString(hiddenDetails);
},
});
freeze(DetailsTokenProto.toString);
/**
* Normally this is the function exported as `assert.details` and often
* spelled `X`. However, if the `{errorTaming: 'unsafe'}` or
* `{errorTaming: 'unsafe-debug'}` option is
* given to `lockdown`, then `unredactedDetails` is used instead.
*
* There are some unconditional uses of `redactedDetails` in this module. All
* of them should be uses where the template literal has no redacted
* substitution values. In those cases, the two are equivalent.
*
* @type {AssertionUtilities['details']}
*/
const redactedDetails = (template, ...args) => {
// Keep in mind that the vast majority of calls to `details` creates
// a details token that is never used, so this path must remain as fast as
// possible. Hence we store what we've got with little processing, postponing
// all the work to happen only if needed, for example, if an assertion fails.
const detailsToken = freeze({ __proto__: DetailsTokenProto });
weakmapSet(hiddenDetailsMap, detailsToken, { template, args });
return /** @type {DetailsToken} */ (/** @type {unknown} */ (detailsToken));
};
freeze(redactedDetails);
/**
* `unredactedDetails` is like `details` except that it does not redact
* anything. It acts like `details` would act if all substitution values
* were wrapped with the `quote` function above (the function normally
* spelled `q`). If the `{errorTaming: 'unsafe'}`
* or `{errorTaming: 'unsafe-debug'}` option is given to
* `lockdown`, then the lockdown-shim arranges for the global `assert` to be
* one whose `details` property is `unredactedDetails`.
* This setting optimizes the debugging and testing experience at the price
* of safety. `unredactedDetails` also sacrifices the speed of `details`,
* which is usually fine in debugging and testing.
*
* @type {AssertionUtilities['details']}
*/
const unredactedDetails = (template, ...args) => {
args = arrayMap(args, arg =>
weakmapHas(declassifiers, arg) ? arg : quote(arg),
);
return redactedDetails(template, ...args);
};
freeze(unredactedDetails);
export { unredactedDetails };
/**
* @param {HiddenDetails} hiddenDetails
* @returns {LogArgs}
*/
const getLogArgs = ({ template, args }) => {
const logArgs = [template[0]];
for (let i = 0; i < args.length; i += 1) {
let arg = args[i];
if (weakmapHas(declassifiers, arg)) {
arg = weakmapGet(declassifiers, arg);
}
// Remove the extra spaces (since console.error puts them
// between each cause).
const priorWithoutSpace = stringReplace(arrayPop(logArgs) || '', / $/, '');
if (priorWithoutSpace !== '') {
arrayPush(logArgs, priorWithoutSpace);
}
const nextWithoutSpace = stringReplace(template[i + 1], /^ /, '');
arrayPush(logArgs, arg, nextWithoutSpace);
}
if (logArgs[logArgs.length - 1] === '') {
arrayPop(logArgs);
}
return logArgs;
};
/**
* @type {WeakMap<Error, LogArgs>}
*
* Maps from an error object to the log args that are a more informative
* alternative message for that error. When logging the error, these
* log args should be preferred to `error.message`.
*/
const hiddenMessageLogArgs = new WeakMap();
// So each error tag will be unique.
let errorTagNum = 0;
/**
* @type {WeakMap<Error, string>}
*/
const errorTags = new WeakMap();
/**
* @param {Error} err
* @param {string=} optErrorName
* @returns {string}
*/
const tagError = (err, optErrorName = err.name) => {
let errorTag = weakmapGet(errorTags, err);
if (errorTag !== undefined) {
return errorTag;
}
errorTagNum += 1;
errorTag = `${optErrorName}#${errorTagNum}`;
weakmapSet(errorTags, err, errorTag);
return errorTag;
};
/**
* Make reasonable best efforts to make a `Passable` error.
* - `sanitizeError` will remove any "extraneous" own properties already added
* by the host,
* such as `fileName`,`lineNumber` on FireFox or `line` on Safari.
* - If any such "extraneous" properties were removed, `sanitizeError` will
* annotate
* the error with them, so they still appear on the causal console
* log output for diagnostic purposes, but not be otherwise visible.
* - `sanitizeError` will ensure that any expected properties already
* added by the host are data
* properties, converting accessor properties to data properties as needed,
* such as `stack` on v8 (Chrome, Brave, Edge?)
* - `sanitizeError` will freeze the error, preventing any correct engine from
* adding or
* altering any of the error's own properties `sanitizeError` is done.
*
* However, `sanitizeError` will not, for example, `harden`
* (i.e., deeply freeze)
* or ensure that the `cause` or `errors` property satisfy the `Passable`
* constraints. The purpose of `sanitizeError` is only to protect against
* mischief the host may have already added to the error as created,
* not to ensure that the error is actually Passable. For that,
* see `toPassableError` in `@endo/pass-style`.
*
* @param {Error} error
*/
export const sanitizeError = error => {
const descs = getOwnPropertyDescriptors(error);
const {
name: _nameDesc,
message: _messageDesc,
errors: _errorsDesc = undefined,
cause: _causeDesc = undefined,
stack: _stackDesc = undefined,
...restDescs
} = descs;
const restNames = ownKeys(restDescs);
if (restNames.length >= 1) {
for (const name of restNames) {
delete error[name];
}
const droppedNote = create(objectPrototype, restDescs);
// eslint-disable-next-line no-use-before-define
note(
error,
redactedDetails`originally with properties ${quote(droppedNote)}`,
);
}
for (const name of ownKeys(error)) {
// @ts-expect-error TS still confused by symbols as property names
const desc = descs[name];
if (desc && objectHasOwnProperty(desc, 'get')) {
defineProperty(error, name, {
value: error[name], // invoke the getter to convert to data property
});
}
}
freeze(error);
};
/**
* @type {AssertionUtilities['error']}
*/
const makeError = (
optDetails = redactedDetails`Assert failed`,
errConstructor = globalThis.Error,
{
errorName = undefined,
cause = undefined,
errors = undefined,
sanitize = true,
} = {},
) => {
if (typeof optDetails === 'string') {
// If it is a string, use it as the literal part of the template so
// it doesn't get quoted.
optDetails = redactedDetails([optDetails]);
}
const hiddenDetails = weakmapGet(hiddenDetailsMap, optDetails);
if (hiddenDetails === undefined) {
throw TypeError(`unrecognized details ${quote(optDetails)}`);
}
const messageString = getMessageString(hiddenDetails);
const opts = cause && { cause };
let error;
if (
typeof AggregateError !== 'undefined' &&
errConstructor === AggregateError
) {
error = AggregateError(errors || [], messageString, opts);
} else {
error = /** @type {ErrorConstructor} */ (errConstructor)(
messageString,
opts,
);
if (errors !== undefined) {
// Since we need to tolerate `errors` on an AggregateError, may as
// well tolerate it on all errors.
defineProperty(error, 'errors', {
value: errors,
writable: true,
enumerable: false,
configurable: true,
});
}
}
weakmapSet(hiddenMessageLogArgs, error, getLogArgs(hiddenDetails));
if (errorName !== undefined) {
tagError(error, errorName);
}
if (sanitize) {
sanitizeError(error);
}
// The next line is a particularly fruitful place to put a breakpoint.
return error;
};
freeze(makeError);
// /////////////////////////////////////////////////////////////////////////////
const { addLogArgs, takeLogArgsArray } = makeNoteLogArgsArrayKit();
/**
* @type {WeakMap<Error, NoteCallback[]>}
*
* An augmented console will normally only take the hidden noteArgs array once,
* when it logs the error being annotated. Once that happens, further
* annotations of that error should go to the console immediately. We arrange
* that by accepting a note-callback function from the console as an optional
* part of that taking operation. Normally there will only be at most one
* callback per error, but that depends on console behavior which we should not
* assume. We make this an array of callbacks so multiple registrations
* are independent.
*/
const hiddenNoteCallbackArrays = new WeakMap();
/** @type {AssertionUtilities['note']} */
const note = (error, detailsNote) => {
if (typeof detailsNote === 'string') {
// If it is a string, use it as the literal part of the template so
// it doesn't get quoted.
detailsNote = redactedDetails([detailsNote]);
}
const hiddenDetails = weakmapGet(hiddenDetailsMap, detailsNote);
if (hiddenDetails === undefined) {
throw TypeError(`unrecognized details ${quote(detailsNote)}`);
}
const logArgs = getLogArgs(hiddenDetails);
const callbacks = weakmapGet(hiddenNoteCallbackArrays, error);
if (callbacks !== undefined) {
for (const callback of callbacks) {
callback(error, logArgs);
}
} else {
addLogArgs(error, logArgs);
}
};
freeze(note);
/**
* The unprivileged form that just uses the de facto `error.stack` property.
* The start compartment normally has a privileged `globalThis.getStackString`
* which should be preferred if present.
*
* @param {Error} error
* @returns {string}
*/
const defaultGetStackString = error => {
if (!('stack' in error)) {
return '';
}
const stackString = `${error.stack}`;
const pos = stringIndexOf(stackString, '\n');
if (stringStartsWith(stackString, ' ') || pos === -1) {
return stackString;
}
return stringSlice(stackString, pos + 1); // exclude the initial newline
};
/** @type {LoggedErrorHandler} */
const loggedErrorHandler = {
getStackString: globalThis.getStackString || defaultGetStackString,
tagError: error => tagError(error),
resetErrorTagNum: () => {
errorTagNum = 0;
},
getMessageLogArgs: error => weakmapGet(hiddenMessageLogArgs, error),
takeMessageLogArgs: error => {
const result = weakmapGet(hiddenMessageLogArgs, error);
weakmapDelete(hiddenMessageLogArgs, error);
return result;
},
takeNoteLogArgsArray: (error, callback) => {
const result = takeLogArgsArray(error);
if (callback !== undefined) {
const callbacks = weakmapGet(hiddenNoteCallbackArrays, error);
if (callbacks) {
arrayPush(callbacks, callback);
} else {
weakmapSet(hiddenNoteCallbackArrays, error, [callback]);
}
}
return result || [];
},
};
freeze(loggedErrorHandler);
export { loggedErrorHandler };
// /////////////////////////////////////////////////////////////////////////////
/**
* @type {MakeAssert}
*/
const makeAssert = (optRaise = undefined, unredacted = false) => {
const details = unredacted ? unredactedDetails : redactedDetails;
const assertFailedDetails = details`Check failed`;
/** @type {AssertionFunctions['fail']} */
const fail = (
optDetails = assertFailedDetails,
errConstructor = undefined,
options = undefined,
) => {
const reason = makeError(optDetails, errConstructor, options);
if (optRaise !== undefined) {
// @ts-ignore returns `never` doesn't mean it isn't callable
optRaise(reason);
}
throw reason;
};
freeze(fail);
/** @type {AssertionUtilities['Fail']} */
const Fail = (template, ...args) => fail(details(template, ...args));
// Don't freeze or export `baseAssert` until we add methods.
// TODO If I change this from a `function` function to an arrow
// function, I seem to get type errors from TypeScript. Why?
/** @type {BaseAssert} */
function baseAssert(
flag,
optDetails = undefined,
errConstructor = undefined,
options = undefined,
) {
flag || fail(optDetails, errConstructor, options);
}
/** @type {AssertionFunctions['equal']} */
const equal = (
actual,
expected,
optDetails = undefined,
errConstructor = undefined,
options = undefined,
) => {
is(actual, expected) ||
fail(
optDetails || details`Expected ${actual} is same as ${expected}`,
errConstructor || RangeError,
options,
);
};
freeze(equal);
/** @type {AssertionFunctions['typeof']} */
const assertTypeof = (specimen, typename, optDetails) => {
// This will safely fall through if typename is not a string,
// which is what we want.
// eslint-disable-next-line valid-typeof
if (typeof specimen === typename) {
return;
}
typeof typename === 'string' || Fail`${quote(typename)} must be a string`;
if (optDetails === undefined) {
// Embed the type phrase without quotes.
const typeWithDeterminer = an(typename);
optDetails = details`${specimen} must be ${bare(typeWithDeterminer)}`;
}
fail(optDetails, TypeError);
};
freeze(assertTypeof);
/** @type {AssertionFunctions['string']} */
const assertString = (specimen, optDetails = undefined) =>
assertTypeof(specimen, 'string', optDetails);
// Note that "assert === baseAssert"
/** @type {Assert} */
const assert = assign(baseAssert, {
error: makeError,
fail,
equal,
typeof: assertTypeof,
string: assertString,
note,
details,
Fail,
quote,
bare,
makeAssert,
});
return freeze(assert);
};
freeze(makeAssert);
export { makeAssert };
/** @type {Assert} */
const assert = makeAssert();
export { assert };
// Internal, to obviate polymorphic dispatch, but may become rigorously
// consistent with @endo/error:
/** @type {AssertionFunctions['equal']} */
const assertEqual = assert.equal;
export {
assertEqual,
makeError,
note as annotateError,
redactedDetails as X,
quote as q,
bare as b,
};