fix: better type-handing in Context class (GoogleCloudPlatform#47)

bshaffer · web-flow · commit 5d51d43c73c8 · 2020-09-09T15:35:43.000-07:00
diff --git a/src/CloudEvent.php b/src/CloudEvent.php
@@ -98,8 +98,19 @@ public function getData()
 
     public static function fromArray(array $arr)
     {
-        $argKeys = ['id', 'source', 'specversion', 'type', 'datacontenttype', 'dataschema', 'subject', 'time', 'data'];
         $args = [];
+        $argKeys = [
+            'id',
+            'source',
+            'specversion',
+            'type',
+            'datacontenttype',
+            'dataschema',
+            'subject',
+            'time',
+            'data'
+        ];
+
         foreach ($argKeys as $key) {
             $args[] = $arr[$key] ?? null;
         }
diff --git a/src/Context.php b/src/Context.php
@@ -19,23 +19,47 @@
 
 class Context
 {
-    public $eventId;
-    public $timestamp;
-    public $eventType;
-    public $resource;
+    private $eventId;
+    private $timestamp;
+    private $eventType;
+    private $resource;
 
-    public function __construct($eventId, $timestamp, $eventType, $resource)
-    {
+    public function __construct(
+        ?string $eventId,
+        ?string $timestamp,
+        ?string $eventType,
+        ?string $resource
+    ) {
         $this->eventId = $eventId;
         $this->timestamp = $timestamp;
         $this->eventType = $eventType;
         $this->resource = $resource;
     }
 
+    public function getEventId(): ?string
+    {
+        return $this->eventId;
+    }
+
+    public function getEventType(): ?string
+    {
+        return $this->eventType;
+    }
+
+    public function getTimestamp(): ?string
+    {
+        return $this->timestamp;
+    }
+
+    public function getResource(): ?string
+    {
+        return $this->resource;
+    }
+
     public static function fromArray(array $arr)
     {
-        $argKeys = ['eventId', 'timestamp', 'eventType', 'resource'];
         $args = [];
+        $argKeys = ['eventId', 'timestamp', 'eventType', 'resource'];
         foreach ($argKeys as $key) {
             $args[] = $arr[$key] ?? null;
         }
diff --git a/tests/BackgroundFunctionWrapperTest.php b/tests/BackgroundFunctionWrapperTest.php
@@ -81,9 +81,9 @@ public function invokeThis($data, Context $context)
     {
         self::$functionCalled = true;
         $this->assertEquals('foo', $data);
-        $this->assertEquals('abc', $context->eventId);
-        $this->assertEquals('def', $context->timestamp);
-        $this->assertEquals('ghi', $context->eventType);
-        $this->assertEquals('jkl', $context->resource);
+        $this->assertEquals('abc', $context->getEventId());
+        $this->assertEquals('def', $context->getTimestamp());
+        $this->assertEquals('ghi', $context->getEventType());
+        $this->assertEquals('jkl', $context->getResource());
     }
 }
diff --git a/tests/ContextTest.php b/tests/ContextTest.php
@@ -33,18 +33,18 @@ public function testFromArray()
             'eventType' => 'ghi',
             'resource' => 'jkl',
         ]);
-        $this->assertEquals('abc', $context->eventId);
-        $this->assertEquals('def', $context->timestamp);
-        $this->assertEquals('ghi', $context->eventType);
-        $this->assertEquals('jkl', $context->resource);
+        $this->assertEquals('abc', $context->getEventId());
+        $this->assertEquals('def', $context->getTimestamp());
+        $this->assertEquals('ghi', $context->getEventType());
+        $this->assertEquals('jkl', $context->getResource());
     }
 
     public function testFromEmptyArray()
     {
         $context = Context::fromArray([]);
-        $this->assertEquals(null, $context->eventId);
-        $this->assertEquals(null, $context->timestamp);
-        $this->assertEquals(null, $context->eventType);
-        $this->assertEquals(null, $context->resource);
+        $this->assertEquals(null, $context->getEventId());
+        $this->assertEquals(null, $context->getTimestamp());
+        $this->assertEquals(null, $context->getEventType());
+        $this->assertEquals(null, $context->getResource());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -81,9 +81,9 @@ public function invokeThis($data, Context $context)`
`81`	`81`	`{`
`82`	`82`	`self::$functionCalled = true;`
`83`	`83`	`$this->assertEquals('foo', $data);`
`84`		`- $this->assertEquals('abc', $context->eventId);`
`85`		`- $this->assertEquals('def', $context->timestamp);`
`86`		`- $this->assertEquals('ghi', $context->eventType);`
`87`		`- $this->assertEquals('jkl', $context->resource);`
	`84`	`+ $this->assertEquals('abc', $context->getEventId());`
	`85`	`+ $this->assertEquals('def', $context->getTimestamp());`
	`86`	`+ $this->assertEquals('ghi', $context->getEventType());`
	`87`	`+ $this->assertEquals('jkl', $context->getResource());`
`88`	`88`	`}`
`89`	`89`	`}`