Add environment property to context

Unleash · Sep 10, 2021 · 0a6e201 · 0a6e201
1 parent 9300303
commit 0a6e201
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 3 deletions.
diff --git a/src/Configuration/Context.php b/src/Configuration/Context.php
@@ -4,7 +4,9 @@
 
 /**
  * @method string|null getHostname()
+ * @method string|null getEnvironment()
  * @method Context     setHostname(string|null $hostname)
+ * @method Context     setEnvironment(string|null $environment)
  */
 interface Context
 {

diff --git a/src/Configuration/UnleashContext.php b/src/Configuration/UnleashContext.php
@@ -17,6 +17,7 @@ public function __construct(
         private ?string $sessionId = null,
         private array $customContext = [],
         ?string $hostname = null,
+        private ?string $environment = null,
     ) {
         $this->setHostname($hostname);
     }
@@ -26,6 +27,11 @@ public function getCurrentUserId(): ?string
         return $this->currentUserId;
     }
 
+    public function getEnvironment(): ?string
+    {
+        return $this->environment;
+    }
+
     public function getIpAddress(): ?string
     {
         return $this->ipAddress ?? $_SERVER['REMOTE_ADDR'] ?? null;
@@ -89,6 +95,13 @@ public function setSessionId(?string $sessionId): self
         return $this;
     }
 
+    public function setEnvironment(?string $environment): self
+    {
+        $this->environment = $environment;
+
+        return $this;
+    }
+
     public function getHostname(): ?string
     {
         return $this->findContextValue('hostname') ?? (gethostname() ?: null);
@@ -124,6 +137,7 @@ public function findContextValue(string $fieldName): ?string
             ContextField::USER_ID, Stickiness::USER_ID => $this->getCurrentUserId(),
             ContextField::SESSION_ID, Stickiness::SESSION_ID => $this->getSessionId(),
             ContextField::IP_ADDRESS => $this->getIpAddress(),
+            ContextField::ENVIRONMENT => $this->getEnvironment(),
             default => $this->customContext[$fieldName] ?? null,
         };
     }

diff --git a/src/Enum/ContextField.php b/src/Enum/ContextField.php
@@ -10,5 +10,7 @@ final class ContextField
 
     public const IP_ADDRESS = 'remoteAddress';
 
+    public const ENVIRONMENT = 'environment';
+
     public const REMOTE_ADDRESS = self::IP_ADDRESS;
 }
diff --git a/tests/ClientSpecificationTest.php b/tests/ClientSpecificationTest.php
@@ -94,6 +94,7 @@ private function createContext(array $context): UnleashContext
         $contextObject = (new UnleashContext())
             ->setCurrentUserId($context['userId'] ?? null)
             ->setSessionId($context['sessionId'] ?? null)
+            ->setEnvironment($context['environment'] ?? null)
             ->setIpAddress($context['remoteAddress'] ?? '');
 
         if (isset($context['properties'])) {

diff --git a/tests/Configuration/UnleashContextTest.php b/tests/Configuration/UnleashContextTest.php
@@ -62,7 +62,7 @@ public function testHasMatchingFieldValue()
     {
         unset($_SERVER['REMOTE_ADDR']);
 
-        $context = (new UnleashContext('123', '456', '789'))
+        $context = (new UnleashContext('123', '456', '789', [], null, 'dev'))
             ->setCustomProperty('someField', '012');
 
         self::assertTrue($context->hasMatchingFieldValue(ContextField::USER_ID, [
@@ -77,6 +77,10 @@ public function testHasMatchingFieldValue()
             '852',
             '789',
         ]));
+        self::assertTrue($context->hasMatchingFieldValue(ContextField::ENVIRONMENT, [
+            'dev',
+            'production',
+        ]));
         self::assertTrue($context->hasMatchingFieldValue('someField', [
             '753',
             '012',

diff --git a/tests/ContextProvider/DefaultUnleashContextProviderTest.php b/tests/ContextProvider/DefaultUnleashContextProviderTest.php
@@ -17,26 +17,29 @@ public function testGetContext()
         self::assertNull($instance->getContext()->getCurrentUserId());
         self::assertNull($instance->getContext()->getIpAddress());
         self::assertNull($instance->getContext()->getSessionId());
+        self::assertNull($instance->getContext()->getEnvironment());
         self::assertNotSame($instance->getContext(), $instance->getContext());
 
-        $instance = new DefaultUnleashContextProvider(new UnleashContext('123', '456', '789'));
+        $instance = new DefaultUnleashContextProvider(new UnleashContext('123', '456', '789', [], null, 'dev'));
         self::assertInstanceOf(UnleashContext::class, $instance->getContext());
         self::assertEquals('123', $instance->getContext()->getCurrentUserId());
         self::assertEquals('456', $instance->getContext()->getIpAddress());
         self::assertEquals('789', $instance->getContext()->getSessionId());
+        self::assertEquals('dev', $instance->getContext()->getEnvironment());
         self::assertNotSame($instance->getContext(), $instance->getContext());
     }
 
     public function testSetDefaultContext()
     {
         $instance = new DefaultUnleashContextProvider();
-        $context = new UnleashContext('123', '456', '789');
+        $context = new UnleashContext('123', '456', '789', [], null, 'dev');
         $instance->setDefaultContext($context);
 
         self::assertInstanceOf(UnleashContext::class, $instance->getContext());
         self::assertEquals('123', $instance->getContext()->getCurrentUserId());
         self::assertEquals('456', $instance->getContext()->getIpAddress());
         self::assertEquals('789', $instance->getContext()->getSessionId());
+        self::assertEquals('dev', $instance->getContext()->getEnvironment());
         self::assertNotSame($instance->getContext(), $instance->getContext());
     }
 }