Merge pull request #70 from Connehito/4.x

fix #61

.travis.yml

@@ -3,6 +3,7 @@ php:
   - 7.2
   - 7.3
   - 7.4
+  - 8.0
 
 cache:
   directories:
@@ -15,13 +16,15 @@ env:
 
 matrix:
   include:
-    - php: 7.4
+    - php: 8.0
       env: PREFER_LOWEST="" TEST=1 CODECOV=1 STAN=0
-    - php: 7.4
+    - php: 8.0
       env: PREFER_LOWEST="" TEST=0 CODECOV=0 STAN=1
 
 before_script:
   - phpenv config-rm xdebug.ini
+  - echo "assert.exception = 1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+  - if [[ $TRAVIS_PHP_VERSION = 7.2 ]]; then composer remove --dev phpspec/prophecy-phpunit; fi
   - composer update --prefer-dist --no-interaction $PREFER_LOWEST
   - composer show -i
   # @see https://github.com/cakephp/cakephp/pull/13567#issuecomment-525844184

README.md

@@ -9,7 +9,7 @@ CakePHP integration for Sentry.
 [![License](https://poser.pugx.org/connehito/cake-sentry/license)](https://packagist.org/packages/connehito/cake-sentry)
 
 ## Requirements
-- PHP 7.2+
+- PHP 7.2+ / PHP 8.0+
 - CakePHP 4.0+
 - and [Sentry](https://sentry.io) account
 
@@ -21,6 +21,23 @@ CakePHP integration for Sentry.
 composer require connehito/cake-sentry:^3.0
 ```
 
+If you do not have the ` php-http/async-client-implementation` package, you will need to install it together.  
+In that case, you will get a message like the following
+
+```
+Problem 1
+- sentry/sentry[3.2.0, ... , 3.3.0] require php-http/async-client-implementation ^1.0 -> could not be found in any version, but the following packages provide it:
+```
+
+Then, you can use the following command to provide a package such as `symfony/http-client`.
+
+```
+composer require connehito/cake-sentry symfony/http-client
+```
+
+You can find the available packages on [Packagist](https://packagist.org/providers/php-http/async-client-implementation).
+
+
 ## Usage
 
 ### Set config files.

composer.json

@@ -3,16 +3,17 @@
     "description": "Sentry plugin for CakePHP",
     "type": "cakephp-plugin",
     "require": {
-        "php": "^7.2",
+        "php": "^7.2 || ^8.0",
         "cakephp/cakephp": "^4.0",
-        "php-http/guzzle6-adapter": "^v1.1.1|^v2.0",
-        "sentry/sentry": "^2.2"
+        "sentry/sentry": "^3.2"
     },
     "require-dev": {
-        "cakephp/cakephp-codesniffer": "^3.0",
-        "jangregor/phpstan-prophecy": "^0.4.2",
+        "cakephp/cakephp-codesniffer": "@stable",
+        "jangregor/phpstan-prophecy": "@stable",
+        "phpspec/prophecy-phpunit": "^2.0",
         "phpstan/phpstan": "@stable",
-        "phpunit/phpunit": "^8.5.0"
+        "phpunit/phpunit": "^8.5 || ^9.3",
+        "symfony/http-client": "^5.2"
     },
     "license": "MIT",
     "autoload": {

phpstan.neon

@@ -1,9 +1,9 @@
 includes:
-- vendor/jangregor/phpstan-prophecy/src/extension.neon
+- vendor/jangregor/phpstan-prophecy/extension.neon
 parameters:
     paths:
       - src
       - tests/TestCase
     level: 5
-    autoload_files:
+    bootstrapFiles:
       - tests/bootstrap.php

src/Error/ConsoleErrorHandler.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Connehito\CakeSentry\Error;
 

src/Error/ErrorHandler.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Connehito\CakeSentry\Error;
 
 use Cake\Error\ErrorHandler as CakeErrorHandler;

src/Error/ErrorHandlerTrait.php

@@ -1,9 +1,8 @@
 <?php
+declare(strict_types=1);
 
 namespace Connehito\CakeSentry\Error;
 
-use Cake\Core\InstanceConfigTrait;
-use Connehito\CakeSentry\Http\Client;
 use ErrorException;
 
 trait ErrorHandlerTrait

src/Error/ErrorLogger.php

@@ -10,7 +10,6 @@
 
 class ErrorLogger extends CakeErrorLogger
 {
-
     /**
      * {@inheritDoc}
      *

src/Http/Client.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Connehito\CakeSentry\Http;
 
@@ -7,11 +8,12 @@
 use Cake\Event\Event;
 use Cake\Event\EventDispatcherTrait;
 use Cake\Utility\Hash;
-use Psr\Http\Message\ServerRequestInterface;
 use RuntimeException;
-use Sentry\Breadcrumb;
+use Sentry\EventHint;
 use Sentry\SentrySdk;
+use Sentry\Serializer\RepresentationSerializer;
 use Sentry\Severity;
+use Sentry\StacktraceBuilder;
 use Sentry\State\Hub;
 use function Sentry\init;
 
@@ -21,13 +23,22 @@ class Client
     use InstanceConfigTrait;
 
     /* @var array default instance config */
-    protected $_defaultConfig = [];
+    protected $_defaultConfig = [
+        'sentry' => [
+            'prefixes' => [
+                APP,
+            ],
+            'in_app_exclude' => [
+                ROOT . DS . 'vendor' . DS,
+            ],
+        ],
+    ];
 
     /* @var Hub */
     protected $hub;
 
-    /* @var ServerRequestInterface */
-    protected $request;
+    /* @var StacktraceBuilder */
+    protected $stackTraceBuilder;
 
     /**
      * Client constructor.
@@ -36,14 +47,22 @@ class Client
      */
     public function __construct(array $config)
     {
+        $userConfig = Configure::read('Sentry');
+        if ($userConfig) {
+            $this->_defaultConfig['sentry'] = array_merge($this->_defaultConfig['sentry'], $userConfig);
+        }
         $this->setConfig($config);
         $this->setupClient();
+        $this->stackTraceBuilder = new StacktraceBuilder(
+            $this->getHub()->getClient()->getOptions(),
+            new RepresentationSerializer($this->getHub()->getClient()->getOptions())
+        );
     }
 
     /**
      * Accessor for current hub
      *
-     * @return Hub
+     * @return \Sentry\State\Hub
      */
     public function getHub(): Hub
     {
@@ -53,10 +72,9 @@ public function getHub(): Hub
     /**
      * Capture exception for sentry.
      *
-     * @param mixed $level error level
+     * @param string|int $level error level
      * @param string $message error message
      * @param array $context subject
-     *
      * @return void
      */
     public function capture($level, string $message, array $context): void
@@ -68,25 +86,23 @@ public function capture($level, string $message, array $context): void
         if ($exception) {
             $lastEventId = $this->hub->captureException($exception);
         } else {
-            $stacks = array_slice(debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT), 3);
-            if (method_exists(Severity::class, $level)) {
-                $severity = (Severity::class . '::' . $level)();
-            } else {
-                $severity = Severity::fromError($level);
-            }
-            foreach ($stacks as $stack) {
-                $method = isset($stack['class']) ? "{$stack['class']}::{$stack['function']}" : $stack['function'];
-                unset($stack['class']);
-                unset($stack['function']);
-                $this->hub->addBreadcrumb(new Breadcrumb(
-                    $severity,
-                    Breadcrumb::TYPE_ERROR,
-                    'method',
-                    $method,
-                    $stack
-                ));
+            $hint = new EventHint();
+
+            $stackTrace = $context['stackTrace'] ?? false;
+            if ($stackTrace) {
+                $hint->stacktrace = $this->stackTraceBuilder->buildFromBacktrace(
+                    $stackTrace,
+                    $stackTrace[0]['file'],
+                    $stackTrace[0]['line']
+                );
+                unset($context['stackTrace']);
             }
-            $lastEventId = $this->hub->captureMessage($message, $severity);
+            $this->hub->configureScope(function (\Sentry\State\Scope $scope) use ($context) {
+                $scope->setExtras($context);
+            });
+
+            $severity = $this->convertLevelToSeverity($level);
+            $lastEventId = $this->hub->captureMessage($message, $severity, $hint);
         }
 
         $context['lastEventId'] = $lastEventId;
@@ -101,7 +117,7 @@ public function capture($level, string $message, array $context): void
      */
     protected function setupClient(): void
     {
-        $config = (array)Configure::read('Sentry');
+        $config = $this->getConfig('sentry');
         if (!Hash::check($config, 'dsn')) {
             throw new RuntimeException('Sentry DSN not provided.');
         }
@@ -112,4 +128,19 @@ protected function setupClient(): void
         $event = new Event('CakeSentry.Client.afterSetup', $this);
         $this->getEventManager()->dispatch($event);
     }
+
+    /**
+     * Convert error info to severity
+     *
+     * @param string|int $level Error name or level(int)
+     * @return \Sentry\Severity
+     */
+    private function convertLevelToSeverity($level): Severity
+    {
+        if (is_string($level) && method_exists(Severity::class, $level)) {
+            return (Severity::class . '::' . $level)();
+        }
+
+        return Severity::fromError($level);
+    }
 }

src/Log/Engine/SentryLog.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Connehito\CakeSentry\Log\Engine;
 
@@ -11,7 +12,7 @@ class SentryLog extends BaseLog
     protected $client;
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function __construct(array $config = [])
     {
@@ -23,10 +24,11 @@ public function __construct(array $config = [])
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function log($level, $message, array $context = [])
     {
+        $context['stackTrace'] = debug_backtrace();
         $this->client->capture($level, $message, $context);
     }
 }

src/Plugin.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Connehito\CakeSentry;
 

tests/TestCase/Error/ErrorHandlerTraitTest.php

@@ -52,8 +52,8 @@ private function getSubject()
             public $wrappedException;
 
             /**
-             * Implement a non-functional method to avoid echoing in running test.
              * {@inheritDoc}
+             * Implement a non-functional method to avoid echoing in running test.
              */
             protected function _displayError(array $error, bool $debug): void
             {

tests/TestCase/Error/ErrorLoggerTest.php

@@ -9,13 +9,15 @@
 use Cake\Log\Log;
 use Cake\TestSuite\TestCase;
 use Connehito\CakeSentry\Error\ErrorLogger;
-use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\MockObject\MockObject; // phpcs:ignore SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse
 use Psr\Log\LoggerInterface;
 use RuntimeException;
 
 final class ErrorLoggerTest extends TestCase
 {
-    /** @var MockObject LoggerInterface */
+    /**
+     * @var MockObject|LoggerInterface LoggerInterface
+     */
     private $subject;
 
     /**