wp-now: create `php` command to execute PHP files #336

sejas · 2023-05-12T21:23:46Z

See #242

Proposed changes

Create a new php command to execute php files
Tests for executePHPFile

wp-cli will have its separate command in a different PR.

Testing instructions

Create a simple php. e.g. example.php: <?php echo "Hello World!";
Copy the relative or absolute path to that file
Execute npx nx preview wp-now php ~/path-to/example.php
Modify your example.php to add WordPress functions: e.g. <?php echo get_bloginfo();
Execute npx nx preview wp-now php ~/path-to/example.php --path=/path-to-your-plugin/gutenberg // To load WordPress needs to be executed in a mode different than index.

Example: npx nx preview wp-now php ~/Desktop/example.php --path=/Users/macbookpro/demo-wp-now/gutenberg

danielbachhuber · 2023-05-15T12:22:17Z

packages/wp-now/src/tests/execute-php-file.spec.ts

+test('php file execution for each PHP Version', async () => {
+	const resultFilePath = path.join(exampleDir, 'php-version-result.txt');
+
+	for (const phpVersion of SupportedPHPVersions) {


Can we add explicit tests here? Assertions inside of for always give me concern because they can accidentally stop working.

I removed the for loop here:
fe410c8

Thanks for the advice.

kozer · 2023-05-15T12:40:46Z

Hello @sejas ! Great job!
I tried to follow the testing steps. The PHP file was executed successfully initially, but for the rest steps (pointing to a plugin directory) it didn't.
What it tried to do, was to download WordPress, and use that, however, as my /home and / are in a different filesystem I got the following error:

Failed to start the server: EXDEV: cross-device link not permitted, rename '/tmp/wordpress' -> '/home/<username>/.wp-now/wordpress-versions/latest'

I know it's not related to the current issue, as it was something I have mentioned in the past, however I'd find it awesome if:

Guide me through a manual way to do that test.
You can fix that error. If this is not possible (as it's not part of this pr, I get it), can you please open a new issue:? If you can't I'm happy to do so.

UPDATE:
In the meantime, I moved manually the downloaded WordPress to my .wp-now folder. However, now I get the following:

WordPress latest folder already exists. Skipping download.
downloaded false
Sqlite folder already exists. Skipping download.
Warning: require_once(/var/www/html/wp-load.php): Failed to open stream: No such file or directory in /tmp/parent.php on line 2
Fatal error: Uncaught Error: Failed opening required '/var/www/html/wp-load.php' (include_path='.:') in /tmp/parent.php:2

Fix: #336 (comment)

sejas · 2023-05-15T13:06:07Z

@kozer, Thanks for sharing your error. I think I fixed it here: d3ea228
Can you give it another try?

Failed to start the server: EXDEV: cross-device link not permitted, rename '/tmp/wordpress' -> '/home/<username>/.wp-now/wordpress-versions/latest'

kozer · 2023-05-15T13:53:18Z

@kozer, Thanks for sharing your error. I think I fixed it here: d3ea228 Can you give it another try?
Failed to start the server: EXDEV: cross-device link not permitted, rename '/tmp/wordpress' -> '/home/<username>/.wp-now/wordpress-versions/latest'

This is now fixed, thanks!
But now, I get the following:

Error: Could not mount /home/wild/.wp-now/sqlite-database-integration-main/db.copy: Not a directory or a symbolic link to a directory.

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

…to add/wp-now-php-file-execution

sejas · 2023-05-15T20:12:30Z

This is now fixed, thanks! But now, I get the following:

Error: Could not mount /home/wild/.wp-now/sqlite-database-integration-main/db.copy: Not a directory or a symbolic link to a directory.

@kozer, I'm glad that the first issue is fixed 🥳

I've created an issue for the second one: Local Environment: Issue mounting db.copy on Linux #344. Feel free to take it. Maybe it will be easier for you to fix it since you can reproduce it.

kozer · 2023-05-16T08:39:25Z

This is now fixed, thanks! But now, I get the following:
Error: Could not mount /home/wild/.wp-now/sqlite-database-integration-main/db.copy: Not a directory or a symbolic link to a directory.
@kozer, I'm glad that the first issue is fixed partying_face

I've created an issue for the second one: Local Environment: Issue mounting db.copy #344. Feel free to take it. Maybe it will be easier for you to fix it since you can reproduce it.

Cool! I'll approve it then, as I don't find any other problems.
Thanks for handling creating this issue!

danielbachhuber · 2023-05-16T11:22:53Z

packages/wp-now/src/execute-php-file.ts

+	// check if filePath exists
+	const absoluteFilePath = path.resolve(filePath);
+	if (!fs.existsSync(absoluteFilePath)) {
+		throw new Error(`File not found: ${absoluteFilePath}`);


Let's match PHP's behavior:

$ php foo.php Could not open input file: foo.php

Changed cd4afb8

danielbachhuber · 2023-05-16T11:25:31Z

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

+				} catch (error) {
+					console.error(error);
+					spinner.fail(
+						`Failed to start the server: ${


I don't think this output is necessary.

Removed 5bd0f53

danielbachhuber · 2023-05-16T11:28:07Z

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

+				});
+			},
+			async (argv) => {
+				const spinner = startSpinner('Running the php command...');


Because the caller might expect to use the output for something else, I don't think wp-now php should provide any additional output.

Removed the wp-now logs:
5157e9e

danielbachhuber · 2023-05-16T11:29:10Z

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

+			describe: "WordPress version to use: e.g. '--wp=6.2'",
+			type: 'string',
+			default: DEFAULT_WORDPRESS_VERSION,
+		});


One issue is that I can't pass arbitrary parameters to my script:

$ nx preview wp-now php example.php --php=8.1 --foo=ba wp-now php <filePath> Run the php command passing the arguments for php cli Positionals: filePath Path to the PHP file to run [string] [required] Options: --version Show version number [boolean] --path Path to the PHP or WordPress project. Defaults to the current w orking directory. [string] [default: "/Users/danielbachhuber/projects/wordpress-playground"] --php PHP version to use. [string] [default: "8.0"] --wp WordPress version to use: e.g. '--wp=6.2' [string] [default: "latest"] -h, --help Show help [boolean] Unknown argument: foo

For wp-cli we will have a different command that will accept any parameters and pass them to wp-cli.

I could do the same for this command, but the trade-off is that the user will not be able to change the php version pr the wp version or any other wp-now parameter.

wojtekn · 2023-05-16T11:50:24Z

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

+					);
+					process.exit(result.status);
+				} catch (error) {
+					console.error(error);


Recently we've merged the output wrapper. Could we use output?.error() here too?

Should we modify shouldOutput to return false when executed from the PHP CLI context?

As long as this function is not a exported from the wp-now package, I think we're good here. There should be no way to trigger it from the outside. As for the internal use, printing too many errors sounds better than printing too few.

Should we modify shouldOutput to return false when executed from the PHP CLI context?

So no output when it's running in PHP CLI? When should it output, then?

Ah you meant wp-now php for shouldOutput=false. Your call.

@adamziel yes, I think it should output whatever the PHP script outputs and nothing more. My "Hello World" script executed using PHP binary built-in with macOS outputs following:

& php /path/to/test.php Hello World!

And our new PHP command:

$ npx nx preview wp-now php /path/to/test.php [...nx build output here...] (node:30521) 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) Running the php command...... directory: /Volumes/Sites/wordpress-playground mode: index php: 8.0 wp: latest Hello World!

Gotcha, that makes sense! FYI the Custom ESM Loaders thing won't be there in the built npm package. I'd love to get rid of it from the repo version as well somehow.

Thanks for confirming that. As far as I saw how npm-installed wp-now works, the nx build output is also gone there.

I removed the wp-now logs but I'm keeping the error trace in case the execution fails.
5157e9e

danielbachhuber

We should update the README in this PR too.

…to add/wp-now-php-file-execution

…/wordpress-playground into add/wp-now-php-file-execution

…to add/wp-now-php-file-execution

sejas · 2023-05-18T14:16:22Z

We should update the README in this PR too.

Updated: 10c3458

sejas · 2023-05-18T14:18:32Z

packages/wp-now/src/download.ts

-		fs.renameSync(path.join(tempFolder, 'wordpress'), finalFolder);
+		fs.moveSync(path.join(tempFolder, 'wordpress'), finalFolder, {
+			overwrite: true,
+		});


This solves @kozer issue #336 (comment)

Follow up from #336 (comment)

Follow up from WordPress/wordpress-playground#336 (comment)

wp-now: create executePHPFile function and command

1d8fbe3

Example: npx nx preview wp-now php ~/Desktop/example.php --path=/Users/macbookpro/demo-wp-now/gutenberg

sejas added the Local Environment i1 label May 12, 2023

sejas self-assigned this May 12, 2023

sejas added 5 commits May 13, 2023 09:52

wp-now: fix execute php file read options mode

2901d14

wp-now: add hello world test for executePHPFIle

e1e9132

wp-now: add phpVersion test for executePHPFIle

121031a

wp-now: fix code style

b1712ef

wp-now: fix code style

6686594

sejas requested review from danielbachhuber, adamziel, kozer, wojtekn and katinthehatsite May 15, 2023 12:10

danielbachhuber reviewed May 15, 2023

View reviewed changes

sejas added 2 commits May 15, 2023 14:01

wp-now: fix linux mount issue

d3ea228

Fix: #336 (comment)

wp-now: remove for loop on execute php file test

fe410c8

sejas added 2 commits May 15, 2023 14:08

wp-now: remove unneceseary imports

d6c0dfd

Merge branch 'WordPress:trunk' into add/wp-now-php-file-execution

85730a6

danielbachhuber reviewed May 15, 2023

View reviewed changes

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

sejas added 2 commits May 15, 2023 15:58

wp-now: remove unecessary log

856ef6f

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

dfd97ae

…to add/wp-now-php-file-execution

sejas mentioned this pull request May 15, 2023

Local Environment: Issue mounting db.copy on Linux #344

Closed

kozer approved these changes May 16, 2023

View reviewed changes

Merge branch 'trunk' into add/wp-now-php-file-execution

e468bab

danielbachhuber reviewed May 16, 2023

View reviewed changes

wojtekn reviewed May 16, 2023

View reviewed changes

danielbachhuber reviewed May 16, 2023

View reviewed changes

sejas added 12 commits May 18, 2023 10:08

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

d5bff9d

…to add/wp-now-php-file-execution

wp-now: restore php command config options

1e73f0c

wp-now: remove unecessary logs for php command

6ba4a10

wp-now: php command update tests

909b410

Merge branch 'add/wp-now-php-file-execution' of github.com:Automattic…

9f8ab40

…/wordpress-playground into add/wp-now-php-file-execution

wp-now: change error message for couldn't find the file

cd4afb8

wp-now: remove error message starting the server

5bd0f53

wp-now: disable output for executePHPFile

5157e9e

wp-now: executePHPFile returns void and throws exception

95c7b4d

wp-now: support multiple php instances for php.cli execution

342bb08

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

c4dbcc9

…to add/wp-now-php-file-execution

wp-now: update README including php command

10c3458

sejas commented May 18, 2023

View reviewed changes

wp-now: use same documentRoot for multiple instances

fc442d4

adamziel merged commit a8ede03 into WordPress:trunk May 18, 2023

sejas deleted the add/wp-now-php-file-execution branch May 18, 2023 14:58

danielbachhuber mentioned this pull request May 18, 2023

wp-now: Some tweaks to the README #390

Merged

danielbachhuber added a commit that referenced this pull request May 18, 2023

wp-now: Some tweaks to the README (#390)

3a53102

Follow up from #336 (comment)

Pookie717 added a commit to Pookie717/wordpress-playground that referenced this pull request Oct 1, 2023

wp-now: Some tweaks to the README (#390)

77de22a

Follow up from WordPress/wordpress-playground#336 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wp-now: create `php` command to execute PHP files #336

wp-now: create `php` command to execute PHP files #336

sejas commented May 12, 2023 •

edited by danielbachhuber

Loading

danielbachhuber May 15, 2023

sejas May 15, 2023

kozer commented May 15, 2023 •

edited

Loading

sejas commented May 15, 2023

kozer commented May 15, 2023

sejas commented May 15, 2023 •

edited

Loading

kozer commented May 16, 2023

danielbachhuber May 16, 2023

sejas May 18, 2023

danielbachhuber May 16, 2023

sejas May 18, 2023

danielbachhuber May 16, 2023

sejas May 18, 2023

danielbachhuber May 16, 2023

sejas May 18, 2023 •

edited

Loading

wojtekn May 16, 2023

adamziel May 16, 2023

adamziel May 16, 2023

adamziel May 16, 2023

wojtekn May 16, 2023

adamziel May 16, 2023 •

edited

Loading

wojtekn May 16, 2023

sejas May 18, 2023

danielbachhuber left a comment

sejas commented May 18, 2023

sejas May 18, 2023

wp-now: create php command to execute PHP files #336

wp-now: create php command to execute PHP files #336

Conversation

sejas commented May 12, 2023 • edited by danielbachhuber Loading

Proposed changes

Testing instructions

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kozer commented May 15, 2023 • edited Loading

sejas commented May 15, 2023

kozer commented May 15, 2023

sejas commented May 15, 2023 • edited Loading

kozer commented May 16, 2023

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sejas May 18, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamziel May 16, 2023 • edited Loading

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

sejas commented May 18, 2023

Choose a reason for hiding this comment

wp-now: create `php` command to execute PHP files #336

wp-now: create `php` command to execute PHP files #336

sejas commented May 12, 2023 •

edited by danielbachhuber

Loading

kozer commented May 15, 2023 •

edited

Loading

sejas commented May 15, 2023 •

edited

Loading

sejas May 18, 2023 •

edited

Loading

adamziel May 16, 2023 •

edited

Loading