Skip to content

fix phpstan and php-cs-fixer errors #359

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
Apr 22, 2025
Merged

fix phpstan and php-cs-fixer errors #359

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
8a95f95
fix phpstan and php-cs-fixer errors
mitchierichie Apr 21, 2025
d32aa6a
add test cases
mitchierichie Apr 21, 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
8 changes: 4 additions & 4 deletions src/Aws/src/AwsSdkInstrumentation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
use Aws\Middleware;
use Aws\ResultInterface;
use Closure;
use Error;
use GuzzleHttp\Promise;
use OpenTelemetry\API\Instrumentation\InstrumentationInterface;
use OpenTelemetry\API\Instrumentation\InstrumentationTrait;
Expand All @@ -18,6 +17,7 @@
use OpenTelemetry\API\Trace\TracerProviderInterface;
use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
use Psr\Http\Message\RequestInterface;
use Stringable;
use Throwable;

/**
Expand Down Expand Up @@ -197,10 +197,10 @@ private function normalizeReason(mixed $reason): ?string
return $reason->getMessage();
}

try {
return strval($reason);
} catch (Error) {
if (is_object($reason) && ! $reason instanceof Stringable) {
return null;
}

return (string) $reason;
}
}
98 changes: 98 additions & 0 deletions src/Aws/tests/Integration/AwsSdkInstrumentationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,18 @@

use Aws\AwsClientInterface;
use Aws\EventBridge\EventBridgeClient;
use Aws\Kms\Exception\KmsException;
use Aws\Kms\KmsClient;
use Aws\S3\S3Client;
use Aws\Sqs\SqsClient;
use GuzzleHttp\Promise;
use OpenTelemetry\API\Trace\StatusCode;
use OpenTelemetry\Aws\AwsSdkInstrumentation;
use OpenTelemetry\Aws\Xray\Propagator;
use OpenTelemetry\SDK\Trace\ReadWriteSpanInterface;
use OpenTelemetry\SDK\Trace\TracerProvider;
use PHPUnit\Framework\TestCase;
use stdClass;

class AwsSdkInstrumentationTest extends TestCase
{
Expand Down Expand Up @@ -213,4 +218,97 @@ public function testPreventsRepeatedInstrumentationOfSameClient()
);
}
}

public function testFailedOperationRecordsSpan()
{
/** @var KmsClient $kmsClient */
$kmsClient = $this->getTestClient('KMS', ['region' => 'eu-west-1']);

$spanProcessor = new CollectingSpanProcessor();
$this->awsSdkInstrumentation->setTracerProvider(new TracerProvider([$spanProcessor]));
$this->awsSdkInstrumentation->setPropagator(new Propagator());
$this->awsSdkInstrumentation->instrumentClients([$kmsClient]);
$this->awsSdkInstrumentation->init();
$this->awsSdkInstrumentation->activate();

try {
$kmsClient->decrypt(['CiphertextBlob' => random_bytes(16)]);
} catch (KmsException) {
}

$collectedSpans = $spanProcessor->getCollectedSpans();
$this->assertCount(1, $collectedSpans);

$span = array_shift($collectedSpans);

/** @var ReadWriteSpanInterface $span */
$this->assertTrue($span->hasEnded());
$this->assertSame(StatusCode::STATUS_ERROR, $span->toSpanData()->getStatus()->getCode());
}

public function testRejectsSafelyWithNonStringableObject()
{
/** @var KmsClient $kmsClient */
$kmsClient = $this->getTestClient('KMS', ['region' => 'eu-west-1']);

$spanProcessor = new CollectingSpanProcessor();
$this->awsSdkInstrumentation->setTracerProvider(new TracerProvider([$spanProcessor]));
$this->awsSdkInstrumentation->setPropagator(new Propagator());
$this->awsSdkInstrumentation->instrumentClients([$kmsClient]);
$this->awsSdkInstrumentation->init();
$this->awsSdkInstrumentation->activate();

$kmsClient->getHandlerList()->appendSign(function () {
return function () {
return Promise\Create::rejectionFor(new stdClass());
};
});

try {
$kmsClient->decrypt(['CiphertextBlob' => random_bytes(16)]);
} catch (Promise\RejectionException) {
}

$collectedSpans = $spanProcessor->getCollectedSpans();
$this->assertCount(1, $collectedSpans);

$span = array_shift($collectedSpans);

/** @var ReadWriteSpanInterface $span */
$this->assertTrue($span->hasEnded());
$this->assertSame(StatusCode::STATUS_ERROR, $span->toSpanData()->getStatus()->getCode());
}

public function testRejectsSafelyWithString()
{
/** @var KmsClient $kmsClient */
$kmsClient = $this->getTestClient('KMS', ['region' => 'eu-west-1']);

$spanProcessor = new CollectingSpanProcessor();
$this->awsSdkInstrumentation->setTracerProvider(new TracerProvider([$spanProcessor]));
$this->awsSdkInstrumentation->setPropagator(new Propagator());
$this->awsSdkInstrumentation->instrumentClients([$kmsClient]);
$this->awsSdkInstrumentation->init();
$this->awsSdkInstrumentation->activate();

$kmsClient->getHandlerList()->appendSign(function () {
return function () {
return Promise\Create::rejectionFor('failed');
};
});

try {
$kmsClient->decrypt(['CiphertextBlob' => random_bytes(16)]);
} catch (Promise\RejectionException) {
}

$collectedSpans = $spanProcessor->getCollectedSpans();
$this->assertCount(1, $collectedSpans);

$span = array_shift($collectedSpans);

/** @var ReadWriteSpanInterface $span */
$this->assertTrue($span->hasEnded());
$this->assertSame(StatusCode::STATUS_ERROR, $span->toSpanData()->getStatus()->getCode());
}
}
Loading