Bad types after smithy upgrade

[xconverge]

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

Here are 2 examples of some issues I am experiencing with types with 3.363.0

I scanned through https://github.com/aws/aws-sdk-js-v3/blob/main/CHANGELOG.md and can't find anything that makes these seem like intentional changes, sorry if this is all a bit vague but maybe someone with more information can ask more pointed questions/add something that helps.

3.362.0 is all good, 3.363.0 has all sorts of issues. The only change that seems relevant to me is #4873

Issues I see with @aws-sdk/s3-request-presigner:

Argument of type 'S3' is not assignable to parameter of type 'Client<any, ServiceInputTypes, MetadataBearer, any>'.
  The types of 'middlewareStack.add' are incompatible between these types.
    Type '{ (middleware: InitializeMiddleware<ServiceInputTypes, ServiceOutputTypes>, options?: (InitializeHandlerOptions & AbsoluteLocation) | undefined): void; (middleware: SerializeMiddleware<...>, options: SerializeHandlerOptions & AbsoluteLocation): void; (middleware: BuildMiddleware<...>, options: BuildHandlerOptions & ...' is not assignable to type '{ (middleware: InitializeMiddleware<ServiceInputTypes, MetadataBearer>, options?: (InitializeHandlerOptions & AbsoluteLocation) | undefined): void; (middleware: SerializeMiddleware<...>, options: SerializeHandlerOptions & AbsoluteLocation): void; (middleware: BuildMiddleware<...>, options: BuildHandlerOptions & Abso...'.
      Types of parameters 'middleware' and 'middleware' are incompatible.
        Types of parameters 'next' and 'next' are incompatible.
          Type 'InitializeHandler<ServiceInputTypes, ServiceOutputTypes>' is not assignable to type 'InitializeHandler<ServiceInputTypes, MetadataBearer>'.
            Type 'ServiceOutputTypes' is not assignable to type 'MetadataBearer'.ts(2345)

Issues I see with @aws-sdk/client-s3:

Property 'Body' does not exist on type 'GetObjectCommandOutput'.ts(2339)

SDK version number

@aws-sdk/s3-request-presigner@3.363.0

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

node v18.16.0

Reproduction Steps

Code snippets in screenshots are one example

Observed Behavior

Lots of typescript errors and weirdness with 3.363.0

Expected Behavior

Types work correctly like in 3.362.0

Possible Solution

No response

Additional Information/Context

No response

[xconverge]

I also just noticed this was reported while I was reporting my issue, and it looks related IMO #4927

[RanVaknin]

Hi @xconverge ,

Thanks for opening this issue.

The code snippets you attached as images are incomplete and hard to assess since they are in image form.

I wrote some repro code loosly based on the information you have provided:

import { S3Client, GetObjectCommand, HeadObjectCommand, GetObjectCommandOutput } from "@aws-sdk/client-s3";

const main = async () => {
  const client = new S3Client({ region: "us-east-1" });
  const params = { Bucket: "testbucket", Key: "hey.txt" };
  const headCommand = new HeadObjectCommand(params);

  return client.send(headCommand).then(async () => {
    const getCommand = new GetObjectCommand(params);
    const data: GetObjectCommandOutput = await client.send(getCommand);

    if (data.Body) {
      console.log("Body exists on data");
      return;
    }
    console.log("Body does not exist on data");
  });
};

main()
  .catch(console.error);

This compiles and runs successfully:

$ npm list
4928@1.0.0 /Users/rvaknin/test_folder/4928
├── @aws-sdk/client-s3@3.363.0
└── @types/node@20.4.0
$ tsc src/sample.ts 
$ node src/sample.js
Body exists on data

This is odd, because I was not able to reproduce #4927 either. To give you an idea of how I'm reproducing this, with each reproduction I'm creating a new project from scratch, so Im wondering maybe your code has some dependencies that aren't resolving correctly.
Can you deleting your node_modules and package-lock.json and try running npm install again to see if it solves the problem?

Otherwise, if you can upload a minimal github repo that can consistently reproduce this behavior, it would be extremely helpful.

Thanks again,
Ran~

[xconverge]

@RanVaknin I did not use client.send, I used the alternative API, so perhaps that makes a difference and is why your repro code doesnt repro it. Sorry for the images, I knew it was a half-baked bug report but was hoping there was something obvious.

If instead of what you wrote you were to do something like this, what do you see?

import { S3Client, GetObjectCommand, HeadObjectCommand, GetObjectCommandOutput } from "@aws-sdk/client-s3";

const main = async () => {
  const client = new S3Client({ region: "us-east-1" });
  const params = { Bucket: "testbucket", Key: "hey.txt" };

  return client.send(headCommand).then(async () => {
    //const getCommand = new GetObjectCommand(params);
    const data: GetObjectCommandOutput = await client.getObject(params);

    if (data.Body) {
      console.log("Body exists on data");
      return;
    }
    console.log("Body does not exist on data");
  });
};

main()
  .catch(console.error);

I will try to get to an actual small reproducible example tomorrow, but I experienced this over a handful of repositories and all of it looks similar (albeit slight differences between which client/lib I was using)

[Joel-PeakMetrics]

I'm seeing the same problem with deno (strict TS checks). Deno version 1.34.2

import { GetObjectCommand, PutObjectCommand, S3Client } from "npm:@aws-sdk/client-s3@3.363.0";
const s3Client = new S3Client({
    "region":"us-east-1",
    "endpoint":"http://localhost:4566",
    "forcePathStyle": true
})

