Composer Workspace global packages

vendor/doctrine/deprecations/README.md

@@ -19,13 +19,16 @@ Enable Doctrine deprecations to be sent to a PSR3 logger:
 ```
 
 Enable Doctrine deprecations to be sent as `@trigger_error($message, E_USER_DEPRECATED)`
-messages.
+messages by setting the `DOCTRINE_DEPRECATIONS` environment variable to `trigger`.
+Alternatively, call:
 
 ```php
 \Doctrine\Deprecations\Deprecation::enableWithTriggerError();
 ```
 
-If you only want to enable deprecation tracking, without logging or calling `trigger_error` then call:
+If you only want to enable deprecation tracking, without logging or calling `trigger_error`
+then set the `DOCTRINE_DEPRECATIONS` environment variable to `track`.
+Alternatively, call:
 
 ```php
 \Doctrine\Deprecations\Deprecation::enableTrackingDeprecations();

vendor/doctrine/deprecations/composer.json

@@ -1,22 +1,28 @@
 {
     "name": "doctrine/deprecations",
-    "type": "library",
     "description": "A small layer on top of trigger_error(E_USER_DEPRECATED) or PSR-3 logging with options to disable all deprecations or selectively for packages.",
-    "homepage": "https://www.doctrine-project.org/",
     "license": "MIT",
+    "type": "library",
+    "homepage": "https://www.doctrine-project.org/",
     "require": {
-        "php": "^7.1|^8.0"
+        "php": "^7.1 || ^8.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5|^8.5|^9.5",
-        "psr/log": "^1|^2|^3",
-        "doctrine/coding-standard": "^9"
+        "doctrine/coding-standard": "^9",
+        "phpstan/phpstan": "1.4.10 || 1.10.15",
+        "phpstan/phpstan-phpunit": "^1.0",
+        "phpunit/phpunit": "^7.5 || ^8.5 || ^9.5",
+        "psalm/plugin-phpunit": "0.18.4",
+        "psr/log": "^1 || ^2 || ^3",
+        "vimeo/psalm": "4.30.0 || 5.12.0"
     },
     "suggest": {
         "psr/log": "Allows logging deprecations via PSR-3 logger implementation"
     },
     "autoload": {
-        "psr-4": {"Doctrine\\Deprecations\\": "lib/Doctrine/Deprecations"}
+        "psr-4": {
+            "Doctrine\\Deprecations\\": "lib/Doctrine/Deprecations"
+        }
     },
     "autoload-dev": {
         "psr-4": {

vendor/doctrine/deprecations/lib/Doctrine/Deprecations/Deprecation.php

@@ -8,6 +8,7 @@ use Psr\Log\LoggerInterface;
 
 use function array_key_exists;
 use function array_reduce;
+use function assert;
 use function debug_backtrace;
 use function sprintf;
 use function strpos;
@@ -46,8 +47,8 @@ class Deprecation
     private const TYPE_TRIGGER_ERROR      = 2;
     private const TYPE_PSR_LOGGER         = 4;
 
-    /** @var int */
-    private static $type = self::TYPE_NONE;
+    /** @var int-mask-of<self::TYPE_*>|null */
+    private static $type;
 
     /** @var LoggerInterface|null */
     private static $logger;
@@ -56,6 +57,9 @@ class Deprecation
     private static $ignoredPackages = [];
 
     /** @var array<string,int> */
+    private static $triggeredDeprecations = [];
+
+    /** @var array<string,bool> */
     private static $ignoredLinks = [];
 
     /** @var bool */
@@ -68,21 +72,27 @@ class Deprecation
      * deprecation. It is additionally used to de-duplicate the trigger of the
      * same deprecation during a request.
      *
-     * @param mixed $args
+     * @param float|int|string $args
      */
     public static function trigger(string $package, string $link, string $message, ...$args): void
     {
-        if (self::$type === self::TYPE_NONE) {
+        $type = self::$type ?? self::getTypeFromEnv();
+
+        if ($type === self::TYPE_NONE) {
             return;
         }
 
-        if (array_key_exists($link, self::$ignoredLinks)) {
-            self::$ignoredLinks[$link]++;
-        } else {
-            self::$ignoredLinks[$link] = 1;
+        if (isset(self::$ignoredLinks[$link])) {
+            return;
         }
 
-        if (self::$deduplication === true && self::$ignoredLinks[$link] > 1) {
+        if (array_key_exists($link, self::$triggeredDeprecations)) {
+            self::$triggeredDeprecations[$link]++;
+        } else {
+            self::$triggeredDeprecations[$link] = 1;
+        }
+
+        if (self::$deduplication === true && self::$triggeredDeprecations[$link] > 1) {
             return;
         }
 
@@ -114,18 +124,20 @@ class Deprecation
      * deprecation tracking is enabled even during deduplication, because it
      * needs to call {@link debug_backtrace()}
      *
-     * @param mixed $args
+     * @param float|int|string $args
      */
     public static function triggerIfCalledFromOutside(string $package, string $link, string $message, ...$args): void
     {
-        if (self::$type === self::TYPE_NONE) {
+        $type = self::$type ?? self::getTypeFromEnv();
+
+        if ($type === self::TYPE_NONE) {
             return;
         }
 
         $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
 
         // first check that the caller is not from a tests folder, in which case we always let deprecations pass
-        if (strpos($backtrace[1]['file'], DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR) === false) {
+        if (isset($backtrace[1]['file'], $backtrace[0]['file']) && strpos($backtrace[1]['file'], DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR) === false) {
             $path = DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . $package . DIRECTORY_SEPARATOR;
 
             if (strpos($backtrace[0]['file'], $path) === false) {
@@ -137,13 +149,17 @@ class Deprecation
             }
         }
 
-        if (array_key_exists($link, self::$ignoredLinks)) {
-            self::$ignoredLinks[$link]++;
-        } else {
-            self::$ignoredLinks[$link] = 1;
+        if (isset(self::$ignoredLinks[$link])) {
+            return;
         }
 
-        if (self::$deduplication === true && self::$ignoredLinks[$link] > 1) {
+        if (array_key_exists($link, self::$triggeredDeprecations)) {
+            self::$triggeredDeprecations[$link]++;
+        } else {
+            self::$triggeredDeprecations[$link] = 1;
+        }
+
+        if (self::$deduplication === true && self::$triggeredDeprecations[$link] > 1) {
             return;
         }
 
@@ -157,31 +173,35 @@ class Deprecation
     }
 
     /**
-     * @param array<mixed> $backtrace
+     * @param list<array{function: string, line?: int, file?: string, class?: class-string, type?: string, args?: mixed[], object?: object}> $backtrace
      */
     private static function delegateTriggerToBackend(string $message, array $backtrace, string $link, string $package): void
     {
-        if ((self::$type & self::TYPE_PSR_LOGGER) > 0) {
+        $type = self::$type ?? self::getTypeFromEnv();
+
+        if (($type & self::TYPE_PSR_LOGGER) > 0) {
             $context = [
-                'file' => $backtrace[0]['file'],
-                'line' => $backtrace[0]['line'],
+                'file' => $backtrace[0]['file'] ?? null,
+                'line' => $backtrace[0]['line'] ?? null,
                 'package' => $package,
                 'link' => $link,
             ];
 
+            assert(self::$logger !== null);
+
             self::$logger->notice($message, $context);
         }
 
-        if (! ((self::$type & self::TYPE_TRIGGER_ERROR) > 0)) {
+        if (! (($type & self::TYPE_TRIGGER_ERROR) > 0)) {
             return;
         }
 
         $message .= sprintf(
             ' (%s:%d called by %s:%d, %s, package %s)',
-            self::basename($backtrace[0]['file']),
-            $backtrace[0]['line'],
-            self::basename($backtrace[1]['file']),
-            $backtrace[1]['line'],
+            self::basename($backtrace[0]['file'] ?? 'native code'),
+            $backtrace[0]['line'] ?? 0,
+            self::basename($backtrace[1]['file'] ?? 'native code'),
+            $backtrace[1]['line'] ?? 0,
             $link,
             $package
         );
@@ -205,16 +225,19 @@ class Deprecation
 
     public static function enableTrackingDeprecations(): void
     {
+        self::$type  = self::$type ?? 0;
         self::$type |= self::TYPE_TRACK_DEPRECATIONS;
     }
 
     public static function enableWithTriggerError(): void
     {
+        self::$type  = self::$type ?? 0;
         self::$type |= self::TYPE_TRIGGER_ERROR;
     }
 
     public static function enableWithPsrLogger(LoggerInterface $logger): void
     {
+        self::$type   = self::$type ?? 0;
         self::$type  |= self::TYPE_PSR_LOGGER;
         self::$logger = $logger;
     }
@@ -229,9 +252,10 @@ class Deprecation
         self::$type          = self::TYPE_NONE;
         self::$logger        = null;
         self::$deduplication = true;
+        self::$ignoredLinks  = [];
 
-        foreach (self::$ignoredLinks as $link => $count) {
-            self::$ignoredLinks[$link] = 0;
+        foreach (self::$triggeredDeprecations as $link => $count) {
+            self::$triggeredDeprecations[$link] = 0;
         }
     }
 
@@ -243,13 +267,13 @@ class Deprecation
     public static function ignoreDeprecations(string ...$links): void
     {
         foreach ($links as $link) {
-            self::$ignoredLinks[$link] = 0;
+            self::$ignoredLinks[$link] = true;
         }
     }
 
     public static function getUniqueTriggeredDeprecationsCount(): int
     {
-        return array_reduce(self::$ignoredLinks, static function (int $carry, int $count) {
+        return array_reduce(self::$triggeredDeprecations, static function (int $carry, int $count) {
             return $carry + $count;
         }, 0);
     }
@@ -261,6 +285,28 @@ class Deprecation
      */
     public static function getTriggeredDeprecations(): array
     {
-        return self::$ignoredLinks;
+        return self::$triggeredDeprecations;
+    }
+
+    /**
+     * @return int-mask-of<self::TYPE_*>
+     */
+    private static function getTypeFromEnv(): int
+    {
+        switch ($_SERVER['DOCTRINE_DEPRECATIONS'] ?? $_ENV['DOCTRINE_DEPRECATIONS'] ?? null) {
+            case 'trigger':
+                self::$type = self::TYPE_TRIGGER_ERROR;
+                break;
+
+            case 'track':
+                self::$type = self::TYPE_TRACK_DEPRECATIONS;
+                break;
+
+            default:
+                self::$type = self::TYPE_NONE;
+                break;
+        }
+
+        return self::$type;
     }
 }

vendor/doctrine/deprecations/phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+    level: 6
+    paths:
+        - lib
+        - tests
+
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-phpunit/rules.neon

vendor/doctrine/deprecations/psalm.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+>
+    <projectFiles>
+        <directory name="lib/Doctrine/Deprecations" />
+        <directory name="tests/Doctrine/Deprecations" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+    <plugins>
+        <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
+    </plugins>
+    <issueHandlers>
+        <DeprecatedMethod>
+            <errorLevel type="suppress">
+                <!-- Remove when dropping support for PHPUnit 9.6 -->
+                <referencedMethod name="PHPUnit\Framework\TestCase::expectDeprecation"/>
+                <referencedMethod name="PHPUnit\Framework\TestCase::expectDeprecationMessage"/>
+            </errorLevel>
+        </DeprecatedMethod>
+    </issueHandlers>
+</psalm>