Proxy Support for APIGatewayClient Broken in 3.502.0 -> 3.513.0

[m3h]

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

GetApiKeysCommand fails when using a proxy with the following error:

node:internal/process/promises:289
            triggerUncaughtException(err, true /* fromPromise */);
            ^

Error: getaddrinfo ENOTFOUND sts.us-east-1.amazonaws.com
    at GetAddrInfoReqWrap.onlookupall [as oncomplete] (node:dns:118:26) {
  errno: -3008,
  code: 'ENOTFOUND',
  syscall: 'getaddrinfo',
  hostname: 'sts.us-east-1.amazonaws.com',
  '$metadata': { attempts: 1, totalRetryDelay: 0 }
}

Node.js v20.10.0

SDK version number

@aws-sdk/client-api-gateway@3.502.0 - @aws-sdk/client-api-gateway@3.513.0

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

v20.10.0

Reproduction Steps

Run the following script, using @aws-sdk/client-api-gateway versions 3.502.0 to 3.513.0, replacing the proxy ("http://127.0.0.1:3128") with an HTTPS-capable proxy. Ensure outbound traffic flows through proxy, and that no DNS queries are made from the sdk (DNS should be handled by proxy). My environment is behind a corporate VPN that blocks general internet access, except via a proxy.

const { NodeHttpHandler } = require('@smithy/node-http-handler');
const { HttpsProxyAgent } = require('hpagent');
const { APIGatewayClient, GetApiKeysCommand } = require('@aws-sdk/client-api-gateway');

const agent = new HttpsProxyAgent({ proxy: "http://127.0.0.1:3128" });
const apiGatewayClient = new APIGatewayClient({
        requestHandler: new NodeHttpHandler({
          httpAgent: agent,
          httpsAgent: agent,
        }),
});

const getApiKeysCmd = new GetApiKeysCommand({
        limit: 2,
        includeValues: true,
});

async function main() {
        const apiGatewayKeysResponse = await apiGatewayClient.send(getApiKeysCmd);
        console.log(apiGatewayKeysResponse);
}

main()

Observed Behavior

node:internal/process/promises:289
            triggerUncaughtException(err, true /* fromPromise */);
            ^

Error: getaddrinfo ENOTFOUND sts.us-east-1.amazonaws.com
    at GetAddrInfoReqWrap.onlookupall [as oncomplete] (node:dns:118:26) {
  errno: -3008,
  code: 'ENOTFOUND',
  syscall: 'getaddrinfo',
  hostname: 'sts.us-east-1.amazonaws.com',
  '$metadata': { attempts: 1, totalRetryDelay: 0 }
}

Node.js v20.10.0

Expected Behavior

I expected the code snippet to print a list of API keys.

Possible Solution

Possibly related to the lazy load STS & SSO clients in credential providers feature, introduced in v3.502.0: https://github.com/aws/aws-sdk-js-v3/releases/tag/v3.502.0

Additional Information/Context

Any version below 3.502.0 seems to work.

Output of npm list:

└─➜ npm list
proxy-issues@ /.../proxy-issues
├── @aws-sdk/client-api-gateway@3.513.0
├── @smithy/node-http-handler@2.3.1
└── hpagent@1.2.0

Output of npm --version:

└─➜ npm --version
10.2.3

[kuhe]

Hi, thanks for reporting this issue. I've made a change in PR #5801 to pass through the requestHandler from the user client.

As a workaround, you can supply it explicitly:

...
import { fromNodeProviderChain } from "@aws-sdk/credential-providers";

const requestHandler = new NodeHttpHandler({
  httpAgent: agent,
  httpsAgent: agent,
});

const apiGatewayClient = new APIGatewayClient({
  requestHandler,
  credentials: fromNodeProviderChain({
    clientConfig: { requestHandler }
  }),
});

[kuhe]

I expect the fix to be released later today in v3.515.0

[m3h]

Thanks, I tried out v3.515.0 and it fixed my issue!

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