Fix unit tests and PHP8.1+ compatability

[aaronjorbin]

Description of the change

Fix #113 and #102

This updates the unit tests to use the Yoast Pollyfill and also wp-env for testing across multiple versions of PHP.

The underlying rollbar-php is both updated and kept the same. It's updated for sites running PHP8+, but kept the same for PHP7. This introduces a bit of technical debt as the actual dependencies aren't in the composer file but instead are in the php7 and php8 folder. To help manage that, a script is included for updating those dependencies.

There are a few spots in the code that now also include PHP version specific code. When php7 support is dropped, these will need to be cleaned up.

Additionally, github actions are added in order to allow unit tests to run across multiple versions of PHP

Testing Instructions

If you want to test this change manually, you can use wp-env. clone the repo and make sure git, docker, and node are installed on your machine. Then run

npm install WP_ENV_PHP_VERSION="7.0" npm run wp-env start -- --update to start with PHP 7.0

You can login to Wordpress at http://localhost:8888/ with the username admin and the password password

If you want to test a different version of PHP, you can restart the env with a different PHP version passed in. For example, WP_ENV_PHP_VERSION="8.2" npm run wp-env start -- --update to start with PHP 8.2

Type of change

• [x] Bug fix (non-breaking change that fixes an issue)
• [ ] New feature (non-breaking change that adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [x] Maintenance
• [ ] New release

Checklists

Development

• [x] The code changed/added as part of this pull request has been covered with tests
• [x] All tests related to the changed code pass in development

Code review

• [x] This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
• [ ] "Ready for review" label attached to the PR and reviewers assigned
• [ ] Issue from task tracker has a link to this pull request
• [ ] Changes have been reviewed by at least one other engineer

[aaronjorbin]

You can see the passing unit tests at https://github.com/aaronjorbin/rollbar-php-wordpress/actions/runs/5512267190

[aaronjorbin]

The 2,021 files changed is due to 1) Moving from having the dependencies in the main composer.json file to there being separate php8 and php7 versions 2) Removing the dependencies that are actually dev dependencies from the build.

The actual files changed that should be reviewed are and a quick summary for each file:

• .github/workflows/php_unit.yml - New action for the unit tests
• .gitignore
• .wp-env.json - New file for local env
• readme.md - Updated instructions for automated tests
• bin/install-wp-tests.sh - deleted due to changes to how the tests are run now
• bin/update-composer-dependencies - new script to make it easier to update dependencies
• composer.json - Changed from including dependencies to having them in php7 and php8 versions, also updated test running and modified the dev dependencies so tests can run across multiple versions
• package.json
• php7/composer.json
• php8/composer.json
• phpunit.xml.dist - Ignore files without tests since this triggers an error in newer PHPUnit versions
• rollbar-php-wordpress.php - Load autoloader based on PHP version
• src/Plugin.php - handle differences in underlying library based on PHP version
• src/Settings.php - Handle differences in underlying library
• tests/BaseTestCase.php - Use the Yoast PHPUnit polyfill library
• tests/DefaultTest - use snakecase from https://github.com/Yoast/PHPUnit-Polyfills#testcases
• tests/PluginTest - handle underlying library changes, snakecase due to https://github.com/Yoast/PHPUnit-Polyfills#testcases and also make dataProvidor static due to PHPUnit changes
• tests/SettingsTest.php snakecase due to https://github.com/Yoast/PHPUnit-Polyfills#testcases and also make dataProvidor static due to PHPUnit changes

[danielmorell]

Hi @aaronjorbin, thank you for the massive amount of work you have put into this! It will take me a little bit to review this, but I think this is heading in a good direction.