action: Implement planning and invoking of actions #1185
Merged
Conversation
This file contains hidden or 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
austinvalle
commented
Jul 15, 2025
Comment on lines
+31
to
+35
| // SendProgress will immediately send a progress update to Terraform core during action invocation. | ||
| // This function is provided by the framework and can be called multiple times while action logic is running. | ||
| // | ||
| // TODO:Actions: More documentation about when you should use this / when you shouldn't | ||
| SendProgress func(event InvokeProgressEvent) |
There was a problem hiding this comment.
It didn't feel beneficial to expose much more than this function to provider developers. Open to discussion on any other ideas for improving this UX
There was a problem hiding this comment.
I think this design makes sense, we only need to expose progress events for now and if we want to expose other types, we can incrementally add callback functions for those types later. I doubt that we will need to expose every event type.
1 task
SBGoods
approved these changes
Jul 16, 2025
Comment on lines
+31
to
+35
| // SendProgress will immediately send a progress update to Terraform core during action invocation. | ||
| // This function is provided by the framework and can be called multiple times while action logic is running. | ||
| // | ||
| // TODO:Actions: More documentation about when you should use this / when you shouldn't | ||
| SendProgress func(event InvokeProgressEvent) |
There was a problem hiding this comment.
I think this design makes sense, we only need to expose progress events for now and if we want to expose other types, we can incrementally add callback functions for those types later. I doubt that we will need to expose every event type.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Related Issue
N/A
Description
This PR introduces the implementation of the
PlanActionandInvokeActionRPCs. Currently planning actions has one hookModifyPlan(the same asModifyPlanin managed resources, so I named it as such), and invoking has one hookInvoke(which always ends with a completed event)The actual streaming mechanism of the protocol is hidden here since the provider always needs to respond with a single completed event, with multiple (optional) progress events in-between. To keep the interface of
Invokesimple, we are just providing a function (InvokeResponse.SendProgress) for providers to call whenever they want to stream a progress event back to Terraform. Once the invoke method has finished, and the provider has set the proper data on the response, then framework automatically sends the completed event and returns.Rollback Plan
Changes to Security Controls
No