WIP wp-now: update blueprints dependencies #116

sejas · 2023-10-04T16:45:36Z

This PR is a draft WIP.

Related to wp-now: ReferenceError: DOMParser is not defined while installing the plugin #113

What?

Updates Playground dependencies

Why?

@wp-playground/blueprints v0.2.0 removes the dependency on DOMParser for the activatePlugin blueprint step.

Testing Instructions

Run nvm use
npm install
npx nx build wp-now
Create the blue print file b.json
Run node dist/packages/wp-now/cli.js start --blueprint=b.json
Observe no errors in the console and the WordPress page opens successfully with the plugin notification installed.

b.json

{
	"$schema": "https://playground.wordpress.net/blueprint-schema.json",
	"landingPage": "/wp-admin/",
	"preferredVersions": {
		"php": "8.0",
		"wp": "latest"
	},
	"steps": [
		{
			"step": "login",
			"username": "admin",
			"password": "password"
		},
		{
			"step": "installPlugin",
			"pluginZipFile": {
				"resource": "wordpress.org/plugins",
				"slug": "notification"
			},
			"options": {
				"activate": true
			}
		}
	]
}

…date/wp-now-blueprints-dependency

… errors with npm

sejas · 2023-10-04T16:51:30Z

I'm running into a couple of errors that we may need to fix on the dependencies.

Error 1

The new package needs the File class, therefore node v20 even if we don't sue blueprints.

