Conflict with composer cmd scripts

[UVLabs]

🐞 bug report

Behavior:

• Freemius composer package causes conflict by stopping composer scripts from running as intended.

• When PHPCodeSniffer is installed via composer using composer require --dev dealerdirect/phpcodesniffer-composer-installer the bin files it creates phpcbf and phpcs should be able to be referenced like this vendor/bin/phpcbf -p that will cause the library to run its behavior. However with the latest version of the SDK this doesn't work.

I reported to the PHPCodeSniffer team and they helped identify the issue. The discussion and reason for the issue can be seen here: PHPCSStandards/PHP_CodeSniffer#781

Versions: (*)

• Freemius SDK Version: 2.10.1
• WordPress Version: N/A
• PHP Version: 8.1 (tried different versions, no difference)

[codex-m]

To add to this bug report, I see that it also affects PHP unit tests in a plugin. Previously, running the unit tests script via command line at the plugin root directory would run without any issues.

However, unit tests won't run if we load the Freemius SDK (version 2.10.1) via the composer vendor directory (autoloaded). I debugged this, and this is the issue: (start.php of Freemius SDK)

if ( ! defined( 'ABSPATH' ) ) {
exit;
}

The problem is that when we execute tests in a command line environment - WordPress is never loaded, ABSPATH is never defined, and the tests will terminate.

However, if you change the above line from exit to return, the test will now work. If ABSPATH is not defined, it will simply bail out and run the rest (including tests).

Proposed solution:

if ( ! defined( 'ABSPATH' ) ) {
return;
}

Though I'm not sure about the consequences of using return for the rest of the Freemius SDK functionalities, this change requires thorough testing if we would like to adopt this approach.

[JUVOJustin]

I can confirm the proposal of @codex-m solves the issue for phpstan and phpcs.

In this context, I would propose to also add typings to the default sdk script output on the ui like this:

/**
 * Freemius init function
 *
 * @return Freemius
 * @throws Freemius_Exception Thrown when an API call returns an exception.
 */
function my_fs(): Freemius {
}

[UVLabs]

@bahiirwa @swashata Are you guys aware of this?

[swashata]

Thanks. It looks like a legit issue and the solution also looks good. @DanieleAlessandra please add this to our internal Asana and let's handle it soon.

[Tmeister]

Same issue here.

When using the composer package, all the vendor/bin/ utilities stop working; in my case:

• phpunit
• php-cs-fixer

[yoren]

I can confirm the issue also happens to us (can't run our unit tests). I currently have to use https://github.com/mcaskill/composer-plugin-exclude-files to exclude the start.php from autoload files to get things back to work (and thus need to manually include start.php in our plugin). Would be great to see an update soon :)

[Mte90]

any updates for this? I just spent an hour investigating this...

[Mte90]

@swashata any update for this?

[swashata]

Hey @Mte90 the change has been made already #789 We will release the next version coming week.

[swashata]

This has been resolved https://github.com/Freemius/wordpress-sdk/releases/tag/2.12.0