From a90fee4438ce22c9b1053ab1d455388ff7bd6617 Mon Sep 17 00:00:00 2001 From: Paul Klimov Date: Tue, 23 Apr 2024 17:16:15 +0300 Subject: [PATCH] initial commit --- .gitattributes | 8 +++ .github/FUNDING.yml | 4 ++ .github/ISSUE_TEMPLATE.md | 14 ++++ .github/PULL_REQUEST_TEMPLATE.md | 7 ++ .github/workflows/build.yml | 31 +++++++++ .gitignore | 35 ++++++++++ CHANGELOG.md | 7 ++ LICENSE.md | 32 +++++++++ README.md | 41 ++++++++++++ composer.json | 39 +++++++++++ phpunit.xml.dist | 15 +++++ src/ErrorHandler.php | 111 +++++++++++++++++++++++++++++++ tests/ErrorHandlerTest.php | 24 +++++++ tests/TestCase.php | 101 ++++++++++++++++++++++++++++ tests/bootstrap.php | 14 ++++ 15 files changed, 483 insertions(+) create mode 100644 .gitattributes create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/build.yml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 composer.json create mode 100644 phpunit.xml.dist create mode 100644 src/ErrorHandler.php create mode 100644 tests/ErrorHandlerTest.php create mode 100644 tests/TestCase.php create mode 100644 tests/bootstrap.php diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..48572f0 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,8 @@ +# Ignore all test and documentation for archive +/.github export-ignore +/.gitattributes export-ignore +/.gitignore export-ignore +/.scrutinizer.yml export-ignore +/phpunit.xml.dist export-ignore +/tests export-ignore +/docs export-ignore \ No newline at end of file diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..99679ca --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,4 @@ +# These are supported funding model platforms + +github: [klimov-paul] +patreon: klimov_paul diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2cc6439 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,14 @@ +### What steps will reproduce the problem? + +### What is the expected result? + +### What do you get instead? + +### Additional info + +| Q | A +|-----------------------| --- +| This Package Version | 1.?.? +| Yii Framework Version | 1.1.? +| PHP version | +| Operating system | diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f4af2f3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +| Q | A +| ------------- | --- +| Is bugfix? | ✔️/❌ +| New feature? | ✔️/❌ +| Breaks BC? | ✔️/❌ +| Tests pass? | ✔️/❌ +| Fixed issues | comma-separated list of tickets # fixed by the PR, if any \ No newline at end of file diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..9b89700 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,31 @@ +name: build + +on: [push, pull_request] + +jobs: + phpunit: + name: PHP ${{ matrix.php }} on ${{ matrix.os }} + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest] + php: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3'] + + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Install PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: mbstring + tools: composer:v2 + coverage: none + + - name: Install dependencies + run: | + composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi + - name: Run unit tests + run: vendor/bin/phpunit --colors=always diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..304f7c8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,35 @@ +# phpstorm project files +.idea + +# netbeans project files +nbproject + +# zend studio for eclipse project files +.buildpath +.project +.settings + +# windows thumbnail cache +Thumbs.db + +# composer vendor dir +/vendor + +/composer.lock + +# composer itself is not needed +composer.phar + +# Mac DS_Store Files +.DS_Store + +# phpunit itself is not needed +phpunit.phar +# local phpunit config +/phpunit.xml +# phpunit cache +.phpunit.result.cache + +# test runtime files +/.phpunit.cache +/tests/runtime \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ee3bf69 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +Yii1 Enhanced Error Handler extension +===================================== + +1.0.0 Under Development +----------------------- + +- Initial release. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..e641e6f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,32 @@ +This is free software. It is released under the terms of the +following BSD License. + +Copyright © 2023 by Yii1Tech (https://github.com/yii1tech) +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Yii1Tech nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..74fe2ae --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +

+ + + +

Yii1 Enhanced Error Handler

+
+

