Skip to content

Turn on logging for deprecation notices by default#6773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulbalandan merged 6 commits into from
Nov 1, 2022
Merged

Turn on logging for deprecation notices by default #6773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
618640f
Turn on logging for deprecations as default
paulbalandan Oct 28, 2022
45cda74
Move faker deprecation check
paulbalandan Oct 28, 2022
f94d834
Update documentations
paulbalandan Oct 28, 2022
89c96f5
Adjust ExceptionsTest
paulbalandan Oct 28, 2022
6716c5a
Adjust property name
paulbalandan Oct 28, 2022
c97227a
Make logger threshold to be environment-specific
paulbalandan Nov 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions app/Config/Exceptions.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,13 +60,13 @@ class Exceptions extends BaseConfig
* Use this option to temporarily cease the warnings and instead log those.
* This option also works for user deprecations.
*/
public bool $logDeprecationsOnly = false;
public bool $logDeprecations = true;

/**
* --------------------------------------------------------------------------
* LOG LEVEL THRESHOLD FOR DEPRECATIONS
* --------------------------------------------------------------------------
* If `$logDeprecationsOnly` is set to `true`, this sets the log level
* If `$logDeprecations` is set to `true`, this sets the log level
* to which the deprecation will be logged. This should be one of the log
* levels recognized by PSR-3.
*
Expand Down
2 changes: 1 addition & 1 deletion app/Config/Logger.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ class Logger extends BaseConfig
*
* @var array|int
*/
public $threshold = 4;
public $threshold = (ENVIRONMENT === 'production') ? 4 : 9;

