feat(storage): add folder deletion support to remove API #14671

osama-rizk · 2026-01-12T15:45:09Z

Description of changes

This PR adds folder deletion support to the Storage remove API.

Key Features:

Folder Deletion: Enhanced remove API to delete entire folders and their contents using S3 batch operations
Progress Tracking: Added progress callbacks for batch deletion operations with success/failure reporting
Cancellation Support: Integrated CancellationToken for long-running folder deletion operations
Path Validation: Added safety checks to prevent deletion of dangerous paths (root, bucket-wide)

Technical Implementation:

New deleteObjects S3 client operation for batch deletion
deleteFolderContents utility for recursive folder deletion with pagination
isPathFolder utility to detect folders vs files
Function overloads on remove APIs for proper type inference
Comprehensive test coverage for all new functionality

Issue #, if available

Closes #5841

Description of how you validated changes

Unit Tests: Added test coverage for all utilities and API changes
Manual Testing: Linked the JS package locally with UI (storage browser) and verify the backward compatibility and the new functionality (folder deletion, progress tracking, cancelling......etc)

Checklist

PR description included
yarn test passes
Unit Tests are changed or added
Relevant documentation is changed or added (and PR referenced)

Checklist for repo maintainers

Verify E2E tests for existing workflows are working as expected or add E2E tests for newly added workflows
New source file paths included in this PR have been added to CODEOWNERS, if appropriate

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

packages/storage/__tests__/providers/s3/utils/validateRemovePath.test.ts

packages/storage/src/providers/s3/utils/generateDeleteObjectsXml.ts

packages/storage/__tests__/providers/s3/utils/CancellationToken.test.ts

packages/storage/src/providers/s3/types/inputs.ts

packages/storage/src/providers/s3/apis/remove.ts

…omise for remove operation.

soberm · 2026-01-13T12:25:43Z

Did you also create E2E tests?

osama-rizk · 2026-01-13T13:26:07Z

Did you also create E2E tests?

Not yet. But will do in a follow up PR. BTW the existing e2e test already verifying this change is working (for files) and backward compatible.

bobbor · 2026-01-15T10:40:25Z

packages/storage/src/providers/s3/utils/client/s3data/deleteObjects.ts

+		delete: '',
+	}).toString();
+
+	const objects = input


better use generateDeleteObjectsXml helper function

packages/storage/src/providers/s3/utils/client/s3data/deleteObjects.ts

bobbor · 2026-01-15T10:43:16Z

packages/storage/src/providers/s3/utils/client/s3data/deleteObjects.ts

+	}).toString();
+
+	const objects = input
+		.Delete!.Objects?.map(obj => `<Object><Key>${obj.Key}</Key></Object>`)


Objects is not optional. the ? is not needed here

also (the optional) VersionId is missing here

bobbor · 2026-01-15T10:48:42Z

packages/storage/src/providers/s3/utils/client/s3data/types.ts

+export interface DeleteObjectsCommandInput {
+	Bucket: string;
+	Delete: {
+		Objects: Array<{ Key: string; VersionId?: string }>;


alternative to what I mentioned further up, remove the VersionId from the types

bobbor · 2026-01-15T11:02:22Z

packages/storage/src/providers/s3/utils/deleteFolderContents.ts

+						Quiet: false,
+					},
+					ExpectedBucketOwner: expectedBucketOwner,
+					ContentMD5: await calculateContentMd5(xmlBody),


move this to the serializer

bobbor · 2026-01-15T11:02:35Z

packages/storage/src/providers/s3/utils/deleteFolderContents.ts

+			}
+
+			const batch = listResult.Contents.map(obj => ({ Key: obj.Key! }));
+			const xmlBody = generateDeleteObjectsXml(batch, false);


this can be done in the serializer

bobbor · 2026-01-15T11:44:43Z

packages/storage/src/providers/s3/types/inputs.ts

