emit warnings when xdebug is not used according to cli-flags #1878

staabm · 2022-10-20T09:19:32Z

we don't have tests with/without xdebug. does this PR require tests?

I tested it manually

$ php bin/phpstan analyze test.php --debug  --level 9
Note: The xdebug php-extension is active, but "--xdebug" is not used.
      This may slow down performance and the process will not halt at breakpoints.
Note: Using configuration file C:\dvl\Workspace\phpstan-src-staabm\phpstan.neon.dist.
C:\dvl\Workspace\phpstan-src-staabm\test.php


$ php bin/phpstan analyze test.php --debug  --level 9   --xdebug
Note: You are running with "--xdebug" enabled, but the xdebug php-extension is not active.
      The process will not halt at breakpoints.
Note: Using configuration file C:\dvl\Workspace\phpstan-src-staabm\phpstan.neon.dist.
C:\dvl\Workspace\phpstan-src-staabm\test.php

staabm · 2022-10-20T09:21:04Z

(sorry for the typo in the PR title)

phpstan-bot · 2022-10-20T09:21:52Z

This pull request has been marked as ready for review.

ondrejmirtes · 2022-10-20T09:35:24Z

src/Command/CommandHelper.php

 		$stdOutput = new SymfonyOutput($output, new SymfonyStyle(new ErrorsConsoleStyle($input, $output)));

 		/** @var Output $errorOutput */
 		$errorOutput = (static function () use ($input, $output): Output {
 			$symfonyErrorOutput = $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output;
 			return new SymfonyOutput($symfonyErrorOutput, new SymfonyStyle(new ErrorsConsoleStyle($input, $symfonyErrorOutput)));
 		})();
+
+		if ($allowXdebug && !XdebugHandler::isXdebugActive()) {
+			$errorOutput->writeLineFormatted(sprintf('Note: You are running with "--xdebug" enabled, but the xdebug php-extension is not active.' . "\n" . '      The process will not halt at breakpoints.'));


Please use $errorOutput->getStyle()->note() instead.

Correct capitalization of Xdebug please: https://xdebug.org/

php-extension should be PHP extension

fixed thanks.

screenshot of the cli error for preview

ondrejmirtes · 2022-10-20T09:43:05Z

Purrrrfect!

ondrejmirtes · 2022-10-20T09:43:15Z

Thank you.

staabm · 2022-10-20T09:44:44Z

off-topic: you may also notice, that my commits from the work pc, now also use the same git user as those from my personal computer

ondrejmirtes · 2022-10-20T09:45:32Z

👏

InvisibleSmiley · 2022-12-05T09:00:47Z

The problem with the current warning message is that it can be interpreted as "please add the --xdebug flag to improve performance" which is wrong of course.

See for example https://youtrack.jetbrains.com/issue/WI-69996

Please improve the message to help people understand that:

if you want to improve performance, disable Xdebug altogether
debugging PHPStan itself, use --xdebug with Xdebug enabled
do not use --xdebug with Xdebug enabled for regular use since it really hurts performance

staabm · 2022-12-05T12:04:04Z

@InvisibleSmiley feel free to suggest a pull request with a concrete message.

jorismak · 2022-12-29T08:42:29Z

Shouldn't it be possible to disable this warning in the configuration file or something?

It now breaks integrations with phpstan because the warning is always displayed. Setting 'start_with_request' to trigger still doesn't quiet the warning.

So on a development machine where you want Xdebug to be available, you now always get this warning? Seems like it now breaks more than it helps? (The performance difference with XDEBUG_MODE=off vs XDEBUG_MODE=debug is very, very small).

ondrejmirtes · 2022-12-29T08:49:41Z

What does it break? It's printed to stderr. And there have always been messages printed to stderr, even when combined with JSON error format for example.

jorismak · 2022-12-29T08:58:48Z

I get a popup in phpstorm and vscode every time it tries to run phpstan, that there is some error running the process (and then shows the xdebug warning).

ondrejmirtes · 2022-12-29T09:05:15Z

The same integration should fail if there's a note in the output about auto-discovered phpstan.neon or phpstan.neon.dist. Is that correct?
Seems like you can disable this message with an environment variable XDEBUG_MODE=off. Is that correct?

jorismak · 2022-12-29T10:29:34Z

I guess these ide plugins have ignored certain output to not complain about other stderr output. Since i almost always need to specify a config file i haven't encountered that situation. In composer.json you can use ***@***.***` in a script definition to set the XDEBUG_MODE variable I've discovered. And in phpstorm you can add commandline options to the php interpreter used for things like phpstan and php-cs-fixer. The option `xdebug.mode=off` has the same effect as the env variable (phpstorm uses this with a -d commandline parameter). So I'm able to work around it for now. Still seems weird to have to do this, as phpstan is often used during development, where xdebug is almost always enabled. Quite easy to see situations where you have little control over the command used to invoke phpstan when it's inside a plugin or something like that . Having config options to quiet all warnings still sound like something that might eventually be necessary.

…

On Thu, Dec 29, 2022, 10:05 Ondřej Mirtes ***@***.***> wrote: 1. The same integration should fail if there's a note in the output about auto-discovered phpstan.neon or phpstan.neon.dist. Is that correct? 2. Seems like you can disable this message with an environment variable XDEBUG_MODE=off. Is that correct? — Reply to this email directly, view it on GitHub <#1878 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ALMD2DW4DTOYDTH6DD62MVLWPVH5PANCNFSM6AAAAAARJ6BNC4> . You are receiving this because you commented.Message ID: ***@***.***>

Balkoth · 2023-02-08T13:29:22Z

I guess this change breaks extensions like this?

ondrejmirtes · 2023-02-08T13:31:44Z

Extension that gets broken when something meant for humans to read is printed to stderr needs to be fixed :)

