endojs / endo

Endo is a distributed secure JavaScript sandbox, based on SES
Apache License 2.0
829 stars 72 forks source link

fix(eventual-send): switch DEBUG option to be comma separated #1922

Closed erights closed 10 months ago

erights commented 10 months ago

refs: https://github.com/Agoric/agoric-sdk/pull/8136 refs: https://github.com/Agoric/agoric-sdk/issues/8096 refs: https://github.com/Agoric/agoric-sdk/blob/master/docs/env.md#DEBUG

Description

As explained at https://github.com/Agoric/agoric-sdk/issues/8096 , prior to this PR, eventual-send's use of the DEBUG option mistakenly split it on colons (':'). This PR switches that one use to split on commas (',') instead.

Security Considerations

Following widespread conventions leads to fewer unpleasant surprises.

Scaling Considerations

none

Documentation Considerations

https://github.com/Agoric/agoric-sdk/blob/master/docs/env.md#DEBUG already speaks in terms of the value of DEBUG being a comma separated list. Prior to this PR, the endo implementation does not conform to that document. But the agoric-sdk implementation would still not conform until fixed by https://github.com/Agoric/agoric-sdk/pull/8136

Testing Considerations

none

Upgrade Considerations

none

mhofman commented 10 months ago

While I agree it's technically a breaking change, I'm wondering if this particular instance warrant the churn associated with a major version bump. @kriskowal opinions?

erights commented 10 months ago

I do not have strong feelings about the breaking change sigil,

I got rid of it. Thanks.