Merge pull request #8 from mimmi20/master

upgrade to Monolog 3

Author: actived

.gitignore

@@ -47,3 +47,5 @@ Thumbs.db
 vendor/
 composer.lock
 
+# cache files
+.phpunit.result.cache

composer.json

@@ -24,13 +24,13 @@
       }
   },
   "require": {
-    "php": ">=7.2",
+    "php": "^8.1",
     "ext-curl": "*",
     "ext-json": "*",
-    "monolog/monolog": "^1.22|^2.0"
+    "monolog/monolog": "^3.1"
   },
   "require-dev": {
-    "phpstan/phpstan": "^0.12.87",
+    "phpstan/phpstan": "^1.8",
     "phpunit/phpunit": "^9.5"
   },
   "suggest": {

phpstan.neon

@@ -1,22 +1,24 @@
 parameters:
-    # level: there are 9 levels (0 is the loosest and 8/max is the strictest)
-    # 0: basic checks, unknown classes, unknown functions, unknown methods called on $this, wrong number of arguments passed to those methods and functions, always undefined variables
-    # 1: possibly undefined variables, unknown magic methods and properties on classes with __call and __get
-    # 2: unknown methods checked on all expressions (not just $this), validating PHPDocs
-    # 3: return types, types assigned to properties
-    # 4: basic dead code checking - always false instanceof and other type checks, dead else branches, unreachable code after return; etc.
-    # 5: checking types of arguments passed to methods and functions
-    # 6: report missing typehints
-    # 7: report partially wrong union types - if you call a method that only exists on some types in a union type, level 7 starts to report that; other possibly incorrect situations
-    # 8/max: report calling methods and accessing properties on nullable types
-    level: 8
-    paths:
-        - src
-    # TRUE: it doesn’t require typehints for properties if the types can be inferred from constructor injection
-    inferPrivatePropertyTypeFromConstructor: true
-
-    # FALSE: using level 6 to report missing typehints when array instead of int[] is fine
-    checkMissingIterableValueType: false
-
-    # FALSE: disable this strict approach to generics by setting
-    checkGenericClassInNonGenericObjectType: false
+  level: max
+  parallel:
+    maximumNumberOfProcesses: 1
+    processTimeout: 200.0
+  paths:
+    - src
+    - tests
+  scanFiles:
+    - %currentWorkingDirectory%/vendor/autoload.php
+  inferPrivatePropertyTypeFromConstructor: true
+  checkGenericClassInNonGenericObjectType: false
+  checkMissingIterableValueType: false
+  treatPhpDocTypesAsCertain: false
+  exceptions:
+    implicitThrows: false
+    checkedExceptionRegexes:
+      - '#Exception#'
+      - '#Throwable#'
+    check:
+      missingCheckedExceptionInThrows: true
+      tooWideThrowType: true
+#  ignoreErrors:
+#    - '~MockObject~'

phpunit.xml.dist

@@ -1,16 +1,46 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" colors="true" bootstrap="tests/bootstrap.php" stopOnFailure="true">
-  <coverage>
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
-  </coverage>
+
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        beStrictAboutChangesToGlobalState="true"
+        beStrictAboutCoversAnnotation="false"
+        beStrictAboutOutputDuringTests="true"
+        beStrictAboutTestsThatDoNotTestAnything="true"
+        beStrictAboutTodoAnnotatedTests="true"
+        beStrictAboutResourceUsageDuringSmallTests="true"
+        convertDeprecationsToExceptions="true"
+        failOnEmptyTestSuite="true"
+        failOnIncomplete="true"
+        failOnRisky="false"
+        failOnSkipped="false"
+        failOnWarning="true"
+        verbose="false"
+        bootstrap="vendor/autoload.php"
+        enforceTimeLimit="false"
+        executionOrder="default"
+        resolveDependencies="true"
+        colors="true"
+>
+  <php>
+    <ini name="date.timezone" value="UTC"/>
+    <env name="TEST_WEBHOOK_DSN" value="https://webhook2/uuid@uuid/IncomingWebhook/id/uuid"/>
+  </php>
+
   <testsuites>
     <testsuite name="MicrosoftTeamsNotifier Test">
       <directory>tests/</directory>
     </testsuite>
   </testsuites>
-  <php>
-    <env name="TEST_WEBHOOK_DSN" value="https://webhook2/uuid@uuid/IncomingWebhook/id/uuid"/>
-  </php>
+
+  <coverage includeUncoveredFiles="true" processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+    <report>
+      <text outputFile="php://stdout" showUncoveredFiles="true" showOnlySummary="false"/>
+    </report>
+  </coverage>
 </phpunit>

src/Handler/MicrosoftTeamsHandler.php

@@ -14,42 +14,46 @@
 use Monolog\Formatter\FormatterInterface;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\AbstractProcessingHandler;
+use Monolog\Level;
 use Monolog\Logger;
+use Monolog\LogRecord;
+use Psr\Log\LogLevel;
 
 class MicrosoftTeamsHandler extends AbstractProcessingHandler
 {
     /**
      * MicrosoftTeams Webhook DSN
      * @var string
      */
-    private $webhookDsn;
+    private string $webhookDsn;
 
     /**
      * Instance of the MicrosoftTeamsRecord
      * @var MicrosoftTeamsRecord
      */
-    private $microsoftTeamsRecord;
+    private MicrosoftTeamsRecord $microsoftTeamsRecord;
 
     /**
      * Format of the message
      * @var string|null
      */
-    private $format;
+    private ?string $format;
 
     /**
-     * MicrosoftTeamsHandler constructor.
      * @param string $webhookDsn
+     * @param int|string|Level $level
      * @param string $title
      * @param string $subject
      * @param string|null $emoji
      * @param string|null $color
      * @param string|null $format
-     * @param mixed $level
      * @param bool $bubble
+     *
+     * @phpstan-param value-of<Level::VALUES>|value-of<Level::NAMES>|Level|LogLevel::* $level
      */
     public function __construct(
         string $webhookDsn,
-        $level = Logger::DEBUG,
+        int|string|Level $level = Level::Debug,
         string $title = 'Message',
         string $subject = 'Date',
         ?string $emoji = null,
@@ -90,12 +94,15 @@ public function getMicrosoftTeamsRecord(): MicrosoftTeamsRecord
     }
 
     /**
-     * {@inheritdoc}
+     * Writes the (already formatted) record down to the log of the implementing handler
+     *
+     * @throws \RuntimeException
      */
-    protected function write(array $record): void
+    protected function write(LogRecord $record): void
     {
         $postData = $this->microsoftTeamsRecord->setData($record)->getData();
         $dataString = json_encode($postData);
+
         $ch = curl_init();
 
         curl_setopt($ch, CURLOPT_URL, $this->webhookDsn);
@@ -109,21 +116,24 @@ protected function write(array $record): void
     }
 
     /**
-     * @param mixed $ch
+     * @param \CurlHandle $ch
      * @param int $repeat
      * @return bool|string
+     * @throws \RuntimeException
      */
-    public static function execute($ch, int $repeat = 3)
+    public static function execute(\CurlHandle $ch, int $repeat = 3): bool|string
     {
         while ($repeat--) {
             $response = curl_exec($ch);
 
             if (false === $response) {
-                if(!$repeat){
+                if (!$repeat) {
                     $errno = curl_errno($ch);
                     $error = curl_error($ch);
+
                     throw new \RuntimeException(sprintf('Curl error %d: %s', $errno, $error));
                 }
+
                 continue;
             }