Skip to main content

Asset cleanup

You are responsible for cleaning up assets that were added by the user and are no longer needed.
Assets may lay around in S3 storage buckets and in the local IndexedDB asset cache.

When it is safe to delete assets​

When the user deletes an asset, they may still undo the deletion by pressing Cmd/Ctrl+Z.
As long as the asset is referenced in the undo stack, it is not safe to delete it.

If you want to clean up assets, you need to ensure that the undo stack is clean, or clear the undo stack.

Getting deleted assets​

When an asset is deleted, it is added to the deletedAssets array, part of the undoableState.
As mentioned above, you need to ensure that the user is unable to undo the deletion first.

Deleting assets​

Deleting assets from IndexedDB​

If you have a assetId from an object in the deletedAssets array, you can delete it from IndexedDB by calling the deleteCachedAsset method.

Deleting assets from S3​

If you have a remoteFileKey from an object in the deletedAssets array, you can delete it from S3 using the following code:

Delete an asset from S3 - must be called from the backend
ts
import {getAwsClient} from '@remotion/lambda/client';
import {requireServerEnv} from '../../editor/utils/server-env';
const {REMOTION_AWS_BUCKET_NAME, REMOTION_AWS_REGION} = requireServerEnv();
const {client, sdk} = getAwsClient({
  region: REMOTION_AWS_REGION,
  service: 's3',
});
const command = new sdk.DeleteObjectCommand({
  Bucket: REMOTION_AWS_BUCKET_NAME,
  Key: remoteFileKey,
});
await client.send(command);

You only need to clear assets which have an assetStatus of uploaded.

Removing from the state​

Once an asset has been successfully deleted from S3 and IndexedDB, you can remove it from the state by calling the clearDeletedAsset() method.

See also​