Fix compat with PHP 7

Author: stayallive

src/Logs/LogsAggregator.php

@@ -12,6 +12,7 @@
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 use Sentry\Util\Arr;
+use Sentry\Util\Str;
 
 /**
  * @internal
@@ -57,21 +58,18 @@ public function add(
             return;
         }
 
-        $formattedMessage = $message;
+        $formattedMessage = Str::vsprintfOrNull($message, $values);
 
-        if (!empty($values)) {
-            try {
-                $formattedMessage = vsprintf($message, $values);
-            } catch (\ValueError $e) {
-                // If formatting fails we don't format the message and log the error
-                if ($sdkLogger !== null) {
-                    $sdkLogger->warning('Failed to format log message with values.', [
-                        'message' => $message,
-                        'values' => $values,
-                        'exception' => $e,
-                    ]);
-                }
+        if ($formattedMessage === null) {
+            // If formatting fails we don't format the message and log the error
+            if ($sdkLogger !== null) {
+                $sdkLogger->warning('Failed to format log message with values.', [
+                    'message' => $message,
+                    'values' => $values,
+                ]);
             }
+
+            $formattedMessage = $message;
         }
 
         $log = (new Log($timestamp, $this->getTraceId($hub), $level, $formattedMessage))

src/Serializer/EnvelopItems/EventItem.php

@@ -9,6 +9,7 @@
 use Sentry\Serializer\Traits\BreadcrumbSeralizerTrait;
 use Sentry\Serializer\Traits\StacktraceFrameSeralizerTrait;
 use Sentry\Util\JSON;
+use Sentry\Util\Str;
 
 /**
  * @internal
@@ -124,7 +125,7 @@ public static function toEnvelopeItem(Event $event): string
                 $payload['message'] = [
                     'message' => $event->getMessage(),
                     'params' => $event->getMessageParams(),
-                    'formatted' => $event->getMessageFormatted() ?? vsprintf($event->getMessage(), $event->getMessageParams()),
+                    'formatted' => $event->getMessageFormatted() ?? Str::vsprintfOrNull($event->getMessage(), $event->getMessageParams()) ?? $event->getMessage(),
                 ];
             }
         }

src/Util/Str.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Util;
+
+/**
+ * This class provides some utility methods to work with strings.
+ *
+ * @internal
+ */
+class Str
+{
+    /**
+     * Safe way of running `vsprintf` without throwing an exception.
+     *
+     * If the string could not be formatted, it returns `null`.
+     *
+     * @see https://www.php.net/manual/en/function.vsprintf.php
+     *
+     * @param array<bool|float|int|string|null> $values
+     */
+    public static function vsprintfOrNull(string $message, array $values): ?string
+    {
+        if (empty($values)) {
+            return $message;
+        }
+
+        try {
+            $result = @vsprintf($message, $values);
+
+            // @phpstan-ignore-next-line on PHP 7 `vsprintf` does not throw an exception but can return `false`
+            return $result === false ? null : $result;
+        } catch (\Error $e) { // This is technically a `ValueError` in PHP 8.0+ but this works in PHP 7 as well
+            return null;
+        }
+    }
+}

tests/Util/StrTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Tests\Util;
+
+use PHPUnit\Framework\TestCase;
+use Sentry\Util\Str;
+
+final class StrTest extends TestCase
+{
+    /**
+     * @dataProvider vsprintfOrNullDataProvider
+     */
+    public function testVsprintfOrNull(string $message, array $values, ?string $expected): void
+    {
+        $this->assertSame($expected, Str::vsprintfOrNull($message, $values));
+    }
+
+    public static function vsprintfOrNullDataProvider(): \Generator
+    {
+        yield [
+            'Simple message without values',
+            [],
+            'Simple message without values',
+        ];
+
+        yield [
+            'Message with a value: %s',
+            ['value'],
+            'Message with a value: value',
+        ];
+
+        yield [
+            'Message with placeholders but no values: %s',
+            [],
+            'Message with placeholders but no values: %s',
+        ];
+
+        yield [
+            'Message with placeholders but incorrect number of values: %s, %s',
+            ['value'],
+            null,
+        ];
+    }
+}