dev-demo: add test api for the s3 createWriteStream

AdminForth/1796/image

Author: yaroslav8765

dev-demo/api.ts

@@ -1,8 +1,14 @@
 import { Express, Response } from "express";
+import { randomBytes } from "crypto";
 import { Filters, IAdminForth, IAdminUserExpressRequest } from "adminforth";
 import * as z from "zod";
 import TwoFactorsAuthPlugin from "../plugins/adminforth-two-factors-auth/index.js";
-import { levelDbAdapter, resourceAdapter, ramAdapter } from './utils.js';
+import { levelDbAdapter, resourceAdapter, ramAdapter, s3StorageAdapter } from './utils.js';
+let isLifecycleSetupDone = false;
+if (!isLifecycleSetupDone) {
+  s3StorageAdapter.setupLifecycle();
+  isLifecycleSetupDone = true;
+}
 
 const CURRENT_KV_ADAPTER = resourceAdapter;
 const CURRENT_COLLECTION = 'dev-demo';
@@ -15,6 +21,7 @@ const DASHBOARD_CAR_SOURCES = [
   { resourceId: 'cars_ch', label: 'ClickHouse' },
 ] as const;
 
+
 type DashboardCarRecord = {
   model: string;
   price: string | number;
@@ -232,4 +239,51 @@ export function initApi(app: Express, admin: IAdminForth) {
       }
     )
   );
+  app.post(`${admin.config.baseUrl}/api/testS3WriteStream/`,
+    admin.express.authorize(
+      async (_req: IAdminUserExpressRequest, res: Response) => {
+        const sizeMb = Math.min(Math.max(Number(_req.body?.sizeMb) || 12, 1), 100);
+        const abort = Boolean(_req.body?.abort);
+        const key = `dev-demo-write-stream-test/${Date.now()}-${randomBytes(4).toString('hex')}.bin`;
+        console.log(`[testS3WriteStream] start, key="${key}", sizeMb=${sizeMb}, abort=${abort}`);
+
+        const startedAt = Date.now();
+        try {
+          const writer = await s3StorageAdapter.createWriteStream(key, 'application/octet-stream');
+          console.log('[testS3WriteStream] writer created, multipart upload started');
+
+          // 1MB of random data per write, so >5MB total gives more than one uploaded part
+          for (let i = 0; i < sizeMb; i++) {
+            await writer.write(randomBytes(1024 * 1024));
+            console.log(`[testS3WriteStream] written chunk ${i + 1}/${sizeMb} (1 MB each)`);
+          }
+
+          if (abort) {
+            await writer.abort();
+            console.log(`[testS3WriteStream] aborted upload for key="${key}"`);
+            res.json({ ok: true, aborted: true, key, sizeMb, tookMs: Date.now() - startedAt });
+            return;
+          }
+
+          await writer.close();
+          console.log(`[testS3WriteStream] closed, multipart upload completed for key="${key}"`);
+
+          const downloadUrl = await s3StorageAdapter.getDownloadUrl(key, 3600);
+          console.log(`[testS3WriteStream] done in ${Date.now() - startedAt}ms, url=${downloadUrl}`);
+
+          res.json({
+            ok: true,
+            aborted: false,
+            key,
+            sizeMb,
+            tookMs: Date.now() - startedAt,
+            downloadUrl,
+          });
+        } catch (e) {
+          console.error('[testS3WriteStream] failed:', e);
+          res.status(500).json({ ok: false, key, error: `${e}` });
+        }
+      }
+    )
+  );
 }

dev-demo/custom/SystemTest.vue

@@ -57,6 +57,21 @@
         </div>
       </section>
 
+      <section class="rounded-xl border border-slate-200 bg-slate-50 p-4">
+        <div class="mb-3 text-xs font-semibold uppercase tracking-wider text-slate-500">
+          S3 Storage
+        </div>
+        <div class="flex flex-col gap-3">
+          <Input class="w-full" v-model="s3SizeMb" placeholder="Size in MB (default 12)" />
+          <Button class="w-full" @click="testS3WriteStream(false)">
+            Start multipart upload (createWriteStream)
+          </Button>
+          <Button class="w-full" @click="testS3WriteStream(true)">
+            Start multipart upload and abort it
+          </Button>
+        </div>
+      </section>
+
       <section class="rounded-xl border border-slate-200 bg-slate-50 p-4">
         <div class="mb-3 text-xs font-semibold uppercase tracking-wider text-slate-500">
           2FA
@@ -104,6 +119,7 @@ const valueStart = ref()
 const kvKey = ref('');
 const kvValue = ref('');
 const kvPrefix = ref('');
+const s3SizeMb = ref('12');
 const lastApiOutput = ref('No output yet. Click a button to run an action.');
 
 function setLastApiOutput(actionName: string, data: unknown, isError = false) {
@@ -209,6 +225,26 @@ async function deleteTaskFromTheLastJob() {
   }
 }
 
+async function testS3WriteStream(abort: boolean) {
+  const actionName = abort ? 'S3 multipart upload (abort)' : 'S3 multipart upload';
+  try {
+    setLastApiOutput(actionName, 'Uploading, check server logs for progress...');
+    const response = await callApi({
+      path: '/api/testS3WriteStream/',
+      method: 'POST',
+      body: {
+        sizeMb: Number(s3SizeMb.value) || 12,
+        abort,
+      },
+    });
+    console.log('S3 write stream result:', response);
+    setLastApiOutput(actionName, response);
+  } catch (error) {
+    console.error('S3 write stream error:', error);
+    setLastApiOutput(actionName, String(error), true);
+  }
+}
+
 async function callHelloWorldApi() {
   try {
     const response = await callApi({ path: '/api/hello/', method: 'GET' });

dev-demo/utils.ts

@@ -2,6 +2,7 @@ import LevelDBKeyValueAdapter from '../adapters/adminforth-key-value-adapter-lev
 import RedisKeyValueAdapter from '../adapters/adminforth-key-value-adapter-redis/index.js';
 import ResourceKeyValueAdapter from '../adapters/adminforth-key-value-adapter-resource/index.js';
 import RAMKeyValueAdapter from '../adapters/adminforth-key-value-adapter-ram/index.js';
+import AdminForthAdapterS3Storage from '../adapters/adminforth-storage-adapter-amazon-s3/index.js'; 
 
 export const levelDbAdapter = new LevelDBKeyValueAdapter({
   dbPath: './testdb',
@@ -17,6 +18,14 @@ export const resourceAdapter = new ResourceKeyValueAdapter({
 
 export const ramAdapter = new RAMKeyValueAdapter();
 
+export const s3StorageAdapter = process.env.AWS_ACCESS_KEY_ID ? new AdminForthAdapterS3Storage({
+  bucket: process.env.AWS_BUCKET_NAME as string,
+  region: process.env.AWS_REGION as string,
+  accessKeyId: process.env.AWS_ACCESS_KEY_ID as string,
+  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY as string,
+  s3ACL: "public-read"
+}) : null;
+
 // Uncomment if you have running Redis instance
 // export const redisAdapter = new RedisKeyValueAdapter({
 //   redisUrl: 'redis://localhost:6379/0',