From 91c29afd59c939e5392d6304534f57eefebb8181 Mon Sep 17 00:00:00 2001 From: Kris Kowal Date: Tue, 9 Jan 2024 17:03:05 -0800 Subject: [PATCH] docs(ses): Clarify that SES reveals stacks to console on uncaught exception --- packages/ses/src/error/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/ses/src/error/README.md b/packages/ses/src/error/README.md index a0bdeb6b74..9f39224e5f 100644 --- a/packages/ses/src/error/README.md +++ b/packages/ses/src/error/README.md @@ -5,7 +5,7 @@ Summary * To that end, SES introduces an `assert` global with functions that add to errors annotations that will be hidden from callers. SES also tames the `Error` constructor to hide the `stack` to parent callers when possible (currently: v8, SpiderMonkey, XS). * SES tames the global `console` and grants it the ability to reveal error annotations and stacks to the actual console. * Both `assert` and `console` are powerful globals that SES does not implicitly carry into child compartments. When creating a child compartment, add `assert` to the compartment’s globals. Either add `console` too, or add a wrapper that annotates the console with a topic. - * SES hides annotations and stack traces by default. To reveal them, use a mechanism like `process.on("uncaughtException")` in Node.js to catch the error and log it back to the `console` tamed by `lockdown`. + * SES hides annotations and stack traces by default. To reveal them, SES uses mechanisms like `process.on("uncaughtException")` in Node.js to catch the error and log it back to the `console` tamed by `lockdown`. * In the scope of the Agoric software ecosystem, this architecture will allow us to eventually introduce a more powerful distributed `console` that can meaningfully capture stack traces for a distributed debugger, based on the design of [Causeway](https://github.com/Agoric/agoric-sdk/issues/1318#issuecomment-662127549).