Fail Gracefully if invalid field is supplied to --fields

[kennypu]

Bug Report

• Yes, I reviewed the contribution guidelines.
• Yes, more specifically, I reviewed the guidelines on how to write clear bug reports.

Describe the current, buggy behavior

When running wp profile stage ... and you provide an invalid field to display, it will Fatal Error.

The error is:

PHP Fatal error:  Uncaught TypeError: Unsupported operand types: string + null in [removed]/.wp-cli/packages/vendor/wp-cli/profile-command/src/Formatter.php:134
Stack trace:
#0 [removed]/.wp-cli/packages/vendor/wp-cli/profile-command/src/Formatter.php(47): WP_CLI\Profile\Formatter->show_table('ASC', NULL, Array, Array, true)
#1 [removed]/.wp-cli/packages/vendor/wp-cli/profile-command/src/Command.php(187): WP_CLI\Profile\Formatter->display_items(Array, true, 'ASC', NULL)
#2 [internal function]: WP_CLI\Profile\Command->stage(Array, Array)
#3 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php(100): call_user_func(Array, Array, Array)
#4 [internal function]: WP_CLI\Dispatcher\CommandFactory::WP_CLI\Dispatcher\{closure}(Array, Array)
#5 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php(497): call_user_func(Object(Closure), Array, Array)
#6 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php(470): WP_CLI\Dispatcher\Subcommand->invoke(Array, Array, Array)
#7 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php(493): WP_CLI\Runner->run_command(Array, Array)
#8 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php(136): WP_CLI\Runner->run_command_and_exit()
#9 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/WP_CLI/Runner.php(1228): WP_CLI\Runner->do_early_invoke('before_wp_load')
#10 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/WP_CLI/Bootstrap/LaunchRunner.php(28): WP_CLI\Runner->start()
#11 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/bootstrap.php(84): WP_CLI\Bootstrap\LaunchRunner->process(Object(WP_CLI\Bootstrap\BootstrapState))
#12 phar:///usr/local/bin/wp-cli/vendor/wp-cli/wp-cli/php/wp-cli.php(35): WP_CLI\bootstrap()
#13 phar:///usr/local/bin/wp-cli/php/boot-phar.php(20): include('phar:///usr/loc...')
#14 /usr/local/bin/wp-cli(4): include('phar:///usr/loc...')
#15 {main}
  thrown in [removed]/.wp-cli/packages/vendor/wp-cli/profile-command/src/Formatter.php on line 134

Describe how other contributors can replicate this bug

Run any wp profile stage command with an invalid field supplied to --fields: wp profile stage template --fields=test will result in the above error.

Describe what you would expect as the correct outcome

Expected behavior is to either:

1. Fail gracefully and ignore. in the case of the example command, it should treat it as if no --fields was supplied. In the case that there are valid fields, the invalid field should just be ignored.

OR

2. Provide a meaningful failure message eg. field 'test' is invalid.

Let us know what environment you are running this on

OS:     Linux 5.15.167.4-microsoft-standard-WSL2 #1 SMP Tue Nov 5 00:21:55 UTC 2024 x86_64
Shell:
PHP binary:     /usr/bin/php8.1
PHP version:    8.1.32
php.ini used:   /etc/php/8.1/cli/php.ini
MySQL binary:   /usr/bin/mariadb
MySQL version:  mariadb  Ver 15.1 Distrib 10.11.11-MariaDB, for debian-linux-gnu (x86_64) using  EditLine wrapper
SQL modes:      STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION
WP-CLI root dir:        phar://wp-cli.phar/vendor/wp-cli/wp-cli
WP-CLI vendor dir:      phar://wp-cli.phar/vendor
WP_CLI phar path:       phar:///usr/local/bin/wp-cli
WP-CLI packages dir:    [removed]/.wp-cli/packages/
WP-CLI cache dir:       [removed]/.wp-cli/cache
WP-CLI global config:
WP-CLI project config:
WP-CLI version: 2.12.0

[iDschepe]

I'd like to work on it.

[iDschepe]

Additionally, I found out, that even existing fields will throw an error, as the "total" count is calculated hard coded to column one which results in a string type, e. g. "total (13)".

Working sample:

mga@devowl test-wp % wp profile stage template                    
+--------------+--------------+---------+------------+-------------+-------------+------------+--------------+--------------+--------------------+
| hook         | callback_cou | time    | query_time | query_count | cache_ratio | cache_hits | cache_misses | request_time | request_count      |
|              | nt           |         |            |             |             |            |              |              |                    |
+--------------+--------------+---------+------------+-------------+-------------+------------+--------------+--------------+--------------------+
| template_red |              | 0.0002s | 0s         | 0           |             | 0          | 0            | 0s           | 0                  |
| irect:before |              |         |            |             |             |            |              |              |                    |
| template_red | 7            | 0.0002s | 0s         | 0           | 100%        | 6          | 0            | 0s           | 0                  |
| irect        |              |         |            |             |             |            |              |              |                    |
| template_inc |              | 0.0099s | 0.0007s    | 3           | 77.23%      | 78         | 23           | 0s           | 0                  |
| lude:before  |              |         |            |             |             |            |              |              |                    |
| template_inc | 0            | 0s      | 0s         | 0           |             | 0          | 0            | 0s           | 0                  |
| lude         |              |         |            |             |             |            |              |              |                    |
| wp_head:befo |              | 0.016s  | 0.0033s    | 9           | 95.37%      | 247        | 12           | 0s           | 0                  |
| re           |              |         |            |             |             |            |              |              |                    |
| loop_start   | 0            | 0s      | 0s         | 0           |             | 0          | 0            | 0s           | 0                  |
| loop_end:bef |              | 0.0021s | 0s         | 0           | 100%        | 60         | 0            | 0s           | 0                  |
| ore          |              |         |            |             |             |            |              |              |                    |
| loop_end     | 0            | 0s      | 0s         | 0           |             | 0          | 0            | 0s           | 0                  |
| wp_footer:be |              | 0.0146s | 0.0003s    | 1           | 98.8%       | 247        | 3            | 0s           | 0                  |
| fore         |              |         |            |             |             |            |              |              |                    |
| wp_head      | 29           | 0.0092s | 0s         | 0           | 98.74%      | 157        | 2            | 0s           | 0                  |
| loop_start:b |              | 0s      | 0s         | 0           |             | 0          | 0            | 0s           | 0                  |
| efore        |              |         |            |             |             |            |              |              |                    |
| wp_footer    | 9            | 0.0003s | 0s         | 0           | 100%        | 11         | 0            | 0s           | 0                  |
| wp_footer:af |              | 0s      | 0s         | 0           |             | 0          | 0            | 0s           | 0                  |
| ter          |              |         |            |             |             |            |              |              |                    |
+--------------+--------------+---------+------------+-------------+-------------+------------+--------------+--------------+--------------------+
| total (13)   | 45           | 0.0526s | 0.0043s    | 13          | 95.73%      | 806        | 40           | 0s           | 0                  |
+--------------+--------------+---------+------------+-------------+-------------+------------+--------------+--------------+--------------------+

