Patch bug in stack-utils npm package
#6451
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kriskowal
approved these changes
Oct 13, 2022
FUDCo
force-pushed
the
patch-for-stack-utils-bug
branch
from
42c2324
to
8436476
Compare
erights
added a commit
to erights/stack-utils
that referenced
this pull request
Oct 13, 2022
JavaScript has a misfeature often called the "override mistake". In an assignment such as ```js res.constructor = true; ``` if `res` does not yet have its own `constructor` property, but inherits one that this assignment would override (as is the intention here), but the property that would be overridden is a non-writable data property, then the assignment fails. Hardened JS and similar frameworks for securing JS routinely freeze all the primordial objects, which causes their data properties to become non-configurable, non-writable. Also, the TC53 JS standard for embedded devices standardizes on Hardened JS, which will also cause this problem. The XS JS engine for embedded devices use the Hardened JS configuration by default on embedded devices. Object literals and classes override inherited properties without problem because they use JS's "define" semantics rather than JS's peculiar "assign" semantics. You can also do so manually via `Object.defineProperty`, as this PR does to repair this issue. See also tapjs#70 Agoric/agoric-sdk#6451
|
PR for stack-utils now at tapjs/stack-utils#71 (If they don't respond to an issue, they often will to a pull request. We'll see) |
|
See also endojs/endo#576 (comment) |
Lockdown breaks Ava under certain versions of NodeJS. It turns out to be due to a bug in the `stack-utils` npm package with trips over the override mistake. I've filed an issue with the maintainer of that package, but in the meantime this patch deals with the problem. See tapjs/stack-utils#70
turadg
force-pushed
the
patch-for-stack-utils-bug
branch
from
8436476
to
7eceb12
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Lockdown breaks Ava under certain versions of NodeJS. It turns out to be due to a bug in the
stack-utilsnpm package which trips over the override mistake. I've filed an issue with the maintainer of that package, but in the meantime this patch deals with the problem.It is unclear which version of Node starts manifesting the problem, but at least v16.16.0 has it. The problem manifests as Ava test failures being reported unhelpfully -- whereas one should get a stack backtrace from the point in the test file where the failure happened, usually along with a nice diff between expected and actual result values from things like
t.deepEqual, instead you get an "Unable to serialize error" exception with a stack trace from somewhere deep in the bowels of Ava. The problem was thestack-utilsnpm package (which Ava uses) failing a property assignment toObject.prototype(which should have been a simple property assignment to an ordinary property of an ordinary object but wasn't because of the override mistake) in an environment whereObject.prototypeis frozen because of lockdown.Without this patch (or, the eventual hoped for fix to the
stack-utilsnpm package itself), debugging Ava test failures is grossly inhibited if you are using one of the newer versions of Node that manifest the problem.See tapjs/stack-utils#70