Dealing with an AWS S3 bucket file not found error: A comprehensive guide

Question

Dealing with an AWS S3 bucket file not found error: A comprehensive guide

My image route uses a controller like this:

public getImage(request: Request, response: Response): Response {
    try {
        const key = request.params.key;
        const read = getFileStream(key);

        return read.pipe(response);
    } catch (error) {
        return response.status(404).json({
            message: 'Image not found.'
        });
    }
}

Additionally, I have the following function:

// aws.ts

export function getFileStream(fileKey: any) {
    const downloadParams = {
        Key: fileKey,
        Bucket: bucketName
    };

    return s3.getObject(downloadParams).createReadStream();
}

However, I encounter an issue when I provide a key that doesn't exist in the S3 bucket. The try/catch block does not handle this scenario, causing my app to crash with an 'Access denied' error code. How can I resolve this situation? Thank you! 😁

typescript express amazon-s3

Answer 1

Answer №1

In order to ensure that the key refers to a valid object, I first validate it by retrieving the object data before attempting to access the object itself. If the object does not exist, an error is thrown which can be caught, as shown below:

// aws.ts

export async function getFileStream(key: string) {
    const downloadParams = {
        Key: key,
        Bucket: bucketName
    };

    try {
        // Check if object exists
        const head = await s3.headObject(downloadParams).promise();

        // Return the object
        return s3.getObject(downloadParams).createReadStream();
    } catch (headErr: any) {
        // Return null if an error occurs
        return null;
    }
}

Then, in the controller:

public async getFile(request: Request, response: Response) {
    const key = request.params.key;

    const read = await getFileStream(key);

    if (read != null) return read.pipe(response);
    else return response.sendStatus(404);
}

Make sure to include the list bucket option in your S3 policy, as it is required to use the headObject() method. Below is an example of the policy needed:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:DeleteObject",
                // The following actions are required
                "s3:GetObject",
                "s3:ListBucket",
            ],
            "Resource": [
                "arn:aws:s3:::YOUR-BUCKET-NAME-HERE",
                "arn:aws:s3:::YOUR-BUCKET-NAME-HERE/*"
            ]
        }
    ]
}

Answer 2

In order to ensure that the key refers to a valid object, I first validate it by retrieving the object data before attempting to access the object itself. If the object does not exist, an error is thrown which can be caught, as shown below:

// aws.ts

export async function getFileStream(key: string) {
    const downloadParams = {
        Key: key,
        Bucket: bucketName
    };

    try {
        // Check if object exists
        const head = await s3.headObject(downloadParams).promise();

        // Return the object
        return s3.getObject(downloadParams).createReadStream();
    } catch (headErr: any) {
        // Return null if an error occurs
        return null;
    }
}

Then, in the controller:

public async getFile(request: Request, response: Response) {
    const key = request.params.key;

    const read = await getFileStream(key);

    if (read != null) return read.pipe(response);
    else return response.sendStatus(404);
}

Make sure to include the list bucket option in your S3 policy, as it is required to use the headObject() method. Below is an example of the policy needed:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:DeleteObject",
                // The following actions are required
                "s3:GetObject",
                "s3:ListBucket",
            ],
            "Resource": [
                "arn:aws:s3:::YOUR-BUCKET-NAME-HERE",
                "arn:aws:s3:::YOUR-BUCKET-NAME-HERE/*"
            ]
        }
    ]
}

Dealing with an AWS S3 bucket file not found error: A comprehensive guide

Answer №1

Similar questions

Encountering a Typescript error while attempting to utilize mongoose functions

Exploring the usage of array map parameters in rxjs 6 when combined with withLatestFrom

Having difficulty implementing dynamic contentEditable for inline editing in Angular 2+

Utilizing Node Express for RESTful API creates a seamless error handling system

Tips for injecting a service into a class (not a component)

Implement a separate module for all routes on express.js version 4

Mongoose: implement the schema from another model

The onSubmit function in React JavaScript is failing to execute, it is not triggering and no error message is being displayed on the frontend console

What is the reason behind the Typescript compiler not converting .ts files to .js files automatically?

Utilizing various settings using `.env` files in NodeJs

The element is implicitly assigned the 'any' type due to the inability to use an expression of type to index the element

removing the mapStateToProps function will result in an undefined value

The state may be modified, but the component remains unchanged

Having trouble with sending values to Angular 7 components' HTML pages

What are the recommended guidelines for using TypeScript effectively?

The "isActive" value does not share any properties with the type 'Properties<string | number, string & {}>'. This issue was encountered while using React with TypeScript

Transition your Sequelize migrations to TypeORM

Errors in Ionic 6 involving the FormBuilder, FormGroup, Validators, FormControl, and ControlContainer

Looking for another alternative to discord.js EvaluatedPermissions?

Generating output from a callback function in TypeScript