Add types for the Monolog integration (#1493)

Author: stof

psalm.baseline.xml

@@ -114,6 +114,11 @@
       <code><![CDATA[$this->app]]></code>
     </UndefinedInterfaceMethod>
   </file>
+  <file src="src/Integration/Monolog/CloudWatch/src/CloudWatchLogsHandler.php">
+    <InvalidOperand>
+      <code><![CDATA[$entry['datetime']->format('U.u')]]></code>
+    </InvalidOperand>
+  </file>
   <file src="src/Integration/Symfony/Bundle/src/DependencyInjection/Configuration.php">
     <PossiblyNullReference>
       <code>scalarNode</code>

src/Integration/Monolog/CloudWatch/src/CloudWatchLogsHandler.php

@@ -11,6 +11,9 @@
 use Monolog\Handler\AbstractProcessingHandler;
 use Monolog\Logger;
 
+/**
+ * @phpstan-import-type FormattedRecord from AbstractProcessingHandler
+ */
 class CloudWatchLogsHandler extends AbstractProcessingHandler
 {
     /**
@@ -38,12 +41,16 @@ class CloudWatchLogsHandler extends AbstractProcessingHandler
     private $client;
 
     /**
-     * @var array
+     * @var array{
+     *   batchSize: int,
+     *   group: string,
+     *   stream: string,
+     * }
      */
     private $options;
 
     /**
-     * @var array
+     * @var array<array{message: string, timestamp: int|float}>
      */
     private $buffer = [];
 
@@ -78,15 +85,14 @@ class CloudWatchLogsHandler extends AbstractProcessingHandler
      *   stream: string,
      * } $options
      * @param int|string $level
-     * @param bool       $bubble
      *
      * @throws \InvalidArgumentException
      */
     public function __construct(
         CloudWatchLogsClient $client,
-        $options,
+        array $options,
         $level = Logger::DEBUG,
-        $bubble = true
+        bool $bubble = true
     ) {
         $options['batchSize'] = $options['batchSize'] ?? 10000;
 
@@ -123,8 +129,6 @@ protected function getDefaultFormatter(): FormatterInterface
 
     /**
      * {@inheritdoc}
-     *
-     * @phpstan-ignore-next-line
      */
     protected function write(array $record): void
     {
@@ -183,6 +187,10 @@ private function flushBuffer(): void
     /**
      * Event size in the batch can not be bigger than 256 KB
      * https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html.
+     *
+     * @phpstan-param FormattedRecord $entry
+     *
+     * @return list<array{message: string, timestamp: int|float}>
      */
     private function formatRecords(array $entry): array
     {
@@ -203,9 +211,9 @@ private function formatRecords(array $entry): array
     /**
      * http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html.
      *
-     * @param array $record
+     * @param array{message: string, timestamp: int|float} $record
      */
-    private function getMessageSize($record): int
+    private function getMessageSize(array $record): int
     {
         return \strlen($record['message']) + 26;
     }
@@ -220,6 +228,8 @@ private function getMessageSize($record): int
      * expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC).
      *  - The maximum number of log events in a batch is 10,000.
      *  - A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
+     *
+     * @param array<array{message: string, timestamp: int|float}> $entries
      */
     private function send(array $entries): void
     {