Improve check-url command output #3929

schlessera · 2019-12-14T13:42:55Z

Summary

Adds the following:

multiple output formats that can be selected via --format=<format>: json, yaml, table, count
tabular format improves output for human consumption
adds filtering via --<field>=<value>
allows selection of fields to display via --fields=<fields>
can return a single column via --field=<field>
uses exit codes for scripting purposes

Depends on #3898

Checklist

My pull request is addressing an open issue (please create one otherwise).
My code is tested and passes existing tests.
My code follows the Engineering Guidelines (updates are often made to the guidelines, check it out periodically).

schlessera · 2019-12-16T13:49:04Z

Noticed a bug in the WP-CLI formatting code while working on this: wp-cli/wp-cli#5330

schlessera · 2019-12-16T13:50:17Z

⚠️ Rebasing the PR to resolve the merge conflict now.

Adds the following: - multiple output formats that can be selected via `--format=<format>`: `json`, `yaml`, `table`, `count` - tabular format improves output for human consumption - adds filtering via `--<field>=<value>` - allows selection of fields to display via `--fields=<fields>` - can return a single column via `--field=<field>` - uses exit codes for scripting purposes

schlessera · 2019-12-17T08:03:42Z

We still don't have functional tests for the commands, so I don't think it is worth the effort to write tests for the command itself right now. We should look into #3076 at some point to improve on this.

kienstra

Looks good overall

Hi @schlessera,
The new formats look great, this is a really nice improvement. In my local, there was a PHP notice with --format=table. There are steps to reproduce below.

--format=json

--format=count

--format=yaml

--format=table

 wp amp validation check-url /with-script/ --format=table
