wp-now: execute blueprint steps given a file path

[sejas]

What?

It adds Blueprint support for wp-now.
Blueprint steps code relies heavily on Web functions and some of them will not work on Javascript for Node.js. We will need to find those steps and convert them into isomorphic javascript.

• Solves wp-now: Support for running a Blueprint on start #80
• Related Local Environment: Replace custom setup logic with a Blueprints-based setup #9

Why?

• It will be a great addition to support different configurations such as wp-now: Add support for custom URL's #78

How?

After setting up WordPress and for all the modes except index we apply the blueprint steps before any PHP request, so before installing the theme/plugin and before auto-logging.

If the steps defineWpConfigConsts or defineSiteUrl are passed in the blueprint steps, then we will use its value to change the absoluteUrl.

Testing Instructions

1. Add 127.0.0.1 myurl.wpnow to your /etc/hosts
2. Create a blueprint JSON file in your current directory named foo.json.

Blueprint example:

{
    "steps": [
        {
            "step": "defineWpConfigConsts",
            "consts": {
                "WP_HOME": "http://myurl.wpnow",
                "WP_SITEURL": "http://myurl.wpnow"
            },
            "virtualize": true
        }
    ]
}

Check out more examples: https://wordpress.github.io/wordpress-playground/docs/blueprints-api/examples

3. Run nvm use > npm install . This PR requires Node v20+
4. Build this branch: npx nx build wp-now
5. Run node dist/packages/wp-now/main.js start --blueprint=foo.json --port=80
6. Observe blurpinrt steps: 1 and Blueprint step completed: defineWpConfigConsts appear in the console output
7. Observe the URL http://myurl.wpnow opens in your browser and WordPress still working as expected.

Ngrok case

1. Run ngrok http 8881.
2. Modify the foo.json file with the ngrok temporal URL.
3. Run node dist/packages/wp-now/main.js start --blueprint=foo.json --port=80
4. Observe the ngrok URL opens and WordPress works as expected.

[sergeymitr]

Hi @sejas.
Thanks for working on this!

I'm getting an error trying start the server:

ReferenceError: CustomEvent is not defined
    at F.notifyProgress (file:///.../node_modules/@wp-playground/blueprints/index.js:725:11)
    at F.finish (file:///.../node_modules/@wp-playground/blueprints/index.js:664:165)
    at Object.run (file:///.../node_modules/@wp-playground/blueprints/index.js:2017:11)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async yt (file:///.../node_modules/@wp-playground/blueprints/index.js:2079:3)
    at async startWPNow (file:///.../dist/packages/wp-now/main.js:570:5)
    at async startServer (file:///.../dist/packages/wp-now/main.js:831:42)
    at async Object.handler (file:///.../dist/packages/wp-now/main.js:987:25)

Removing dist and node_modules and rebuilding didn't help.

[sejas]

Hi @sejas. Thanks for working on this!

I'm getting an error trying start the server:

@sergeymitr , thanks for trying this PR. I changed the testing instructions to cover the custom domain case.

Not all the blueprints are supported at the moment. For example, install plugins/themes are failing. We will need to adapt those blueprint steps to work in Node.js. This is not limiting for merging this PR, though.

[sejas]

Using 127.0.0.1 instead of myurl.wpnow because the DNS tests would fail resolving that custom URL.
The default URL is localhost:8881.

[kozer]

I checked that @sejas , and works as expected! Nice work!

[sejas]

I merged this branch. It would be great to bump the playground dependencies such us @wp-playground/blueprints when they are released on NPM.

[danielbachhuber]

In the future, can we handle version bumps as a separate PR?

Related WordPress/wordpress-playground#591 (review)

[danielbachhuber]

Thanks for including docs! I cleaned up a couple of things with #85

[dmsnell]

Do we need to publish the packages now that this is merged? it doesn't seem like support is there in the version pulled from npx @wp-now/wp-now

[danielbachhuber]

Do we need to publish the packages now that this is merged? it doesn't seem like support is there in the version pulled from npx @wp-now/wp-now

To close the loop on this: we met in Slack and published the new version.

[dawidurbanski]

Is there any reason why only steps from blueprints are supported?
I just tested this and it seems like neither landingPage option nor preferredVersions is respected.
Should I create new ticket for this? I'm also happy to contribute in this matter.

[dawidurbanski]

Never mind, I see this being mentioned in the PR description: #9