Fix review comments

Author: Seb33300

src/Monolog/Handler/Teams/TeamsRecord.php renamed to src/Monolog/Handler/Teams/TeamsPayload.php

@@ -22,8 +22,10 @@
  *
  * @author Sébastien Alfaiate <[email protected]>
  * @see    https://learn.microsoft.com/adaptive-cards/authoring-cards/getting-started
+ *
+ * @internal
  */
-class TeamsRecord
+class TeamsPayload
 {
     public const COLOR_ATTENTION = 'attention';
 
@@ -33,53 +35,34 @@ class TeamsRecord
 
     public const COLOR_DEFAULT = 'default';
 
-    /**
-     * Whether the card should include context and extra data
-     */
-    private bool $includeContextAndExtra;
-
-    /**
-     * Dot separated list of fields to exclude from MS Teams message. E.g. ['context.field1', 'extra.field2']
-     * @var string[]
-     */
-    private array $excludeFields;
-
-    /**
-     * Dot separated list of fields to display with a toggle button in MS Teams message. E.g. ['context.field1', 'extra.field2']
-     * @var string[]
-     */
-    private array $toggleFields;
-
-    private FormatterInterface|null $formatter;
-
     private NormalizerFormatter $normalizerFormatter;
 
     /**
-     * @param string[] $excludeFields
-     * @param string[] $toggleFields
+     * @param bool     $includeContextAndExtra Whether the card should include context and extra data
+     * @param bool     $formatMessage          Whether the message should be formatted
+     * @param string[] $excludeFields          Dot separated list of fields to exclude from MS Teams message. E.g. ['context.field1', 'extra.field2']
+     * @param string[] $toggleFields           Dot separated list of fields to display with a toggle button in MS Teams message. E.g. ['context.field1', 'extra.field2']
      */
     public function __construct(
-        bool $includeContextAndExtra = false,
-        array $excludeFields = [],
-        array $toggleFields = [],
-        FormatterInterface|null $formatter = null
+        private bool $includeContextAndExtra = false,
+        private bool $formatMessage = false,
+        private array $excludeFields = [],
+        private array $toggleFields = [],
     ) {
-        $this
-            ->includeContextAndExtra($includeContextAndExtra)
-            ->excludeFields($excludeFields)
-            ->toggleFields($toggleFields)
-            ->setFormatter($formatter);
+        if ($this->includeContextAndExtra) {
+            $this->normalizerFormatter = new NormalizerFormatter();
+        }
     }
 
     /**
      * Returns required data in format that MS Teams is expecting.
      *
      * @phpstan-return mixed[]
      */
-    public function getAdaptiveCardPayload(LogRecord $record): array
+    public function getAdaptiveCardPayload(LogRecord $record, ?FormatterInterface $formatter = null): array
     {
-        if ($this->formatter !== null) {
-            $message = $this->formatter->format($record);
+        if ($formatter !== null && $this->formatMessage) {
+            $message = $formatter->format($record);
         } else {
             $message = $record->message;
         }
@@ -150,7 +133,7 @@ public function getAdaptiveCardPayload(LogRecord $record): array
     /**
      * Returns MS Teams container style associated with provided level.
      */
-    public function getContainerStyle(Level $level): string
+    private function getContainerStyle(Level $level): string
     {
         return match ($level) {
             Level::Error, Level::Critical, Level::Alert, Level::Emergency => static::COLOR_ATTENTION,
@@ -165,7 +148,7 @@ public function getContainerStyle(Level $level): string
      *
      * @param mixed[] $fields
      */
-    public function stringify(array $fields): string
+    private function stringify(array $fields): string
     {
         /** @var array<array<mixed>|bool|float|int|string|null> $normalized */
         $normalized = $this->normalizerFormatter->normalizeValue($fields);
@@ -178,52 +161,6 @@ public function stringify(array $fields): string
             : Utils::jsonEncode($normalized, Utils::DEFAULT_JSON_FLAGS);
     }
 
-    /**
-     * @return $this
-     */
-    public function includeContextAndExtra(bool $includeContextAndExtra = false): self
-    {
-        $this->includeContextAndExtra = $includeContextAndExtra;
-
-        if ($this->includeContextAndExtra) {
-            $this->normalizerFormatter = new NormalizerFormatter();
-        }
-
-        return $this;
-    }
-
-    /**
-     * @param  string[] $excludeFields
-     * @return $this
-     */
-    public function excludeFields(array $excludeFields = []): self
-    {
-        $this->excludeFields = $excludeFields;
-
-        return $this;
-    }
-
-    /**
-     * @param  string[] $toggleFields
-     * @return $this
-     */
-    public function toggleFields(array $toggleFields = []): self
-    {
-        $this->toggleFields = $toggleFields;
-
-        return $this;
-    }
-
-    /**
-     * @return $this
-     */
-    public function setFormatter(?FormatterInterface $formatter = null): self
-    {
-        $this->formatter = $formatter;
-
-        return $this;
-    }
-
     /**
      * Generates fact field
      *
@@ -308,6 +245,7 @@ private function generateContextAndExtraFields(array $data, string $type): array
     private function removeExcludedFields(LogRecord $record): array
     {
         $recordData = $record->toArray();
+
         foreach ($this->excludeFields as $field) {
             $keys = explode('.', $field);
             $node = &$recordData;

src/Monolog/Handler/TeamsWebhookHandler.php

@@ -11,10 +11,9 @@
 
 namespace Monolog\Handler;
 
-use Monolog\Formatter\FormatterInterface;
 use Monolog\Level;
 use Monolog\Utils;
-use Monolog\Handler\Teams\TeamsRecord;
+use Monolog\Handler\Teams\TeamsPayload;
 use Monolog\LogRecord;
 
 /**
@@ -34,9 +33,9 @@ class TeamsWebhookHandler extends AbstractProcessingHandler
     private string $webhookUrl;
 
     /**
-     * Instance of the TeamsRecord util class preparing data for MS Teams API.
+     * Instance of the TeamsPayload util class preparing data for MS Teams API.
      */
-    private TeamsRecord $teamsRecord;
+    private TeamsPayload $teamsPayload;
 
     /**
      * @param non-empty-string $webhookUrl             MS Teams Webhook URL
@@ -49,6 +48,7 @@ class TeamsWebhookHandler extends AbstractProcessingHandler
     public function __construct(
         string $webhookUrl,
         bool $includeContextAndExtra = false,
+        bool $formatMessage = false,
         $level = Level::Critical,
         bool $bubble = true,
         array $excludeFields = [],
@@ -62,29 +62,20 @@ public function __construct(
 
         $this->webhookUrl = $webhookUrl;
 
-        $this->teamsRecord = new TeamsRecord(
-            $includeContextAndExtra,
-            $excludeFields,
-            $toggleFields
-        );
+        $this->teamsPayload = new TeamsPayload($includeContextAndExtra, $formatMessage, $excludeFields, $toggleFields);
     }
 
-    public function getTeamsRecord(): TeamsRecord
+    public function getTeamsPayload(): TeamsPayload
     {
-        return $this->teamsRecord;
-    }
-
-    public function getWebhookUrl(): string
-    {
-        return $this->webhookUrl;
+        return $this->teamsPayload;
     }
 
     /**
      * @inheritDoc
      */
     protected function write(LogRecord $record): void
     {
-        $postData = $this->teamsRecord->getAdaptiveCardPayload($record);
+        $postData = $this->teamsPayload->getAdaptiveCardPayload($record, $this->getFormatter());
         $postString = Utils::jsonEncode($postData);
 
         $ch = curl_init();
@@ -100,20 +91,4 @@ protected function write(LogRecord $record): void
 
         Curl\Util::execute($ch);
     }
-
-    public function setFormatter(FormatterInterface $formatter): HandlerInterface
-    {
-        parent::setFormatter($formatter);
-        $this->teamsRecord->setFormatter($formatter);
-
-        return $this;
-    }
-
-    public function getFormatter(): FormatterInterface
-    {
-        $formatter = parent::getFormatter();
-        $this->teamsRecord->setFormatter($formatter);
-
-        return $formatter;
-    }
 }