aws-sdk's AbortSignal can't be given to Response

[koSakano]

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 abortController.signal passed to client.send is internally passed to Respnose, but an error occurred in that area.

const abortController = new AbortController();
const client = new S3Client(clientParams);

const requestPromise = client.send(new CreateBucketCommand(commandParams), {
  abortSignal: abortController.signal,
});

SDK version number

@aws-sdk/[email protected] @aws-sdk/[email protected]

Which JavaScript Runtime is this issue in?

Browser

Details of the browser/Node.js/ReactNative version

Chrome: 111.0.5563.110

Reproduction Steps

import { AbortController } from '@aws-sdk/abort-controller';

const controller = new AbortController();
// Type 'AbortSignal' is missing the following properties from type 'AbortSignal': reason, throwIfAborted, addEventListener,  removeEventListener, dispatchEvent
new Response(url, { signal: controller.signal });

aws-sdk-js-v3/packages/fetch-http-handler/src/fetch-http-handler.ts

Line 75 in 9152e21

const fetchRequest = new Request(url, requestOptions);

Observed Behavior

TypeError: Failed to construct 'Request': Failed to read the 'signal' property from 'RequestInit': Failed to convert value to 'AbortSignal'.

Expected Behavior

Works like a standard AbortController.

Possible Solution

No response

Additional Information/Context

No response

[RanVaknin]

Hi @koSakano ,

Can confirm this is only happening after bundling for web.

[koSakano]

@RanVaknin
Yes, I can confirm that it probably only happens after bundling for the web.
This did not happen with Node18.

[kuhe]

For browsers, don't bundle the AbortController implementation from the @aws-sdk/abort-controller package.

Just use the browser's native AbortController, and it should be fine.

[koSakano]

@kuhe
The browser's native AbortController is not available because it has a different type than the aws-sdk's AbortController.

// The browser's native AbortController
const abortController = new AbortController();
const client = new S3Client(clientParams);

const requestPromise = client.send(new CreateBucketCommand(commandParams), {
  // error occurred
  abortSignal: abortController.signal,
});

For example, in this case you will get the following error.

No overload matches this call.
  Overload 1 of 3, '(command: Command<ServiceInputTypes, PutObjectCommandInput, ServiceOutputTypes, PutObjectCommandOutput, SmithyResolvedConfiguration<...>>, options?: HttpHandlerOptions | undefined): Promise<...>', gave the following error.
    Type 'AbortSignal' is not assignable to type 'import(".../node_modules/@aws-sdk/types/dist-types/abort").AbortSignal'.
  Overload 2 of 3, '(command: Command<ServiceInputTypes, PutObjectCommandInput, ServiceOutputTypes, PutObjectCommandOutput, SmithyResolvedConfiguration<...>>, cb: (err: any, data?: PutObjectCommandOutput | undefined) => void): void', gave the following error.
    Argument of type '{ abortSignal: AbortSignal; }' is not assignable to parameter of type '(err: any, data?: PutObjectCommandOutput | undefined) => void'.
      Object literal may only specify known properties, and 'abortSignal' does not exist in type '(err: any, data?: PutObjectCommandOutput | undefined) => void'.

[kuhe]

override the type error with abortController.signal as any, until a fix is made.

[kuhe]

in #4591 I've loosened the type requirement such that this should no longer be a compilation error in future versions

[koSakano]

@kuhe
I've confirmed that the error no longer occurs in v.3.303.0. Thanks for the fix.

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