wp-now: Add executeWPCli() function to download and execute WP-CLI

[sejas]

What?

• Add the executeWPCli function to download and execute `wp-cli.
• In the future, we may include the command wp-now wp. Currently, we drop it out until we improve the pthreads execution. Currently a PR in progress: PHP: Explore building with pthreads #346
• Surface emscriptenOptions to catch print and print error for wp-cli execution.

Why?

• See wp-now: Make it possible to use WP-CLI playground-tools#25

How?

It downloads the wp-cli.phar file if the file doesn't exist, then uses php.cli() to execute it.
There are some limitations in the wp-cli features. Some of them may not work.

Testing Instructions

• Check out this branch.
• Copy your path to your theme or plugin
• After installing and building the project, run:
• Run the tests npx nx test wp-now
• Observe the tests pass.

[adamziel]

@sejas is that callback just for unit tests? If yes, you could mock process.stdout instead

[sejas]

@sejas is that callback just for unit tests? If yes, you could mock process.stdout instead

@adamziel , yes this callback is just for the unit test.
I tried it to mock the process.stdout but I couldn't make it work.

So I decided to go with the option of onStdout.

99174cc

Some things I tried:

process.stdout.on('data', collectOutput);
process.stdout.off('data', collectOutput);

 let stdoutWriteMock;

  beforeEach(() => {
    stdoutWriteMock = vi.spyOn(process.stdout, 'write').mockImplementation((buffer: Buffer | string, cb?: ((err?: Error) => void) | undefined) => {
      if (cb) cb();
      return true;
    });
  });

  afterEach(() => {
    stdoutWriteMock.mockRestore();
  });

Maybe a related bug: jestjs/jest#9984

[adamziel]

@sejas oh, sorry, that wasn't process.stdout. Here's what Emscripten does by default:

var out = Module["print"] || console.log.bind(console);
var err = Module["printErr"] || console.warn.bind(console);

Mocking console.log should work better

[sejas]

@adamziel , Yay!, it worked. I mocked the console.log. Thanks for the direction.

[sejas]

@danielbachhuber , @adamziel , I think this PR is ready to merge.

[danielbachhuber]

Should this be a temp directory?

[sejas]

I found that using a temporal directory on my laptop, the wp-cli.phar cannot be executed.
I tried setting the right permissions fs.chmod() to the file and folder and it didn't work.

[danielbachhuber]

@sejas Ok. I think we should use a tmp directory in any case. I added with 5e8e97c

@adamziel Any idea why the test might fail?

[sejas]

@danielbachhuber , with the temp folder, it seems to pass ok in CI. But it is still failing on my local computer.
Maybe it's something just in my environment.

[adamziel]

Is it getting mounted correctly @sejas? What do you see when you list files?

[danielbachhuber]

@sejas It failed locally for me too.

[sejas]

Is it getting mounted correctly @sejas? What do you see when you list files?

Yes, the file is accessible in VFS and the file size is correct. It must be something related to MacOs and the tmp path.

[adamziel]

@sejas would you start a new issue for this? I'd like to make sure this works on MacOs

[wojtekn]

Fixing it with WordPress/playground-tools#42

[sejas]

There was a conflict mounting /var and using the hostFilesystem.
A second PR was needed:
WordPress/playground-tools@bf31e3e

[adamziel]

FYI I merged this change: https://github.com/WordPress/wordpress-playground/pull/470/files#diff-3652c54df4b8d0d8e367481121e32f08cc409cfc4236fdb3172d69dcbf6ca8b0

It shouldn't matter here at all and this check still passes, but I wanted to flag it here just in case.

[adamziel]

nice

[adamziel]

wp-cli support 💯