lib/cache/s3.js

// Copyright (c) 2018, Compiler Explorer Authors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

import * as Sentry from '@sentry/node';

import { logger } from '../logger';
import { S3Bucket } from '../s3-handler';

import { BaseCache } from './base';

function messageFor(e) {
    return e.message || e.toString();
}

export class S3Cache extends BaseCache {
    constructor(cacheName, bucket, path, region) {
        super(cacheName, `S3Cache(s3://${bucket}/${path} in ${region})`, 's3');
        this.bucket = bucket;
        this.path = path;
        this.region = region;
        this.s3 = new S3Bucket(bucket, region);
    }

    getInternal(key) {
        return this.s3.get(key, this.path)
            .catch(e => {
                Sentry.captureException(e);
                logger.error(`Error while trying to read S3 cache: ${messageFor(e)}`);
                return {hit: false};
            });
    }

    putInternal(key, value, creator) {
        const options = {
            metadata: {},
            redundancy: 'REDUCED_REDUNDANCY',
        };
        if (creator) {
            options.metadata.CreatedBy = creator;
        }
        return this.s3.put(key, value, this.path, options)
            .catch(e => {
                Sentry.captureException(e);
                logger.error(`Error while trying to write to S3 cache: ${messageFor(e)}`);
            });
    }
}