Library fails in typescript compilation with exactOptionalPropertyTypes=true

FranzZemen commented 1 week ago

Checkboxes for prior research

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

Describe the bug

Pretty simple. Set exactOptionalPropertyTypes=true in 3.693.0 (this morning's latest NPM release) and compile. You will get transpiration errors such as:

BatchStatementRequest' is not assignable to type '{ Parameters?: any[]; }' with 'exactOptionalPropertyTypes: true

Set it to false, and there is no issue.

This causes problems for any project that is using the flag.

I have the following installed in my npm dependencies:

    "@aws-sdk/client-cloudwatch-logs": "^3.693.0",
    "@aws-sdk/client-s3": "^3.693.0",
    "@aws-sdk/credential-providers": "^3.693.0",
    "@aws-sdk/lib-dynamodb": "^3.693.0",

It does NOT happen in 3.687.0. Not sure about versions in between.

Node V20.2.0, Typescript 5.6.3 for both working and non-working versions

Regression Issue

[ ] Select this option if this issue appears to be a regression.

SDK version number

@aws-sdk/lib-dynamo@3.693.0

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

Node V20.2.0, Typescript 5.6.3

Reproduction Steps

set exactOptionalPropertyTypes=true and transpile using tsc

Observed Behavior

Typescript errors within AWS v3 library such as

BatchStatementRequest' is not assignable to type '{ Parameters?: any[]; }' with 'exactOptionalPropertyTypes: true

Expected Behavior

No typescript errors

Possible Solution

workaround is to set exactOptionalPropertyTypes=false

Additional Information/Context

No response

zshzbh commented 5 days ago

Hey @FranzZemen ,

Could you please provide a minimal code reproduction? The error occurs because with exactOptionalPropertyTypes: true, we need to be more precise with our type definitions.

Thanks! Maggie

zshzbh commented 5 days ago

I worked on this a fair bit-

The dependencies I have

  "dependencies": {
    "@aws-sdk/client-cloudwatch-logs": "^3.693.0",
    "@aws-sdk/client-dynamodb": "^3.693.0",
    "@aws-sdk/client-s3": "^3.693.0",
    "@aws-sdk/credential-providers": "^3.693.0",
    "@aws-sdk/lib-dynamodb": "^3.693.0",
    "@types/node": "^20.2.0",
    "ts-node": "^x.x.x",
    "typescript": "^5.6.3"
  }

In tsconfig.json, I set "exactOptionalPropertyTypes": true,

I ran npm run build , and I don't see any error. I can share my code below, hopefully it can be a good reference to solve the issue you have . In the code below, I use executeBatchStatements to insert the sample data and batchReadItems to read the data-


import { 
    DynamoDBClient, 
    BatchExecuteStatementCommand,
    BatchStatementRequest,
    AttributeValue
  } from "@aws-sdk/client-dynamodb";

  // Define interfaces
  interface Item {
    id: string;
    name: string;
    category?: string;
    price?: number;
  }

  interface BatchOperationResponse {
    success: boolean;
    data?: any;
    error?: Error;
  }

  // DynamoDB client configuration
  const client = new DynamoDBClient({ 
    region: "us-west-2" 
  });

  // Main batch operation function
  async function executeBatchStatements(items: Item[]): Promise<BatchOperationResponse> {
    const statements: BatchStatementRequest[] = items.map((item) => {
      const parameters: AttributeValue[] = [
        { S: item.id },
        { S: item.name },
        item.category ? { S: item.category } : { NULL: true },
        item.price !== undefined ? { N: item.price.toString() } : { NULL: true }
      ];

      return {
        Statement: "INSERT INTO Products VALUE {'id': ?, 'name': ?, 'category': ?, 'price': ?}",
        Parameters: parameters,
        ConsistentRead: true
      };
    });

    try {
      const command = new BatchExecuteStatementCommand({
        Statements: statements
      });

      const response = await client.send(command);

      if (response.Responses) {
        const errors = response.Responses.filter(r => r.Error);
        if (errors.length > 0) {
          console.warn('Some statements failed:', errors);
        }
      }

      return {
        success: true,
        data: response.Responses
      };

    } catch (error) {
      console.error('Batch operation failed:', error);
      return {
        success: false,
        error: error as Error
      };
    }
  }

  // Batch read operation
  async function batchReadItems(ids: string[]): Promise<BatchOperationResponse> {
    const statements: BatchStatementRequest[] = ids.map(id => ({
      Statement: "SELECT * FROM Products WHERE id = ?",
      Parameters: [{ S: id }],
      ConsistentRead: true
    }));

    try {
      const command = new BatchExecuteStatementCommand({
        Statements: statements
      });

      const response = await client.send(command);

      return {
        success: true,
        data: response.Responses
      };

    } catch (error) {
      console.error('Batch read operation failed:', error);
      return {
        success: false,
        error: error as Error
      };
    }
  }

  // Example usage
  async function main() {
    const items: Item[] = [
      {
        id: "1",
        name: "Product 1",
        category: "Electronics",
        price: 299.99
      },
      {
        id: "2",
        name: "Product 2",
        category: "Books",
        price: 19.99
      }
    ];

    console.log('Executing batch insert...');
    const insertResult = await executeBatchStatements(items);
    console.log('Insert result:', insertResult);

    console.log('Executing batch read...');
    const readResult = await batchReadItems(["1", "2"]);
    console.log('Read result:', readResult);
  }

  // Execute with error handling
  main()
    .then(() => console.log('All operations completed'))
    .catch(error => console.error('Error in main execution:', error));

Since I don't have the minimal code reproduction yet, I'd like to suggest to check the types, and use precise types instead of any for Optional Properties.

If you still have questions, please share minimal code reproduction and we can help you from there!

Thanks! Maggie

FranzZemen commented 4 days ago

In the repo below, in tsconfig.base.json, with "exactOptionalPropertyTypes": true it produces the errors. With "exactOptionalPropertyTypes": false it does not.

Commands:

git clone https://github.com/FranzZemen/aws.3.693.0.bug cd AWS.3.693.0.bug npm i ./node_modules/typescript/bin/tsc

Or find relevant info below

Repo @franzzemen/aws.3.693.0.bug

If more convenient here are the need files. Test src below (can't attach .ts file) package.json tsconfig.base.json tsconfig.json

source file contents, place in ./src/test.ts

import {DynamoDBDocument} from '@aws-sdk/lib-dynamodb';
import {DynamoDBClient} from '@aws-sdk/client-dynamodb';

export class DynamoClient {
  private documentClient: DynamoDBDocument;
  private dbClient: DynamoDBClient;

  constructor() {

    this.dbClient = new DynamoDBClient();
    this.documentClient = DynamoDBDocument.from(this.dbClient, {
      marshallOptions: {
        removeUndefinedValues: true
      }
    });
  }
}

monholm commented 4 days ago

And even simpler repro with some additional context in the readme can be found at: https://github.com/monholm/aws-sdk-ts-repro

The issue was introduced in v3.691.0 and remains in the latest version (v3.693.0 as of 2024-11-19) Downgrading to @aws-sdk/client-dynamodb@3.687.0 and @aws-sdk/lib-dynamodb@3.689.0 will resolve it. These versions are the latest versions released prior to v3.691.0.

kuhe commented 2 days ago

merged https://github.com/aws/aws-sdk-js-v3/pull/6683, will be released in the next published version expected tomorrow.

aws / aws-sdk-js-v3