wp-now: execute blueprint steps given a file path #82

sejas · 2023-06-19T12:26:33Z

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.

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

Add 127.0.0.1 myurl.wpnow to your /etc/hosts
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

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

Ngrok case

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

sergeymitr · 2023-06-20T00:18:38Z

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.

… ini entry two times

sejas · 2023-06-20T11:23:17Z

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.

…le classes

…eBlueprint fn

…d/wp-now-blueprints

…P_SITEURL

sejas · 2023-06-23T12:34:57Z

packages/wp-now/src/tests/blueprints/wp-config.json

+			"step": "defineWpConfigConsts",
+			"consts": {
+				"WP_HOME": "http://127.0.0.1",
+				"WP_SITEURL": "http://127.0.0.1"


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 · 2023-06-23T13:46:07Z

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

sejas · 2023-06-23T16:43:52Z

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 · 2023-06-29T22:05:42Z

packages/wp-now/src/main.ts

@@ -1,6 +1,6 @@
 import { runCli } from './run-cli';

-const requiredMajorVersion = 18;
+const requiredMajorVersion = 20;


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

Related WordPress/wordpress-playground#591 (review)

danielbachhuber · 2023-06-29T22:10:12Z

packages/wp-now/README.md

@@ -65,6 +66,92 @@ Of these, `wp-now php` currently supports the `--path=<path>` and `--php=<versio
 -   The `~/.wp-now` home directory is used to store the WP versions and the `wp-content` folders for projects using 'theme', 'plugin', 'wp-content', and 'playground' modes. The path to `wp-content` directory for the 'plugin', 'theme', and 'wp-content' modes is `~/.wp-now/wp-content/${projectName}-${directoryHash}`. 'playground' mode shares the same `~/.wp-now/wp-content/playground` directory, regardless of where it's started.
 -   For the database setup, `wp-now` is using [SQLite database integration plugin](https://wordpress.org/plugins/sqlite-database-integration/). The path to SQLite database is ` ~/.wp-now/wp-content/${projectName}-${directoryHash}/database/.ht.sqlite`

+## Using Blueprints


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

From #82

dmsnell · 2023-07-18T19:31:53Z

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 · 2023-07-18T21:40:59Z

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 · 2023-07-23T15:57:59Z

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 · 2023-07-23T16:01:26Z

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

sejas added 3 commits June 19, 2023 13:12

wp-now: add blueprint parameter

124f62d

wp-now: read and parse blueprint on config

3d2b4a6

wp-now: Compile and execute blueprint steps

6602715

sejas added the wp-now label Jun 19, 2023

sejas self-assigned this Jun 19, 2023

sejas mentioned this pull request Jun 19, 2023

wp-now: Add support for custom URL's #78

Closed

wp-now: output only the step name

49dde3a

sejas added 4 commits June 20, 2023 09:58

wp-now: move blueprint executinon before any php request to avoid php…

f616148

… ini entry two times

wp-now: avoid appending default port 80

82011a5

wp-now: use blueprint WP_SITEURL to overwrite options.absoluteUrl

498d7c7

wp-now: use blueprint WP_SITEURL to overwrite options.absoluteUrl

753eb73

sejas added 3 commits June 20, 2023 12:37

wp-now: apply same blueprint logic to defineSiteUrl

f9ef309

wp-now: set siteUrl from blueprint to work remotely

83b77e2

wp-now: code style

9cdae2a

sejas changed the title ~~WIP wp-now: execute blueprint steps given a file path~~ wp-now: execute blueprint steps given a file path Jun 20, 2023

sejas marked this pull request as ready for review June 20, 2023 13:20

sejas mentioned this pull request Jun 21, 2023

Blueprints: add support for NodeJS WordPress/wordpress-playground#576

Closed

sejas added 8 commits June 22, 2023 18:42

Bump minimum Node version to v20 to be able to use CustomEvent and Fi…

f0e91f1

…le classes

wp-now: consider case where output is undefined

9124473

wp-now: add tests for blueprints

420ef76

wp-now: remove todo validate blueprint since it will happen on compil…

a1ecbfb

…eBlueprint fn

wp-now: update blueprint tests

0263f8e

wp-now: add Blueprint documentation to README.md

a426b99

wp-now: add Debugging steps using blueprints to README.md

ba1ad7a

Merge branch 'trunk' of github.com:WordPress/playground-tools into ad…

b749bec

…d/wp-now-blueprints

sejas requested review from adamziel, wojtekn and kozer June 23, 2023 11:10

sejas requested a review from danielbachhuber June 23, 2023 11:10

sejas added 5 commits June 23, 2023 13:12

wp-now: remove unnecessary import

598c570

wp-now: update blueprint tests to include WP_DEBUG_LOG and simplify W…

56f2e44

…P_SITEURL

code style format

e821a67

wp-now: update blueprint tests

f42ddfd

wp-now: undo restore removed tests

d61b6c2

sejas commented Jun 23, 2023

View reviewed changes

kozer approved these changes Jun 23, 2023

View reviewed changes

sejas merged commit 02f25d4 into trunk Jun 23, 2023

sejas deleted the add/wp-now-blueprints branch June 23, 2023 16:43

sejas linked an issue Jun 23, 2023 that may be closed by this pull request

wp-now: Support for running a Blueprint on start #80

Closed

sejas mentioned this pull request Jun 23, 2023

Blueprints and Client: update engine to node v20 on package.json WordPress/wordpress-playground#591

Closed

danielbachhuber mentioned this pull request Jun 29, 2023

wp-now: Clean up the README a bit #85

Merged

danielbachhuber reviewed Jun 29, 2023

View reviewed changes

danielbachhuber added a commit that referenced this pull request Jun 29, 2023

wp-now: Clean up the README a bit (#85)

bfeec20

From #82

danielbachhuber mentioned this pull request Jul 6, 2023

wp-now: Restore node 18 support #87

Closed

adamziel mentioned this pull request Dec 17, 2023

Polyfills for Node.js v18 and JSDOM runtimes WordPress/wordpress-playground#875

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wp-now: execute blueprint steps given a file path #82

wp-now: execute blueprint steps given a file path #82

sejas commented Jun 19, 2023 •

edited

Loading

sergeymitr commented Jun 20, 2023

sejas commented Jun 20, 2023

sejas Jun 23, 2023

kozer commented Jun 23, 2023

sejas commented Jun 23, 2023

danielbachhuber Jun 29, 2023

danielbachhuber Jun 29, 2023

dmsnell commented Jul 18, 2023

danielbachhuber commented Jul 18, 2023

dawidurbanski commented Jul 23, 2023

dawidurbanski commented Jul 23, 2023

wp-now: execute blueprint steps given a file path #82

wp-now: execute blueprint steps given a file path #82

Conversation

sejas commented Jun 19, 2023 • edited Loading

What?

Why?

How?

Testing Instructions

sergeymitr commented Jun 20, 2023

sejas commented Jun 20, 2023

sejas Jun 23, 2023

Choose a reason for hiding this comment

kozer commented Jun 23, 2023

sejas commented Jun 23, 2023

danielbachhuber Jun 29, 2023

Choose a reason for hiding this comment

danielbachhuber Jun 29, 2023

Choose a reason for hiding this comment

dmsnell commented Jul 18, 2023

danielbachhuber commented Jul 18, 2023

dawidurbanski commented Jul 23, 2023

dawidurbanski commented Jul 23, 2023

sejas commented Jun 19, 2023 •

edited

Loading