fix(orchestration): harden exported patterns #10470
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
Deploying agoric-sdk with
|
| Latest commit: |
5943756
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1027f5b3.agoric-sdk.pages.dev |
| Branch Preview URL: | https://markm-orch-type-guards.agoric-sdk.pages.dev |
turadg
approved these changes
Nov 13, 2024
turadg
approved these changes
Nov 13, 2024
turadg
force-pushed
the
markm-orch-type-guards
branch
from
d298c5a
to
341f4f1
Compare
turadg
added
automerge:rebase
erights
commented
Nov 14, 2024
erights
force-pushed
the
markm-orch-type-guards
branch
3 times, most recently
from
cd068e6
to
52db2ee
Compare
erights
force-pushed
the
markm-orch-type-guards
branch
from
52db2ee
to
5943756
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.
closes: #XXXX
refs: #XXXX
Description
orchestration/src/typeGuards was defining and exporting some patterns as just unhardened object literals. This is locally wrong, since these are not valid patterns (or even passables) until hardened. The only reason these errors were uncaught must be because they were then used in a context which happened to harden them before they were used in a context where they were validated as patterns or passables.
Started as a drive-by of #10456 , where I import some of these patterns for usage elsewhere.
Security Considerations
defensive hardening is good
Scaling Considerations
none
Documentation Considerations
one less thing we would need to explain
Testing Considerations
In theory, a test could have revealed the bug that these were exported unhardened. But IMO, such tests would only be too much noise. We should just fix these. But this PR only fixes these in this one file. I don't know how many others there are.
Upgrade Considerations
In theory, it is possible that some importing code somewhere accidentally replies on these being unhardened, perhaps because it mutates one in place before using it, corrupting use by all other importers. If so, this PR will break such uses, which is good, because the silent corruption is a worse surprise than a new noisy error.