[CLI] Set debug constants during boot

[bgrgicak]

This PR sets the WordPress debug constants during the CLI boot.

Depending on the --debug flag, WP_DEBUG, and WP_DEBUG_LOG will be set to true or false during boot.
The WP_DEBUG_DISPLAY constant will always be set to false to match the Website behavior.

Disabling WP_DEBUG_DISPLAY will also avoid crashing the CLI during boot if a plugin activation fails. Long-term #1979 shouldn't crash Playground anymore, but we still want these constant defaults in the CLI.

Testing Instructions (or ideally a Blueprint)

• Store this blueprint on your machine

{
  "steps": [
    {
      "step": "installPlugin",
      "pluginData": {
        "resource": "wordpress.org/plugins",
        "slug": "002-ps-custom-post-type"
      },
      "options": {
        "activate": true
      }
    }
  ]
}

• Start the CLI with the blueprint (change the BLUEPRINT_PATH to match your path)

bun ./packages/playground/cli/src/cli.ts server --debug --blueprint BLUEPRINT_PATH

[brandonpayton]

I left a question about WP_DEBUG_DISPLAY, but this looks good and tests well to me. Thanks, Bero!

[brandonpayton]

In your experience, is this something that most people prefer to disable? It's not clear to me that I'd want it disabled if running with the --debug flag because having messages printing in-page might be the feedback that is easiest to access.

[bgrgicak]

WP_DEBUG_DISPLAY is rarely enabled. It literally prints all error levels into the HTML and most of the time messes up the page.

But now when I think of it, the point of the debug flag is to control the displaying of logs and not data collection.

I will set these the same way we do on the Website and users can always override them using Blueprints.

[bgrgicak]

This is the debug flag description. It shouldn't control logging.

wordpress-playground/packages/playground/cli/src/cli.ts

Line 107 in 3c95e98

'Return PHP error log content if an error occurs while building the site.',

[adamziel]

What does "return" mean in this context? It's not a function return

[adamziel]

And let's update the description to clarify this – is the --debug flag only effective at build time? Or does it also affect the runtime or the built site later on?

[bgrgicak]

Ok!

is the --debug flag only effective at build time? Or does it also affect the runtime or the built site later on?

Only during the build, but it would be nice for it to also return errors during runtime.

[adamziel]

By "return" do you mean "print"? Or "save to file"? Or something else?

[bgrgicak]

It's printing, thanks for the questions, they help narrow down what's missing in the text.
Here is an improved version https://github.com/WordPress/wordpress-playground/pull/1985/files#diff-ff00c9c03a9587a4ac648349850e14a53fdd62418bce04573537c9c794c95811R107

[adamziel]

What happened here? Why remove this @bgrgicak ?

[bgrgicak]

It was causing errors and it's not supported anymore since we changed the way login works. Should I open an issue to add login support?

We have an option to login users with CLI, but it requires a specific URL parameter (playground_force_auto_login_as_user), we could print this in the CLI output and enable users to login that way.

[adamziel]

Couldn't login work the same way as on Playground web?

[bgrgicak]

PR to fix login #1985

[adamziel]

I like having a --debug option, thank you @bgrgicak. I have concerns about the details and I left some comments.