Skip to content

fix(tracer): properly return DynamoDB.DocumentClient #528

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.

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 4 commits into from
Feb 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion packages/tracing/src/Tracer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,12 @@ class Tracer implements TracerInterface {
return this.provider.captureAWSClient(service);
} catch (error) {
try {
return this.provider.captureAWSClient((service as unknown as T & { service: T }).service);
// This is needed because some aws-sdk clients like AWS.DynamoDB.DocumentDB don't comply with the same
// instrumentation contract like most base clients.
// For detailed explanation see: https://github.com/awslabs/aws-lambda-powertools-typescript/issues/524#issuecomment-1024493662
this.provider.captureAWSClient((service as T & { service: T }).service);

return service;
} catch {
throw error;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/tracing/tests/e2e/tracer.test.Decorator.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Tracer } from '../../src';
import { Callback, Context } from 'aws-lambda';
import { DynamoDBClient, ScanCommand } from '@aws-sdk/client-dynamodb';
import { DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';
// eslint-disable-next-line @typescript-eslint/no-var-requires
let AWS = require('aws-sdk');

Expand Down Expand Up @@ -52,8 +52,8 @@ export class MyFunctionWithDecorator {
}

return Promise.all([
dynamoDBv2.scan({ TableName: testTableName }).promise(),
dynamoDBv3.send(new ScanCommand({ TableName: testTableName })),
dynamoDBv2.put({ TableName: testTableName, Item: { id: `${serviceName}-${event.invocation}-sdkv2` } }).promise(),
dynamoDBv3.send(new PutItemCommand({ TableName: testTableName, Item: { id: { 'S': `${serviceName}-${event.invocation}-sdkv3` } } })),
new Promise((resolve, reject) => {
setTimeout(() => {
const res = this.myMethod();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Tracer } from '../../src';
import { Context } from 'aws-lambda';
import { DynamoDBClient, ScanCommand } from '@aws-sdk/client-dynamodb';
import { DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';
// eslint-disable-next-line @typescript-eslint/no-var-requires
let AWS = require('aws-sdk');

Expand Down Expand Up @@ -52,13 +52,13 @@ export class MyFunctionWithDecorator {
}

try {
await dynamoDBv2.scan({ TableName: testTableName }).promise();
await dynamoDBv2.put({ TableName: testTableName, Item: { id: `${serviceName}-${event.invocation}-sdkv2` } }).promise();
} catch (err) {
console.error(err);
}

try {
await dynamoDBv3.send(new ScanCommand({ TableName: testTableName }));
await dynamoDBv3.send(new PutItemCommand({ TableName: testTableName, Item: { id: { 'S': `${serviceName}-${event.invocation}-sdkv3` } } }));
} catch (err) {
console.error(err);
}
Expand Down
6 changes: 3 additions & 3 deletions packages/tracing/tests/e2e/tracer.test.Manual.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Tracer } from '../../src';
import { Context } from 'aws-lambda';
import { DynamoDBClient, ScanCommand } from '@aws-sdk/client-dynamodb';
import { DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';
// eslint-disable-next-line @typescript-eslint/no-var-requires
let AWS = require('aws-sdk');

Expand Down Expand Up @@ -55,13 +55,13 @@ export const handler = async (event: CustomEvent, _context: Context): Promise<vo
dynamoDBv2 = new AWS.DynamoDB.DocumentClient();
}
try {
await dynamoDBv2.scan({ TableName: testTableName }).promise();
await dynamoDBv2.put({ TableName: testTableName, Item: { id: `${serviceName}-${event.invocation}-sdkv2` } }).promise();
} catch (err) {
console.error(err);
}

try {
await dynamoDBv3.send(new ScanCommand({ TableName: testTableName }));
await dynamoDBv3.send(new PutItemCommand({ TableName: testTableName, Item: { id: { 'S': `${serviceName}-${event.invocation}-sdkv3` } } }));
} catch (err) {
console.error(err);
}
Expand Down
6 changes: 3 additions & 3 deletions packages/tracing/tests/e2e/tracer.test.Middleware.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import middy from '@middy/core';
import { captureLambdaHandler, Tracer } from '../../src';
import { Context } from 'aws-lambda';
import { DynamoDBClient, ScanCommand } from '@aws-sdk/client-dynamodb';
import { DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';
// eslint-disable-next-line @typescript-eslint/no-var-requires
let AWS = require('aws-sdk');

Expand Down Expand Up @@ -49,13 +49,13 @@ export const handler = middy(async (event: CustomEvent, _context: Context): Prom
dynamoDBv2 = new AWS.DynamoDB.DocumentClient();
}
try {
await dynamoDBv2.scan({ TableName: testTableName }).promise();
await dynamoDBv2.put({ TableName: testTableName, Item: { id: `${serviceName}-${event.invocation}-sdkv2` } }).promise();
} catch (err) {
console.error(err);
}

try {
await dynamoDBv3.send(new ScanCommand({ TableName: testTableName }));
await dynamoDBv3.send(new PutItemCommand({ TableName: testTableName, Item: { id: { 'S': `${serviceName}-${event.invocation}-sdkv3` } } }));
} catch (err) {
console.error(err);
}
Expand Down
2 changes: 1 addition & 1 deletion packages/tracing/tests/e2e/tracer.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ describe('Tracer integration tests', () => {
},
timeout: Duration.seconds(30),
});
table.grantReadData(fn);
table.grantWriteData(fn);
invocationsMap[functionName] = {
serviceName: expectedServiceName,
resourceArn: `arn:aws:lambda:${region}:${account}:function:${functionName}`, // ARN is still a token at this point, so we construct the ARN manually
Expand Down
28 changes: 11 additions & 17 deletions packages/tracing/tests/unit/Tracer.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import { Tracer } from '../../src';
import { Callback, Context, Handler } from 'aws-lambda/handler';
import { Segment, setContextMissingStrategy, Subsegment } from 'aws-xray-sdk-core';
import { DynamoDB } from 'aws-sdk';

interface LambdaInterface {
handler: Handler
Expand Down Expand Up @@ -1057,29 +1058,27 @@ describe('Class: Tracer', () => {
const captureAWSClientSpy = jest.spyOn(tracer.provider, 'captureAWSClient');

// Act
tracer.captureAWSClient({});
const client = tracer.captureAWSClient(new DynamoDB());

// Assess
expect(captureAWSClientSpy).toBeCalledTimes(0);
expect(client).toBeInstanceOf(DynamoDB);

});

test('when called with a simple AWS SDK v2 client, it returns it back instrumented', () => {
test('when called with a base AWS SDK v2 client, it returns it back instrumented', () => {

// Prepare
const tracer: Tracer = new Tracer();
const captureAWSClientSpy = jest.spyOn(tracer.provider, 'captureAWSClient');
// Minimum shape required for a regular AWS v2 client (i.e. AWS.S3) to be instrumented
const dummyClient = {
customizeRequests: () => null,
};

// Act
tracer.captureAWSClient(dummyClient);
const client = tracer.captureAWSClient(new DynamoDB());

// Assess
expect(captureAWSClientSpy).toBeCalledTimes(1);
expect(captureAWSClientSpy).toBeCalledWith(dummyClient);
expect(captureAWSClientSpy).toBeCalledWith(client);
expect(client).toBeInstanceOf(DynamoDB);

});

Expand All @@ -1088,20 +1087,15 @@ describe('Class: Tracer', () => {
// Prepare
const tracer: Tracer = new Tracer();
const captureAWSClientSpy = jest.spyOn(tracer.provider, 'captureAWSClient');
// Minimum shape required for a complex AWS v2 client (i.e. AWS.DocumentClient) to be instrumented
const dummyClient = {
service: {
customizeRequests: () => null,
}
};

// Act
tracer.captureAWSClient(dummyClient);
const client = tracer.captureAWSClient(new DynamoDB.DocumentClient());

// Assess
expect(captureAWSClientSpy).toBeCalledTimes(2);
expect(captureAWSClientSpy).toHaveBeenNthCalledWith(1, dummyClient);
expect(captureAWSClientSpy).toHaveBeenNthCalledWith(2, dummyClient.service);
expect(captureAWSClientSpy).toHaveBeenNthCalledWith(1, client);
expect(captureAWSClientSpy).toHaveBeenNthCalledWith(2, (client as unknown as DynamoDB & { service: DynamoDB }).service);
expect(client).toBeInstanceOf(DynamoDB.DocumentClient);

});

Expand Down