Skip to content

Update TTY checks#145

Merged
schlessera merged 1 commit intowp-cli:masterfrom
skeltoac:update-tty-checks
Jul 1, 2021
Merged

Update TTY checks#145
schlessera merged 1 commit intowp-cli:masterfrom
skeltoac:update-tty-checks

Conversation

@skeltoac
Copy link
Contributor

The function stream_isatty() (PHP manual) is available since PHP 7.2.0/8.0.

Determines if stream stream refers to a valid terminal type device. This is a more portable version of posix_isatty(), since it works on Windows systems too.

This update also enables the use of an Output stream as an argument without triggering a warning, as in the folowing code.

define( 'STDOUT', fopen( 'php://output', 'w' ) );
var_dump(posix_isatty(STDOUT));
var_dump(stream_isatty(STDOUT));

=>

<b>Warning</b>:  posix_isatty(): could not use stream of type 'Output' in <b>/usr/local/var/www/wp-cli/php/boot-fpm.php</b> on line <b>22</b><br />
bool(false)
bool(false)

It is necessary to define STDOUT in this way while using the fpm-fcgi SAPI. This is useful when running lots of WP-CLI commands in a high-volume task scheduler where up to 95% of CPU time is wasted on the redundant work of loading PHP code. We found that php-fpm's opcode caching reduces resource usage significantly, idling hundreds of CPU cores that are otherwise occupied loading the same code over and over again.

The fpm-fcgi SAPI runs WP CLI through a modified boot script. A command line program passes commands via an FCGI client and returns results on standard streams. It is suitable for non-interactive commands. This work will also be contributed to the wp-cli project.

The function `stream_isatty()` ([PHP manual](https://www.php.net/manual/en/function.stream-isatty.php)) is available since PHP 7.2.0/8.0.

> Determines if stream stream refers to a valid terminal type device. This is a more portable version of posix_isatty(), since it works on Windows systems too.

This update also enables the use of an Output stream as an argument without triggering a warning, as in the folowing code.

```
define( 'STDOUT', fopen( 'php://output', 'w' ) );
var_dump(posix_isatty(STDOUT));
var_dump(stream_isatty(STDOUT));

=>

<b>Warning</b>:  posix_isatty(): could not use stream of type 'Output' in <b>/usr/local/var/www/wp-cli/php/boot-fpm.php</b> on line <b>22</b><br />
bool(false)
bool(false)
```

It is necessary to define `STDOUT` in this way while using the `fpm-fcgi` SAPI. This is useful when running lots of WP-CLI commands in a high-volume task scheduler where up to 95% of CPU time is wasted on the redundant work of loading PHP code. We found that php-fpm's opcode caching reduces resource usage significantly, idling hundreds of CPUs that are otherwise occupied loading the same code over and over again.

The `fpm-fcgi` SAPI runs WP CLI through a modified boot script. A command line program passes commands via an FCGI client and returns results on standard streams. This work will also be contributed to the `wp-cli` project.
Copy link
Member

@schlessera schlessera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I notice that spacing is all over the place in this repo, so I'll have to enforce a meaningful CS at some point. But that shouldn't be a blocker for this PR.

@schlessera schlessera added this to the 0.11.13 milestone Jul 1, 2021
@schlessera schlessera added the bug label Jul 1, 2021
@schlessera schlessera merged commit a286685 into wp-cli:master Jul 1, 2021
@dan-m-joh
Copy link
Contributor

The function isTty() in Streams.php returns wrong information.
If the output is to an TTY then it returns false and if the output is a pipe or file it returns true, it should be the other way around.

The function should look like this (in my opinion):

        static public function isTty() {
                if ( function_exists('stream_isatty') ) {
                          return stream_isatty(static::$out);
                } else {
                        return (function_exists('posix_isatty') && posix_isatty(static::$out));
                }
        }

The function in Shell.php is correct (as it is also called isPiped()).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants