Allow for pipeline step parameters to be fully JSON
#161
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
joshtyf
added this to the M3: Users & Organisation Management, Forms and URL Step Improvements milestone
joshtyf
commented
May 26, 2024
| Parameters: map[string]any{ | ||
| "method": "${method}", | ||
| "url": "https://httpbin.org/${method}?param=${param}", | ||
| "data": "{\"key\": \"${value}\", \"${key}\": \"hardcoded_value\"}", |
There was a problem hiding this comment.
data is currently a json encoded string. this will eventually be changed to be a proper JSON object like headers
joshtyf
commented
May 26, 2024
| requestMethod := step.Parameters["method"] | ||
| url := step.Parameters["url"] | ||
| requestBody := step.Parameters["data"] | ||
| requestMethod := step.Parameters["method"].(string) // TODO: add documentation for parameters, specifically the type for safe type assertion |
There was a problem hiding this comment.
when creating the pipeline in the frontend, the user doesn't know what parameters are required for the API step type. he also doesn't know if the parameter value should be of what type. we can add both documentation and validation for this
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
Previously,
parameterswas of typemap[string]string. This meant that the user had to define all parameter values as strings. If they needed maps/lists, they would have to write as json encoded strings and our backend had to further decode these strings into a proper map/list.I've updated the type to now be of type
map[string]any. This allows the user to write the parameters normally using JSON syntax. However, this requires each step to properly type assert their parameters. I'm thinking we can further improve this and refactor in another PR to add more safety.With this change, I can add in the request headers in a proper JSON object. Same for request data.
Others
Currently, our executor isn't handling panics well. If there is a panic, there won't be any errors shown. I believe this is because the execution is run in a separate goroutine and the panic isn't shown in the main program process.