wp-now: create first version of the command #188

sejas · 2023-04-10T17:36:09Z

Closes Local Environment: Prototype initial implementation #187
Related Local Environment: Compare command line interfaces from wp-env, Laravel Valet, and WP-CLI #195

Proposed changes

Create an initial version of wp-now start

Testing instructions

Create a wordpress theme or plugin. Or just a index.php.
Run nx preview wp-now start --path=/Users/path-to-your-theme-or-plugin
Open the browser in the displayed URL. By default http://127.0.0.1:8881
wp-now will detect if the given folder, or current directory correspond to any of these modes:
index: Simple php file
theme : loads WordPress with your theme included
plugin : loads WordPress with your plugin included

Screencast

wp-now-run-source-code-peq.mp4

adamziel · 2023-04-11T13:35:18Z

Nx has a command that will set up a new "project" for you and add all the necessary boilerplate:

nx g @nrwl/node:application

If you use it to create a wp-now project in the packages/playground directory, it will create and wire the tsconfig.json files correctly, give you a correct package.json, and generate the project.json file that would then enable you to build this project using nx, e.g. nx build wp-now.

…to add/wp-now

dmsnell · 2023-04-24T14:40:47Z

packages/wp-now/src/start-server.ts

+    multipartData += `${json[key]}${eol}`;
+  }
+
+  multipartData += `--${boundary}--${eol}`;


will this not interfere with other multipart segments?
I would imagine that if we have more than one call to generateMultipartFormDataString and then concatenate the strings we'll get empty parts because the boundary will be duplicated with no content in between

It's one-off per request and not meant to be concatenated. Eventually I'd love to somehow get rid of this entirely

why not add the final boundary outside of the function then? or create a kind of multipartJoinSegments function so we don't do this?

I guess I was just a little confused because the function name suggests to me that it's a generic function to create multiple multi-part chunks.

dmsnell · 2023-04-24T14:42:19Z

packages/wp-now/src/wp-now.ts