/**
* --------------------------------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions phpunit.xml.dist
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@

<php>
<server name="app.baseURL" value="http://example.com/"/>
<server name="CODEIGNITER_SCREAM_DEPRECATIONS" value="1"/>
<!-- Directory containing phpunit.xml -->
<const name="HOMEPATH" value="./"/>
<!-- Directory containing the Paths config file -->
Expand Down
26 changes: 14 additions & 12 deletions system/Debug/Exceptions.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,8 +83,8 @@ public function __construct(ExceptionsConfig $config, $request, ResponseInterfac
if (! isset($this->config->sensitiveDataInTrace)) {
$this->config->sensitiveDataInTrace = [];
}
if (! isset($this->config->logDeprecationsOnly, $this->config->deprecationLogLevel)) {
$this->config->logDeprecationsOnly = false;
if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
$this->config->logDeprecations = false;
$this->config->deprecationLogLevel = LogLevel::WARNING;
}
}
Expand DownExpand Up@@ -158,17 +158,20 @@ public function exceptionHandler(Throwable $exception)
*/
public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
{
if ($this->isDeprecationError($severity) && $this->config->logDeprecationsOnly) {
return $this->handleDeprecationError($message, $file, $line);
}

if (error_reporting() & $severity) {
if ($this->isDeprecationError($severity)) {
// @TODO Remove if Faker is fixed.
if ($this->isFakerDeprecationError($severity, $message, $file, $line)) {
// Ignore the error.
if ($this->isFakerDeprecationError($message, $file, $line)) {
return true;
}

if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
throw new ErrorException($message, 0, $severity, $file, $line);
}

return $this->handleDeprecationError($message, $file, $line);
}

if (error_reporting() & $severity) {
throw new ErrorException($message, 0, $severity, $file, $line);
}

Expand All@@ -180,11 +183,10 @@ public function errorHandler(int $severity, string $message, ?string $file = nul
*
* @see https://github.com/FakerPHP/Faker/issues/479
*/
private function isFakerDeprecationError(int $severity, string $message, ?string $file = null, ?int $line = null)
private function isFakerDeprecationError(string $message, ?string $file = null, ?int $line = null)
{
if (
$severity === E_DEPRECATED
&& strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
&& $message === 'Use of "static" in callables is deprecated'
) {
log_message(
Expand Down
18 changes: 16 additions & 2 deletions tests/system/Debug/ExceptionsTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,20 @@ final class ExceptionsTest extends CIUnitTestCase

private \CodeIgniter\Debug\Exceptions $exception;

public static function setUpBeforeClass(): void
{
parent::setUpBeforeClass();

unset($_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS']);
}

public static function tearDownAfterClass(): void
{
parent::tearDownAfterClass();

$_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS'] = '1';
}

protected function setUp(): void
{
parent::setUp();
Expand All@@ -45,7 +59,7 @@ public function testDeprecationsOnPhp81DoNotThrow(): void
{
$config = new ExceptionsConfig();

$config->logDeprecationsOnly = true;
$config->logDeprecations = true;
$config->deprecationLogLevel = 'error';

$this->exception = new Exceptions($config, Services::request(), Services::response());
Expand All@@ -69,7 +83,7 @@ public function testSuppressedDeprecationsAreLogged(): void
{
$config = new ExceptionsConfig();

$config->logDeprecationsOnly = true;
$config->logDeprecations = true;
$config->deprecationLogLevel = 'error';

$this->exception = new Exceptions($config, Services::request(), Services::response());
Expand Down
6 changes: 4 additions & 2 deletions user_guide_src/source/changelogs/v4.3.0.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -221,7 +221,10 @@ Helpers and Functions
Error Handling
==============

- You can now log deprecation errors instead of throwing them. See :ref:`logging_deprecation_errors` for details.
- You can now log deprecation warnings instead of throwing exceptions. See :ref:`logging_deprecation_warnings` for details.
- Logging of deprecations is turned on by default.
- To *temporarily* enable throwing of deprecations, set the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
- ``Config\Logger::$threshold`` is now, by default, environment-specific. For production environment, default threshold is still ``4`` but changed to ``9`` for other environments.

Others
======
Expand DownExpand Up@@ -270,4 +273,3 @@ Bugs Fixed
**********

- Fixed a bug when all types of ``Prepared Queries`` were returning a ``Result`` object instead of a bool value for write-type queries.

9 changes: 6 additions & 3 deletions user_guide_src/source/general/errors.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,10 +134,10 @@ Since v4.3.0, you can specify the exit code for your Exception class to implemen

When an exception implementing ``HasExitCodeInterface`` is caught by CodeIgniter's exception handler, the code returned from the ``getExitCode()`` method will become the exit code.

.. _logging_deprecation_errors:
.. _logging_deprecation_warnings:

Logging Deprecation Errors
==========================
Logging Deprecation Warnings
============================

.. versionadded:: 4.3.0

Expand All@@ -161,3 +161,6 @@ After that, subsequent deprecations will be logged instead of thrown.
This feature also works with user deprecations:

.. literalinclude:: errors/014.php

For testing your application you may want to always throw on deprecations. You may configure this by
setting the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
2 changes: 1 addition & 1 deletion user_guide_src/source/general/errors/012.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ class Exceptions extends BaseConfig
{
// ... other properties

public bool $logDeprecationsOnly = true;
public bool $logDeprecations = true;
public string $deprecationLogLevel = LogLevel::WARNING; // this should be one of the log levels supported by PSR-3
}
2 changes: 1 addition & 1 deletion user_guide_src/source/installation/upgrade_430.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -178,7 +178,7 @@ The following files received significant changes (including deprecations or visu
and it is recommended that you merge the updated versions with your application:

* ``app/Config/Exceptions.php``
* Two additional public properties were added: ``$logDeprecationsOnly`` and ``$deprecationLogLevel``.
* Two additional public properties were added: ``$logDeprecations`` and ``$deprecationLogLevel``.
* ``app/Config/Routes.php``
* Due to the fact that the approach to running Spark Commands has changed, there is no longer a need to load the internal routes of the framework.

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Turn on logging for deprecation notices by default by paulbalandan · Pull Request #6773 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
Turn on logging for deprecation notices by default#6773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 6 commits into

from

Nov 1, 2022
 Merged


Turn on logging for deprecation notices by default
#6773
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
618640f

Turn on logging for deprecations as default


paulbalandan Oct 28, 2022
45cda74

Move faker deprecation check


paulbalandan Oct 28, 2022
f94d834

Update documentations


paulbalandan Oct 28, 2022
89c96f5

Adjust ExceptionsTest


paulbalandan Oct 28, 2022
6716c5a

Adjust property name


paulbalandan Oct 28, 2022
c97227a

Make logger threshold to be environment-specific


paulbalandan Nov 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
app/Config/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,13 +60,13 @@ class Exceptions extends BaseConfig
 * Use this option to temporarily cease the warnings and instead log those.
 * This option also works for user deprecations.
 */
 public bool $logDeprecationsOnly = false;
 public bool $logDeprecations = true;

 /**
 * --------------------------------------------------------------------------
 * LOG LEVEL THRESHOLD FOR DEPRECATIONS
 * --------------------------------------------------------------------------
 * If `$logDeprecationsOnly` is set to `true`, this sets the log level
 * If `$logDeprecations` is set to `true`, this sets the log level
 * to which the deprecation will be logged. This should be one of the log
 * levels recognized by PSR-3.
 *
Expand Down

2 changes: 1 addition & 1 deletion
app/Config/Logger.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ class Logger extends BaseConfig
 *
 * @var array|int
 */
 public $threshold = 4;
 public $threshold = (ENVIRONMENT === 'production') ? 4 : 9;

 /**
 * --------------------------------------------------------------------------
Expand Down

1 change: 1 addition & 0 deletions
phpunit.xml.dist

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@

 <php>
 <server name="app.baseURL" value="http://example.com/"/>
 <server name="CODEIGNITER_SCREAM_DEPRECATIONS" value="1"/>
 <!-- Directory containing phpunit.xml -->
 <const name="HOMEPATH" value="./"/>
 <!-- Directory containing the Paths config file -->
Expand Down

26 changes: 14 additions & 12 deletions
system/Debug/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,8 +83,8 @@ public function __construct(ExceptionsConfig $config, $request, ResponseInterfac
 if (! isset($this->config->sensitiveDataInTrace)) {
 $this->config->sensitiveDataInTrace = [];
 }
 if (! isset($this->config->logDeprecationsOnly, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecationsOnly = false;
 if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecations  = false;
 $this->config->deprecationLogLevel = LogLevel::WARNING;
 }
 }
Expand DownExpand Up@@ -158,17 +158,20 @@ public function exceptionHandler(Throwable $exception)
 */
 public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
 {
 if ($this->isDeprecationError($severity) && $this->config->logDeprecationsOnly) {
 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 if ($this->isDeprecationError($severity)) {
 // @TODO Remove if Faker is fixed.
 if ($this->isFakerDeprecationError($severity, $message, $file, $line)) {
 // Ignore the error.
 if ($this->isFakerDeprecationError($message, $file, $line)) {
 return true;
 }

 if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

Expand All@@ -180,11 +183,10 @@ public function errorHandler(int $severity, string $message, ?string $file = nul
 *
 * @see https://github.com/FakerPHP/Faker/issues/479
 */
 private function isFakerDeprecationError(int $severity, string $message, ?string $file = null, ?int $line = null)
 private function isFakerDeprecationError(string $message, ?string $file = null, ?int $line = null)
 {
 if (
 $severity === E_DEPRECATED
 && strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 && $message === 'Use of "static" in callables is deprecated'
 ) {
 log_message(
Expand Down

18 changes: 16 additions & 2 deletions
tests/system/Debug/ExceptionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,20 @@ final class ExceptionsTest extends CIUnitTestCase

 private \CodeIgniter\Debug\Exceptions $exception;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 unset($_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS']);
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 $_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS'] = '1';
 }

 protected function setUp(): void
 {
 parent::setUp();
Expand All@@ -45,7 +59,7 @@ public function testDeprecationsOnPhp81DoNotThrow(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand All@@ -69,7 +83,7 @@ public function testSuppressedDeprecationsAreLogged(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand Down

6 changes: 4 additions & 2 deletions
user_guide_src/source/changelogs/v4.3.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,7 +221,10 @@ Helpers and Functions
Error Handling
==============

- You can now log deprecation errors instead of throwing them. See :ref:`logging_deprecation_errors` for details.
- You can now log deprecation warnings instead of throwing exceptions. See :ref:`logging_deprecation_warnings` for details.
- Logging of deprecations is turned on by default.
- To *temporarily* enable throwing of deprecations, set the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
- ``Config\Logger::$threshold`` is now, by default, environment-specific. For production environment, default threshold is still ``4`` but changed to ``9`` for other environments.

Others
======
Expand DownExpand Up@@ -270,4 +273,3 @@ Bugs Fixed
**********

- Fixed a bug when all types of ``Prepared Queries`` were returning a ``Result`` object instead of a bool value for write-type queries.


9 changes: 6 additions & 3 deletions
user_guide_src/source/general/errors.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,10 +134,10 @@ Since v4.3.0, you can specify the exit code for your Exception class to implemen

When an exception implementing ``HasExitCodeInterface`` is caught by CodeIgniter's exception handler, the code returned from the ``getExitCode()`` method will become the exit code.

.. _logging_deprecation_errors:
.. _logging_deprecation_warnings:

Logging Deprecation Errors
==========================
Logging Deprecation Warnings
============================

.. versionadded:: 4.3.0

Expand All@@ -161,3 +161,6 @@ After that, subsequent deprecations will be logged instead of thrown.
This feature also works with user deprecations:

.. literalinclude:: errors/014.php

For testing your application you may want to always throw on deprecations. You may configure this by
setting the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.

2 changes: 1 addition & 1 deletion
user_guide_src/source/general/errors/012.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ class Exceptions extends BaseConfig
{
 // ... other properties

 public bool $logDeprecationsOnly = true;
 public bool $logDeprecations  = true;
 public string $deprecationLogLevel = LogLevel::WARNING; // this should be one of the log levels supported by PSR-3
}

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/upgrade_430.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -178,7 +178,7 @@ The following files received significant changes (including deprecations or visu
and it is recommended that you merge the updated versions with your application:

* ``app/Config/Exceptions.php``
 * Two additional public properties were added: ``$logDeprecationsOnly`` and ``$deprecationLogLevel``.
 * Two additional public properties were added: ``$logDeprecations`` and ``$deprecationLogLevel``.
* ``app/Config/Routes.php``
 * Due to the fact that the approach to running Spark Commands has changed, there is no longer a need to load the internal routes of the framework.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Turn on logging for deprecation notices by default by paulbalandan · Pull Request #6773 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
Turn on logging for deprecation notices by default#6773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 6 commits into

from

Nov 1, 2022
 Merged


Turn on logging for deprecation notices by default
#6773
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
618640f

Turn on logging for deprecations as default


paulbalandan Oct 28, 2022
45cda74

Move faker deprecation check


paulbalandan Oct 28, 2022
f94d834

Update documentations


paulbalandan Oct 28, 2022
89c96f5

Adjust ExceptionsTest


paulbalandan Oct 28, 2022
6716c5a

Adjust property name


paulbalandan Oct 28, 2022
c97227a

Make logger threshold to be environment-specific


paulbalandan Nov 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
app/Config/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,13 +60,13 @@ class Exceptions extends BaseConfig
 * Use this option to temporarily cease the warnings and instead log those.
 * This option also works for user deprecations.
 */
 public bool $logDeprecationsOnly = false;
 public bool $logDeprecations = true;

 /**
 * --------------------------------------------------------------------------
 * LOG LEVEL THRESHOLD FOR DEPRECATIONS
 * --------------------------------------------------------------------------
 * If `$logDeprecationsOnly` is set to `true`, this sets the log level
 * If `$logDeprecations` is set to `true`, this sets the log level
 * to which the deprecation will be logged. This should be one of the log
 * levels recognized by PSR-3.
 *
Expand Down

2 changes: 1 addition & 1 deletion
app/Config/Logger.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ class Logger extends BaseConfig
 *
 * @var array|int
 */
 public $threshold = 4;
 public $threshold = (ENVIRONMENT === 'production') ? 4 : 9;

 /**
 * --------------------------------------------------------------------------
Expand Down

1 change: 1 addition & 0 deletions
phpunit.xml.dist

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@

 <php>
 <server name="app.baseURL" value="http://example.com/"/>
 <server name="CODEIGNITER_SCREAM_DEPRECATIONS" value="1"/>
 <!-- Directory containing phpunit.xml -->
 <const name="HOMEPATH" value="./"/>
 <!-- Directory containing the Paths config file -->
Expand Down

26 changes: 14 additions & 12 deletions
system/Debug/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,8 +83,8 @@ public function __construct(ExceptionsConfig $config, $request, ResponseInterfac
 if (! isset($this->config->sensitiveDataInTrace)) {
 $this->config->sensitiveDataInTrace = [];
 }
 if (! isset($this->config->logDeprecationsOnly, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecationsOnly = false;
 if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecations  = false;
 $this->config->deprecationLogLevel = LogLevel::WARNING;
 }
 }
Expand DownExpand Up@@ -158,17 +158,20 @@ public function exceptionHandler(Throwable $exception)
 */
 public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
 {
 if ($this->isDeprecationError($severity) && $this->config->logDeprecationsOnly) {
 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 if ($this->isDeprecationError($severity)) {
 // @TODO Remove if Faker is fixed.
 if ($this->isFakerDeprecationError($severity, $message, $file, $line)) {
 // Ignore the error.
 if ($this->isFakerDeprecationError($message, $file, $line)) {
 return true;
 }

 if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

Expand All@@ -180,11 +183,10 @@ public function errorHandler(int $severity, string $message, ?string $file = nul
 *
 * @see https://github.com/FakerPHP/Faker/issues/479
 */
 private function isFakerDeprecationError(int $severity, string $message, ?string $file = null, ?int $line = null)
 private function isFakerDeprecationError(string $message, ?string $file = null, ?int $line = null)
 {
 if (
 $severity === E_DEPRECATED
 && strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 && $message === 'Use of "static" in callables is deprecated'
 ) {
 log_message(
Expand Down

18 changes: 16 additions & 2 deletions
tests/system/Debug/ExceptionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,20 @@ final class ExceptionsTest extends CIUnitTestCase

 private \CodeIgniter\Debug\Exceptions $exception;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 unset($_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS']);
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 $_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS'] = '1';
 }

 protected function setUp(): void
 {
 parent::setUp();
Expand All@@ -45,7 +59,7 @@ public function testDeprecationsOnPhp81DoNotThrow(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand All@@ -69,7 +83,7 @@ public function testSuppressedDeprecationsAreLogged(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand Down

6 changes: 4 additions & 2 deletions
user_guide_src/source/changelogs/v4.3.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,7 +221,10 @@ Helpers and Functions
Error Handling
==============

- You can now log deprecation errors instead of throwing them. See :ref:`logging_deprecation_errors` for details.
- You can now log deprecation warnings instead of throwing exceptions. See :ref:`logging_deprecation_warnings` for details.
- Logging of deprecations is turned on by default.
- To *temporarily* enable throwing of deprecations, set the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
- ``Config\Logger::$threshold`` is now, by default, environment-specific. For production environment, default threshold is still ``4`` but changed to ``9`` for other environments.

Others
======
Expand DownExpand Up@@ -270,4 +273,3 @@ Bugs Fixed
**********

- Fixed a bug when all types of ``Prepared Queries`` were returning a ``Result`` object instead of a bool value for write-type queries.


9 changes: 6 additions & 3 deletions
user_guide_src/source/general/errors.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,10 +134,10 @@ Since v4.3.0, you can specify the exit code for your Exception class to implemen

When an exception implementing ``HasExitCodeInterface`` is caught by CodeIgniter's exception handler, the code returned from the ``getExitCode()`` method will become the exit code.

.. _logging_deprecation_errors:
.. _logging_deprecation_warnings:

Logging Deprecation Errors
==========================
Logging Deprecation Warnings
============================

.. versionadded:: 4.3.0

Expand All@@ -161,3 +161,6 @@ After that, subsequent deprecations will be logged instead of thrown.
This feature also works with user deprecations:

.. literalinclude:: errors/014.php

For testing your application you may want to always throw on deprecations. You may configure this by
setting the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.

2 changes: 1 addition & 1 deletion
user_guide_src/source/general/errors/012.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ class Exceptions extends BaseConfig
{
 // ... other properties

 public bool $logDeprecationsOnly = true;
 public bool $logDeprecations  = true;
 public string $deprecationLogLevel = LogLevel::WARNING; // this should be one of the log levels supported by PSR-3
}

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/upgrade_430.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -178,7 +178,7 @@ The following files received significant changes (including deprecations or visu
and it is recommended that you merge the updated versions with your application:

* ``app/Config/Exceptions.php``
 * Two additional public properties were added: ``$logDeprecationsOnly`` and ``$deprecationLogLevel``.
 * Two additional public properties were added: ``$logDeprecations`` and ``$deprecationLogLevel``.
* ``app/Config/Routes.php``
 * Due to the fact that the approach to running Spark Commands has changed, there is no longer a need to load the internal routes of the framework.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Turn on logging for deprecation notices by default by paulbalandan · Pull Request #6773 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
Turn on logging for deprecation notices by default#6773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 6 commits into

from

Nov 1, 2022
 Merged


Turn on logging for deprecation notices by default
#6773
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
618640f

Turn on logging for deprecations as default


paulbalandan Oct 28, 2022
45cda74

Move faker deprecation check


paulbalandan Oct 28, 2022
f94d834

Update documentations


paulbalandan Oct 28, 2022
89c96f5

Adjust ExceptionsTest


paulbalandan Oct 28, 2022
6716c5a

Adjust property name


paulbalandan Oct 28, 2022
c97227a

Make logger threshold to be environment-specific


paulbalandan Nov 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
app/Config/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,13 +60,13 @@ class Exceptions extends BaseConfig
 * Use this option to temporarily cease the warnings and instead log those.
 * This option also works for user deprecations.
 */
 public bool $logDeprecationsOnly = false;
 public bool $logDeprecations = true;

 /**
 * --------------------------------------------------------------------------
 * LOG LEVEL THRESHOLD FOR DEPRECATIONS
 * --------------------------------------------------------------------------
 * If `$logDeprecationsOnly` is set to `true`, this sets the log level
 * If `$logDeprecations` is set to `true`, this sets the log level
 * to which the deprecation will be logged. This should be one of the log
 * levels recognized by PSR-3.
 *
Expand Down

2 changes: 1 addition & 1 deletion
app/Config/Logger.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ class Logger extends BaseConfig
 *
 * @var array|int
 */
 public $threshold = 4;
 public $threshold = (ENVIRONMENT === 'production') ? 4 : 9;

 /**
 * --------------------------------------------------------------------------
Expand Down

1 change: 1 addition & 0 deletions
phpunit.xml.dist

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@

 <php>
 <server name="app.baseURL" value="http://example.com/"/>
 <server name="CODEIGNITER_SCREAM_DEPRECATIONS" value="1"/>
 <!-- Directory containing phpunit.xml -->
 <const name="HOMEPATH" value="./"/>
 <!-- Directory containing the Paths config file -->
Expand Down

26 changes: 14 additions & 12 deletions
system/Debug/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,8 +83,8 @@ public function __construct(ExceptionsConfig $config, $request, ResponseInterfac
 if (! isset($this->config->sensitiveDataInTrace)) {
 $this->config->sensitiveDataInTrace = [];
 }
 if (! isset($this->config->logDeprecationsOnly, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecationsOnly = false;
 if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecations  = false;
 $this->config->deprecationLogLevel = LogLevel::WARNING;
 }
 }
Expand DownExpand Up@@ -158,17 +158,20 @@ public function exceptionHandler(Throwable $exception)
 */
 public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
 {
 if ($this->isDeprecationError($severity) && $this->config->logDeprecationsOnly) {
 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 if ($this->isDeprecationError($severity)) {
 // @TODO Remove if Faker is fixed.
 if ($this->isFakerDeprecationError($severity, $message, $file, $line)) {
 // Ignore the error.
 if ($this->isFakerDeprecationError($message, $file, $line)) {
 return true;
 }

 if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

Expand All@@ -180,11 +183,10 @@ public function errorHandler(int $severity, string $message, ?string $file = nul
 *
 * @see https://github.com/FakerPHP/Faker/issues/479
 */
 private function isFakerDeprecationError(int $severity, string $message, ?string $file = null, ?int $line = null)
 private function isFakerDeprecationError(string $message, ?string $file = null, ?int $line = null)
 {
 if (
 $severity === E_DEPRECATED
 && strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 && $message === 'Use of "static" in callables is deprecated'
 ) {
 log_message(
Expand Down

18 changes: 16 additions & 2 deletions
tests/system/Debug/ExceptionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,20 @@ final class ExceptionsTest extends CIUnitTestCase

 private \CodeIgniter\Debug\Exceptions $exception;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 unset($_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS']);
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 $_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS'] = '1';
 }

 protected function setUp(): void
 {
 parent::setUp();
Expand All@@ -45,7 +59,7 @@ public function testDeprecationsOnPhp81DoNotThrow(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand All@@ -69,7 +83,7 @@ public function testSuppressedDeprecationsAreLogged(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand Down

6 changes: 4 additions & 2 deletions
user_guide_src/source/changelogs/v4.3.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,7 +221,10 @@ Helpers and Functions
Error Handling
==============

- You can now log deprecation errors instead of throwing them. See :ref:`logging_deprecation_errors` for details.
- You can now log deprecation warnings instead of throwing exceptions. See :ref:`logging_deprecation_warnings` for details.
- Logging of deprecations is turned on by default.
- To *temporarily* enable throwing of deprecations, set the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
- ``Config\Logger::$threshold`` is now, by default, environment-specific. For production environment, default threshold is still ``4`` but changed to ``9`` for other environments.

Others
======
Expand DownExpand Up@@ -270,4 +273,3 @@ Bugs Fixed
**********

- Fixed a bug when all types of ``Prepared Queries`` were returning a ``Result`` object instead of a bool value for write-type queries.


9 changes: 6 additions & 3 deletions
user_guide_src/source/general/errors.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,10 +134,10 @@ Since v4.3.0, you can specify the exit code for your Exception class to implemen

When an exception implementing ``HasExitCodeInterface`` is caught by CodeIgniter's exception handler, the code returned from the ``getExitCode()`` method will become the exit code.

.. _logging_deprecation_errors:
.. _logging_deprecation_warnings:

Logging Deprecation Errors
==========================
Logging Deprecation Warnings
============================

.. versionadded:: 4.3.0

Expand All@@ -161,3 +161,6 @@ After that, subsequent deprecations will be logged instead of thrown.
This feature also works with user deprecations:

.. literalinclude:: errors/014.php

For testing your application you may want to always throw on deprecations. You may configure this by
setting the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.

2 changes: 1 addition & 1 deletion
user_guide_src/source/general/errors/012.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ class Exceptions extends BaseConfig
{
 // ... other properties

 public bool $logDeprecationsOnly = true;
 public bool $logDeprecations  = true;
 public string $deprecationLogLevel = LogLevel::WARNING; // this should be one of the log levels supported by PSR-3
}

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/upgrade_430.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -178,7 +178,7 @@ The following files received significant changes (including deprecations or visu
and it is recommended that you merge the updated versions with your application:

* ``app/Config/Exceptions.php``
 * Two additional public properties were added: ``$logDeprecationsOnly`` and ``$deprecationLogLevel``.
 * Two additional public properties were added: ``$logDeprecations`` and ``$deprecationLogLevel``.
* ``app/Config/Routes.php``
 * Due to the fact that the approach to running Spark Commands has changed, there is no longer a need to load the internal routes of the framework.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Turn on logging for deprecation notices by default by paulbalandan · Pull Request #6773 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
Turn on logging for deprecation notices by default#6773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 6 commits into

from

Nov 1, 2022
 Merged


Turn on logging for deprecation notices by default
#6773
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
618640f

Turn on logging for deprecations as default


paulbalandan Oct 28, 2022
45cda74

Move faker deprecation check


paulbalandan Oct 28, 2022
f94d834

Update documentations


paulbalandan Oct 28, 2022
89c96f5

Adjust ExceptionsTest


paulbalandan Oct 28, 2022
6716c5a

Adjust property name


paulbalandan Oct 28, 2022
c97227a

Make logger threshold to be environment-specific


paulbalandan Nov 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
app/Config/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,13 +60,13 @@ class Exceptions extends BaseConfig
 * Use this option to temporarily cease the warnings and instead log those.
 * This option also works for user deprecations.
 */
 public bool $logDeprecationsOnly = false;
 public bool $logDeprecations = true;

 /**
 * --------------------------------------------------------------------------
 * LOG LEVEL THRESHOLD FOR DEPRECATIONS
 * --------------------------------------------------------------------------
 * If `$logDeprecationsOnly` is set to `true`, this sets the log level
 * If `$logDeprecations` is set to `true`, this sets the log level
 * to which the deprecation will be logged. This should be one of the log
 * levels recognized by PSR-3.
 *
Expand Down

2 changes: 1 addition & 1 deletion
app/Config/Logger.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ class Logger extends BaseConfig
 *
 * @var array|int
 */
 public $threshold = 4;
 public $threshold = (ENVIRONMENT === 'production') ? 4 : 9;

 /**
 * --------------------------------------------------------------------------
Expand Down

1 change: 1 addition & 0 deletions
phpunit.xml.dist

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@

 <php>
 <server name="app.baseURL" value="http://example.com/"/>
 <server name="CODEIGNITER_SCREAM_DEPRECATIONS" value="1"/>
 <!-- Directory containing phpunit.xml -->
 <const name="HOMEPATH" value="./"/>
 <!-- Directory containing the Paths config file -->
Expand Down

26 changes: 14 additions & 12 deletions
system/Debug/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,8 +83,8 @@ public function __construct(ExceptionsConfig $config, $request, ResponseInterfac
 if (! isset($this->config->sensitiveDataInTrace)) {
 $this->config->sensitiveDataInTrace = [];
 }
 if (! isset($this->config->logDeprecationsOnly, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecationsOnly = false;
 if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecations  = false;
 $this->config->deprecationLogLevel = LogLevel::WARNING;
 }
 }
Expand DownExpand Up@@ -158,17 +158,20 @@ public function exceptionHandler(Throwable $exception)
 */
 public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
 {
 if ($this->isDeprecationError($severity) && $this->config->logDeprecationsOnly) {
 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 if ($this->isDeprecationError($severity)) {
 // @TODO Remove if Faker is fixed.
 if ($this->isFakerDeprecationError($severity, $message, $file, $line)) {
 // Ignore the error.
 if ($this->isFakerDeprecationError($message, $file, $line)) {
 return true;
 }

 if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

Expand All@@ -180,11 +183,10 @@ public function errorHandler(int $severity, string $message, ?string $file = nul
 *
 * @see https://github.com/FakerPHP/Faker/issues/479
 */
 private function isFakerDeprecationError(int $severity, string $message, ?string $file = null, ?int $line = null)
 private function isFakerDeprecationError(string $message, ?string $file = null, ?int $line = null)
 {
 if (
 $severity === E_DEPRECATED
 && strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 && $message === 'Use of "static" in callables is deprecated'
 ) {
 log_message(
Expand Down

18 changes: 16 additions & 2 deletions
tests/system/Debug/ExceptionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,20 @@ final class ExceptionsTest extends CIUnitTestCase

 private \CodeIgniter\Debug\Exceptions $exception;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 unset($_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS']);
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 $_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS'] = '1';
 }

 protected function setUp(): void
 {
 parent::setUp();
Expand All@@ -45,7 +59,7 @@ public function testDeprecationsOnPhp81DoNotThrow(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand All@@ -69,7 +83,7 @@ public function testSuppressedDeprecationsAreLogged(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand Down

6 changes: 4 additions & 2 deletions
user_guide_src/source/changelogs/v4.3.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,7 +221,10 @@ Helpers and Functions
Error Handling
==============

- You can now log deprecation errors instead of throwing them. See :ref:`logging_deprecation_errors` for details.
- You can now log deprecation warnings instead of throwing exceptions. See :ref:`logging_deprecation_warnings` for details.
- Logging of deprecations is turned on by default.
- To *temporarily* enable throwing of deprecations, set the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
- ``Config\Logger::$threshold`` is now, by default, environment-specific. For production environment, default threshold is still ``4`` but changed to ``9`` for other environments.

Others
======
Expand DownExpand Up@@ -270,4 +273,3 @@ Bugs Fixed
**********

- Fixed a bug when all types of ``Prepared Queries`` were returning a ``Result`` object instead of a bool value for write-type queries.


9 changes: 6 additions & 3 deletions
user_guide_src/source/general/errors.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,10 +134,10 @@ Since v4.3.0, you can specify the exit code for your Exception class to implemen

When an exception implementing ``HasExitCodeInterface`` is caught by CodeIgniter's exception handler, the code returned from the ``getExitCode()`` method will become the exit code.

.. _logging_deprecation_errors:
.. _logging_deprecation_warnings:

Logging Deprecation Errors
==========================
Logging Deprecation Warnings
============================

.. versionadded:: 4.3.0

Expand All@@ -161,3 +161,6 @@ After that, subsequent deprecations will be logged instead of thrown.
This feature also works with user deprecations:

.. literalinclude:: errors/014.php

For testing your application you may want to always throw on deprecations. You may configure this by
setting the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.

2 changes: 1 addition & 1 deletion
user_guide_src/source/general/errors/012.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ class Exceptions extends BaseConfig
{
 // ... other properties

 public bool $logDeprecationsOnly = true;
 public bool $logDeprecations  = true;
 public string $deprecationLogLevel = LogLevel::WARNING; // this should be one of the log levels supported by PSR-3
}

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/upgrade_430.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -178,7 +178,7 @@ The following files received significant changes (including deprecations or visu
and it is recommended that you merge the updated versions with your application:

* ``app/Config/Exceptions.php``
 * Two additional public properties were added: ``$logDeprecationsOnly`` and ``$deprecationLogLevel``.
 * Two additional public properties were added: ``$logDeprecations`` and ``$deprecationLogLevel``.
* ``app/Config/Routes.php``
 * Due to the fact that the approach to running Spark Commands has changed, there is no longer a need to load the internal routes of the framework.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Turn on logging for deprecation notices by default by paulbalandan · Pull Request #6773 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
Turn on logging for deprecation notices by default#6773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 6 commits into

from

Nov 1, 2022
 Merged


Turn on logging for deprecation notices by default
#6773
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
618640f

Turn on logging for deprecations as default


paulbalandan Oct 28, 2022
45cda74

Move faker deprecation check


paulbalandan Oct 28, 2022
f94d834

Update documentations


paulbalandan Oct 28, 2022
89c96f5

Adjust ExceptionsTest


paulbalandan Oct 28, 2022
6716c5a

Adjust property name


paulbalandan Oct 28, 2022
c97227a

Make logger threshold to be environment-specific


paulbalandan Nov 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
app/Config/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,13 +60,13 @@ class Exceptions extends BaseConfig
 * Use this option to temporarily cease the warnings and instead log those.
 * This option also works for user deprecations.
 */
 public bool $logDeprecationsOnly = false;
 public bool $logDeprecations = true;

 /**
 * --------------------------------------------------------------------------
 * LOG LEVEL THRESHOLD FOR DEPRECATIONS
 * --------------------------------------------------------------------------
 * If `$logDeprecationsOnly` is set to `true`, this sets the log level
 * If `$logDeprecations` is set to `true`, this sets the log level
 * to which the deprecation will be logged. This should be one of the log
 * levels recognized by PSR-3.
 *
Expand Down

2 changes: 1 addition & 1 deletion
app/Config/Logger.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ class Logger extends BaseConfig
 *
 * @var array|int
 */
 public $threshold = 4;
 public $threshold = (ENVIRONMENT === 'production') ? 4 : 9;

 /**
 * --------------------------------------------------------------------------
Expand Down

1 change: 1 addition & 0 deletions
phpunit.xml.dist

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@

 <php>
 <server name="app.baseURL" value="http://example.com/"/>
 <server name="CODEIGNITER_SCREAM_DEPRECATIONS" value="1"/>
 <!-- Directory containing phpunit.xml -->
 <const name="HOMEPATH" value="./"/>
 <!-- Directory containing the Paths config file -->
Expand Down

26 changes: 14 additions & 12 deletions
system/Debug/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,8 +83,8 @@ public function __construct(ExceptionsConfig $config, $request, ResponseInterfac
 if (! isset($this->config->sensitiveDataInTrace)) {
 $this->config->sensitiveDataInTrace = [];
 }
 if (! isset($this->config->logDeprecationsOnly, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecationsOnly = false;
 if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecations  = false;
 $this->config->deprecationLogLevel = LogLevel::WARNING;
 }
 }
Expand DownExpand Up@@ -158,17 +158,20 @@ public function exceptionHandler(Throwable $exception)
 */
 public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
 {
 if ($this->isDeprecationError($severity) && $this->config->logDeprecationsOnly) {
 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 if ($this->isDeprecationError($severity)) {
 // @TODO Remove if Faker is fixed.
 if ($this->isFakerDeprecationError($severity, $message, $file, $line)) {
 // Ignore the error.
 if ($this->isFakerDeprecationError($message, $file, $line)) {
 return true;
 }

 if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

Expand All@@ -180,11 +183,10 @@ public function errorHandler(int $severity, string $message, ?string $file = nul
 *
 * @see https://github.com/FakerPHP/Faker/issues/479
 */
 private function isFakerDeprecationError(int $severity, string $message, ?string $file = null, ?int $line = null)
 private function isFakerDeprecationError(string $message, ?string $file = null, ?int $line = null)
 {
 if (
 $severity === E_DEPRECATED
 && strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 && $message === 'Use of "static" in callables is deprecated'
 ) {
 log_message(
Expand Down

18 changes: 16 additions & 2 deletions
tests/system/Debug/ExceptionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,20 @@ final class ExceptionsTest extends CIUnitTestCase

 private \CodeIgniter\Debug\Exceptions $exception;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 unset($_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS']);
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 $_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS'] = '1';
 }

 protected function setUp(): void
 {
 parent::setUp();
Expand All@@ -45,7 +59,7 @@ public function testDeprecationsOnPhp81DoNotThrow(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand All@@ -69,7 +83,7 @@ public function testSuppressedDeprecationsAreLogged(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand Down

6 changes: 4 additions & 2 deletions
user_guide_src/source/changelogs/v4.3.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,7 +221,10 @@ Helpers and Functions
Error Handling
==============

- You can now log deprecation errors instead of throwing them. See :ref:`logging_deprecation_errors` for details.
- You can now log deprecation warnings instead of throwing exceptions. See :ref:`logging_deprecation_warnings` for details.
- Logging of deprecations is turned on by default.
- To *temporarily* enable throwing of deprecations, set the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
- ``Config\Logger::$threshold`` is now, by default, environment-specific. For production environment, default threshold is still ``4`` but changed to ``9`` for other environments.

Others
======
Expand DownExpand Up@@ -270,4 +273,3 @@ Bugs Fixed
**********

- Fixed a bug when all types of ``Prepared Queries`` were returning a ``Result`` object instead of a bool value for write-type queries.


9 changes: 6 additions & 3 deletions
user_guide_src/source/general/errors.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,10 +134,10 @@ Since v4.3.0, you can specify the exit code for your Exception class to implemen

When an exception implementing ``HasExitCodeInterface`` is caught by CodeIgniter's exception handler, the code returned from the ``getExitCode()`` method will become the exit code.

.. _logging_deprecation_errors:
.. _logging_deprecation_warnings:

Logging Deprecation Errors
==========================
Logging Deprecation Warnings
============================

.. versionadded:: 4.3.0

Expand All@@ -161,3 +161,6 @@ After that, subsequent deprecations will be logged instead of thrown.
This feature also works with user deprecations:

.. literalinclude:: errors/014.php

For testing your application you may want to always throw on deprecations. You may configure this by
setting the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.

2 changes: 1 addition & 1 deletion
user_guide_src/source/general/errors/012.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ class Exceptions extends BaseConfig
{
 // ... other properties

 public bool $logDeprecationsOnly = true;
 public bool $logDeprecations  = true;
 public string $deprecationLogLevel = LogLevel::WARNING; // this should be one of the log levels supported by PSR-3
}

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/upgrade_430.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -178,7 +178,7 @@ The following files received significant changes (including deprecations or visu
and it is recommended that you merge the updated versions with your application:

* ``app/Config/Exceptions.php``
 * Two additional public properties were added: ``$logDeprecationsOnly`` and ``$deprecationLogLevel``.
 * Two additional public properties were added: ``$logDeprecations`` and ``$deprecationLogLevel``.
* ``app/Config/Routes.php``
 * Due to the fact that the approach to running Spark Commands has changed, there is no longer a need to load the internal routes of the framework.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Turn on logging for deprecation notices by default by paulbalandan · Pull Request #6773 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
Turn on logging for deprecation notices by default#6773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 6 commits into

from

Nov 1, 2022
 Merged


Turn on logging for deprecation notices by default
#6773
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
618640f

Turn on logging for deprecations as default


paulbalandan Oct 28, 2022
45cda74

Move faker deprecation check


paulbalandan Oct 28, 2022
f94d834

Update documentations


paulbalandan Oct 28, 2022
89c96f5

Adjust ExceptionsTest


paulbalandan Oct 28, 2022
6716c5a

Adjust property name


paulbalandan Oct 28, 2022
c97227a

Make logger threshold to be environment-specific


paulbalandan Nov 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
app/Config/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,13 +60,13 @@ class Exceptions extends BaseConfig
 * Use this option to temporarily cease the warnings and instead log those.
 * This option also works for user deprecations.
 */
 public bool $logDeprecationsOnly = false;
 public bool $logDeprecations = true;

 /**
 * --------------------------------------------------------------------------
 * LOG LEVEL THRESHOLD FOR DEPRECATIONS
 * --------------------------------------------------------------------------
 * If `$logDeprecationsOnly` is set to `true`, this sets the log level
 * If `$logDeprecations` is set to `true`, this sets the log level
 * to which the deprecation will be logged. This should be one of the log
 * levels recognized by PSR-3.
 *
Expand Down

2 changes: 1 addition & 1 deletion
app/Config/Logger.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ class Logger extends BaseConfig
 *
 * @var array|int
 */
 public $threshold = 4;
 public $threshold = (ENVIRONMENT === 'production') ? 4 : 9;

 /**
 * --------------------------------------------------------------------------
Expand Down

1 change: 1 addition & 0 deletions
phpunit.xml.dist

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@

 <php>
 <server name="app.baseURL" value="http://example.com/"/>
 <server name="CODEIGNITER_SCREAM_DEPRECATIONS" value="1"/>
 <!-- Directory containing phpunit.xml -->
 <const name="HOMEPATH" value="./"/>
 <!-- Directory containing the Paths config file -->
Expand Down

26 changes: 14 additions & 12 deletions
system/Debug/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,8 +83,8 @@ public function __construct(ExceptionsConfig $config, $request, ResponseInterfac
 if (! isset($this->config->sensitiveDataInTrace)) {
 $this->config->sensitiveDataInTrace = [];
 }
 if (! isset($this->config->logDeprecationsOnly, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecationsOnly = false;
 if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecations  = false;
 $this->config->deprecationLogLevel = LogLevel::WARNING;
 }
 }
Expand DownExpand Up@@ -158,17 +158,20 @@ public function exceptionHandler(Throwable $exception)
 */
 public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
 {
 if ($this->isDeprecationError($severity) && $this->config->logDeprecationsOnly) {
 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 if ($this->isDeprecationError($severity)) {
 // @TODO Remove if Faker is fixed.
 if ($this->isFakerDeprecationError($severity, $message, $file, $line)) {
 // Ignore the error.
 if ($this->isFakerDeprecationError($message, $file, $line)) {
 return true;
 }

 if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

Expand All@@ -180,11 +183,10 @@ public function errorHandler(int $severity, string $message, ?string $file = nul
 *
 * @see https://github.com/FakerPHP/Faker/issues/479
 */
 private function isFakerDeprecationError(int $severity, string $message, ?string $file = null, ?int $line = null)
 private function isFakerDeprecationError(string $message, ?string $file = null, ?int $line = null)
 {
 if (
 $severity === E_DEPRECATED
 && strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 && $message === 'Use of "static" in callables is deprecated'
 ) {
 log_message(
Expand Down

18 changes: 16 additions & 2 deletions
tests/system/Debug/ExceptionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,20 @@ final class ExceptionsTest extends CIUnitTestCase

 private \CodeIgniter\Debug\Exceptions $exception;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 unset($_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS']);
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 $_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS'] = '1';
 }

 protected function setUp(): void
 {
 parent::setUp();
Expand All@@ -45,7 +59,7 @@ public function testDeprecationsOnPhp81DoNotThrow(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand All@@ -69,7 +83,7 @@ public function testSuppressedDeprecationsAreLogged(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand Down

6 changes: 4 additions & 2 deletions
user_guide_src/source/changelogs/v4.3.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,7 +221,10 @@ Helpers and Functions
Error Handling
==============

- You can now log deprecation errors instead of throwing them. See :ref:`logging_deprecation_errors` for details.
- You can now log deprecation warnings instead of throwing exceptions. See :ref:`logging_deprecation_warnings` for details.
- Logging of deprecations is turned on by default.
- To *temporarily* enable throwing of deprecations, set the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
- ``Config\Logger::$threshold`` is now, by default, environment-specific. For production environment, default threshold is still ``4`` but changed to ``9`` for other environments.

Others
======
Expand DownExpand Up@@ -270,4 +273,3 @@ Bugs Fixed
**********

- Fixed a bug when all types of ``Prepared Queries`` were returning a ``Result`` object instead of a bool value for write-type queries.


9 changes: 6 additions & 3 deletions
user_guide_src/source/general/errors.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,10 +134,10 @@ Since v4.3.0, you can specify the exit code for your Exception class to implemen

When an exception implementing ``HasExitCodeInterface`` is caught by CodeIgniter's exception handler, the code returned from the ``getExitCode()`` method will become the exit code.

.. _logging_deprecation_errors:
.. _logging_deprecation_warnings:

Logging Deprecation Errors
==========================
Logging Deprecation Warnings
============================

.. versionadded:: 4.3.0

Expand All@@ -161,3 +161,6 @@ After that, subsequent deprecations will be logged instead of thrown.
This feature also works with user deprecations:

.. literalinclude:: errors/014.php

For testing your application you may want to always throw on deprecations. You may configure this by
setting the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.

2 changes: 1 addition & 1 deletion
user_guide_src/source/general/errors/012.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ class Exceptions extends BaseConfig
{
 // ... other properties

 public bool $logDeprecationsOnly = true;
 public bool $logDeprecations  = true;
 public string $deprecationLogLevel = LogLevel::WARNING; // this should be one of the log levels supported by PSR-3
}

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/upgrade_430.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -178,7 +178,7 @@ The following files received significant changes (including deprecations or visu
and it is recommended that you merge the updated versions with your application:

* ``app/Config/Exceptions.php``
 * Two additional public properties were added: ``$logDeprecationsOnly`` and ``$deprecationLogLevel``.
 * Two additional public properties were added: ``$logDeprecations`` and ``$deprecationLogLevel``.
* ``app/Config/Routes.php``
 * Due to the fact that the approach to running Spark Commands has changed, there is no longer a need to load the internal routes of the framework.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Turn on logging for deprecation notices by default by paulbalandan · Pull Request #6773 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
Turn on logging for deprecation notices by default#6773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 6 commits into

from

Nov 1, 2022
 Merged


Turn on logging for deprecation notices by default
#6773
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
618640f

Turn on logging for deprecations as default


paulbalandan Oct 28, 2022
45cda74

Move faker deprecation check


paulbalandan Oct 28, 2022
f94d834

Update documentations


paulbalandan Oct 28, 2022
89c96f5

Adjust ExceptionsTest


paulbalandan Oct 28, 2022
6716c5a

Adjust property name


paulbalandan Oct 28, 2022
c97227a

Make logger threshold to be environment-specific


paulbalandan Nov 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
app/Config/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,13 +60,13 @@ class Exceptions extends BaseConfig
 * Use this option to temporarily cease the warnings and instead log those.
 * This option also works for user deprecations.
 */
 public bool $logDeprecationsOnly = false;
 public bool $logDeprecations = true;

 /**
 * --------------------------------------------------------------------------
 * LOG LEVEL THRESHOLD FOR DEPRECATIONS
 * --------------------------------------------------------------------------
 * If `$logDeprecationsOnly` is set to `true`, this sets the log level
 * If `$logDeprecations` is set to `true`, this sets the log level
 * to which the deprecation will be logged. This should be one of the log
 * levels recognized by PSR-3.
 *
Expand Down

2 changes: 1 addition & 1 deletion
app/Config/Logger.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ class Logger extends BaseConfig
 *
 * @var array|int
 */
 public $threshold = 4;
 public $threshold = (ENVIRONMENT === 'production') ? 4 : 9;

 /**
 * --------------------------------------------------------------------------
Expand Down

1 change: 1 addition & 0 deletions
phpunit.xml.dist

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@

 <php>
 <server name="app.baseURL" value="http://example.com/"/>
 <server name="CODEIGNITER_SCREAM_DEPRECATIONS" value="1"/>
 <!-- Directory containing phpunit.xml -->
 <const name="HOMEPATH" value="./"/>
 <!-- Directory containing the Paths config file -->
Expand Down

26 changes: 14 additions & 12 deletions
system/Debug/Exceptions.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,8 +83,8 @@ public function __construct(ExceptionsConfig $config, $request, ResponseInterfac
 if (! isset($this->config->sensitiveDataInTrace)) {
 $this->config->sensitiveDataInTrace = [];
 }
 if (! isset($this->config->logDeprecationsOnly, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecationsOnly = false;
 if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
 $this->config->logDeprecations  = false;
 $this->config->deprecationLogLevel = LogLevel::WARNING;
 }
 }
Expand DownExpand Up@@ -158,17 +158,20 @@ public function exceptionHandler(Throwable $exception)
 */
 public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
 {
 if ($this->isDeprecationError($severity) && $this->config->logDeprecationsOnly) {
 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 if ($this->isDeprecationError($severity)) {
 // @TODO Remove if Faker is fixed.
 if ($this->isFakerDeprecationError($severity, $message, $file, $line)) {
 // Ignore the error.
 if ($this->isFakerDeprecationError($message, $file, $line)) {
 return true;
 }

 if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

 return $this->handleDeprecationError($message, $file, $line);
 }

 if (error_reporting() & $severity) {
 throw new ErrorException($message, 0, $severity, $file, $line);
 }

Expand All@@ -180,11 +183,10 @@ public function errorHandler(int $severity, string $message, ?string $file = nul
 *
 * @see https://github.com/FakerPHP/Faker/issues/479
 */
 private function isFakerDeprecationError(int $severity, string $message, ?string $file = null, ?int $line = null)
 private function isFakerDeprecationError(string $message, ?string $file = null, ?int $line = null)
 {
 if (
 $severity === E_DEPRECATED
 && strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 strpos($file, VENDORPATH . 'fakerphp/faker/') !== false
 && $message === 'Use of "static" in callables is deprecated'
 ) {
 log_message(
Expand Down

18 changes: 16 additions & 2 deletions
tests/system/Debug/ExceptionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,20 @@ final class ExceptionsTest extends CIUnitTestCase

 private \CodeIgniter\Debug\Exceptions $exception;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 unset($_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS']);
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 $_SERVER['CODEIGNITER_SCREAM_DEPRECATIONS'] = '1';
 }

 protected function setUp(): void
 {
 parent::setUp();
Expand All@@ -45,7 +59,7 @@ public function testDeprecationsOnPhp81DoNotThrow(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand All@@ -69,7 +83,7 @@ public function testSuppressedDeprecationsAreLogged(): void
 {
 $config = new ExceptionsConfig();

 $config->logDeprecationsOnly = true;
 $config->logDeprecations  = true;
 $config->deprecationLogLevel = 'error';

 $this->exception = new Exceptions($config, Services::request(), Services::response());
Expand Down

6 changes: 4 additions & 2 deletions
user_guide_src/source/changelogs/v4.3.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,7 +221,10 @@ Helpers and Functions
Error Handling
==============

- You can now log deprecation errors instead of throwing them. See :ref:`logging_deprecation_errors` for details.
- You can now log deprecation warnings instead of throwing exceptions. See :ref:`logging_deprecation_warnings` for details.
- Logging of deprecations is turned on by default.
- To *temporarily* enable throwing of deprecations, set the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.
- ``Config\Logger::$threshold`` is now, by default, environment-specific. For production environment, default threshold is still ``4`` but changed to ``9`` for other environments.

Others
======
Expand DownExpand Up@@ -270,4 +273,3 @@ Bugs Fixed
**********

- Fixed a bug when all types of ``Prepared Queries`` were returning a ``Result`` object instead of a bool value for write-type queries.


9 changes: 6 additions & 3 deletions
user_guide_src/source/general/errors.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,10 +134,10 @@ Since v4.3.0, you can specify the exit code for your Exception class to implemen

When an exception implementing ``HasExitCodeInterface`` is caught by CodeIgniter's exception handler, the code returned from the ``getExitCode()`` method will become the exit code.

.. _logging_deprecation_errors:
.. _logging_deprecation_warnings:

Logging Deprecation Errors
==========================
Logging Deprecation Warnings
============================

.. versionadded:: 4.3.0

Expand All@@ -161,3 +161,6 @@ After that, subsequent deprecations will be logged instead of thrown.
This feature also works with user deprecations:

.. literalinclude:: errors/014.php

For testing your application you may want to always throw on deprecations. You may configure this by
setting the environment variable ``CODEIGNITER_SCREAM_DEPRECATIONS`` to a truthy value.

2 changes: 1 addition & 1 deletion
user_guide_src/source/general/errors/012.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ class Exceptions extends BaseConfig
{
 // ... other properties

 public bool $logDeprecationsOnly = true;
 public bool $logDeprecations  = true;
 public string $deprecationLogLevel = LogLevel::WARNING; // this should be one of the log levels supported by PSR-3
}

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/upgrade_430.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -178,7 +178,7 @@ The following files received significant changes (including deprecations or visu
and it is recommended that you merge the updated versions with your application:

* ``app/Config/Exceptions.php``
 * Two additional public properties were added: ``$logDeprecationsOnly`` and ``$deprecationLogLevel``.
 * Two additional public properties were added: ``$logDeprecations`` and ``$deprecationLogLevel``.
* ``app/Config/Routes.php``
 * Due to the fact that the approach to running Spark Commands has changed, there is no longer a need to load the internal routes of the framework.

Expand Down