Add package info to SDK payload (#1823)

Author: stayallive

src/Event.php

@@ -19,6 +19,10 @@
  *     count: int,
  *     tags: array<string>,
  * }
+ * @phpstan-type SdkPackageEntry array{
+ *     name: string,
+ *     version: string,
+ * }
  */
 final class Event
 {
@@ -174,6 +178,16 @@ final class Event
      */
     private $sdkVersion = Client::SDK_VERSION;
 
+    /**
+     * @var SdkPackageEntry[] The Sentry SDK packages
+     */
+    private $sdkPackages = [
+        [
+            'name' => 'composer:sentry/sentry',
+            'version' => Client::SDK_VERSION,
+        ],
+    ];
+
     /**
      * @var EventType The type of the Event
      */
@@ -276,6 +290,40 @@ public function setSdkVersion(string $sdkVersion): self
         return $this;
     }
 
+    /**
+     * Append a package to the list of SDK packages.
+     *
+     * @param SdkPackageEntry $package The package to append
+     *
+     * @return $this
+     *
+     * @internal
+     */
+    public function appendSdkPackage(array $package): self
+    {
+        $this->sdkPackages[] = $package;
+
+        return $this;
+    }
+
+    /**
+     * Gets the SDK playload that will be sent to Sentry.
+     *
+     * @see https://develop.sentry.dev/sdk/data-model/event-payloads/sdk/
+     *
+     * @return array{name: string, version: string, packages: SdkPackageEntry[]}
+     *
+     * @internal
+     */
+    public function getSdkPayload(): array
+    {
+        return [
+            'name' => $this->sdkIdentifier,
+            'version' => $this->sdkVersion,
+            'packages' => $this->sdkPackages,
+        ];
+    }
+
     /**
      * Gets the timestamp of when this event was generated.
      */

src/Serializer/EnvelopItems/EventItem.php

@@ -28,10 +28,7 @@ public static function toEnvelopeItem(Event $event): string
         $payload = [
             'timestamp' => $event->getTimestamp(),
             'platform' => 'php',
-            'sdk' => [
-                'name' => $event->getSdkIdentifier(),
-                'version' => $event->getSdkVersion(),
-            ],
+            'sdk' => $event->getSdkPayload(),
         ];
 
         if ($event->getStartTimestamp() !== null) {

src/Serializer/EnvelopItems/TransactionItem.php

@@ -35,10 +35,7 @@ public static function toEnvelopeItem(Event $event): string
         $payload = [
             'timestamp' => $event->getTimestamp(),
             'platform' => 'php',
-            'sdk' => [
-                'name' => $event->getSdkIdentifier(),
-                'version' => $event->getSdkVersion(),
-            ],
+            'sdk' => $event->getSdkPayload(),
         ];
 
         if ($event->getStartTimestamp() !== null) {

src/Serializer/PayloadSerializer.php

@@ -42,10 +42,7 @@ public function serialize(Event $event): string
             'event_id' => (string) $event->getId(),
             'sent_at' => gmdate('Y-m-d\TH:i:s\Z'),
             'dsn' => (string) $this->options->getDsn(),
-            'sdk' => [
-                'name' => $event->getSdkIdentifier(),
-                'version' => $event->getSdkVersion(),
-            ],
+            'sdk' => $event->getSdkPayload(),
         ];
 
         $dynamicSamplingContext = $event->getSdkMetadata('dynamic_sampling_context');