fix: Improve error handling in OpenFeatureClient (#121)

## This PR The PR adds the `flagKey` to EvaluationDetailsBuilder during error handling, providing more context for debugging. It also includes error message within the ResolutionError for more complete error information. ### How to test Modify the NoOpProvider to throw any exception with a message. This should then propergate through to this new error handling Signed-off-by: Andrew Menino-Barlow <[email protected]>
open-feature · May 7, 2024 · 58e97d2 · 58e97d2
1 parent 2123274
commit 58e97d2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/src/OpenFeatureClient.php b/src/OpenFeatureClient.php
@@ -372,9 +372,10 @@ private function evaluateFlag(
                 ),
             );
 
-            $error = $err instanceof ThrowableWithResolutionError ? $err->getResolutionError() : new ResolutionError(ErrorCode::GENERAL());
+            $error = $err instanceof ThrowableWithResolutionError ? $err->getResolutionError() : new ResolutionError(ErrorCode::GENERAL(), $err->getMessage());
 
             $details = (new EvaluationDetailsBuilder())
+                            ->withFlagKey($flagKey)
                             ->withValue($defaultValue)
                             ->withReason(Reason::ERROR)
                             ->withError($error)

diff --git a/tests/unit/OpenFeatureClientTest.php b/tests/unit/OpenFeatureClientTest.php
@@ -499,6 +499,7 @@ public function testClientEvaluationDetailsAbnormalExecutionHasErrorCodeField():
         $resolutionError = $actualDetails->getError();
         $this->assertNotNull($resolutionError);
         $this->assertEquals($expectedErrorCode, $resolutionError->getResolutionErrorCode());
+        $this->assertEquals('flagKey', $actualDetails->getFlagKey());
     }
 
     /**
@@ -563,9 +564,14 @@ public function testClientShouldLogInformativeErrorDuringAbnormalExecution(): vo
         $client = new OpenFeatureClient($api, 'test-name', 'test-version');
         $client->setLogger($mockLogger);
 
-        $value = $client->getBooleanValue('flagKey', false);
+        $details = $client->getBooleanDetails('flagKey', false);
 
-        $this->assertEquals($value, false);
+        $this->assertEquals(false, $details->getValue());
+        $this->assertEquals('flagKey', $details->getFlagKey());
+
+        $this->assertInstanceOf(ResolutionError::class, $details->getError());
+        $this->assertEquals(ErrorCode::GENERAL(), $details->getError()->getResolutionErrorCode());
+        $this->assertEquals('NETWORK_ERROR', $details->getError()->getResolutionErrorMessage());
     }
 
     /**