feat: add PackageApiR2Bucket

Author: velut

codebook.toml

@@ -4,6 +4,7 @@ words = [
     "bitbucket",
     "braintree",
     "cloudflare",
+    "cloudflarestorage",
     "cwd",
     "dompurify",
     "fflate",

lib/db/package-api-r2-bucket.test.ts

@@ -0,0 +1,53 @@
+import { GetObjectCommand, PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
+import { sdkStreamMixin } from "@smithy/util-stream";
+import { fromAny } from "@total-typescript/shoehorn";
+import { mockClient } from "aws-sdk-client-mock";
+import { compressSync, strToU8 } from "fflate";
+import { goTry } from "go-go-try";
+import { beforeEach } from "node:test";
+import { Readable } from "stream";
+import { expect, test } from "vitest";
+import { PackageApiR2Bucket } from "./package-api-r2-bucket";
+
+const s3Mock = mockClient(S3Client);
+
+beforeEach(() => {
+	s3Mock.reset();
+});
+
+test("setPackageApi fail", async () => {
+	s3Mock.on(PutObjectCommand).rejects("test");
+	const db = new PackageApiR2Bucket();
+	const [err] = await goTry(db.setPackageApi("foo", fromAny({ name: "foo" })));
+	expect(err).toBeDefined();
+});
+
+test("setPackageApi success", async () => {
+	s3Mock.on(PutObjectCommand).resolves({});
+	const db = new PackageApiR2Bucket();
+	const [err] = await goTry(db.setPackageApi("foo", fromAny({ name: "foo" })));
+	expect(err).toBeUndefined();
+});
+
+test("getPackageApi fail", async () => {
+	s3Mock.on(GetObjectCommand).rejects("test");
+	const db = new PackageApiR2Bucket();
+	const [err] = await goTry(db.getPackageApi("foo"));
+	expect(err).toBeDefined();
+});
+
+test("getPackageApi success", async () => {
+	const pkgApiGz = compressSync(strToU8(JSON.stringify({ name: "foo" })));
+	const stream = new Readable();
+	stream.push(pkgApiGz);
+	stream.push(null);
+	s3Mock.on(GetObjectCommand).resolves({ Body: sdkStreamMixin(stream) });
+	const db = new PackageApiR2Bucket();
+	const [err, pkgApi] = await goTry(db.getPackageApi("foo"));
+	expect(err).toBeUndefined();
+	expect(pkgApi).toMatchInlineSnapshot(`
+		{
+		  "name": "foo",
+		}
+	`);
+});

lib/db/package-api-r2-bucket.ts

@@ -0,0 +1,40 @@
+import { GetObjectCommand, PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
+import type { PackageApi } from "@jsdocs-io/extractor";
+import { compressSync, decompressSync, strFromU8, strToU8 } from "fflate";
+import { serverEnv } from "../server-env";
+import type { PackageApiDb } from "./package-api-db";
+
+export class PackageApiR2Bucket implements PackageApiDb {
+	dbName = "PackageApiR2Bucket";
+	#s3 = new S3Client({
+		region: "auto",
+		endpoint: `https://${serverEnv.CF_ACCOUNT_ID}.r2.cloudflarestorage.com`,
+		credentials: {
+			accessKeyId: serverEnv.CF_ACCESS_KEY_ID,
+			secretAccessKey: serverEnv.CF_SECRET_ACCESS_KEY,
+		},
+	});
+
+	async getPackageApi(pkgId: string): Promise<PackageApi> {
+		const cmd = new GetObjectCommand({
+			Bucket: serverEnv.CF_BUCKET_NAME,
+			Key: `${pkgId}.gz`,
+		});
+		const res = await this.#s3.send(cmd);
+		const body = await res.Body!.transformToByteArray();
+		const pkgApiJson = strFromU8(decompressSync(body));
+		const pkgApi = JSON.parse(pkgApiJson) as unknown as PackageApi;
+		return pkgApi;
+	}
+
+	async setPackageApi(pkgId: string, pkgApi: PackageApi) {
+		const pkgApiJson = JSON.stringify(pkgApi);
+		const pkgApiGz = compressSync(strToU8(pkgApiJson));
+		const cmd = new PutObjectCommand({
+			Bucket: serverEnv.CF_BUCKET_NAME,
+			Key: `${pkgId}.gz`,
+			Body: pkgApiGz,
+		});
+		await this.#s3.send(cmd);
+	}
+}