Add named constructor to the Event class

getsentry · Sep 10, 2020 · d65ef99 · d65ef99
1 parent 53e8aee
commit d65ef99
Show file tree

Hide file tree

Showing 19 changed files with 95 additions and 81 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+### Unreleased
+
+- [BC BREAK] Add named constructors to the `Event` class (#1085)
+
 ## 3.0.0-beta1 (2020-09-03)
 
 **Tracing API**

diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md
@@ -109,3 +109,4 @@
 - Removed the `Frame::toArray()` and `Frame::jsonSerialize()` methods
 - Removed the `Stacktrace::toArray()` and `Stacktrace::jsonSerialize()` methods
 - Removed the `SpoolTransport` class and the `SpoolInterface` interface with related implementation
+- Made the `Event::__construct()` method `private`, use the named constructors instead
diff --git a/src/Event.php b/src/Event.php
@@ -158,17 +158,32 @@ final class Event
      */
     private $type;
 
+    private function __construct(?EventId $eventId, EventType $eventType)
+    {
+        $this->id = $eventId ?? EventId::generate();
+        $this->timestamp = gmdate('Y-m-d\TH:i:s\Z');
+        $this->sdkVersion = PrettyVersions::getVersion('sentry/sentry')->getPrettyVersion();
+        $this->type = $eventType;
+    }
+
     /**
-     * Class constructor.
+     * Creates a new event.
      *
      * @param EventId|null $eventId The ID of the event
      */
-    public function __construct(?EventId $eventId = null)
+    public static function createEvent(?EventId $eventId = null): self
     {
-        $this->id = $eventId ?? EventId::generate();
-        $this->timestamp = gmdate('Y-m-d\TH:i:s\Z');
-        $this->sdkVersion = PrettyVersions::getVersion('sentry/sentry')->getPrettyVersion();
-        $this->type = EventType::default();
+        return new self($eventId, EventType::default());
+    }
+
+    /**
+     * Creates a new transaction event.
+     *
+     * @param EventId|null $eventId The ID of the event
+     */
+    public static function createTransaction(EventId $eventId = null): self
+    {
+        return new self($eventId, EventType::transaction());
     }
 
     /**

diff --git a/src/EventFactory.php b/src/EventFactory.php
@@ -85,7 +85,7 @@ public function create($payload): Event
             if ($payload instanceof Event) {
                 $event = $payload;
             } else {
-                $event = new Event();
+                $event = Event::createEvent();
 
                 if (isset($payload['logger'])) {
                     $event->setLogger($payload['logger']);

diff --git a/src/Tracing/Transaction.php b/src/Tracing/Transaction.php
@@ -6,7 +6,6 @@
 
 use Sentry\Event;
 use Sentry\EventId;
-use Sentry\EventType;
 use Sentry\Severity;
 use Sentry\State\HubInterface;
 
@@ -90,8 +89,7 @@ public function finish(?float $endTimestamp = null): ?EventId
      */
     public function toEvent(): Event
     {
-        $event = new Event();
-        $event->setType(EventType::transaction());
+        $event = Event::createTransaction();
         $event->setTags(array_merge($event->getTags(), $this->tags));
         $event->setTransaction($this->name);
         $event->setStartTimestamp($this->startTimestamp);

diff --git a/tests/EventTest.php b/tests/EventTest.php
@@ -15,8 +15,8 @@ final class EventTest extends TestCase
 {
     public function testEventIsGeneratedWithUniqueIdentifier(): void
     {
-        $event1 = new Event();
-        $event2 = new Event();
+        $event1 = Event::createEvent();
+        $event2 = Event::createEvent();
 
         $this->assertNotEquals($event1->getId(), $event2->getId());
     }
@@ -26,7 +26,7 @@ public function testEventIsGeneratedWithUniqueIdentifier(): void
      */
     public function testGetMessage(array $setMessageArguments, array $expectedValue): void
     {
-        $event = new Event();
+        $event = Event::createEvent();
 
         \call_user_func_array([$event, 'setMessage'], $setMessageArguments);
 
@@ -80,7 +80,7 @@ public function testGettersAndSetters(string $propertyName, $propertyValue): voi
         $getterMethod = 'get' . ucfirst($propertyName);
         $setterMethod = 'set' . ucfirst($propertyName);
 
-        $event = new Event();
+        $event = Event::createEvent();
         $event->$setterMethod($propertyValue);
 
         $this->assertEquals($event->$getterMethod(), $propertyValue);

diff --git a/tests/FunctionsTest.php b/tests/FunctionsTest.php
@@ -112,7 +112,7 @@ public function testAddBreadcrumb(): void
 
         addBreadcrumb($breadcrumb);
         configureScope(function (Scope $scope) use ($breadcrumb): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
             $this->assertSame([$breadcrumb], $event->getBreadcrumbs());

diff --git a/tests/Integration/EnvironmentIntegrationTest.php b/tests/Integration/EnvironmentIntegrationTest.php
@@ -35,7 +35,7 @@ public function testInvoke(bool $isIntegrationEnabled, ?RuntimeContext $initialR
         SentrySdk::getCurrentHub()->bindClient($client);
 
         withScope(function (Scope $scope) use ($expectedRuntimeContext, $expectedOsContext, $initialRuntimeContext, $initialOsContext): void {
-            $event = new Event();
+            $event = Event::createEvent();
             $event->setRuntimeContext($initialRuntimeContext);
             $event->setOsContext($initialOsContext);
 

diff --git a/tests/Integration/FrameContextifierIntegrationTest.php b/tests/Integration/FrameContextifierIntegrationTest.php
@@ -63,7 +63,7 @@ public function testInvoke(string $fixtureFilePath, int $lineNumber, int $contex
             new Frame('[unknown]', $fixtureFilePath, $lineNumber, null, $fixtureFilePath),
         ]);
 
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setStacktrace($stacktrace);
 
         withScope(static function (Scope $scope) use (&$event): void {
@@ -157,7 +157,7 @@ public function testInvokeLogsWarningMessageIfSourceCodeExcerptCannotBeRetrieved
             new Frame(null, 'file.ext', 10, null, 'file.ext'),
         ]);
 
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setStacktrace($stacktrace);
 
         withScope(static function (Scope $scope) use (&$event): void {

diff --git a/tests/Integration/IgnoreErrorsIntegrationTest.php b/tests/Integration/IgnoreErrorsIntegrationTest.php
@@ -45,31 +45,31 @@ public function testInvoke(Event $event, bool $isIntegrationEnabled, array $inte
 
     public function invokeDataProvider(): \Generator
     {
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setExceptions([new ExceptionDataBag(new \RuntimeException())]);
 
         yield 'Integration disabled' => [
-            new Event(),
+            Event::createEvent(),
             false,
             [
                 'ignore_exceptions' => [],
             ],
             false,
         ];
 
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setExceptions([new ExceptionDataBag(new \RuntimeException())]);
 
         yield 'No exceptions to check' => [
-            new Event(),
+            Event::createEvent(),
             true,
             [
                 'ignore_exceptions' => [],
             ],
             false,
         ];
 
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setExceptions([new ExceptionDataBag(new \RuntimeException())]);
 
         yield 'The exception is matching exactly the "ignore_exceptions" option' => [
@@ -83,7 +83,7 @@ public function invokeDataProvider(): \Generator
             true,
         ];
 
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setExceptions([new ExceptionDataBag(new \RuntimeException())]);
 
         yield 'The exception is matching the "ignore_exceptions" option' => [

diff --git a/tests/Integration/ModulesIntegrationTest.php b/tests/Integration/ModulesIntegrationTest.php
@@ -32,7 +32,7 @@ public function testInvoke(bool $isIntegrationEnabled, bool $expectedEmptyModule
         SentrySdk::getCurrentHub()->bindClient($client);
 
         withScope(function (Scope $scope) use ($expectedEmptyModules): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
 

diff --git a/tests/Integration/RequestIntegrationTest.php b/tests/Integration/RequestIntegrationTest.php
@@ -28,7 +28,7 @@ final class RequestIntegrationTest extends TestCase
      */
     public function testInvoke(array $options, ServerRequestInterface $request, array $expectedRequestContextData, ?UserDataBag $initialUser, ?UserDataBag $expectedUser): void
     {
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setUser($initialUser);
 
         $integration = new RequestIntegration($this->createRequestFetcher($request));

diff --git a/tests/Integration/TransactionIntegrationTest.php b/tests/Integration/TransactionIntegrationTest.php
@@ -46,30 +46,30 @@ public function testSetupOnce(Event $event, bool $isIntegrationEnabled, array $p
     public function setupOnceDataProvider(): \Generator
     {
         yield [
-            new Event(),
+            Event::createEvent(),
             true,
             [],
             [],
             null,
         ];
 
         yield [
-            new Event(),
+            Event::createEvent(),
             true,
             ['transaction' => '/foo/bar'],
             [],
             '/foo/bar',
         ];
 
         yield [
-            new Event(),
+            Event::createEvent(),
             true,
             [],
             ['PATH_INFO' => '/foo/bar'],
             '/foo/bar',
         ];
 
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setTransaction('/foo/bar');
 
         yield [
@@ -80,7 +80,7 @@ public function setupOnceDataProvider(): \Generator
             '/foo/bar',
         ];
 
-        $event = new Event();
+        $event = Event::createEvent();
         $event->setTransaction('/foo/bar');
 
         yield [
@@ -92,7 +92,7 @@ public function setupOnceDataProvider(): \Generator
         ];
 
         yield [
-            new Event(),
+            Event::createEvent(),
             false,
             ['transaction' => '/foo/bar'],
             [],

diff --git a/tests/Monolog/HandlerTest.php b/tests/Monolog/HandlerTest.php
@@ -26,7 +26,7 @@ public function testHandle(array $record, array $expectedPayload, array $expecte
         $client->expects($this->once())
             ->method('captureEvent')
             ->with($expectedPayload, $this->callback(function (Scope $scopeArg) use ($expectedExtra): bool {
-                $event = $scopeArg->applyToEvent(new Event(), []);
+                $event = $scopeArg->applyToEvent(Event::createEvent(), []);
 
                 $this->assertNotNull($event);
                 $this->assertSame($expectedExtra, $event->getExtra());

diff --git a/tests/Serializer/PayloadSerializerTest.php b/tests/Serializer/PayloadSerializerTest.php
@@ -11,7 +11,6 @@
 use Sentry\Context\RuntimeContext;
 use Sentry\Event;
 use Sentry\EventId;
-use Sentry\EventType;
 use Sentry\ExceptionDataBag;
 use Sentry\ExceptionMechanism;
 use Sentry\Frame;
@@ -62,7 +61,7 @@ public function serializeDataProvider(): iterable
         $sdkVersion = PrettyVersions::getVersion('sentry/sentry')->getPrettyVersion();
 
         yield [
-            new Event(new EventId('fc9442f5aef34234bb22b9a615e30ccd')),
+            Event::createEvent(new EventId('fc9442f5aef34234bb22b9a615e30ccd')),
             <<<JSON
 {
     "event_id": "fc9442f5aef34234bb22b9a615e30ccd",
@@ -78,7 +77,7 @@ public function serializeDataProvider(): iterable
             true,
         ];
 
-        $event = new Event(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
+        $event = Event::createEvent(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
         $event->setLevel(Severity::error());
         $event->setLogger('app.php');
         $event->setTransaction('/users/<username>/');
@@ -316,7 +315,7 @@ public function serializeDataProvider(): iterable
             true,
         ];
 
-        $event = new Event(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
+        $event = Event::createEvent(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
         $event->setMessage('My raw message with interpreted strings like this', []);
 
         yield [
@@ -337,7 +336,7 @@ public function serializeDataProvider(): iterable
             true,
         ];
 
-        $event = new Event(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
+        $event = Event::createEvent(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
         $event->setMessage('My raw message with interpreted strings like %s', ['this']);
 
         yield [
@@ -362,7 +361,7 @@ public function serializeDataProvider(): iterable
             true,
         ];
 
-        $event = new Event(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
+        $event = Event::createEvent(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
         $event->setMessage('My raw message with interpreted strings like %s', ['this'], 'My raw message with interpreted strings like that');
 
         yield [
@@ -409,8 +408,7 @@ public function serializeDataProvider(): iterable
 
         $span2->finish(1598659060);
 
-        $event = new Event(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
-        $event->setType(EventType::transaction());
+        $event = Event::createTransaction(new EventId('fc9442f5aef34234bb22b9a615e30ccd'));
         $event->setSpans([$span1, $span2]);
 
         yield [

diff --git a/tests/State/HubTest.php b/tests/State/HubTest.php
@@ -289,7 +289,7 @@ public function testAddBreadcrumb(): void
 
         $hub->addBreadcrumb($breadcrumb);
         $hub->configureScope(function (Scope $scope): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
             $this->assertEmpty($event->getBreadcrumbs());
@@ -298,7 +298,7 @@ public function testAddBreadcrumb(): void
         $hub->bindClient($client);
         $hub->addBreadcrumb($breadcrumb);
         $hub->configureScope(function (Scope $scope) use (&$callbackInvoked, $breadcrumb): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
             $this->assertSame([$breadcrumb], $event->getBreadcrumbs());
@@ -321,7 +321,7 @@ public function testAddBreadcrumbDoesNothingIfMaxBreadcrumbsLimitIsZero(): void
 
         $hub->addBreadcrumb(new Breadcrumb(Breadcrumb::LEVEL_ERROR, Breadcrumb::TYPE_ERROR, 'error_reporting'));
         $hub->configureScope(function (Scope $scope): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
             $this->assertEmpty($event->getBreadcrumbs());
@@ -345,7 +345,7 @@ public function testAddBreadcrumbRespectsMaxBreadcrumbsLimit(): void
         $hub->addBreadcrumb($breadcrumb2);
 
         $hub->configureScope(function (Scope $scope) use ($breadcrumb1, $breadcrumb2): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
             $this->assertSame([$breadcrumb1, $breadcrumb2], $event->getBreadcrumbs());
@@ -354,7 +354,7 @@ public function testAddBreadcrumbRespectsMaxBreadcrumbsLimit(): void
         $hub->addBreadcrumb($breadcrumb3);
 
         $hub->configureScope(function (Scope $scope) use ($breadcrumb2, $breadcrumb3): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
             $this->assertSame([$breadcrumb2, $breadcrumb3], $event->getBreadcrumbs());
@@ -377,7 +377,7 @@ public function testAddBreadcrumbDoesNothingWhenBeforeBreadcrumbCallbackReturnsN
 
         $hub->addBreadcrumb(new Breadcrumb(Breadcrumb::LEVEL_ERROR, Breadcrumb::TYPE_ERROR, 'error_reporting'));
         $hub->configureScope(function (Scope $scope): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
             $this->assertEmpty($event->getBreadcrumbs());
@@ -404,7 +404,7 @@ public function testAddBreadcrumbStoresBreadcrumbReturnedByBeforeBreadcrumbCallb
 
         $hub->addBreadcrumb($breadcrumb1);
         $hub->configureScope(function (Scope $scope) use (&$callbackInvoked, $breadcrumb2): void {
-            $event = $scope->applyToEvent(new Event(), []);
+            $event = $scope->applyToEvent(Event::createEvent(), []);
 
             $this->assertNotNull($event);
             $this->assertSame([$breadcrumb2], $event->getBreadcrumbs());