ExecuteStatementCommand in lib-dynamodb failing with lists

[cpyle0819]

Checkboxes for prior research

• I've gone through Developer Guide and API reference
• I've checked AWS Forums and StackOverflow.
• I've searched for previous similar issues and didn't find any solution.

Describe the bug

The ExecuteStatementCommand from lib-dynamodb is failing when given a list as a parameter.

SDK version number

@aws-sdk/client-dynamodb: "^3.210.0"

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

18.12.1

Reproduction Steps

import {
  DynamoDBDocumentClient,
  ExecuteStatementCommand,
} from "@aws-sdk/lib-dynamodb";

const client = new DynamoDBClient({});
const docClient = DynamoDBDocumentClient.from(client);

const command = new ExecuteStatementCommand({
  Statement: `INSERT INTO Coffees value {'varietal':?, 'profile':?}`,
  Parameters: ["arabica", ["chocolate", "floral"]],
});
await docClient.send(command);

Observed Behavior

TypeError: Cannot read properties of undefined (reading '0')
    at AttributeValue.visit (/Users/corepyle/Documents/teams/aws-doc-sdk-examples/javascriptv3/node_modules/@aws-sdk/client-dynamodb/dist-cjs/models/models_0.js:645:40)

Expected Behavior

Expected the parameters array to be able to handle an array parameter.

Possible Solution

No response

Additional Information/Context

Working version with the base client:

import { ExecuteStatementCommand, DynamoDBClient } from "@aws-sdk/client-dynamodb";

const client = new DynamoDBClient({});

const command = new ExecuteStatementCommand({
  Statement: `INSERT INTO Coffees value {'varietal':?, 'profile':?}`,
  Parameters: [{ S: "arabica" }, { L: [{ S: "chocolate" }, { S: "floral" }] }],
});
await client.send(command);

[RanVaknin]

Hi @cpyle0819 ,

You are importing ExecuteStatementCommand from lib-dynamodb, but this is an import from the client-dynamodb package.

As far as I can tell, this command is a low level command to interact with dynamo using PartiQL.
Instead, lib-dynamodb would have PutCommand that would be an abstraction on top of this INSERT command.

Please check out this doc page

So in your case it would look something like:

import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
import { DynamoDBDocumentClient, PutCommand } from "@aws-sdk/lib-dynamodb";

const client = new DynamoDBClient({ region: "us-east-1" });
const docClient = DynamoDBDocumentClient.from(client);


try {
    await docClient.send(new PutCommand({
        TableName: "Coffees",
        Item: {
            'varietal': "arabica",
            'profile': ["chocolate", "floral"]
        }
    }));
    console.log("Item inserted successfully.");  
} catch (error) {
    console.error(error);
}

Let me know if you have any other questions!
Thanks,
Ran~

[cpyle0819]

Hey, Ran. lib-dynamodb exports the ExecuteStatementCommand so data attribute types can be avoided. It sounds like you're telling me not to use that command from lib-dynamodb. It's a documented part of the library. Is that wrong?

[RanVaknin]

Hi @cpyle0819 ,

I totally missed that part. Partly because we don't have an example for it anywhere!

I'm able to reproduce the bug with the provided code and confirm that the serialization fails when trying to insert an array of arrays.

Will add to backlog.
Thanks,
Ran~

[samuel-bach]

Same error also gets thrown for objects:

const command = new ExecuteStatementCommand({
  Statement: `INSERT INTO Coffees value {'varietal':?, 'profile':?}`,
  Parameters: ["arabica", { foo: "bar"}],
});

[kitsunde]

@RanVaknin Could the typescript defs be fixed first since I am assuming this will take some time? ExecuteStatementCommand accepts NativeAttributeValue because of: https://github.com/aws/aws-sdk-js-v3/blob/main/packages/util-dynamodb/src/models.ts#L15 but it doesn't seem to actually handle {foo: 'bar'} as a value.

What seem to be happening is a parameter:

{foo: 'bar'}

becomes

{ foo: {S: 'bar'} }

but if you nest it:

{ inner: {foo: 'bar'} }

It understands the inner parts just fine:

{ inner: { M: { foo: { S: 'bar' } } } }

Effectively using the document client with PartiQL becomes not practical when dealing with non-scalar values.

[kitsunde]

In case anyone else runs into this, you'll want to import marshall from util-dynamodb and use call the regular dynamodb client instead.

To get this working:

Same error also gets thrown for objects:

const command = new ExecuteStatementCommand({
  Statement: `INSERT INTO Coffees value {'varietal':?, 'profile':?}`,
  Parameters: ["arabica", { foo: "bar"}],
});

Do this:

const { DynamoDBClient, ExecuteStatementCommand } = require('@aws-sdk/client-dynamodb');
const { marshall } = require('@aws-sdk/util-dynamodb');
const client = new DynamoDBClient({});

const command = new ExecuteStatementCommand({
  Statement: `INSERT INTO Coffees value {'varietal':?, 'profile':?}`,
  Parameters: marshall([
    "arabica",
    { foo: "bar"}
  ]),
});

await client.send(statement);

[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.