waitUntilObjectNotExists hangs when Bucket is missing.

[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

When waitUntilObjectNotExists is called without providing a Bucket, it hangs indefinitely.

Regression Issue

• Select this option if this issue appears to be a regression.

SDK version number

@aws-sdk/[email protected]

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

v20.17.0

Reproduction Steps

import { waitUntilObjectNotExists, S3Client } from "@aws-sdk/client-s3";

const main = async () => {
  await waitUntilObjectNotExists(
    { client: new S3Client({}) },
    { Key: "some-key" }
  );
};

// Call function if run directly
import { fileURLToPath } from "url";
if (process.argv[1] === fileURLToPath(import.meta.url)) {
  main();
}

Observed Behavior

Waiter should fail immediately due to missing param.

Expected Behavior

Waiter hangs forever.

Possible Solution

No response

Additional Information/Context

No response

[aBurmeseDev]

Hi Corey - thanks for reaching out.

In JSv3, waiters requires maxWaitTime field in waiter configuration because the bare-bones modular client does not include the waitFor operation by default. This is similar to delay and maxAttempts fields in JSv2 waiters.

...
await waitUntilObjectNotExists({ client, maxWaitTime: 30 });
...

If you have the maxWaitTime field in your waiter configuration and the client is missing the Bucket property, you will encounter a waiter timeout error. This is how waiters are designed to operate.

However, there's room for improvements in our waiter docs, particularly in providing examples. I created this new issue to address the need for better documentation on waiters.

Closing this issue now.

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