+ * Represents an ongoing remove operation with cancellation and state tracking capabilities
+ * @template T - The type of the result (RemoveWithPathOutput | RemoveOutput)
+ */
+export interface RemoveOperation<T> {


better update this type to

interface NonPausableTransferTask<T> extends Omit<TransferTask<T>, 'pause' | 'resume' | 'state'> { state: Omit<TransferTask<T>['state'], 'PAUSED'>; } interface RemoveOperation<T> extends NonPausableTransferTask<T>, Promise<T> {}

bobbor · 2026-01-15T11:45:39Z

packages/storage/src/providers/s3/apis/internal/remove.ts

-	);
+		then: wrappedPromise.then.bind(wrappedPromise),
+		catch: wrappedPromise.catch.bind(wrappedPromise),
+		finally: wrappedPromise.finally.bind(wrappedPromise),


use Object.assign here, to assign these operation props to the wrappedPromise and then you can drop the then/catch/finally

bobbor · 2026-01-15T11:46:04Z

packages/storage/src/providers/s3/apis/internal/remove.ts

-		logger.debug(`removing object in path "${finalKey}"`);
-	}
+): RemoveOperation<RemoveOutput | RemoveWithPathOutput> {
+	const cancellationToken = new CancellationToken();


here an AbortController is better to use as it is built-in

ultimately check if the AbortController can be passed all the way down to the transferHandler/fetchHandler.

bobbor · 2026-01-15T11:52:08Z

packages/storage/src/providers/s3/apis/internal/remove.ts

+	let state: RemoveTaskState = 'IN_PROGRESS';
+
+	const resultPromise = executeRemove(amplify, input, cancellationToken);
+	const wrappedPromise = resultPromise


see if it makes sense to create a factory function for "AbortablePromise / AbortableTask", which consolidates the result/cancel function with promises.

But some tasks might not have pause/resume on them aka "NonPausableTransferTask"

bobbor · 2026-01-15T12:00:32Z

packages/storage/src/providers/s3/apis/internal/remove.ts

+
+			await deleteObject(
+				{
+					...s3Config,


here you can add the abortSignal

osama-rizk added 2 commits January 12, 2026 15:08

feat(storage): add folder deletion support to remove API

63d77aa

Add unit tests

e0cd53e

osama-rizk requested review from a team, avi-karthik, pranavosu and sarayev as code owners January 12, 2026 15:45

Merge branch 'main' into feature/storage-remove-folder-deletion

8022a46

osama-rizk added the run-tests run the pr-label workflow label Jan 12, 2026

Raise remove function size limit

c507383

osama-rizk requested a review from a team as a code owner January 12, 2026 16:10

osama-rizk added run-tests run the pr-label workflow and removed run-tests run the pr-label workflow labels Jan 12, 2026

soberm self-assigned this Jan 13, 2026

soberm reviewed Jan 13, 2026

View reviewed changes

Address PR review comments. Add XML escaping, update tests, extend pr…

1849103

…omise for remove operation.

osama-rizk force-pushed the feature/storage-remove-folder-deletion branch from 4e2d753 to 1849103 Compare January 13, 2026 12:03

Merge branch 'main' into feature/storage-remove-folder-deletion

72e01f8

soberm previously approved these changes Jan 13, 2026

View reviewed changes

osama-rizk assigned bobbor Jan 13, 2026

bobbor reviewed Jan 15, 2026

View reviewed changes

packages/storage/src/providers/s3/utils/client/s3data/deleteObjects.ts Outdated Show resolved Hide resolved

bobbor reviewed Jan 15, 2026

View reviewed changes

osama-rizk added 3 commits January 15, 2026 14:44

move MD5 calculation to deleteObjects serializer

a9f379a

Create "NonPausableTransferTask" type

96b988a

Use AbortController.

47f2157

osama-rizk dismissed soberm’s stale review via 47f2157 January 15, 2026 15:04

osama-rizk and others added 2 commits January 15, 2026 16:38

Add abortable factory function.

2b38bd1

Merge branch 'main' into feature/storage-remove-folder-deletion

3f4fbc6

feat(storage): add folder deletion support to remove API #14671

Are you sure you want to change the base?

feat(storage): add folder deletion support to remove API #14671

Uh oh!

Conversation

osama-rizk commented Jan 12, 2026

Description of changes

Issue #, if available

Description of how you validated changes

Checklist

Checklist for repo maintainers

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

soberm commented Jan 13, 2026

Uh oh!

osama-rizk commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

osama-rizk commented Jan 13, 2026 •

edited

Loading