From 08736ed61069a5f1634eb1bf721369263199ccc9 Mon Sep 17 00:00:00 2001 From: Hayden Young Date: Thu, 14 Oct 2021 23:04:03 +0100 Subject: feat: implement an S3-based storage API --- cdn/src/util/S3Storage.ts | 53 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 cdn/src/util/S3Storage.ts (limited to 'cdn/src/util/S3Storage.ts') diff --git a/cdn/src/util/S3Storage.ts b/cdn/src/util/S3Storage.ts new file mode 100644 index 00000000..33a6ba39 --- /dev/null +++ b/cdn/src/util/S3Storage.ts @@ -0,0 +1,53 @@ +import { S3 } from "@aws-sdk/client-s3"; +import { Readable, Stream } from "stream"; +import { Storage } from "./Storage"; + +const readableToBuffer = (readable: Readable): Promise => + new Promise((resolve, reject) => { + const chunks: Buffer[] = []; + readable.on('data', chunk => chunks.push(chunk)); + readable.on('error', reject); + readable.on('end', () => resolve(Buffer.concat(chunks))); + }); + +export class S3Storage implements Storage { + public constructor( + private client: S3, + private basePath: string, + private bucket: string + ) {} + + async set(path: string, data: Buffer): Promise { + await this.client.putObject({ + Bucket: this.bucket, + Key: `${this.basePath}${path}`, + Body: data + }); + } + + async get(path: string): Promise { + try { + const s3Object = await this.client.getObject({ + Bucket: this.bucket, + Key: `${this.basePath}${path}` + }); + + if (!s3Object.Body) return null; + + const body = s3Object.Body; + + return await readableToBuffer( body); + } catch(err) { + console.error(`[CDN] Unable to get S3 object at path ${path}.`); + console.error(err); + return null; + } + } + + async delete(path: string): Promise { + await this.client.deleteObject({ + Bucket: this.bucket, + Key: `${this.basePath}${path}` + }); + } +} -- cgit 1.5.1 From ef157c9aa7a683aa8e30e0db0a7d555918272137 Mon Sep 17 00:00:00 2001 From: Hayden Young Date: Thu, 14 Oct 2021 23:04:11 +0100 Subject: chore: remove unused import --- cdn/src/util/S3Storage.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'cdn/src/util/S3Storage.ts') diff --git a/cdn/src/util/S3Storage.ts b/cdn/src/util/S3Storage.ts index 33a6ba39..8c7f7813 100644 --- a/cdn/src/util/S3Storage.ts +++ b/cdn/src/util/S3Storage.ts @@ -1,5 +1,5 @@ import { S3 } from "@aws-sdk/client-s3"; -import { Readable, Stream } from "stream"; +import { Readable } from "stream"; import { Storage } from "./Storage"; const readableToBuffer = (readable: Readable): Promise => -- cgit 1.5.1 From 0e5172bc5f5c42b24a60b5d49e5e03812be6f9ac Mon Sep 17 00:00:00 2001 From: Hayden Young Date: Thu, 14 Oct 2021 23:15:03 +0100 Subject: fix: don't set location by default --- cdn/src/util/S3Storage.ts | 17 ++++++++++++----- cdn/src/util/Storage.ts | 6 +++--- 2 files changed, 15 insertions(+), 8 deletions(-) (limited to 'cdn/src/util/S3Storage.ts') diff --git a/cdn/src/util/S3Storage.ts b/cdn/src/util/S3Storage.ts index 8c7f7813..df5bc19c 100644 --- a/cdn/src/util/S3Storage.ts +++ b/cdn/src/util/S3Storage.ts @@ -13,14 +13,21 @@ const readableToBuffer = (readable: Readable): Promise => export class S3Storage implements Storage { public constructor( private client: S3, - private basePath: string, - private bucket: string + private bucket: string, + private basePath?: string, ) {} + /** + * Always return a string, to ensure consistency. + */ + get bucketBasePath() { + return this.basePath ?? ''; + } + async set(path: string, data: Buffer): Promise { await this.client.putObject({ Bucket: this.bucket, - Key: `${this.basePath}${path}`, + Key: `${this.bucketBasePath}${path}`, Body: data }); } @@ -29,7 +36,7 @@ export class S3Storage implements Storage { try { const s3Object = await this.client.getObject({ Bucket: this.bucket, - Key: `${this.basePath}${path}` + Key: `${this.bucketBasePath ?? ''}${path}` }); if (!s3Object.Body) return null; @@ -47,7 +54,7 @@ export class S3Storage implements Storage { async delete(path: string): Promise { await this.client.deleteObject({ Bucket: this.bucket, - Key: `${this.basePath}${path}` + Key: `${this.bucketBasePath}${path}` }); } } diff --git a/cdn/src/util/Storage.ts b/cdn/src/util/Storage.ts index acef9df3..3332f21c 100644 --- a/cdn/src/util/Storage.ts +++ b/cdn/src/util/Storage.ts @@ -45,13 +45,13 @@ if (process.env.STORAGE_PROVIDER === "file" || !process.env.STORAGE_PROVIDER) { let location = process.env.STORAGE_LOCATION; if (!location) { - console.warn(`[CDN] STORAGE_LOCATION unconfigured for S3 provider, defaulting to '/'...`); - location = "/"; + console.warn(`[CDN] STORAGE_LOCATION unconfigured for S3 provider, defaulting to the bucket root...`); + location = undefined; } const client = new S3({ region }); - storage = new S3Storage(client, location, bucket); + storage = new S3Storage(client, bucket, location); } export { storage }; -- cgit 1.5.1