PHP Notice:  Array to string conversion in /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php on line 218
PHP Stack trace:
PHP   1. {main}() /usr/local/bin/wp:0
PHP   2. include() /usr/local/bin/wp:4
PHP   3. include() phar:///usr/local/bin/wp/php/boot-phar.php:11
PHP   4. WP_CLI\bootstrap() phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/wp-cli.php:27
PHP   5. WP_CLI\Bootstrap\LaunchRunner->process($state = class WP_CLI\Bootstrap\BootstrapState { private $state = array () }) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/bootstrap.php:74
PHP   6. WP_CLI\Runner->start() phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Bootstrap/LaunchRunner.php:23
PHP   7. WP_CLI\Runner->run_command_and_exit($help_exit_warning = *uninitialized*) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:1160
PHP   8. WP_CLI\Runner->run_command($args = array (0 => 'amp', 1 => 'validation', 2 => 'check-url', 3 => '/with-script/'), $assoc_args = array ('format' => 'table'), $options = *uninitialized*) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:394
PHP   9. WP_CLI\Dispatcher\Subcommand->invoke($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table'), $extra_args = array ()) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:371
PHP  10. call_user_func:{phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451}(class Closure { public $static = array ('callable' => array (0 => 'AMP_CLI_Validation_Command', 1 => 'check_url')); public $parameter = array ('$args' => '<required>', '$assoc_args' => '<required>') }, array (0 => '/with-script/'), array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451
PHP  11. WP_CLI\Dispatcher\CommandFactory::WP_CLI\Dispatcher\{closure:phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:95-102}($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451
PHP  12. call_user_func:{phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98}(array (0 => class AMP_CLI_Validation_Command { public $wp_cli_progress = NULL; public $total_errors = 0; public $unaccepted_errors = 0; public $number_crawled = 0; public $force_crawl_urls = FALSE; public $include_conditionals = array (); public $limit_type_validate_count = NULL; public $validity_by_type = array () }, 1 => 'check_url'), array (0 => '/with-script/'), array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98
PHP  13. AMP_CLI_Validation_Command->check_url($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98
PHP  14. WP_CLI\Formatter->display_items($items = array (0 => array ('node_name' => 'script', 'parent_name' => 'div', 'code' => '\033[31mDISALLOWED_TAG\033[0m', 'type' => 'js_error', 'node_attributes' => '[]', 'text' => 'doThis()', 'sources' => '1.  [{"hook":"the_content","filter":true,"post_id":5206,"post_type":"post","sources":[{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":59,"function":"WP_Embed::run_shortcode"},{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":404,"function":"WP_Embed::autoembed"},{"type":"core","name":"wp-includes","file":"blocks.php","line":308,"function":"do_blocks"},{"type":"core","name":"wp-includes","file":"formatting.php","line":51,"function":"wptexturize"},{"type":"core","name":"wp-includes","file":"formatting.php","line":455,"function":"wpautop"},{"type":"core","name":"wp-includes","file":"formatting.php","line":838,"function":"shortcode_unautop"},{"type":"core","name":"wp-includes","file":"post-template.php","line":1649,"function":"prepend_attachment"},{"type":"core","name":"wp-includes","file":"media.php","line":1432,"function":"wp_make_content_images_responsive"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5690,"function":"wp_staticize_emoji"},{"type":"plugin","name":"amp","file":"includes/sanitizers/class-amp-core-theme-sanitizer.php","line":500,"function":"{closure}"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5323,"function":"capital_P_dangit"},{"type":"core","name":"wp-includes","file":"shortcodes.php","line":177,"function":"do_shortcode"},{"type":"core","name":"wp-includes","file":"formatting.php","line":3324,"function":"convert_smilies"}]}] | 2.  [{"block_name":"core/html","post_id":5206,"block_content_index":0}]', 'sanitized' => '\033[32;1myes\033[0m')), $ascii_pre_colorized = TRUE) /srv/www/loc/public_html/wp-content/plugins/amp/includes/cli/class-amp-cli-validation-command.php:435
PHP  15. WP_CLI\Formatter->find_item_key($item = array ('node_name' => 'script', 'parent_name' => 'div', 'code' => '\033[31mDISALLOWED_TAG\033[0m', 'type' => 'js_error', 'node_attributes' => '[]', 'text' => 'doThis()', 'sources' => '1.  [{"hook":"the_content","filter":true,"post_id":5206,"post_type":"post","sources":[{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":59,"function":"WP_Embed::run_shortcode"},{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":404,"function":"WP_Embed::autoembed"},{"type":"core","name":"wp-includes","file":"blocks.php","line":308,"function":"do_blocks"},{"type":"core","name":"wp-includes","file":"formatting.php","line":51,"function":"wptexturize"},{"type":"core","name":"wp-includes","file":"formatting.php","line":455,"function":"wpautop"},{"type":"core","name":"wp-includes","file":"formatting.php","line":838,"function":"shortcode_unautop"},{"type":"core","name":"wp-includes","file":"post-template.php","line":1649,"function":"prepend_attachment"},{"type":"core","name":"wp-includes","file":"media.php","line":1432,"function":"wp_make_content_images_responsive"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5690,"function":"wp_staticize_emoji"},{"type":"plugin","name":"amp","file":"includes/sanitizers/class-amp-core-theme-sanitizer.php","line":500,"function":"{closure}"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5323,"function":"capital_P_dangit"},{"type":"core","name":"wp-includes","file":"shortcodes.php","line":177,"function":"do_shortcode"},{"type":"core","name":"wp-includes","file":"formatting.php","line":3324,"function":"convert_smilies"}]}] | 2.  [{"block_name":"core/html","post_id":5206,"block_content_index":0}]', 'sanitized' => '\033[32;1myes\033[0m'), $field = 'node_name') /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php:76
PHP Notice:  Array to string conversion in /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php on line 218
PHP Stack trace:
PHP   1. {main}() /usr/local/bin/wp:0
PHP   2. include() /usr/local/bin/wp:4
PHP   3. include() phar:///usr/local/bin/wp/php/boot-phar.php:11
PHP   4. WP_CLI\bootstrap() phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/wp-cli.php:27
PHP   5. WP_CLI\Bootstrap\LaunchRunner->process($state = class WP_CLI\Bootstrap\BootstrapState { private $state = array () }) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/bootstrap.php:74
PHP   6. WP_CLI\Runner->start() phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Bootstrap/LaunchRunner.php:23
PHP   7. WP_CLI\Runner->run_command_and_exit($help_exit_warning = *uninitialized*) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:1160
PHP   8. WP_CLI\Runner->run_command($args = array (0 => 'amp', 1 => 'validation', 2 => 'check-url', 3 => '/with-script/'), $assoc_args = array ('format' => 'table'), $options = *uninitialized*) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:394
PHP   9. WP_CLI\Dispatcher\Subcommand->invoke($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table'), $extra_args = array ()) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:371
PHP  10. call_user_func:{phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451}(class Closure { public $static = array ('callable' => array (0 => 'AMP_CLI_Validation_Command', 1 => 'check_url')); public $parameter = array ('$args' => '<required>', '$assoc_args' => '<required>') }, array (0 => '/with-script/'), array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451
PHP  11. WP_CLI\Dispatcher\CommandFactory::WP_CLI\Dispatcher\{closure:phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:95-102}($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451
PHP  12. call_user_func:{phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98}(array (0 => class AMP_CLI_Validation_Command { public $wp_cli_progress = NULL; public $total_errors = 0; public $unaccepted_errors = 0; public $number_crawled = 0; public $force_crawl_urls = FALSE; public $include_conditionals = array (); public $limit_type_validate_count = NULL; public $validity_by_type = array () }, 1 => 'check_url'), array (0 => '/with-script/'), array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98
PHP  13. AMP_CLI_Validation_Command->check_url($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98
PHP  14. WP_CLI\Formatter->display_items($items = array (0 => array ('node_name' => 'script', 'parent_name' => 'div', 'code' => '\033[31mDISALLOWED_TAG\033[0m', 'type' => 'js_error', 'node_attributes' => '[]', 'text' => 'doThis()', 'sources' => '1.  [{"hook":"the_content","filter":true,"post_id":5206,"post_type":"post","sources":[{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":59,"function":"WP_Embed::run_shortcode"},{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":404,"function":"WP_Embed::autoembed"},{"type":"core","name":"wp-includes","file":"blocks.php","line":308,"function":"do_blocks"},{"type":"core","name":"wp-includes","file":"formatting.php","line":51,"function":"wptexturize"},{"type":"core","name":"wp-includes","file":"formatting.php","line":455,"function":"wpautop"},{"type":"core","name":"wp-includes","file":"formatting.php","line":838,"function":"shortcode_unautop"},{"type":"core","name":"wp-includes","file":"post-template.php","line":1649,"function":"prepend_attachment"},{"type":"core","name":"wp-includes","file":"media.php","line":1432,"function":"wp_make_content_images_responsive"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5690,"function":"wp_staticize_emoji"},{"type":"plugin","name":"amp","file":"includes/sanitizers/class-amp-core-theme-sanitizer.php","line":500,"function":"{closure}"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5323,"function":"capital_P_dangit"},{"type":"core","name":"wp-includes","file":"shortcodes.php","line":177,"function":"do_shortcode"},{"type":"core","name":"wp-includes","file":"formatting.php","line":3324,"function":"convert_smilies"}]}] | 2.  [{"block_name":"core/html","post_id":5206,"block_content_index":0}]', 'sanitized' => '\033[32;1myes\033[0m')), $ascii_pre_colorized = TRUE) /srv/www/loc/public_html/wp-content/plugins/amp/includes/cli/class-amp-cli-validation-command.php:435
PHP  15. WP_CLI\Formatter->find_item_key($item = array ('node_name' => 'script', 'parent_name' => 'div', 'code' => '\033[31mDISALLOWED_TAG\033[0m', 'type' => 'js_error', 'node_attributes' => '[]', 'text' => 'doThis()', 'sources' => '1.  [{"hook":"the_content","filter":true,"post_id":5206,"post_type":"post","sources":[{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":59,"function":"WP_Embed::run_shortcode"},{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":404,"function":"WP_Embed::autoembed"},{"type":"core","name":"wp-includes","file":"blocks.php","line":308,"function":"do_blocks"},{"type":"core","name":"wp-includes","file":"formatting.php","line":51,"function":"wptexturize"},{"type":"core","name":"wp-includes","file":"formatting.php","line":455,"function":"wpautop"},{"type":"core","name":"wp-includes","file":"formatting.php","line":838,"function":"shortcode_unautop"},{"type":"core","name":"wp-includes","file":"post-template.php","line":1649,"function":"prepend_attachment"},{"type":"core","name":"wp-includes","file":"media.php","line":1432,"function":"wp_make_content_images_responsive"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5690,"function":"wp_staticize_emoji"},{"type":"plugin","name":"amp","file":"includes/sanitizers/class-amp-core-theme-sanitizer.php","line":500,"function":"{closure}"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5323,"function":"capital_P_dangit"},{"type":"core","name":"wp-includes","file":"shortcodes.php","line":177,"function":"do_shortcode"},{"type":"core","name":"wp-includes","file":"formatting.php","line":3324,"function":"convert_smilies"}]}] | 2.  [{"block_name":"core/html","post_id":5206,"block_content_index":0}]', 'sanitized' => '\033[32;1myes\033[0m'), $field = 'parent_name') /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php:76
PHP Notice:  Array to string conversion in /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php on line 218
PHP Stack trace:
PHP   1. {main}() /usr/local/bin/wp:0
PHP   2. include() /usr/local/bin/wp:4
PHP   3. include() phar:///usr/local/bin/wp/php/boot-phar.php:11
PHP   4. WP_CLI\bootstrap() phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/wp-cli.php:27
PHP   5. WP_CLI\Bootstrap\LaunchRunner->process($state = class WP_CLI\Bootstrap\BootstrapState { private $state = array () }) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/bootstrap.php:74
PHP   6. WP_CLI\Runner->start() phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Bootstrap/LaunchRunner.php:23
PHP   7. WP_CLI\Runner->run_command_and_exit($help_exit_warning = *uninitialized*) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:1160
PHP   8. WP_CLI\Runner->run_command($args = array (0 => 'amp', 1 => 'validation', 2 => 'check-url', 3 => '/with-script/'), $assoc_args = array ('format' => 'table'), $options = *uninitialized*) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:394
PHP   9. WP_CLI\Dispatcher\Subcommand->invoke($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table'), $extra_args = array ()) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:371
PHP  10. call_user_func:{phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451}(class Closure { public $static = array ('callable' => array (0 => 'AMP_CLI_Validation_Command', 1 => 'check_url')); public $parameter = array ('$args' => '<required>', '$assoc_args' => '<required>') }, array (0 => '/with-script/'), array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451
PHP  11. WP_CLI\Dispatcher\CommandFactory::WP_CLI\Dispatcher\{closure:phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:95-102}($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451
PHP  12. call_user_func:{phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98}(array (0 => class AMP_CLI_Validation_Command { public $wp_cli_progress = NULL; public $total_errors = 0; public $unaccepted_errors = 0; public $number_crawled = 0; public $force_crawl_urls = FALSE; public $include_conditionals = array (); public $limit_type_validate_count = NULL; public $validity_by_type = array () }, 1 => 'check_url'), array (0 => '/with-script/'), array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98
PHP  13. AMP_CLI_Validation_Command->check_url($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98
PHP  14. WP_CLI\Formatter->display_items($items = array (0 => array ('node_name' => 'script', 'parent_name' => 'div', 'code' => '\033[31mDISALLOWED_TAG\033[0m', 'type' => 'js_error', 'node_attributes' => '[]', 'text' => 'doThis()', 'sources' => '1.  [{"hook":"the_content","filter":true,"post_id":5206,"post_type":"post","sources":[{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":59,"function":"WP_Embed::run_shortcode"},{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":404,"function":"WP_Embed::autoembed"},{"type":"core","name":"wp-includes","file":"blocks.php","line":308,"function":"do_blocks"},{"type":"core","name":"wp-includes","file":"formatting.php","line":51,"function":"wptexturize"},{"type":"core","name":"wp-includes","file":"formatting.php","line":455,"function":"wpautop"},{"type":"core","name":"wp-includes","file":"formatting.php","line":838,"function":"shortcode_unautop"},{"type":"core","name":"wp-includes","file":"post-template.php","line":1649,"function":"prepend_attachment"},{"type":"core","name":"wp-includes","file":"media.php","line":1432,"function":"wp_make_content_images_responsive"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5690,"function":"wp_staticize_emoji"},{"type":"plugin","name":"amp","file":"includes/sanitizers/class-amp-core-theme-sanitizer.php","line":500,"function":"{closure}"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5323,"function":"capital_P_dangit"},{"type":"core","name":"wp-includes","file":"shortcodes.php","line":177,"function":"do_shortcode"},{"type":"core","name":"wp-includes","file":"formatting.php","line":3324,"function":"convert_smilies"}]}] | 2.  [{"block_name":"core/html","post_id":5206,"block_content_index":0}]', 'sanitized' => '\033[32;1myes\033[0m')), $ascii_pre_colorized = TRUE) /srv/www/loc/public_html/wp-content/plugins/amp/includes/cli/class-amp-cli-validation-command.php:435
PHP  15. WP_CLI\Formatter->find_item_key($item = array ('node_name' => 'script', 'parent_name' => 'div', 'code' => '\033[31mDISALLOWED_TAG\033[0m', 'type' => 'js_error', 'node_attributes' => '[]', 'text' => 'doThis()', 'sources' => '1.  [{"hook":"the_content","filter":true,"post_id":5206,"post_type":"post","sources":[{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":59,"function":"WP_Embed::run_shortcode"},{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":404,"function":"WP_Embed::autoembed"},{"type":"core","name":"wp-includes","file":"blocks.php","line":308,"function":"do_blocks"},{"type":"core","name":"wp-includes","file":"formatting.php","line":51,"function":"wptexturize"},{"type":"core","name":"wp-includes","file":"formatting.php","line":455,"function":"wpautop"},{"type":"core","name":"wp-includes","file":"formatting.php","line":838,"function":"shortcode_unautop"},{"type":"core","name":"wp-includes","file":"post-template.php","line":1649,"function":"prepend_attachment"},{"type":"core","name":"wp-includes","file":"media.php","line":1432,"function":"wp_make_content_images_responsive"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5690,"function":"wp_staticize_emoji"},{"type":"plugin","name":"amp","file":"includes/sanitizers/class-amp-core-theme-sanitizer.php","line":500,"function":"{closure}"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5323,"function":"capital_P_dangit"},{"type":"core","name":"wp-includes","file":"shortcodes.php","line":177,"function":"do_shortcode"},{"type":"core","name":"wp-includes","file":"formatting.php","line":3324,"function":"convert_smilies"}]}] | 2.  [{"block_name":"core/html","post_id":5206,"block_content_index":0}]', 'sanitized' => '\033[32;1myes\033[0m'), $field = 'code') /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php:76
PHP Notice:  Array to string conversion in /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php on line 218
PHP Stack trace:
PHP   1. {main}() /usr/local/bin/wp:0
PHP   2. include() /usr/local/bin/wp:4
PHP   3. include() phar:///usr/local/bin/wp/php/boot-phar.php:11
PHP   4. WP_CLI\bootstrap() phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/wp-cli.php:27
PHP   5. WP_CLI\Bootstrap\LaunchRunner->process($state = class WP_CLI\Bootstrap\BootstrapState { private $state = array () }) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/bootstrap.php:74
PHP   6. WP_CLI\Runner->start() phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Bootstrap/LaunchRunner.php:23
PHP   7. WP_CLI\Runner->run_command_and_exit($help_exit_warning = *uninitialized*) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:1160
PHP   8. WP_CLI\Runner->run_command($args = array (0 => 'amp', 1 => 'validation', 2 => 'check-url', 3 => '/with-script/'), $assoc_args = array ('format' => 'table'), $options = *uninitialized*) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:394
PHP   9. WP_CLI\Dispatcher\Subcommand->invoke($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table'), $extra_args = array ()) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php:371
PHP  10. call_user_func:{phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451}(class Closure { public $static = array ('callable' => array (0 => 'AMP_CLI_Validation_Command', 1 => 'check_url')); public $parameter = array ('$args' => '<required>', '$assoc_args' => '<required>') }, array (0 => '/with-script/'), array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451
PHP  11. WP_CLI\Dispatcher\CommandFactory::WP_CLI\Dispatcher\{closure:phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:95-102}($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php:451
PHP  12. call_user_func:{phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98}(array (0 => class AMP_CLI_Validation_Command { public $wp_cli_progress = NULL; public $total_errors = 0; public $unaccepted_errors = 0; public $number_crawled = 0; public $force_crawl_urls = FALSE; public $include_conditionals = array (); public $limit_type_validate_count = NULL; public $validity_by_type = array () }, 1 => 'check_url'), array (0 => '/with-script/'), array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98
PHP  13. AMP_CLI_Validation_Command->check_url($args = array (0 => '/with-script/'), $assoc_args = array ('format' => 'table')) phar:///usr/local/bin/wp/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php:98
PHP  14. WP_CLI\Formatter->display_items($items = array (0 => array ('node_name' => 'script', 'parent_name' => 'div', 'code' => '\033[31mDISALLOWED_TAG\033[0m', 'type' => 'js_error', 'node_attributes' => '[]', 'text' => 'doThis()', 'sources' => '1.  [{"hook":"the_content","filter":true,"post_id":5206,"post_type":"post","sources":[{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":59,"function":"WP_Embed::run_shortcode"},{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":404,"function":"WP_Embed::autoembed"},{"type":"core","name":"wp-includes","file":"blocks.php","line":308,"function":"do_blocks"},{"type":"core","name":"wp-includes","file":"formatting.php","line":51,"function":"wptexturize"},{"type":"core","name":"wp-includes","file":"formatting.php","line":455,"function":"wpautop"},{"type":"core","name":"wp-includes","file":"formatting.php","line":838,"function":"shortcode_unautop"},{"type":"core","name":"wp-includes","file":"post-template.php","line":1649,"function":"prepend_attachment"},{"type":"core","name":"wp-includes","file":"media.php","line":1432,"function":"wp_make_content_images_responsive"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5690,"function":"wp_staticize_emoji"},{"type":"plugin","name":"amp","file":"includes/sanitizers/class-amp-core-theme-sanitizer.php","line":500,"function":"{closure}"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5323,"function":"capital_P_dangit"},{"type":"core","name":"wp-includes","file":"shortcodes.php","line":177,"function":"do_shortcode"},{"type":"core","name":"wp-includes","file":"formatting.php","line":3324,"function":"convert_smilies"}]}] | 2.  [{"block_name":"core/html","post_id":5206,"block_content_index":0}]', 'sanitized' => '\033[32;1myes\033[0m')), $ascii_pre_colorized = TRUE) /srv/www/loc/public_html/wp-content/plugins/amp/includes/cli/class-amp-cli-validation-command.php:435
PHP  15. WP_CLI\Formatter->find_item_key($item = array ('node_name' => 'script', 'parent_name' => 'div', 'code' => '\033[31mDISALLOWED_TAG\033[0m', 'type' => 'js_error', 'node_attributes' => '[]', 'text' => 'doThis()', 'sources' => '1.  [{"hook":"the_content","filter":true,"post_id":5206,"post_type":"post","sources":[{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":59,"function":"WP_Embed::run_shortcode"},{"type":"core","name":"wp-includes","file":"class-wp-embed.php","line":404,"function":"WP_Embed::autoembed"},{"type":"core","name":"wp-includes","file":"blocks.php","line":308,"function":"do_blocks"},{"type":"core","name":"wp-includes","file":"formatting.php","line":51,"function":"wptexturize"},{"type":"core","name":"wp-includes","file":"formatting.php","line":455,"function":"wpautop"},{"type":"core","name":"wp-includes","file":"formatting.php","line":838,"function":"shortcode_unautop"},{"type":"core","name":"wp-includes","file":"post-template.php","line":1649,"function":"prepend_attachment"},{"type":"core","name":"wp-includes","file":"media.php","line":1432,"function":"wp_make_content_images_responsive"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5690,"function":"wp_staticize_emoji"},{"type":"plugin","name":"amp","file":"includes/sanitizers/class-amp-core-theme-sanitizer.php","line":500,"function":"{closure}"},{"type":"core","name":"wp-includes","file":"formatting.php","line":5323,"function":"capital_P_dangit"},{"type":"core","name":"wp-includes","file":"shortcodes.php","line":177,"function":"do_shortcode"},{"type":"core","name":"wp-includes","file":"formatting.php","line":3324,"function":"convert_smilies"}]}] | 2.  [{"block_name":"core/html","post_id":5206,"block_content_index":0}]', 'sanitized' => '\033[32;1myes\033[0m'), $field = 'type') /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php:76
PHP Notice:  Array to string conversion in /srv/www/loc/public_html/wp-content/plugins/amp/vendor/wp-cli/wp-cli/php/WP_CLI/Formatter.php on line 218
...

Steps to reproduce

Create a new post, with a title like 'With Script'
Add a Custom HTML block
Add a script to it, like <script>doThis()</script>
Publish the post, and look at the permalink, like /with-script
Run wp amp validation check-url /with-script/ --format=table
Expected: there is no PHP notice (I think)
Actual: there's a PHP notice, as above. The notice still appeared with Xdebug off, but it was much less verbose.

kienstra · 2019-12-17T18:34:20Z

Still, that PHP notice could just be from my local. The AMP plugin is the only active plugin.

php --version shows PHP 7.2.25-1+ubuntu18.04.1+deb.sury.org+1 (cli) (built: Nov 28 2019 07:42:26) ( NTS )

And wp --version shows WP-CLI 2.4.0.

westonruter · 2019-12-20T01:16:58Z

includes/cli/class-amp-cli-validation-command.php

+		$errors = $this->flatten_validation_errors( $response['results'] );
+
+		if ( 'json' === $assoc_args['format'] ) {
+			WP_CLI::line( wp_json_encode( $errors, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) );


If json I think it should output the entire $response here, as there is more data in the $response than just the resultant $errors.

Suggested change

WP_CLI::line( wp_json_encode( $errors, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) );

WP_CLI::line( wp_json_encode( $response, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) );

As such, this if ( 'json' === $assoc_args['format'] ) condition should be moved above the if ( empty( $response['results'] ) ) check.

westonruter · 2019-12-20T01:26:19Z

includes/cli/class-amp-cli-validation-command.php

+		if ( $response instanceof WP_Error ) {
+			WP_CLI::error( $response );
+		}
+


Let's go ahead and store the results in the amp_validated_url post type by adding something like this:

$validated_url_post = AMP_Validated_URL_Post_Type::store_validation_errors( $response['results'], $response['url'], wp_array_slice_assoc( $response, [ 'object' ] ) ); if ( $validated_url_post instanceof WP_Error ) { WP_CLI::error( $validated_url_post ); }

The URL to the results in the admin can then be another format that can be returned:

if ( 'url' === $assoc_args['format'] ) { WP_CLI::line( get_permalink( $validated_url_post ) ); exit( 0 ); }

And in general, at the very end of the method here prior to exit there can be printing to STDERR the admin URL, which would allow the JSON results to be returned in addition to the validated URL screen admin URL.

westonruter · 2020-01-18T22:33:35Z

Additional data that would need to be included here is what is obtained from the stylesheets as introduced on the AMP validated URL screen in #4026.

westonruter · 2020-04-16T21:30:37Z

@schlessera Please create an issue for this and connect this PR with it.

CLAassistant · 2020-10-08T23:48:29Z

All committers have signed the CLA.

schlessera added Validation WP-CLI labels Dec 14, 2019

googlebot added the cla: yes Signed the Google CLA label Dec 14, 2019

schlessera force-pushed the improve-check-url-cli-command branch from 9299e78 to 1fb34aa Compare December 16, 2019 13:52

schlessera added 4 commits December 16, 2019 15:25

Deal with differing field combinations

c28efee

Add test for get_validation_error_fields()

29b2292

Add test for pad_validation_error_fields()

ee95baf

Add non-hooked function logic

6720d3e

schlessera requested review from kienstra, westonruter and pierlon December 17, 2019 08:04

kienstra reviewed Dec 17, 2019

View reviewed changes

westonruter reviewed Dec 20, 2019

View reviewed changes

schlessera added the WS:Core Work stream for Plugin core label Aug 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve check-url command output #3929

Improve check-url command output #3929

schlessera commented Dec 14, 2019

schlessera commented Dec 16, 2019

schlessera commented Dec 16, 2019

schlessera commented Dec 17, 2019

kienstra left a comment •

edited

Loading

kienstra commented Dec 17, 2019 •

edited

Loading

westonruter Dec 20, 2019

westonruter Dec 20, 2019

westonruter Dec 20, 2019

westonruter commented Jan 18, 2020

westonruter commented Apr 16, 2020

CLAassistant commented Oct 8, 2020 •

edited

Loading

	WP_CLI::line( wp_json_encode( $errors, JSON_PRETTY_PRINT \| JSON_UNESCAPED_SLASHES ) );
	WP_CLI::line( wp_json_encode( $response, JSON_PRETTY_PRINT \| JSON_UNESCAPED_SLASHES ) );

Improve check-url command output #3929

Are you sure you want to change the base?

Improve check-url command output #3929

Conversation

schlessera commented Dec 14, 2019

Summary

Checklist

schlessera commented Dec 16, 2019

schlessera commented Dec 16, 2019

schlessera commented Dec 17, 2019

kienstra left a comment • edited Loading

Choose a reason for hiding this comment

--format=json

--format=count

--format=yaml

--format=table

Steps to reproduce

kienstra commented Dec 17, 2019 • edited Loading

westonruter Dec 20, 2019

Choose a reason for hiding this comment

westonruter Dec 20, 2019

Choose a reason for hiding this comment

westonruter Dec 20, 2019

Choose a reason for hiding this comment

westonruter commented Jan 18, 2020

westonruter commented Apr 16, 2020

CLAassistant commented Oct 8, 2020 • edited Loading

kienstra left a comment •

edited

Loading

kienstra commented Dec 17, 2019 •

edited

Loading

CLAassistant commented Oct 8, 2020 •

edited

Loading