test(ses-ava): use causal console

[erights]

closes: #611
closes: #891
refs: Agoric/agoric-sdk#8965 (comment) #647 #1467 #2107 Agoric/agoric-sdk#8662 #1798 #2101 #2107 https://github.com/Agoric/agoric-sdk/wiki/agoric-sdk-unit-testing#patterns

Description

Replaces #2101 and #2107 , though unclosed conversations there probably apply here as well.

Alter ses-ava so that

• The exposed virtual t.log first goes through our causal console logic, to show redacted information including nesting errors, but still ultimately directs the output to the original t.log so it retains all the ordering and verbosity switching associated with Ava's original t.log.
• When a test fails by throwing or rejecting, the error is also logged with the virtual t.log, so you see its redacted info as well, while staying associated with the error.

To get access to the SES's causal console logic, this PR also adds a new export for a privileged power, which ses-ava needs and imports using

import { makeCausalConsoleFromLogger } from 'ses/console-tools.js';

#2107 review comments raise the issue of whether such special powers should be "exported" from ses and "imported" by privileged clients vs import, as this PR currently does, or as a global binding of the start compartment. Unlike #2101 and #2107, this PR currently bundles the ses changes and the ses-ava changes together so we can coordinate changing our minds on this. Reviewers, once that settles, we can split this up into two PRs again if you wish.

Security Considerations

As of this PR, ses-ava will import makeCausalConsoleFromLogger from console-tools.js. We must ensure that this arrangement does not accidentally make these powers available to non-privileged code executing in constructed (non-start) compartments.

Scaling Considerations

none

Documentation Considerations

none

Testing Considerations

The whole point. Since this PR changes only the logging of errors or rejections from the t => {...} function, it will not by itself clean up console output in general. But at least it will cause these error reports to appear at the "right" place in the overall console output.

In addition, the "export" of makeCausalConsoleFromLogger from ses/console-tools.js enables other testing tools to build on our causal console the way ses-ava does.

Compatibility Considerations

Mostly none.

If there are programs post-processing our voluminous console output, they might need to change. However,

• I am not aware of any such programs
• the console output was never stable anyway, so any such programs should be adaptable enough to tolerate this change as well.

Upgrade Considerations

Nothing breaking.

• Includes *BREAKING*: in the commit message with migration instructions for any breaking change.
• Updates NEWS.md for user-facing changes.

[erights]

May want to redo #701 (comment) as part of this PR. It would be a natural fit.

[gibson042]

Very nice! But I wonder if we can thread the unsealing/unredaction power through a bit more directly (see below).

[erights]

Apologies to my reviewers, but in responding to @kriskowal 's request about how ses makes the special console-making-power available to @endo/ses-ava at this time, I went about making the change in a way that squashed. I hope this does not make further review too difficult. I have not yet responded to the reviewer comments still open above, and will do so from this baseline.

[kriskowal]

I’m satisfied by this coupling at a global symbol between ses and ses-ava since this is a stopgap on a path and not where we want to land for error unsealing in general.

I defer to @gibson042 for the final stamp since he has pending feedback!

[dckc]

I gather @gibson042 and @kriskowal have this review well in hand.

[erights]

Ping. I addressed all reviewer suggestions. PTAL. thanks.