Add logger API

[bgrgicak]

What is this PR doing?

This PR adds a logger API endpoint to Playground.WordPress.net.

What problem is it solving?

It creates a standard place where users can send crash reports.

How is the problem addressed?

A PHP script accepts the log message, validates the format, and sends the log message to a Making WordPress Slack channel.

Testing Instructions

• Start a local PHP server
• Copy the logger.php file to the server
• Follow the readme to get the token and replace the token and channel ID with these values in logger.php
• Send a request and confirm a message was sent to the Slack channel (replace http://localhost:10013/logger.php with your path)

curl --location 'http://localhost:10013/logger.php' \
--form 'message="What happened?

Ut consequuntur esse sint sequi sapiente corrupti. Suscipit est facere voluptatem omnis earum necessitatibus molestiae. Exercitationem odio id ut alias voluptatum.

Dolor ut dolores labore hic at. Aspernatur provident voluptatem dignissimos et aut minima et aut. Eaque odio aut consequatur quam quidem.

Logs

[02-Jan-2024 08:08:06 UTC] PHP-WASM Fatal: null function or function signature mismatch Error: null function or function signature mismatch
    at #handleRequest (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/base-php.ts?t=1710835676492:518:24)
    at async WebPHP.run (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/base-php.ts?t=1710835676492:211:24)
    at async #dispatchToPHP (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/php-request-handler.ts?t=1710835676492:178:14)
    at async PHPRequestHandler.request (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/php-request-handler.ts?t=1710835676492:84:14)
    at async PHPBrowser.request (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/php-browser.ts:32:22)
[19-Mar-2024 08:08:06 UTC] PHP-WASM Fatal: null function or function signature mismatch Error: null function or function signature mismatch
    at #handleRequest (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/base-php.ts?t=1710835676492:518:24)
    at async WebPHP.run (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/base-php.ts?t=1710835676492:211:24)
    at async #dispatchToPHP (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/php-request-handler.ts?t=1710835676492:178:14)
    at async PHPRequestHandler.request (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/php-request-handler.ts?t=1710835676492:84:14)
    at async PHPBrowser.request (http://localhost:5400/@fs/Users/bero/Projects/wordpress-playground/packages/php-wasm/universal/src/lib/php-browser.ts:32:22)

Url

http://localhost:5400/website-server/?php=8.0&wp=latest&storage=none&networking=yes#%7B%20%22landingPage%22:%20%22/wp-admin/%22,%20%22features%22:%20%7B%20%22networking%22:%20true%20%7D,%20%22steps%22:%20%5B%20%7B%20%22step%22:%20%22login%22%20%7D,%20%7B%20%22step%22:%20%22writeFile%22,%20%22path%22:%20%22/wordpress/wp-content/mu-plugins/rewrite.php%22,%20%22data%22:%20%22%3C?php%20add_action(%20'\''shutdown'\'',%20function()%20%7B%20post_message_to_js('\''test'\'');%20%7D%20);%22%20%7D%20%5D%20%7D"'

[adamziel]

This is cool, thank you @bgrgicak! The only thing I'd adjust before merging is disabling PHP error messages in case someone found a way to expose secrets by trigerring a warning or so.

[brandonpayton]

Should we add any sort of rate-limiting for specific IPs to help avoid people abusing the logging endpoint and causing DoS due to hitting Slack API limits?

[brandonpayton]

Should we add any sort of rate-limiting for specific IPs to help avoid people abusing the logging endpoint and causing DoS due to hitting Slack API limits?

Perhaps there is already some kind of limiting at the web server as well.

[adamziel]

Perhaps there is already some kind of limiting at the web server as well.

It's not designed to protect against that use-case so rate-limiting sounds like a good idea 👍 I wonder how is it implemented in other WP.org endpoints forwarding data to Slack.

[bgrgicak]

Should we add any sort of rate-limiting for specific IPs to help avoid people abusing the logging endpoint and causing DoS due to hitting Slack API limits?

Sounds like a good idea. I need to check first what we can use on the server for this. Usually storing IPs and counts in Memcache worked well for me.

[bgrgicak]

I took a quick look and it seems like the server doesn't have Memcache. The only alternative I can think of is storing counts in a file or db. It would slow down the request, but I don't expect a lot so we should be ok.

@adamziel do you have any suggestions? What does the server support and can we install things on it?

[adamziel]

cc @dd32 for comments – I wonder how WP.org services approach this problem.

[bgrgicak]

@adamziel @brandonpayton would it be ok for me to merge this as-is?
I would like to finish the modal this week and ensure it works with the logger API.

I would add the rate-limiting once we decide on how to do it.

Alternatively I could add a simple limiter to this PR and update it later if we find a better solution.

[adamziel]

Let's do that @bgrgicak and keep the discussion going – perhaps in a separate issue?

[brandonpayton]

would it be ok for me to merge this as-is?

Let's do that @bgrgicak and keep the discussion going – perhaps in a separate issue?

👍 That sounds good.

[dd32]

I wonder how WP.org services approach this problem.

FWIW WordPress.org uses Memcache for it.

You could potentially use apcu but I don't know what's enabled/installed on the WordPress.net system.

[brandonpayton]

Thanks, @dd32 🙇

[bgrgicak]

You could potentially use apcu but I don't know what's enabled/installed on the WordPress.net system.

It's not enabled on the server, but it seems like a good solution.