Release v3.27.0

Author: imjoehaines

.gitattributes

@@ -19,3 +19,5 @@
 /packager.sh export-ignore
 /packager.php export-ignore
 /phpunit.xml.dist export-ignore
+/phpstan.neon.dist export-ignore
+/phpstan export-ignore

.github/workflows/test-package.yml

@@ -49,3 +49,42 @@ jobs:
       run: composer update --prefer-dist --no-progress --no-suggest --no-interaction ${{ matrix.composer-flags }}
 
     - run: composer run-script test
+
+  phpstan:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # TODO: we likely have to care about Guzzle's version too - ideally we'd
+        #       check our use of Guzzle is correct on each version
+        php-version: ['7.1', '8.1']
+        phpstan-version: ['~1.4']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: install PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-version }}
+        coverage: none
+        extensions: intl, mbstring
+        # by default setup-php uses a production php.ini so force development values
+        ini-values: >-
+          zend.exception_ignore_args=Off,
+          zend.exception_string_param_max_len=15,
+          error_reporting=-1,
+          display_errors=On,
+          display_startup_errors=On,
+          zend.assertions=1
+
+    # - name: require guzzle
+    #   run: composer require "guzzlehttp/guzzle:${{ matrix.guzzle-version }}" --no-update ${{ matrix.composer-flags }}
+
+    - name: require phpstan
+      run: composer require "phpstan/phpstan:${{ matrix.phpstan-version }}" --no-update ${{ matrix.composer-flags }}
+
+    - name: install dependencies
+      run: composer update --prefer-dist --no-progress --no-suggest --no-interaction ${{ matrix.composer-flags }}
+
+    - run: ./vendor/bin/phpstan

.gitignore

@@ -5,3 +5,4 @@ vendor
 /.idea
 .phpunit.result.cache
 decisions.yml
+phpstan.neon

CHANGELOG.md

@@ -1,6 +1,26 @@
 Changelog
 =========
 
+## 3.27.0 (2022-02-07)
+
+### Enhancements
+
+* Improve serialisation of backed enums. Previously a backed enum would JSON encode to their backing value, but will now include the enum name like `EnumName::CaseName (value)`
+  [#639](https://github.com/bugsnag/bugsnag-php/pull/639)
+
+### Fixes
+
+* A number of errors in docblocks have been corrected
+  [xPaw](https://github.com/xPaw)
+  [#633](https://github.com/bugsnag/bugsnag-php/pull/633)
+  [#637](https://github.com/bugsnag/bugsnag-php/pull/637)
+* Handle serialising pure enums when added as metadata. Previously a pure enum would be JSON encoded as `null`, but will now be converted to a string like `EnumName::CaseName`
+  [#639](https://github.com/bugsnag/bugsnag-php/pull/639)
+* Remove use of the deprecated `strftime` function
+  [#640](https://github.com/bugsnag/bugsnag-php/pull/640)
+* Fix session throttling when storage backend doesn't store integers
+  [#643](https://github.com/bugsnag/bugsnag-php/pull/643)
+
 ## 3.26.1 (2021-09-09)
 
 ### Fixes

Dockerfile

@@ -1,8 +1,9 @@
-FROM php:5.5.38-alpine
+FROM php:5.5-alpine
 
 ENV COMPOSER_ALLOW_SUPERUSER 1
 
-RUN curl -sS https://getcomposer.org/installer | php \
-    && mv composer.phar /usr/local/bin/composer
+RUN apk update && apk upgrade
+
+COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
 
 ENTRYPOINT ["php"]

package.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 if [[ "$(docker images -q bugsnag/php:5.5 2> /dev/null)" == "" ]]; then
-    docker pull php:5.5.38-alpine
+    docker pull php:5.5-alpine
     docker build --no-cache -t bugsnag/php:5.5 .
 fi
 

phpstan.neon.dist

@@ -0,0 +1,17 @@
+includes:
+    - phpstan/ignore-by-php-version.neon.php
+
+parameters:
+    level: 6
+
+    treatPhpDocTypesAsCertain: false
+    checkMissingIterableValueType: false # TODO: remove this!
+
+    paths:
+        - src/
+
+    ignoreErrors:
+        -
+            message: "#^Property Bugsnag\\\\Handler\\:\\:\\$reservedMemory is never read, only written\\.$#"
+            count: 1
+            path: src/Handler.php

phpstan/baseline-less-than-8.1.neon

@@ -0,0 +1,7 @@
+parameters:
+    ignoreErrors:
+        - '#Class UnitEnum not found\.#'
+        - '#.*invalid type UnitEnum\.#'
+        - '#.*unknown class UnitEnum\.#'
+        - '#Class BackedEnum not found\.#'
+        - '#.*unknown class BackedEnum\.#'

phpstan/ignore-by-php-version.neon.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Ignore errors based on the current PHP version.
+ *
+ * This is useful in cases where errors are caused by the use of features that
+ * do not exist in the current version of PHP, e.g. enums
+ *
+ * This is the approach used by PHPStan itself:
+ * https://github.com/phpstan/phpstan-src/blob/master/build/ignore-by-php-version.neon.php
+ */
+
+use PHPStan\DependencyInjection\NeonAdapter;
+
+$config = [];
+$adapter = new NeonAdapter();
+
+if (version_compare(PHP_VERSION, '8.1.0', '<')) {
+    $config = array_merge_recursive($config, $adapter->load(__DIR__.'/baseline-less-than-8.1.neon'));
+}
+
+$config['parameters']['phpVersion'] = PHP_VERSION_ID;
+
+return $config;

phpunit.xml.dist

@@ -16,6 +16,7 @@
     stopOnError="false"
     stopOnFailure="false"
     verbose="true"
+    executionOrder="random"
 >
     <coverage processUncoveredFiles="true">
         <include>