Incorrect transform schema - corrected tests

Author: benpoulson

composer.json

@@ -9,6 +9,11 @@
       "Perfbase\\SDK\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Perfbase\\SDK\\Tests\\": "tests/"
+    }
+  },
   "authors": [
     {
       "name": "Ben Poulson",

composer.lock

@@ -2,6 +2,7 @@
 
 namespace Perfbase\SDK;
 
+use Perfbase\SDK\Exception\PerfbaseApiKeyMissingException;
 use Perfbase\SDK\Exception\PerfbaseStateException;
 use Perfbase\SDK\Tracing\TraceInstance;
 use Perfbase\SDK\Utils\ExtensionUtils;
@@ -52,6 +53,7 @@ public static function hasInstance(): bool
      * @param Config $config
      * @return TraceInstance
      * @throws PerfbaseStateException
+     * @throws PerfbaseApiKeyMissingException
      */
     public static function createInstance(Config $config): TraceInstance
     {

src/Perfbase.php

@@ -12,71 +12,71 @@ class Attributes
      * Eg, "GET /users/:userId", "Cron:DailyReport", "Queue:ProcessEmails"
      * @var string|null
      */
-    public ?string $action;
+    public ?string $action = null;
 
     /**
      * The unique user ID of the user that triggered this trace.
      * @var string|null
      */
-    public ?string $userId;
+    public ?string $userId = null;
 
     /**
      * The IP address of the user that triggered this trace.
      * @var string|null
      */
-    public ?string $userIp;
+    public ?string $userIp = null;
 
     /**
      * The user agent of the user that triggered this trace.
      * @var string|null
      */
-    public ?string $userAgent;
+    public ?string $userAgent = null;
 
     /**
      * The hostname of the server that this trace was collected on.
      * @var string|null
      */
-    public ?string $hostname;
+    public ?string $hostname = null;
 
     /**
      * The environment that this trace was collected in.
      * Eg, "production", "staging", "development"
      * @var string|null
      */
-    public ?string $environment;
+    public ?string $environment = null;
 
     /**
      * The version of the application that this trace was collected in.
      * This could be a git commit hash, a version number, or anything else.
      * @var string|null
      */
-    public ?string $appVersion;
+    public ?string $appVersion = null;
 
     /**
      * The version of PHP that this trace was collected in.
      * @var string|null
      */
-    public ?string $phpVersion;
+    public ?string $phpVersion = null;
 
     /**
      * The HTTP method that was used to trigger this trace, if applicable.
      * Eg, "GET", "POST", "PUT", "DELETE"
      * @var string|null
      */
-    public ?string $httpMethod;
+    public ?string $httpMethod = null;
 
     /**
      * The HTTP status code that was returned by the server, if applicable.
      * Eg, 200, 404, 500
      * @var int|null
      */
-    public ?int $httpStatusCode;
+    public ?int $httpStatusCode = null;
 
     /**
      * The full URL that was requested to trigger this trace, if applicable.
      * @var string|null
      */
-    public ?string $httpUrl;
+    public ?string $httpUrl = null;
 
     public function __construct()
     {

src/Tracing/Attributes.php

@@ -2,6 +2,7 @@
 
 namespace Perfbase\SDK\Tracing;
 
+use http\Exception\RuntimeException;
 use JsonException;
 use Perfbase\SDK\Config;
 use Perfbase\SDK\Exception\PerfbaseApiKeyMissingException;
@@ -146,6 +147,27 @@ public function sendProfilingData(): void
      */
     public function transformData(): array
     {
+        // Compress the performance data
+        $compressedPerfData = gzencode(json_encode($this->performanceData), -1, FORCE_GZIP);
+        if ($compressedPerfData === false) {
+            throw new RuntimeException('Failed to compress performance data');
+        }
+        $perfData = base64_encode($compressedPerfData);
+        unset($compressedPerfData);
+
+        // Compress the metadata, if any
+        if (count($this->metaData)) {
+            $compressedMetaData = gzencode(json_encode($this->metaData), -1, FORCE_GZIP);
+            if ($compressedMetaData === false) {
+                throw new RuntimeException('Failed to compress performance data');
+            }
+            $metaData = base64_encode($compressedMetaData);
+            unset($compressedMetaData);
+        } else {
+            $metaData = null;
+        }
+
+        // Return the transformed data
         return [
             'action' => $this->attributes->action,
             'user_id' => $this->attributes->userId,
@@ -158,8 +180,8 @@ public function transformData(): array
             'http_method' => $this->attributes->httpMethod,
             'http_status_code' => $this->attributes->httpStatusCode,
             'http_url' => $this->attributes->httpUrl,
-            'perf_data' => json_encode($this->performanceData),
-            'meta_data' => json_encode($this->metaData)
+            'perf_data' => $perfData,
+            'meta_data' => $metaData
         ];
     }
 }

src/Tracing/TraceInstance.php

@@ -0,0 +1,3 @@
+#!/bin/bash
+php -d memory_limit=-1 vendor/bin/phpstan analyse -c phpstan.neon --memory-limit=2G
+php -d memory_limit=-1 vendor/bin/phpunit

test.sh

@@ -15,7 +15,7 @@ for VERSION in "${PHP_VERSIONS[@]}"; do
 
     if [ $? -eq 0 ]; then
       echo "Successfully built ${IMAGE_NAME}. Running tests..."
-      docker run --rm "$IMAGE_NAME" -it 'sh -c php -d memory_limit=-1 vendor/bin/phpstan analyse -c phpstan.neon --memory-limit=2G && php -d memory_limit=-1 vendor/bin/phpunit'
+      docker run --rm "$IMAGE_NAME" './test.sh'
 
       if [ $? -eq 0 ]; then
         echo "Tests passed for PHP ${VERSION}."

test_docker.sh

@@ -1,6 +1,6 @@
 <?php
 
-namespace Tests;
+namespace Perfbase\SDK\Tests;
 
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Handler\MockHandler;
@@ -16,7 +16,7 @@
 /**
  * @coversDefaultClass \Perfbase\SDK\Http\ApiClient
  */
-class ApiClientTest extends \PHPUnit\Framework\TestCase
+class ApiClientTest extends BaseTest
 {
 
     /**

tests/ApiClientTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Perfbase\SDK\Tests;
+
+use PHPUnit\Framework\TestCase;
+use ReflectionException;
+
+abstract class BaseTest extends TestCase
+{
+    /**
+     * Retrieves the value of a private or protected property from an object.
+     *
+     * @param object $object The object containing the private property.
+     * @param string $propertyName The name of the property to access.
+     * @return mixed The value of the private property.
+     * @throws ReflectionException If the property does not exist.
+     */
+    protected function getPrivateFieldValue(object $object, string $propertyName)
+    {
+        $reflection = new \ReflectionClass($object);
+        $property = $reflection->getProperty($propertyName);
+        $property->setAccessible(true);
+        return $property->getValue($object);
+    }
+
+    /**
+     * Sets the value of a private or protected property on an object.
+     *
+     * @param object $object The object containing the private property.
+     * @param string $propertyName The name of the property to modify.
+     * @param mixed $value The new value to set.
+     * @throws ReflectionException If the property does not exist.
+     */
+    protected function setPrivateField(object $object, string $propertyName, $value): void
+    {
+        $reflection = new \ReflectionClass($object);
+        $property = $reflection->getProperty($propertyName);
+        $property->setAccessible(true);
+        $property->setValue($object, $value);
+    }
+}

tests/BaseTest.php

@@ -1,11 +1,13 @@
 <?php
 
+namespace Perfbase\SDK\Tests;
+
 use Perfbase\SDK\Config;
 
 /**
  * @coversDefaultClass \Perfbase\SDK\Config
  */
-class ConfigTest extends \PHPUnit\Framework\TestCase
+class ConfigTest extends BaseTest
 {
     /**
      * Test the default configuration values