New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support for validation failures from Construct RPC #16132
Open
EronWright
wants to merge
15
commits into
master
Choose a base branch
from
issue-6933
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,432
−168
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
Changelog[uncommitted] (2024-05-09)Features
|
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.
Description
Implements support for returning
Failures
from theConstruct
RPC. Design doc:https://docs.google.com/document/d/1CK5YgSBK2g3LzY-bZVMMrMwyel-7nbQYisSYExJQ4Fw/edit?usp=sharing
Implementation Details
An important aspect of validation failures is that they don't cause spurious error messages like "rpc error" or "bailed". With that in mind, this implements strives to handle failure in the way that it is handled for
Check
RPC.To recap how
Check
works: the resource monitor receives a registration request, sends aregisterResourceEvent
to the registration channel, and then blocks. The step executor callsCheck
, reports on the failures, then cancels the deployment, with the event's done channel left open. The resource monitor is ultimately cancelled.Unlike
Check
,Construct
is handled directly by the resource monitor and doesn't involve a step. The resource monitor needs a way to poison the deployment via the iterator. So, the monitor simply closes an abort channel, causing the iterator to bail to nice effect.Fixes #6933
Example
Given a component provider whose construct function resembles:
And a program:
We see the expected behavior:
Checklist
make tidy
to update any new dependenciesmake lint
to verify my code passes the lint checkgofumpt
make changelog
and committed thechangelog/pending/<file>
documenting my change