Error example, using fields specified. This would try to add a value of a cache_hits row to the string "total (13)" string value which in fact is string + int.

mga@devowl test-wp % wp profile stage template --fields=cache_hits
PHP Fatal error:  Uncaught TypeError: Unsupported operand types: string + int in /Users/mga/Workspaces/wp-cli-dev/profile-command/src/Formatter.php:165
Stack trace:
#0 /Users/mga/Workspaces/wp-cli-dev/profile-command/src/Formatter.php(78): WP_CLI\Profile\Formatter->show_table('ASC', NULL, Array, Array, true)
#1 /Users/mga/Workspaces/wp-cli-dev/profile-command/src/Command.php(187): WP_CLI\Profile\Formatter->display_items(Array, true, 'ASC', NULL)
#2 [internal function]: WP_CLI\Profile\Command->stage(Array, Array)
#3 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php(100): call_user_func(Array, Array, Array)
#4 [internal function]: WP_CLI\Dispatcher\CommandFactory::{closure:WP_CLI\Dispatcher\CommandFactory::create_subcommand():97}(Array, Array)
#5 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php(497): call_user_func(Object(Closure), Array, Array)
#6 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Runner.php(470): WP_CLI\Dispatcher\Subcommand->invoke(Array, Array, Array)
#7 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Runner.php(493): WP_CLI\Runner->run_command(Array, Array)
#8 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Runner.php(136): WP_CLI\Runner->run_command_and_exit()
#9 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Runner.php(1228): WP_CLI\Runner->do_early_invoke('before_wp_load')
#10 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Bootstrap/LaunchRunner.php(28): WP_CLI\Runner->start()
#11 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/bootstrap.php(84): WP_CLI\Bootstrap\LaunchRunner->process(Object(WP_CLI\Bootstrap\BootstrapState))
#12 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/wp-cli.php(35): WP_CLI\bootstrap()
#13 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/boot-fs.php(17): require_once('/Users/mga/Work...')
#14 {main}
  thrown in /Users/mga/Workspaces/wp-cli-dev/profile-command/src/Formatter.php on line 165
Fatal error: Uncaught TypeError: Unsupported operand types: string + int in /Users/mga/Workspaces/wp-cli-dev/profile-command/src/Formatter.php:165
Stack trace:
#0 /Users/mga/Workspaces/wp-cli-dev/profile-command/src/Formatter.php(78): WP_CLI\Profile\Formatter->show_table('ASC', NULL, Array, Array, true)
#1 /Users/mga/Workspaces/wp-cli-dev/profile-command/src/Command.php(187): WP_CLI\Profile\Formatter->display_items(Array, true, 'ASC', NULL)
#2 [internal function]: WP_CLI\Profile\Command->stage(Array, Array)
#3 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Dispatcher/CommandFactory.php(100): call_user_func(Array, Array, Array)
#4 [internal function]: WP_CLI\Dispatcher\CommandFactory::{closure:WP_CLI\Dispatcher\CommandFactory::create_subcommand():97}(Array, Array)
#5 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Dispatcher/Subcommand.php(497): call_user_func(Object(Closure), Array, Array)
#6 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Runner.php(470): WP_CLI\Dispatcher\Subcommand->invoke(Array, Array, Array)
#7 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Runner.php(493): WP_CLI\Runner->run_command(Array, Array)
#8 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Runner.php(136): WP_CLI\Runner->run_command_and_exit()
#9 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Runner.php(1228): WP_CLI\Runner->do_early_invoke('before_wp_load')
#10 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/WP_CLI/Bootstrap/LaunchRunner.php(28): WP_CLI\Runner->start()
#11 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/bootstrap.php(84): WP_CLI\Bootstrap\LaunchRunner->process(Object(WP_CLI\Bootstrap\BootstrapState))
#12 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/wp-cli.php(35): WP_CLI\bootstrap()
#13 /Users/mga/Workspaces/wp-cli-dev/wp-cli/php/boot-fs.php(17): require_once('/Users/mga/Work...')
#14 {main}
  thrown in /Users/mga/Workspaces/wp-cli-dev/profile-command/src/Formatter.php on line 165
Error: Es gab einen kritischen Fehler auf deiner Website.Erfahre mehr über die Problembehandlung in WordPress. Es gab einen kritischen Fehler auf deiner Website.