ABSPATH bootstrap issue with 2.0.3

[mikemanger]

We have a plugin file with some constants loaded in as a bootstrap file:

parameters:
	bootstrapFiles:
		- wp-content/plugins/my-plugin/my-plugin.php
	paths:
		- wp-content/plugins/my-plugin

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

define( 'PLUGIN_DIR_PATH', plugin_dir_path( __FILE__ ) );

/**
 * Used for TCPDF.
 */
require_once ABSPATH . 'vendor/autoload.php';

// ...

This worked fine in version 2.0.2 however in 2.0.3 it gives the error:

Note: Using configuration file /agent/build/phpstan.neon.dist.
Warning: require_once(/vendor/autoload.php): Failed to open stream: No such file or directory in /agent/build/wp-content/plugins/my-plugin/my-plugin.php on line 23
Error thrown in /agent/build/wp-content/plugins/my-plugin/my-plugin.php on line 23 while loading bootstrap file /agent/build/wp-content/plugins/my-plugin/my-plugin.php: Failed opening required '/vendor/autoload.php' (include_path='.:/usr/local/lib/php')
Script phpstan analyse --memory-limit=2048M handling the phpstan event returned with error code 1

It seems to be due to ABSPATH getting changed from ./ to / (1d6d3f3).

[szepeviktor]

Hello @mikemanger 👋🏻
Try using scanFiles instead of bootstrapFiles

[szepeviktor]

Maybe put vendor/autoload.php in bootstrapFiles

[IanDelMar]

I'm fairly sure this stems from the change to ABSPATH in #286, but I'm not convinced it's a general issue.

@mikemanger Your problem arises because you're bootstrapping your wp-content/plugins/my-plugin/my-plugin.php, which expects a particular value of ABSPATH that matches this specific setup. The value currently provided by szepeviktor/phpstan-wordpress won’t necessarily reflect your real ABSPATH (which also wouldn't be "./" in a WordPress production environment). If this were a running WordPress instance, you’d be looking for the vendor directory in the WordPress root, whereas you most likely want the vendor directory in your plugin root. As you’ve already defined PLUGIN_DIR_PATH a few lines above, it’s better to use that rather than ABSPATH: require_once PLUGIN_DIR_PATH . 'vendor/autoload.php'.

@szepeviktor Unless we're bootstrapping code that requires ABSPATH or any of the other dynamic constants to exist, we could drop defining them altogether. Since PHPStan 1.7.0 there’s no special handling needed just to analyse code that references global constants.

If a constant's value can differ across environments, the config reference recommends using dynamicConstantNames. In PHPStan < 2.1.23 this is a list of constant names; in PHPStan > 2.1.22 you can even explicitly set the type per constant:

# PHPStan < 2.1.23
parameters:
  dynamicConstantNames:
    - ABSPATH

# PHPStan > 2.1.22
parameters:
  dynamicConstantNames:
    ABSPATH: string

If a project truly needs to bootstrap files that depend on WordPress' dynamic constants, those projects can define the constants themselves (e.g. via bootstrapFiles) with values that match their folder structure. Not bootstrapping the dynamic constants would also prevent the package from imposing an environment-specific ABSPATH (and similar constants) on everyone else.

[IanDelMar]

Maybe put vendor/autoload.php in bootstrapFiles

PHPStan should scan those files automatically - though without bootstrapping. See the second bullet in the discovering symbols guide:

Composer dependencies of the analysed project