Test/hello world blueprint #908
Conversation
…cak/wordpress-playground into test/hello-world-blueprint
|
|
|
@adamziel please let me know if you have any feedback on this. |
| `, | ||
| }); | ||
|
|
||
| if (phpResponse.errors) { |
There was a problem hiding this comment.
Yup! I wonder if we should just throw an exception instead. Thoughts on that? My worry is a scenario where PHP crashes without any output in stderr which could be confusing to the developer, although we could perhaps detect that based on the exit code and provide some useful guidelines in the error message.
There was a problem hiding this comment.
Would a promise reject be good here?
There was a problem hiding this comment.
Yup! Maybe, actually. There is no error per se, the PHP program actually ran and completed, it just happened to yield a different set of output/error/exit code values. We still want to access those. Perhaps Promise.reject(response)?
| /** | ||
| * Print messages to the console. | ||
| */ | ||
| helloWorld?: string; |
There was a problem hiding this comment.
For completeness – this is a new Blueprint top-level property. A step would be a part of the steps array. Either is fine, depending on what you hoped to achieve here, but I'm mentioning since you specifically used the word step.
There was a problem hiding this comment.
Reading on, it seems like you wanted to do a step. Then this change and the one in compile.ts may be removed – You've updated the StepDefinition type so you can now use a helloWorld step as a part of the steps array.
There was a problem hiding this comment.
I did it in this way just to see if I can do it.
I will clean it up in case we want to use this as a example in the future.
| @@ -33,6 +33,8 @@ import type { ValidateFunction } from 'ajv'; | |||
| export type CompiledStep = (php: UniversalPHP) => Promise<void> | void; | |||
|
|
|||
| export interface CompiledBlueprint { | |||
| /** The hello message printed in the console */ | |||
| helloWorld?: string; | |||
There was a problem hiding this comment.
| */ | ||
| export const helloWorld: StepHandler<HelloWorldStep> = async ( | ||
| playground, | ||
| { message } |
There was a problem hiding this comment.
Nice! You may also want to play with the third argument (progress?), see the install-plugin.ts step for more details on that.
|
This looks pretty good! You may also want to try adding a unit tests and an E2E test for that step to see how that setup works. I'm also interested in your thoughts about simplifying the class and interface structure here – it seems overly complex. As for the build error, we have a custom Docusaurus plugin that extracts docstrings from step types. Perhaps adding an empty block comment to |
Thanks! I missed this block comment, should be good now.
I actually think this is better. Documentation is important 🙂 |
This is a demo, it shouldn't be merged.
What is this PR doing?
Creates a
helloWorldblueprint step and executes PHP code to build a response message.What problem is it solving?
Demonstrating how to add blueprint steps.
How is the problem addressed?
By adding a new blueprint step that executes code in base-php.
Testing Instructions
npm run dev