isConsoleRequest() may return erroneously when testing the Web application in Codeception

[michaelrog]

In the course of plugin support, I encountered a weird issue where Craft was unable to resolve its current route while running via Codeception, causing tests to fail.

The relevant logic is in a branch where isConsoleRequest() returns true, so the plugin is expecting to be dealing with craft\console\Request in that branch... but the app is bootstrapped as a Web application, and therefore uses a craft\web\Request... leading to an Exception.

The confounding factor seems to be that, by default, isConsoleRequest() only uses PHP_SAPI to test its situation — which of course will reflect that we're running in the console, i.e. Codeception.

Is there a way Craft could avoid tripping over this? — For example, maybe craft\web\Request could explicitly set setIsConsoleRequest(false) at init?

[brandonkelly]

getIsConsoleRequest() is defined by yii\base\Request, so this is more of a Yii thing. Not really interested in overriding it or customizing the behavior, when the bug (if there is one here) really should be fixed in Yii.

[michaelrog]

Good point. I'll open up a thread there. (I imagine somebody has had to contend with this before; maybe there's a way you're Supposed To deal with this...)

Thanks!