+ +This extension provides Enhanced Error Handler for Yii1 application. + +For license information check the [LICENSE](LICENSE.md)-file. + +[![Latest Stable Version](https://img.shields.io/packagist/v/yii1tech/error-handler.svg)](https://packagist.org/packages/yii1tech/error-handler) +[![Total Downloads](https://img.shields.io/packagist/dt/yii1tech/error-handler.svg)](https://packagist.org/packages/yii1tech/error-handler) +[![Build Status](https://github.com/yii1tech/error-handler/workflows/build/badge.svg)](https://github.com/yii1tech/error-handler/actions) + + +Installation +------------ + +The preferred way to install this extension is through [composer](http://getcomposer.org/download/). + +Either run + +``` +php composer.phar require --prefer-dist yii1tech/error-handler +``` + +or add + +```json +"yii1tech/error-handler": "*" +``` + +to the "require" section of your composer.json. + + +Usage +----- + +This extension provides Enhanced Error Handler for Yii1 application. \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..ddb9ed6 --- /dev/null +++ b/composer.json @@ -0,0 +1,39 @@ +{ + "name": "yii1tech/error-handler", + "description": "Provides Enhanced Error Handler for Yii1 application", + "keywords": ["yii1", "error", "handler", "exception"], + "license": "BSD-3-Clause", + "support": { + "issues": "https://github.com/yii1tech/error-handler/issues", + "wiki": "https://github.com/yii1tech/error-handler/wiki", + "source": "https://github.com/yii1tech/error-handler" + }, + "authors": [ + { + "name": "Paul Klimov", + "email": "klimov.paul@gmail.com" + } + ], + "require": { + "php": ">=7.2", + "yiisoft/yii": "~1.1.0" + }, + "require-dev": { + "phpunit/phpunit": "^6.0 || ^7.0 || ^8.0 || ^9.3 || ^10.0.7" + }, + "autoload": { + "psr-4": { + "yii1tech\\error\\handler\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "yii1tech\\error\\handler\\test\\": "tests" + } + }, + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + } +} \ No newline at end of file diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..69a0e24 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,15 @@ + + + + + ./tests + + + diff --git a/src/ErrorHandler.php b/src/ErrorHandler.php new file mode 100644 index 0000000..436f8d4 --- /dev/null +++ b/src/ErrorHandler.php @@ -0,0 +1,111 @@ + [ + * 'errorHandler', // override default error handler, allowing error to exception conversion + * // ... + * ], + * 'components' => [ + * 'errorHandler' => [ + * 'class' => \yii1tech\error\handler\ErrorHandler::class, + * ], + * // ... + * ], + * // ... + * ] + * ``` + * + * @author Paul Klimov + * @since 1.0 + */ +class ErrorHandler extends CErrorHandler +{ + /** + * @var bool whether to convert PHP Errors into Exceptions. + * @see \ErrorException + */ + public $convertErrorToException = true; + + /** + * {@inheritDoc} + */ + public function init() + { + parent::init(); + + if (YII_ENABLE_ERROR_HANDLER) { + restore_error_handler(); // unset default Yii error handler, which is set to {@see \CApplication::handleError()} + + set_error_handler([$this, 'handleErrorGlobal'], error_reporting()); + } + } + + /** + * Handles global PHP execution errors such as warnings, notices. + * + * This method is implemented as a PHP error handler. It requires + * that constant `YII_ENABLE_ERROR_HANDLER` be defined true. + * + * @param int $code the level of the error raised + * @param string $message the error message + * @param string $file the filename that the error was raised in + * @param int $line the line number the error was raised at + * @return bool whether the normal error handler continues. + */ + public function handleErrorGlobal(int $code, string $message, string $file, int $line): bool + { + if (!$this->convertErrorToException) { + Yii::app()->handleError($code, $message, $file, $line); + + return false; + } + + if (error_reporting() & $code) { + $exception = new ErrorException($message, $code, $code, $file, $line); + + $trace = debug_backtrace(); + array_shift($trace); + $this->setExceptionTrace($exception, $trace); + + if (PHP_VERSION_ID < 70400) { + // prior to PHP 7.4 we can't throw exceptions inside of __toString() - it will result a fatal error + foreach ($trace as $frame) { + if ($frame['function'] === '__toString') { + Yii::app()->handleException($exception); + + return false; + } + } + } + + throw $exception; + } + + return false; + } + + /** + * Sets up the trace for the given exception. + * + * > Note: exception trace can't be modified and used directly with PHP, thus a reflection is used here. + * + * @param \Exception $exception exception instance. + * @param array $trace new stack trace. + */ + protected function setExceptionTrace(\Exception $exception, array $trace): void + { + $traceReflection = new \ReflectionProperty(\Exception::class, 'trace'); + $traceReflection->setAccessible(true); + $traceReflection->setValue($exception, $trace); + } +} \ No newline at end of file diff --git a/tests/ErrorHandlerTest.php b/tests/ErrorHandlerTest.php new file mode 100644 index 0000000..27f6e68 --- /dev/null +++ b/tests/ErrorHandlerTest.php @@ -0,0 +1,24 @@ +withYiiErrorHandler(function () { + trigger_error('Test message', E_USER_WARNING); + }); + } catch (\Throwable $exception) {} + + $this->assertTrue(isset($exception)); + $this->assertSame('Test message', $exception->getMessage()); + $this->assertSame(E_USER_WARNING, $exception->getCode()); + + $trace = $exception->getTrace(); + + $this->assertSame('trigger_error', $trace[0]['function']); + $this->assertFalse(empty($trace[0]['args'])); + } +} \ No newline at end of file diff --git a/tests/TestCase.php b/tests/TestCase.php new file mode 100644 index 0000000..38821c3 --- /dev/null +++ b/tests/TestCase.php @@ -0,0 +1,101 @@ +mockApplication(); + } + + /** + * {@inheritdoc} + */ + protected function tearDown(): void + { + $this->destroyApplication(); + } + + /** + * Populates Yii::app() with a new application + * The application will be destroyed on tearDown() automatically. + * @param array $config The application configuration, if needed + * @param string $appClass name of the application class to create + */ + protected function mockApplication($config = [], $appClass = CConsoleApplication::class) + { + Yii::setApplication(null); + + new $appClass(CMap::mergeArray([ + 'id' => 'testapp', + 'basePath' => __DIR__, + 'components' => [ + 'errorHandler' => [ + 'class' => \yii1tech\error\handler\ErrorHandler::class, + ], + ], + ], $config)); + } + + /** + * Destroys Yii application by setting it to null. + */ + protected function destroyApplication() + { + Yii::setApplication(null); + } + + /** + * Registers Yii application error handler. + */ + protected function registerYiiErrorHandler(): void + { + error_reporting(-1); + + set_error_handler([Yii::app()->getErrorHandler(), 'handleErrorGlobal'], error_reporting()); + set_exception_handler([Yii::app(), 'handleException']); + } + + /** + * Restores previous error handler. + */ + protected function restoreErrorHandler(): void + { + restore_error_handler(); + restore_exception_handler(); + } + + /** + * Executes given PHP callback inside the scope of Yii error handler enabled. + * Restores original error handler afterwards. + * + * @param callable $callback PHP callback to be executed. + * @return mixed callback result. + */ + protected function withYiiErrorHandler(callable $callback) + { + $this->registerYiiErrorHandler(); + + try { + $result = call_user_func($callback); + } catch (\Throwable $exception) { + $this->restoreErrorHandler(); + + throw $exception; + } + + $this->restoreErrorHandler(); + + return $result; + } +} \ No newline at end of file diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..f238b2d --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,14 @@ +