+          define('WP_HOME', "${this.options.absoluteUrl}");
+          define('WP_SITEURL', "${this.options.absoluteUrl}");
+          ?>${contents}`
+  );


it seems like @adamziel has been abstracting this into setupSiteUrl()

if we're concatenating <?php multiple times we'll run into trouble, plus by defining WP_HOME twice we might run into PHP crashes

For reference: defineSiteUrl

Nice addition! 🥳

In order to use defineSiteUrl I would like to accept a custom documentRoot.

Here is my PR: Blueprints: Use playground.documentRoot instead of hardcoding /wordpress path #216

Another option would be changing the wp-now documentRoot to /wordpress

Tricky question: How could we handle wp-now run script.php where script.php needs files outside of the current working directory? e.g. include "../../vendor/something.phar";.

Calling php.useHostFilesystem() would make it just work, but you couldn't mount WordPress anymore. Since it's all JavaScript, we could add support for mounting inside already–mounted paths, but first I'd like to explore what use-cases we're dealing with.

Would I need to ever go one level up from the WordPress path:

If I'm a core developer? Probably no

If I'm a plugin developer? Maybe...? But hopefully unlikely

If I want to use wp-now just for its PHP and without WordPress? Surely! But that's out of scope for this project.

dmsnell · 2023-04-24T14:43:51Z

packages/wp-now/src/wp-now.ts

+
+  mount() {
+    this.mountWordpress()
+    this.mountSqlite()


mountSqlite is async but this function isn't. we might want to make this async and await this.mountSqlite() or acknowledge that mount() might return before mountSqlite has completed (or technically, before it has even begun to process)

Good catch!
mountSqlite shouldn't be async 👍
Fixed here: 684fb86

Closes: #232

danielbachhuber

I checked out this branch, ran yarn install, and then nx preview crashed with this error:

nx preview wp-now start --path=/Users/danielbachhuber/projects/vanilla

> nx run wp-now:"build:bundle"


> nx run wp-now:"build:package-json"


> nx run wp-now:build


> nx run wp-now:preview start --path=/Users/danielbachhuber/projects/vanilla

(node:55204) ExperimentalWarning: Custom ESM Loaders is an experimental feature and might change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
/Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/dist-raw/node-internal-modules-esm-resolve.js:286
  throw new ERR_MODULE_NOT_FOUND(
        ^
CustomError: Cannot find package '/Users/danielbachhuber/projects/wordpress-playground/node_modules/@php-wasm/node/' imported from /Users/danielbachhuber/projects/wordpress-playground/dist/packages/wp-now/main.js
    at legacyMainResolve (/Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/dist-raw/node-internal-modules-esm-resolve.js:286:9)
    at packageResolve (/Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/dist-raw/node-internal-modules-esm-resolve.js:750:14)
    at moduleResolve (/Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/dist-raw/node-internal-modules-esm-resolve.js:798:18)
    at Object.defaultResolve (/Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/dist-raw/node-internal-modules-esm-resolve.js:912:11)
    at /Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/src/esm.ts:218:35
    at entrypointFallback (/Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/src/esm.ts:168:34)
    at /Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/src/esm.ts:217:14
    at addShortCircuitFlag (/Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/src/esm.ts:409:21)
    at resolve (/Users/danielbachhuber/projects/wordpress-playground/node_modules/ts-node/src/esm.ts:197:12)
    at resolve (file:///Users/danielbachhuber/projects/wordpress-playground/packages/nx-extensions/src/executors/built-script/loader.mjs:37:15)

 —————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————

 >  NX   Ran target preview for project wp-now and 3 task(s) they depend on (1s)

         With additional flags:
           start
           --path=/Users/danielbachhuber/projects/vanilla

    ✖    1/4 failed
    ✔    3/4 succeeded [0 read from cache]

Is there another setup step I'm missing?

danielbachhuber · 2023-05-03T11:39:33Z

Is there another setup step I'm missing?

I see the README now. Might be worth mentioning that in the PR description.

danielbachhuber

Couple of minor nits. I think this is good to land otherwise

danielbachhuber · 2023-05-03T11:37:35Z

packages/wp-now/README.md

@@ -0,0 +1,31 @@
+# WP-NOW
+
+`wp-now` is an intuitive Command Line Interface (CLI) tool designed to streamline the process of setting up a local WordPress environment by using only Node.js. This powerful tool is an ideal choice for developers working on WordPress themes and plugins.


Suggested change

`wp-now` is an intuitive Command Line Interface (CLI) tool designed to streamline the process of setting up a local WordPress environment by using only Node.js. This powerful tool is an ideal choice for developers working on WordPress themes and plugins.

`wp-now` is a Command Line Interface (CLI) tool designed to streamline the process of setting up a local WordPress environment by using only Node.js. This powerful tool is optimized for developers working on WordPress themes and plugins.

Done here: dec0385

Thanks for the suggestion.

danielbachhuber · 2023-05-03T12:03:00Z

packages/wp-now/src/run-cli.ts

+					type: 'string',
+					default: process.cwd(),
+				});
+				yargs.option('wp-content', {


I think this argument is confusing. Can we remove it for now, and re-think it at a later point?

Removed! 55189e4

The goal of the parameter was to map the wp-content folder to a diferent path.
Currently we are mapping it to: ~/.wp-now/wp-content/${projectName}-${sha1(projectPath)}

packages/wp-now/src/run-cli.ts

dmsnell

my approval shouldn't matter, but I'm giving it to say I see no reason to block this. thanks for creating associated issues!

sejas · 2023-05-03T14:15:16Z

@dmsnell, thank you for your invaluable code reviews 🙏. Your help has increased the quality of the code. Much appreciated!

Now that we've successfully merged the first prototype, I believe it will be easier to iterate and improve wp-now through smaller PRs.

dmsnell · 2023-05-03T14:25:53Z

nice work on the code. thanks for your effort and time on this!

packages/wp-now/src/download.ts

adamziel · 2023-05-04T13:45:00Z

packages/wp-now/src/wp-now.ts

+		if (mode === 'plugin' || mode === 'theme') {
+			const folderName = path.basename(this.options.projectPath);
+			const partialPath = mode === 'plugin' ? 'plugins' : 'themes';
+			fs.ensureDirSync(path.join(wpContentPath, partialPath, folderName));


Let's put ensureDirSync directly in NodePHP

🤔 , Not sure about this change. I'll take a deeper look tomorrow.

Rationale: I keep seeing confused developers "why is my mount() not working?" Everyone is going to get stuck here for a moment, make a few checks, and realize they need this to ensure the directory exists – we can remove the speed bump and just do it for them.

adamziel · 2023-05-04T13:46:04Z

I just caught up with everything here. I agree with everything @dmsnell noted and added a few nits of my own, but other than that this is great! Thank you so much for working on this @sejas!

wp-now: create dummy commands and new package

a30209a

sejas self-assigned this Apr 11, 2023

adamziel added the Local Environment i1 label Apr 12, 2023

sejas added 21 commits April 12, 2023 19:11

Merge branch 'trunk' of github.com:Automattic/wordpress-playground in…

62a0ed5

…to add/wp-now

wp-now: re-create wp-now folders using nx

e3ae069

wp-now: execute php code example

35e2456

Merge branch 'trunk' of github.com:Automattic/wordpress-playground in…

16f998a

…to add/wp-now

wp-now: add connect node proxy to php runtime

41762a9

wp-now: download latest wp zip in .wp-now dir

91828e5

wp-now: download wordpress and proxy requests fixing location

4e8c642

wp-now: remove unused run method

b1d41e0

wp-now: clean unused imports

3ce5341

wp-now: css fixed, redirect fixed

19100fa

wp-now: setup sqlite

385cda7

Merge branch 'trunk' of github.com:Automattic/wordpress-playground in…

37d7791

…to add/wp-now

wp-now: use express and change the response to bytes

69aa6c8

wp-now: rename download lib

5f2b761

wp-now: add sqlite funciton

180d20a

wp-now: move sqlite logic to nodejs and unify paths

bfeda15

wp-now: split create-server run-cli logic

bfbd50f

Merge branch 'trunk' of github.com:Automattic/wordpress-playground in…

1cf9db4

…to add/wp-now

wp-now: update yarn lock

19898c0

wp-now: import HTTPMethod from abstract

308727e

wp-now: avoid importing abstract

6cb0106

dmsnell reviewed Apr 24, 2023

View reviewed changes

sejas added 2 commits April 25, 2023 15:24

wp-now: remove async from mountSqlite

684fb86

wp-now: clean unnecesary cli

d608cfe

sejas changed the title ~~WIP: wp-now: create first version of the command~~ wp-now: create first version of the command May 3, 2023

sejas added 5 commits May 3, 2023 11:31

wp-now: reuse defineSiteUrl

099d64c

wp-now: include a WP-NOW Readme and copy it to dist

2f7fc11

wp-now: improve the readme redaction

1f3523b

wp-now: improve the readme redaction

ea97101

wp-now: add phpVersion parameter

a53ca84

Closes: #232

danielbachhuber reviewed May 3, 2023

View reviewed changes

sejas added 4 commits May 3, 2023 12:42

wp-now: fix code style

396596e

wp-now: default mode is index

9cb8b28

wp-now: fix code style

dd6037b

wp-now: use dashes for wordpress-versions folder

fd3f4a3

danielbachhuber reviewed May 3, 2023

View reviewed changes

sejas added 3 commits May 3, 2023 13:10

wp-now: update readme

dec0385

wp-now: remove wp-content argument to use only home directory

55189e4

wp-now: rename phpVersion argument name to php

bc0573d

danielbachhuber self-requested a review May 3, 2023 12:21

danielbachhuber approved these changes May 3, 2023

View reviewed changes

wp-now: pass php version value from php argument

93cff0b

dmsnell approved these changes May 3, 2023

View reviewed changes

danielbachhuber merged commit 6c532ef into WordPress:trunk May 3, 2023

sejas deleted the add/wp-now branch May 3, 2023 14:13

sejas mentioned this pull request May 3, 2023

wp-now: download and unzip using pipes #241

Merged

adamziel reviewed May 4, 2023

View reviewed changes

packages/wp-now/src/download.ts Show resolved Hide resolved

adamziel reviewed May 4, 2023

View reviewed changes

sejas mentioned this pull request May 4, 2023

wp-now: rename downloadSqliteIntegrationPlugin function #249

Merged

dcalhoun mentioned this pull request May 10, 2024

WP-NOW: fix file uploads using multipart form data WordPress/playground-tools#203

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wp-now: create first version of the command #188

wp-now: create first version of the command #188

sejas commented Apr 10, 2023 •

edited

Loading

adamziel commented Apr 11, 2023

dmsnell Apr 24, 2023

adamziel Apr 24, 2023 •

edited

Loading

dmsnell Apr 24, 2023

dmsnell Apr 24, 2023

adamziel Apr 24, 2023 •

edited

Loading

sejas Apr 25, 2023 •

edited

Loading

adamziel Apr 28, 2023

dmsnell Apr 24, 2023

sejas Apr 25, 2023

danielbachhuber left a comment

danielbachhuber commented May 3, 2023

danielbachhuber left a comment

danielbachhuber May 3, 2023

sejas May 3, 2023

danielbachhuber May 3, 2023

sejas May 3, 2023

dmsnell left a comment

sejas commented May 3, 2023

dmsnell commented May 3, 2023

adamziel May 4, 2023

sejas May 4, 2023

adamziel May 4, 2023 •

edited

Loading

adamziel commented May 4, 2023

		@@ -0,0 +1,31 @@
		# WP-NOW

		`wp-now` is an intuitive Command Line Interface (CLI) tool designed to streamline the process of setting up a local WordPress environment by using only Node.js. This powerful tool is an ideal choice for developers working on WordPress themes and plugins.

	`wp-now` is an intuitive Command Line Interface (CLI) tool designed to streamline the process of setting up a local WordPress environment by using only Node.js. This powerful tool is an ideal choice for developers working on WordPress themes and plugins.
	`wp-now` is a Command Line Interface (CLI) tool designed to streamline the process of setting up a local WordPress environment by using only Node.js. This powerful tool is optimized for developers working on WordPress themes and plugins.

wp-now: create first version of the command #188

wp-now: create first version of the command #188

Conversation

sejas commented Apr 10, 2023 • edited Loading

Proposed changes

Testing instructions

Screencast

adamziel commented Apr 11, 2023

Choose a reason for hiding this comment

adamziel Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamziel Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

sejas Apr 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielbachhuber left a comment

Choose a reason for hiding this comment

danielbachhuber commented May 3, 2023

danielbachhuber left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmsnell left a comment

Choose a reason for hiding this comment

sejas commented May 3, 2023

dmsnell commented May 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamziel May 4, 2023 • edited Loading

Choose a reason for hiding this comment

adamziel commented May 4, 2023

sejas commented Apr 10, 2023 •

edited

Loading

adamziel Apr 24, 2023 •

edited

Loading

adamziel Apr 24, 2023 •

edited

Loading

sejas Apr 25, 2023 •

edited

Loading

adamziel May 4, 2023 •

edited

Loading