Add test for Sdk instrumentation patch

Author: blairhyy-amazon

aws-distro-opentelemetry-node-autoinstrumentation/package.json

@@ -78,6 +78,7 @@
     "@aws-sdk/client-s3": "3.632.0",
     "@aws-sdk/client-secrets-manager": "3.632.0",
     "@aws-sdk/client-sfn": "3.632.0",
+    "@aws-sdk/client-sts": "3.632.0",
     "@aws-sdk/client-sns": "3.632.0",
     "@opentelemetry/contrib-test-utils": "^0.45.0",
     "@smithy/protocol-http": "^5.0.1",

aws-distro-opentelemetry-node-autoinstrumentation/src/patches/instrumentation-patch.ts

@@ -370,7 +370,7 @@ type V3PluginCommand = AwsV3Command<any, any, any, any, any> & {
 // (e.g., sts:AssumeRoleWithWebIdentity) which go through the same instrumented 'send' method.
 // Without this flag, each credential request would trigger another credential extraction attempt,
 // creating an infinite loop of nested AWS SDK calls.
-const SKIP_CREDENTIAL_CAPTURE_KEY = Symbol('skip-credential-capture');
+export const SKIP_CREDENTIAL_CAPTURE_KEY = Symbol('skip-credential-capture');
 function patchAwsSdkInstrumentation(instrumentation: Instrumentation): void {
   if (instrumentation) {
     (instrumentation as AwsInstrumentation)['_getV3SmithyClientSendPatch'] = function (

aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts

@@ -5,6 +5,7 @@ import {
   Attributes,
   diag,
   Context as OtelContext,
+  context as otelContext,
   trace,
   context,
   propagation,
@@ -27,6 +28,7 @@ import {
   AWSXRAY_TRACE_ID_HEADER_CAPITALIZED,
   customExtractor,
   headerGetter,
+  SKIP_CREDENTIAL_CAPTURE_KEY,
 } from './../../src/patches/instrumentation-patch';
 import * as sinon from 'sinon';
 import { AWSXRAY_TRACE_ID_HEADER, AWSXRayPropagator } from '@opentelemetry/propagator-aws-xray';
@@ -37,6 +39,7 @@ import * as nock from 'nock';
 import { ReadableSpan, Span as SDKSpan } from '@opentelemetry/sdk-trace-base';
 import { getTestSpans } from '@opentelemetry/contrib-test-utils';
 import { instrumentationConfigs } from '../../src/register';
+import { STS } from '@aws-sdk/client-sts';
 
 // It is assumed that bedrock.test.ts has already registered the
 // necessary instrumentations for testing by calling:
@@ -692,6 +695,54 @@ describe('InstrumentationPatchTest', () => {
       });
     });
 
+    it('prevents recursion when credentials provider makes STS calls', async () => {
+      let credentialsCallCount = 0;
+      let skipCredentialCaptureValue = false;
+
+      // Create recursive credentials provider
+      const recursiveCredentialsProvider = async (): Promise<any> => {
+        credentialsCallCount++;
+        if (otelContext.active().getValue(SKIP_CREDENTIAL_CAPTURE_KEY)) {
+          skipCredentialCaptureValue = true;
+        }
+
+        const credentialsStsClient = new STS({
+          region: 'us-east-1',
+          credentials: recursiveCredentialsProvider,
+        });
+        await credentialsStsClient
+          .assumeRoleWithWebIdentity({
+            RoleArn: 'arn:aws:iam::123456789012:role/test-role',
+            RoleSessionName: 'test-session',
+            WebIdentityToken: 'mock-token',
+          })
+          .catch((err: any) => {});
+        return { accessKeyId: 'sts-access-key', secretAccessKey: 'secret' };
+      };
+
+      // Create main client with recursive credentials provider
+      const mainClient = new STS({
+        region: 'us-east-1',
+        credentials: recursiveCredentialsProvider,
+      });
+
+      // Mock HTTP responses
+      nock('https://sts.us-east-1.amazonaws.com')
+        .post('/')
+        .reply(200, '<GetCallerIdentityResponse></GetCallerIdentityResponse>');
+
+      // Make Lambda call - this triggers credential extraction which calls STS
+      await mainClient.getCallerIdentity({}).catch((err: any) => {});
+
+      const testSpans = getTestSpans();
+      const stsSpans = testSpans.filter(s => s.name.includes('GetCallerIdentity'));
+
+      expect(stsSpans.length).toBe(1);
+      expect(credentialsCallCount).toBe(2); // 1. Main client needs credentials 2. Nested STS client needs credentials
+      expect(skipCredentialCaptureValue).toBe(true); // Should detect skip key in context
+      expect(stsSpans[0].attributes[AWS_ATTRIBUTE_KEYS.AWS_AUTH_ACCOUNT_ACCESS_KEY]).toBe('sts-access-key');
+    });
+
     it('injects trace context header into request via propagator', async () => {
       lambda = new Lambda({
         region: region,