node dist/packages/wp-now/cli.js start                  
file:///playground-tools/node_modules/@wp-playground/blueprints/index.js:61
class Oi extends File {
                 ^

ReferenceError: File is not defined
    at file:///playground-tools/node_modules/@wp-playground/blueprints/index.js:61:18
    at ModuleJob.run (node:internal/modules/esm/module_job:194:25)

Node.js v18.13.0

Error 2

With Node v20, the activatePlugin step fails to move the plugin to VFS. I'll find a solution in the next few days.

node dist/packages/wp-now/cli.js start --blueprint=b.json
Starting the server......
directory: /playground-tools
mode: playground
php: 8.0
wp: latest
WordPress latest folder already exists. Skipping download.
SQLite folder already exists. Skipping download.
blueprint steps: 2
Blueprint step completed: login
Proceeding without the Notification plugin. Could not install it in wp-admin. The original error was: Error: Could not move "/tmp/assets/Notification/notification": Cross-device link.
Error: Could not move "/tmp/assets/Notification/notification": Cross-device link.
    at descriptor.value (/playground-tools/node_modules/@php-wasm/node/index.cjs:67481:17)
    at Cs (file:///playground-tools/node_modules/@wp-playground/blueprints/index.js:398:20)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async Module.Ji [as installPlugin] (file:///playground-tools/node_modules/@wp-playground/blueprints/index.js:410:36)
    at async a (file:///playground-tools/node_modules/@wp-playground/blueprints/index.js:8090:30)
    at async Object.run (file:///playground-tools/node_modules/@wp-playground/blueprints/index.js:8035:21)
    at async zu (file:///playground-tools/node_modules/@wp-playground/blueprints/index.js:8125:3)
    at async startWPNow (file:///playground-tools/dist/packages/wp-now/main.js:609:5)
    at async startServer (file:///playground-tools/dist/packages/wp-now/main.js:878:42)
    at async Object.handler (file:///playground-tools/dist/packages/wp-now/main.js:1050:25) {
  [cause]: ErrnoError
      at Object.ensureErrnoError (/playground-tools/node_modules/@php-wasm/node/index.cjs:20271:33)
      at Object.staticInit (/playground-tools/node_modules/@php-wasm/node/index.cjs:20279:10)
      at Object.init3 (/playground-tools/node_modules/@php-wasm/node/index.cjs:24127:6)
      at loadPHPRuntime (/playground-tools/node_modules/@php-wasm/node/index.cjs:67495:38)
      at doLoad (/playground-tools/node_modules/@php-wasm/node/index.cjs:68407:31)
      at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
      at async _NodePHP.load (/playground-tools/node_modules/@php-wasm/node/index.cjs:68379:12)
      at async startWPNow (file:///playground-tools/dist/packages/wp-now/main.js:546:7)
      at async startServer (file:///playground-tools/dist/packages/wp-now/main.js:878:42)
      at async Object.handler (file:///playground-tools/dist/packages/wp-now/main.js:1050:25) {
    node: undefined,
    setErrno: [Function (anonymous)],
    errno: 75,
    message: 'FS error'
  }
}
Blueprint step completed: installPlugin
Server running at http://localhost:8881

adamziel · 2023-10-06T16:32:34Z

@sejas for the File class you'll need a polyfill.

The cross-device link error is weird, though. I noticed your disk path starts with /playground-tools. Are you working in a Docker or a VM? Does this error happen to you with the older versions of the Blueprint package, too? Maybe it's unrelated to Blueprints and related to that specific dev env setup?

adamziel · 2023-10-06T16:42:02Z

I clicked "ready for review" to see the CI tests.

sejas · 2023-10-06T18:26:41Z

@sejas for the File class you'll need a polyfill.

What's unexpected for me, is that the class File is loaded even if I don't run any blueprint. I'll investigate it further.
I agree that polyfills will be needed.

The cross-device link error is weird, though. I noticed your disk path starts with /playground-tools. Are you working in a Docker or a VM? Does this error happen to you with the older versions of the Blueprint package, too? Maybe it's unrelated to Blueprints and related to that specific dev env setup?

Sorry for the confusion, I shared a modified "error logs" to remove my home directory. It's a normal Mac environment.
Debugging a bit, I've found the line that raises the error and the values.

https://github.com/WordPress/wordpress-playground/blob/32f17e1216030dc35412a049958d57e1e67d970a/packages/playground/blueprints/src/lib/steps/install-asset.ts#L86

playground.mv( '/tmp/assets/Notification/notification', '/var/www/html/wp-content/plugins/notification' )

I think it's a general limitation on php-wasm/node moving files from VFS

I tried unzipping directly in the folder, and the files appeared in the folder, although it had the extra folder produced by the unzipping. But it worked.

adamziel · 2023-10-12T12:08:46Z

So sounds like it's just about the File class polyfill then? The Blueprint JS library is imported whether you apply a Blueprint or not which is likely why that errors always happens.

eliot-akira · 2023-11-22T16:27:55Z

The new package needs the File class, therefore node v20 even if we don't use blueprints.

For Node.js 18 support, here are some candidates to polyfill the File class.

NPM package web-file-polyfill

Its GibHub repo was archived 2 years ago. The File class implementation looks simple (here) but it depends on a polyfill for Blob (web-blob) whose repo no longer exists.
File API polyfill - Isomorphic File, FileReader, and FileReaderSync for Node.js, Deno, Bun, and browsers

This is a more recent library, @webfill/fileapi.

Here's a link to a discussion about removing the use of DOMParser from blueprints, so the steps can run on server side.

..That was done for activatePlugin and activateTheme already, and I worked on a pull request for rewriting installPlugin and installTheme.

The remaining step that's yet to be rewritten is importFile.

..This workaround requires that all Blueprint steps that use the File class must import it from steps/common, instead of assuming that it exists as a global name. That may be convenient for polyfilling the same class for Node.js 18.

adamziel · 2023-12-19T15:42:03Z

@sejas WordPress/wordpress-playground#875 fixed the Node.js v18 issue! 🎉 You can update the Playground packages to version 0.5.1 and confirm.

The other one with cross-device move is still a problem, though. WordPress/wordpress-playground#846 may solve it once its ready.

@sejas

…root (#886) Solves the [error discovered by @sejas](WordPress/playground-tools#116 (comment)) caused by calling `php.mv(fromPath, toPath)` when `fromPath` is a mounted local directory and `toPath` is a MEMFS directory. Emscripten doesn't support such a scenario: ``` Proceeding without the Notification plugin. Could not install it in wp-admin. The original error was: Error: Could not move "/tmp/assets/Notification/notification": Cross-device link. Error: Could not move "/tmp/assets/Notification/notification": Cross-device link. at descriptor.value (/playground-tools/node_modules/@php-wasm/node/index.cjs:67481:17) ``` The solution proposed in this PR replaces a `/tmp` directory with a randomly-named temporary directory inside `wp-content`. `/tmp` doesn't necessarily point to a system temp directory and needs to be revisited anyway. Whether we should use a temporary directory inside `wp-content` is another matter, but that part may be revisited once the [recursive cp](#846) feature is added.

adamziel · 2023-12-20T09:21:13Z

WordPress/wordpress-playground#886 solved the cross-device move problem. I went ahead and updated this PR to use the new 0.5.2 version of the Playground packages:

cc @sejas @danielbachhuber

sejas · 2024-02-05T11:01:30Z

Closing this PR since the Polyfills were introduced on WordPress/wordpress-playground#875 and we are already using that version of the playground.

I'm still seeing an error related to crypto.randomUUID. I'll comment on the issue.

sejas added 4 commits October 4, 2023 13:26

update playground dependencies

0b006ae

remove type module from nx-extensions to avoid ES module error

14916a5

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

8f3e4f3

…date/wp-now-blueprints-dependency

restore type module on nx-extensions package.json, due to not finding…

a4b46c7

… errors with npm

sejas added the wp-now label Oct 4, 2023

sejas self-assigned this Oct 4, 2023

sejas mentioned this pull request Oct 4, 2023

wp-now: ReferenceError: DOMParser is not defined while installing the plugin #113

Closed

adamziel marked this pull request as ready for review October 6, 2023 16:41

adamziel mentioned this pull request Nov 23, 2023

Add pooling and request limiting to prevent memory leaks #110

Closed

seanmorris mentioned this pull request Dec 6, 2023

Fix cross-device mv by switching to copy WordPress/wordpress-playground#846

Closed

adamziel mentioned this pull request Dec 17, 2023

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

Merged

adamziel mentioned this pull request Dec 19, 2023

Fix a cross-device mv error by using a tmp directory inside document root WordPress/wordpress-playground#886

Merged

Update Blueprints versions

91a6d50

adamziel mentioned this pull request Jan 16, 2024

Playground Block: Accept a Blueprint URL so setup Playground using remote JSON Blueprints #143

Closed

sejas closed this Feb 5, 2024

sejas deleted the update/wp-now-blueprints-dependency branch February 5, 2024 11:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP wp-now: update blueprints dependencies #116

WIP wp-now: update blueprints dependencies #116

sejas commented Oct 4, 2023

sejas commented Oct 4, 2023

adamziel commented Oct 6, 2023 •

edited

adamziel commented Oct 6, 2023

sejas commented Oct 6, 2023 •

edited

adamziel commented Oct 12, 2023 •

edited

eliot-akira commented Nov 22, 2023

adamziel commented Dec 19, 2023 •

edited

adamziel commented Dec 20, 2023

sejas commented Feb 5, 2024

WIP wp-now: update blueprints dependencies #116

WIP wp-now: update blueprints dependencies #116

Conversation

sejas commented Oct 4, 2023

What?

Why?

Testing Instructions

sejas commented Oct 4, 2023

Error 1

Error 2

adamziel commented Oct 6, 2023 • edited

adamziel commented Oct 6, 2023

sejas commented Oct 6, 2023 • edited

adamziel commented Oct 12, 2023 • edited

eliot-akira commented Nov 22, 2023

adamziel commented Dec 19, 2023 • edited

adamziel commented Dec 20, 2023

sejas commented Feb 5, 2024

adamziel commented Oct 6, 2023 •

edited

sejas commented Oct 6, 2023 •

edited

adamziel commented Oct 12, 2023 •

edited

adamziel commented Dec 19, 2023 •

edited