feat(util-dynamodb): [WIP] DocumentClient with basic put operation

[trivikr]

Issue

Attempt to fix: #1223

Description

[WIP] DocumentClient with basic put operation

Testing

Tested with the following code:

With DocumentClient

Code

const { DocumentClient } = require("../aws-sdk-js-v3/packages/util-dynamodb");
const {
  DynamoDB,
  waitForTableExists,
} = require("../aws-sdk-js-v3/clients/client-dynamodb");

(async () => {
  const region = "us-west-2";
  const client = new DynamoDB({ region });

  const TableName = `test-${Math.ceil(Math.random() * 10 ** 10)}`;

  const params = {
    TableName,
    AttributeDefinitions: [{ AttributeName: "id", AttributeType: "S" }],
    KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
    BillingMode: "PAY_PER_REQUEST",
  };

  await client.createTable({ ...params, TableName });
  await waitForTableExists({ client }, { TableName });

  const docClient = new DocumentClient({ region });
  await docClient.put({
    TableName,
    Item: { id: "1", content: "inserted through await call" },
  });

  console.log(await client.getItem({ TableName, Key: { id: { S: "1" } } }));

  docClient.put(
    {
      TableName,
      Item: { id: "2", content: "inserted through callback" },
    },
    (err, data) => {
      console.log(err);
      client
        .getItem({ TableName, Key: { id: { S: "2" } } })
        .then((data) => console.log(data))
        .catch((err) => console.log(err));

      client.deleteTable({ TableName });
    }
  );
})();

Output

{
  '$metadata': {
    httpStatusCode: 200,
    requestId: '3SRG017G8Q3074S2FIV8EIUVVFVV4KQNSO5AEMVJF66Q9ASUAAJG',
    extendedRequestId: undefined,
    cfId: undefined,
    attempts: 1,
    totalRetryDelay: 0
  },
  ConsumedCapacity: undefined,
  Item: { content: { S: 'inserted through await call' }, id: { S: '1' } }
}
null
{
  '$metadata': {
    httpStatusCode: 200,
    requestId: 'LFBQENN54KF5M8LGVBGUKSVR2JVV4KQNSO5AEMVJF66Q9ASUAAJG',
    extendedRequestId: undefined,
    cfId: undefined,
    attempts: 1,
    totalRetryDelay: 0
  },
  ConsumedCapacity: undefined,
  Item: { content: { S: 'inserted through callback' }, id: { S: '2' } }
}

With DynamoDBClient

Code

const {
  PutItemDocumentCommand,
} = require("../aws-sdk-js-v3/packages/util-dynamodb");
const {
  DynamoDBClient,
  CreateTableCommand,
  DeleteTableCommand,
  GetItemCommand,
  waitForTableExists,
} = require("../aws-sdk-js-v3/clients/client-dynamodb");

(async () => {
  const region = "us-west-2";
  const client = new DynamoDBClient({ region });

  const TableName = `test-${Math.ceil(Math.random() * 10 ** 10)}`;

  const params = {
    TableName,
    AttributeDefinitions: [{ AttributeName: "id", AttributeType: "S" }],
    KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
    BillingMode: "PAY_PER_REQUEST",
  };

  await client.send(new CreateTableCommand(params));
  await waitForTableExists({ client }, { TableName });

  await client.send(
    new PutItemDocumentCommand({
      TableName,
      Item: { id: "1", content: "inserted through await call" },
    })
  );

  console.log(
    await client.send(
      new GetItemCommand({ TableName, Key: { id: { S: "1" } } })
    )
  );

  client.send(
    new PutItemDocumentCommand({
      TableName,
      Item: { id: "2", content: "inserted through callback" },
    }),
    (err, data) => {
      console.log(err);
      client
        .send(new GetItemCommand({ TableName, Key: { id: { S: "2" } } }))
        .then((data) => console.log(data))
        .catch((err) => console.log(err));

      client.send(new DeleteTableCommand({ TableName }));
    }
  );
})();

Output

{
  '$metadata': {
    httpStatusCode: 200,
    requestId: '7IOO78ES6CQR744U79CITTJV2VVV4KQNSO5AEMVJF66Q9ASUAAJG',
    extendedRequestId: undefined,
    cfId: undefined,
    attempts: 1,
    totalRetryDelay: 0
  },
  ConsumedCapacity: undefined,
  Item: { content: { S: 'inserted through await call' }, id: { S: '1' } }
}
null
{
  '$metadata': {
    httpStatusCode: 200,
    requestId: 'NHBFORD136J3493UTA7FOMSVLRVV4KQNSO5AEMVJF66Q9ASUAAJG',
    extendedRequestId: undefined,
    cfId: undefined,
    attempts: 1,
    totalRetryDelay: 0
  },
  ConsumedCapacity: undefined,
  Item: { content: { S: 'inserted through callback' }, id: { S: '2' } }
}

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[kyeotic]

Thank you!!! This is what we need.

My only concern is the selection of DynamoDB instead of DynamoDBClient. Correct me if I am wrong (which seems likely, the docs confuse the hell out of me) but using DynamoDB will break tree-shaking and pull in all command types and methods into the output.

Since you are only using send() anyway you should be able to use DynamoDBClient, which wont pull in all the methods on DynamoDB, and wont restrict your ability to provide the methods you want.

[stang-tgs]

I believe Set is also marshalled?

[trivikr]

Yup, we have marshall/unmarshall support for as this code reuses existing utilities.
The documentation was copied from DocumentClient in v2, and will need re-edit while polishing.

[trivikr]

My only concern is the selection of DynamoDB instead of DynamoDBClient. Correct me if I am wrong (which seems likely, the docs confuse the hell out of me) but using DynamoDB will break tree-shaking and pull in all command types and methods into the output.

Did you mean the usage in the test code? You can use DynamoDBClient instead of DynamoDB?
This experimental implementation is not modular though. We're not planning to publish modular implementation of Document Client as of now, as that would not be straightforward.

[kyeotic]

@trivikr What do you mean by "test code"? This looks like the actual implementation to me.

[trivikr]

What do you mean by "test code"? This looks like the actual implementation to me.

By test code I meant the code used under testing in this implementation (under PR description).

[aws-sdk-js-automation]

AWS CodeBuild CI Report

• CodeBuild project: sdk-staging-test
• Commit ID: 1bcd6ab
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[cadam11]

Excited to have this power in v3 sdk - thanks, @trivikr !

[rati-dzidziguri]

I liked the philosophy behind V3 and modular architecture. Having this package kind of goes against it. If one has a Lambda that does not require any writing or put item operations in a microservice world, it will still include unnecessary code when using this implementation of the DocumentClient. While the philosophy behind V3 is fully aligned with a distributed application model, backporting things in this way might be a little bit step backward instead.

[trivikr]

Superceded by #2062

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.