const command = new GetObjectCommand({
    Bucket: "local-raw-data",
    Key: "*",
});
const objectsFound = await s3Client.send(command);

$ deno check s3test.ts
Check file:///.../s3test.ts
TS2345 [ERROR]: Argument of type 'GetObjectCommand' is not assignable to parameter of type 'Command<ServiceInputTypes, GetObjectCommandInput, ServiceOutputTypes, GetObjectCommandOutput, SmithyResolvedConfiguration<...>>'.
  Types of property 'resolveMiddleware' are incompatible.
    Type '(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: HttpHandlerOptions | undefined) => Handler<...>' is not assignable to type '(stack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SmithyResolvedConfiguration<HttpHandlerOptions>, options: any) => Handler<...>'.
      Types of parameters 'clientStack' and 'stack' are incompatible.
        Type 'import("file:///.../node_modules/.deno/@smithy+smithy-client@1.0.3/node_modules/@smithy/types/dist-types/middleware.d.ts").MiddlewareStack<import("file:///.../node_modules/.deno/@aws-sdk+client-s3@3.363.0/node_mod...' is not assignable to type 'import("file:///.../node_modules/.deno/@aws-sdk+client-s3@3.363.0/node_modules/@smithy/types/dist-types/middleware.d.ts").MiddlewareStack<import("file:///.../node_modules/.deno/@aws-sdk+client-s3@3.363.0/node_modu...'.
          Types of property 'concat' are incompatible.
            Type '<InputType extends import("file:///.../node_modules/.deno/@aws-sdk+client-s3@3.363.0/node_modules/@aws-sdk/client-s3/dist-types/S3Client.d.ts").ServiceInputTypes, OutputType extends import("file:///.../node_module...' is not assignable to type '<InputType extends import("file:///.../node_modules/.deno/@aws-sdk+client-s3@3.363.0/node_modules/@aws-sdk/client-s3/dist-types/S3Client.d.ts").ServiceInputTypes, OutputType extends import("file:///.../node_module...'. Two different types with this name exist, but they are unrelated.
              Types of parameters 'from' and 'from' are incompatible.
                Type 'MiddlewareStack<InputType, OutputType>' is not assignable to type 'MiddlewareStack<InputType, ServiceOutputTypes>'.
                  Types of property 'addRelativeTo' are incompatible.
                    Type '(middleware: MiddlewareType<InputType, OutputType>, options: RelativeMiddlewareOptions) => void' is not assignable to type '(middleware: MiddlewareType<InputType, ServiceOutputTypes>, options: RelativeMiddlewareOptions) => void'.
                      Types of parameters 'middleware' and 'middleware' are incompatible.
                        Type 'MiddlewareType<InputType, ServiceOutputTypes>' is not assignable to type 'MiddlewareType<InputType, OutputType>'.
                          Type 'InitializeMiddleware<InputType, ServiceOutputTypes>' is not assignable to type 'MiddlewareType<InputType, OutputType>'.
                            Type 'InitializeMiddleware<InputType, ServiceOutputTypes>' is not assignable to type 'InitializeMiddleware<InputType, OutputType>'.
                              Call signature return types 'InitializeHandler<InputType, ServiceOutputTypes>' and 'InitializeHandler<InputType, OutputType>' are incompatible.
                                Type 'Promise<InitializeHandlerOutput<ServiceOutputTypes>>' is not assignable to type 'Promise<InitializeHandlerOutput<OutputType>>'.
                                  Type 'InitializeHandlerOutput<ServiceOutputTypes>' is not assignable to type 'InitializeHandlerOutput<OutputType>'.
                                    Types of property 'output' are incompatible.
                                      Type 'ServiceOutputTypes' is not assignable to type 'OutputType'.
                                        'ServiceOutputTypes' is assignable to the constraint of type 'OutputType', but 'OutputType' could be instantiated with a different subtype of constraint 'ServiceOutputTypes'.
                                          Type 'AbortMultipartUploadCommandOutput' is not assignable to type 'OutputType'.
                                            'AbortMultipartUploadCommandOutput' is assignable to the constraint of type 'OutputType', but 'OutputType' could be instantiated with a different subtype of constraint 'ServiceOutputTypes'.
const objectsFound = await s3Client.send(command);
                                         ~~~~~~~
    at file:///.../s3test.ts:14:42

Found 2 errors.

[RanVaknin]

Hi @xconverge,

I noticed some inconsistencies in your code. It seems like you were trying to use S3.headObject() rather than s3Client.send(new HeadObjectCommand({})) but I think I understand what you were trying to demonstrate:

import { S3, GetObjectCommandOutput } from "@aws-sdk/client-s3";

const main = async () => {
  const client = new S3({ region: "us-east-1" });
  const params = { Bucket: "testbucket", Key: "hey.txt" };

  return client.headObject(params).then(async () => {
    const data: GetObjectCommandOutput = await client.getObject(params);

    if (data.Body) {
      console.log("Body exists on data");
      return;
    }
    console.log("Body does not exist on data");
  });
};

main()
  .catch(console.error);

Yet, this modification doesn't seem to alter the outcome. The body is still present, which aligns with the type definitions.

We are aware that some users are encountering this issue, but it's been challenging for our team to replicate. If you could provide a minimal repository demonstrating this issue, it would be greatly appreciated.

Thanks again,
Ran~

[xconverge]

Deleting my lock file and reinstalling seems to resolve the issues...

[richgarner-nsw-gov]

I think this is the same as I raised here

Especially the comment