Revamp JoinRecords

.env.sample

@@ -1,8 +1,17 @@
 MESHDB_URL=http://127.0.0.1:8000
 NEXT_PUBLIC_MESHDB_URL=http://127.0.0.1:8000
 
+JOIN_RECORD_BUCKET_NAME=meshdb-join-form-log
+JOIN_RECORD_PREFIX=dev-join-form-submissions
+
+S3_ENDPOINT=http://127.0.0.1:9000
+AWS_ACCESS_KEY=sampleaccesskey
+AWS_SECRET_KEY=samplesecretkey
+AWS_REGION=us-east-1
+
 # Docker compose environment variables
 # Set this to true in prod
 COMPOSE_EXTERNAL_NETWORK=false
 # Set this to traefik-net in prod
 COMPOSE_NETWORK_NAME=
+

.github/workflows/playwright.yml

@@ -15,6 +15,20 @@ jobs:
     - uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6
       with:
         node-version: lts/*
+    - name: Setup Minio
+      run: |
+          docker run -d -p 9000:9000 --name minio \
+          -e "MINIO_ACCESS_KEY=sampleaccesskey" \
+          -e "MINIO_SECRET_KEY=samplesecretkey" \
+          -e "MINIO_DEFAULT_BUCKETS=meshdb-join-form-log" \
+          -v /tmp/data:/data \
+          -v /tmp/config:/root/.minio \
+          minio/minio server /data
+
+          export AWS_ACCESS_KEY_ID=sampleaccesskey
+          export AWS_SECRET_ACCESS_KEY=samplesecretkey
+          export AWS_EC2_METADATA_DISABLED=true
+          aws --endpoint-url http://127.0.0.1:9000/ s3 mb s3://meshdb-join-form-log
     - name: Install dependencies
       run: npm ci
     - name: Install Playwright Browsers
@@ -24,6 +38,13 @@ jobs:
       env:
         NEXT_PUBLIC_MESHDB_URL: https://127.0.0.1:8000 # Throwaway to make the mock work
         MESHDB_URL: https://127.0.0.1:8000 # Throwaway to make the mock work
+        # We now check the JoinRecord stuff, so submit that too.
+        JOIN_RECORD_BUCKET_NAME: meshdb-join-form-log
+        JOIN_RECORD_PREFIX: dev-join-form-submissions
+        S3_ENDPOINT: http://127.0.0.1:9000
+        AWS_ACCESS_KEY_ID: sampleaccesskey 
+        AWS_SECRET_ACCESS_KEY: samplesecretkey
+        AWS_REGION: us-east-1
     - uses: actions/upload-artifact@v4
       if: always()
       with:

app/join_record.ts

@@ -0,0 +1,126 @@
+"use server";
+// import { access, constants, appendFileSync, readFile } from "node:fs";
+import {
+  S3Client,
+  PutObjectCommand,
+  GetObjectCommand,
+  ListBucketsCommand,
+} from "@aws-sdk/client-s3";
+import { JoinFormValues } from "@/components/JoinForm/JoinForm";
+import { Readable } from "stream";
+import { JoinRecord } from "./types";
+
+// const JOIN_FORM_LOG = process.env.JOIN_FORM_LOG as string;
+
+class JoinRecordS3 {
+  private s3Client: S3Client;
+
+  private BUCKET_NAME: string;
+  private PREFIX: string;
+
+  private S3_ENDPOINT: string;
+  private AWS_ACCESS_KEY_ID: string;
+  private AWS_SECRET_ACCESS_KEY: string;
+
+  constructor() {
+    this.BUCKET_NAME = process.env.JOIN_RECORD_BUCKET_NAME as string;
+    this.PREFIX = process.env.JOIN_RECORD_PREFIX as string;
+    this.S3_ENDPOINT = process.env.S3_ENDPOINT as string;
+    this.AWS_ACCESS_KEY_ID = process.env.AWS_ACCESS_KEY_ID as string;
+    this.AWS_SECRET_ACCESS_KEY = process.env.AWS_SECRET_ACCESS_KEY as string;
+
+    // Setup the S3 client
+    this.s3Client = new S3Client({
+      endpoint:
+        this.S3_ENDPOINT != undefined
+          ? this.S3_ENDPOINT
+          : "https://s3.us-east-1.amazonaws.com",
+    });
+  }
+
+  // Records the submission we just got as a JSON object in an S3 bucket.
+  // submission: A Join Form Submission. We append a few things to this.
+  // key: The S3 path we store the submission at
+  // responseCode: If we have a response code for this submission, add it here.
+  async save(joinRecord: JoinRecord, key: string = "") {
+    // Check if the S3 client is working and exit gracefully with a warning if it is not.
+    try {
+      const command = new ListBucketsCommand({});
+      await this.s3Client.send(command);
+    } catch (error) {
+      console.warn(
+        "S3 Client not configured properly. I WILL NOT SAVE THIS SUBMISSION.",
+        error,
+      );
+      return;
+    }
+
+    // Get the date to store this submission under (this is part of the path)
+    const submissionKey = joinRecord.submission_time
+      .replace(/[-:T]/g, "/")
+      .slice(0, 19);
+
+    // Create the path, or use the one provided.
+    key = key != "" ? key : `${this.PREFIX}/${submissionKey}.json`;
+
+    let body = JSON.stringify(joinRecord);
+
+    const command = new PutObjectCommand({
+      Bucket: this.BUCKET_NAME,
+      Key: key,
+      Body: body,
+    });
+
+    try {
+      const response = await this.s3Client.send(command);
+      console.log(response);
+    } catch (err) {
+      // Oof, guess we'll drop this on the floor.
+      console.error(err);
+      throw err;
+    }
+
+    // Return the key later so we can update it.
+    return key;
+  }
+
+  // Gets the contents of a JoinRecord for testing
+  async get(key: string) {
+    const getObjectCommand = new GetObjectCommand({
+      Bucket: this.BUCKET_NAME,
+      Key: key,
+    });
+    const getObjectResponse = await this.s3Client.send(getObjectCommand);
+
+    if (getObjectResponse.Body) {
+      const content = await this.streamToString(
+        getObjectResponse.Body as Readable,
+      );
+      return JSON.parse(content);
+    }
+    throw new Error("Could not get Record from S3");
+  }
+
+  // Decode S3 response
+  async streamToString(stream: Readable): Promise<string> {
+    return await new Promise((resolve, reject) => {
+      const chunks: Buffer[] = [];
+      stream.on("data", (chunk) => chunks.push(chunk));
+      stream.on("end", () => resolve(Buffer.concat(chunks).toString("utf-8")));
+      stream.on("error", reject);
+    });
+  }
+}
+
+const joinRecordS3 = new JoinRecordS3();
+
+export async function saveJoinRecordToS3(
+  submission: JoinRecord,
+  key: string = "",
+) {
+  return joinRecordS3.save(submission, key);
+}
+
+export async function getJoinRecordFromS3(key: string) {
+  return joinRecordS3.get(key);
+}

app/types.ts

@@ -0,0 +1,10 @@
+import { JoinFormValues } from "@/components/JoinForm/JoinForm";
+
+type JoinRecord = JoinFormValues & {
+  submission_time: string;
+  code: number | null;
+  replayed: number;
+  install_number: number | null;
+};
+
+export type { JoinRecord };