Skip to content

feat(log): Improve error log in OpenFeatureClient #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 14, 2025
Merged

feat(log): Improve error log in OpenFeatureClient #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
117ba9f
feat(log): Improve error log in client
jaugustin Sep 2, 2025
913d407
fix(log): improve assert in test following genmini suggestions
jaugustin Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/OpenFeatureClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@

use function array_merge;
use function array_reverse;
use function sprintf;

class OpenFeatureClient implements Client, LoggerAwareInterface
{
Expand Down Expand Up @@ -365,11 +364,12 @@ private function evaluateFlag(
$hookExecutor->afterHooks($flagValueType, $hookContext, $resolutionDetails, $mergedRemainingHooks, $hookHints);
} catch (Throwable $err) {
$this->getLogger()->error(
sprintf(
"An error occurred during feature flag evaluation of flag '%s': %s",
$flagKey,
$err->getMessage(),
),
"An error occurred during feature flag evaluation of flag '{flagKey}': {errorMessage}",
[
'flagKey' => $flagKey,
'errorMessage' => $err->getMessage(),
'exception' => $err,
],
);

$error = $err instanceof ThrowableWithResolutionError ? $err->getResolutionError() : new ResolutionError(ErrorCode::GENERAL(), $err->getMessage());
Expand Down
17 changes: 16 additions & 1 deletion tests/unit/OpenFeatureClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
use OpenFeature\interfaces\provider\Provider;
use Psr\Log\LoggerInterface;
use ReflectionClass;
use Throwable;

class OpenFeatureClientTest extends TestCase
{
Expand Down Expand Up @@ -556,7 +557,21 @@ public function testClientShouldLogInformativeErrorDuringAbnormalExecution(): vo

/** @var LoggerInterface|MockInterface $mockLogger */
$mockLogger = $this->mockery(LoggerInterface::class);
$mockLogger->shouldReceive('error')->once();
$mockLogger->shouldReceive('error')->with(
"An error occurred during feature flag evaluation of flag '{flagKey}': {errorMessage}",
Mockery::on(function ($context) {
$this->assertIsArray($context);
$this->assertArrayHasKey('flagKey', $context);
$this->assertSame('flagKey', $context['flagKey']);
$this->assertArrayHasKey('errorMessage', $context);
$this->assertSame('NETWORK_ERROR', $context['errorMessage']);
$this->assertArrayHasKey('exception', $context);
$this->assertInstanceOf(Throwable::class, $context['exception']);
$this->assertSame('NETWORK_ERROR', $context['exception']->getMessage());

return true;
}),
)->once();
$api->setLogger($mockLogger);

$mockProvider = $this->getDefaultMockProvider();
Expand Down