ondrejmirtes · 2023-02-08T13:32:17Z

Anyway, if you have any questions, please open new issues or discussions in phpstan/phpstan. Thank you.

clxmstaab force-pushed the xdebug-warn branch from 92e9daf to 49add99 Compare October 20, 2022 09:20

staabm changed the title ~~emit warnings when xdebug is not used according th cli-flags~~ emit warnings when xdebug is not used according to cli-flags Oct 20, 2022

staabm marked this pull request as ready for review October 20, 2022 09:21

ondrejmirtes requested changes Oct 20, 2022

View reviewed changes

clxmstaab force-pushed the xdebug-warn branch from 49add99 to 0280a3e Compare October 20, 2022 09:39

emit warnings when xdebug is not used according th cli-flags

1f0abfc

clxmstaab force-pushed the xdebug-warn branch from 0280a3e to 1f0abfc Compare October 20, 2022 09:39

ondrejmirtes merged commit 7277d46 into phpstan:1.9.x Oct 20, 2022

staabm deleted the xdebug-warn branch October 20, 2022 09:43

ruudk mentioned this pull request Nov 3, 2022

[1.9.0] "Xdebug PHP extension is active" warning should maybe consider xdebug.mode and xdebug.start_with_request? phpstan/phpstan#8269

Closed

InvisibleSmiley mentioned this pull request Dec 5, 2022

Improve Xdebug note #2052

Closed

phpstan locked as resolved and limited conversation to collaborators Feb 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

emit warnings when xdebug is not used according to cli-flags #1878

emit warnings when xdebug is not used according to cli-flags #1878

staabm commented Oct 20, 2022 •

edited

Loading

staabm commented Oct 20, 2022

phpstan-bot commented Oct 20, 2022

ondrejmirtes Oct 20, 2022

staabm Oct 20, 2022

ondrejmirtes commented Oct 20, 2022

ondrejmirtes commented Oct 20, 2022

staabm commented Oct 20, 2022 •

edited

Loading

ondrejmirtes commented Oct 20, 2022

InvisibleSmiley commented Dec 5, 2022

staabm commented Dec 5, 2022

jorismak commented Dec 29, 2022

ondrejmirtes commented Dec 29, 2022

jorismak commented Dec 29, 2022

ondrejmirtes commented Dec 29, 2022

jorismak commented Dec 29, 2022 via email

Balkoth commented Feb 8, 2023

ondrejmirtes commented Feb 8, 2023

ondrejmirtes commented Feb 8, 2023

emit warnings when xdebug is not used according to cli-flags #1878

emit warnings when xdebug is not used according to cli-flags #1878

Conversation

staabm commented Oct 20, 2022 • edited Loading

staabm commented Oct 20, 2022

phpstan-bot commented Oct 20, 2022

ondrejmirtes Oct 20, 2022

Choose a reason for hiding this comment

staabm Oct 20, 2022

Choose a reason for hiding this comment

ondrejmirtes commented Oct 20, 2022

ondrejmirtes commented Oct 20, 2022

staabm commented Oct 20, 2022 • edited Loading

ondrejmirtes commented Oct 20, 2022

InvisibleSmiley commented Dec 5, 2022

staabm commented Dec 5, 2022

jorismak commented Dec 29, 2022

ondrejmirtes commented Dec 29, 2022

jorismak commented Dec 29, 2022

ondrejmirtes commented Dec 29, 2022

jorismak commented Dec 29, 2022 via email

Balkoth commented Feb 8, 2023

ondrejmirtes commented Feb 8, 2023

ondrejmirtes commented Feb 8, 2023

staabm commented Oct 20, 2022 •

edited

Loading

staabm commented Oct 20, 2022 •

edited

Loading