feat: persist user feedback until marked as resolved (#1583)

This will enable people to report issues with examples.

migrations/20240820194742_add-feedback-table.js

@@ -0,0 +1,15 @@
+module.exports.up = (knex) => {
+  return knex.schema.createTable('feedback', (table) => {
+    table.increments('id').primary();
+    table.string('name').notNullable();
+    table.string('email').notNullable();
+    table.text('message').notNullable();
+    table.json('attachments');
+    table.boolean('is_acknowledged').defaultTo(false);
+    table.timestamp('created_at').defaultTo(knex.fn.now());
+  });
+};
+
+module.exports.down = (knex) => {
+  return knex.schema.dropTable('feedback');
+};

src/controllers/IndexController/IndexController.ts

@@ -1,12 +1,10 @@
 import express from 'express';
-
-import { getIndexFileContents } from './getIndexFileContents';
 import { getDatabase } from '../../data_layer';
 import AuthenticationService from '../../services/AuthenticationService';
 import TokenRepository from '../../data_layer/TokenRepository';
 import UsersRepository from '../../data_layer/UsersRepository';
 import { configureUserLocal } from '../../routes/middleware/configureUserLocal';
-import { useDefaultEmailService } from '../../services/EmailService/EmailService';
+import { getIndexFileContents } from './getIndexFileContents';
 
 class IndexController {
   public getIndex(request: express.Request, response: express.Response) {
@@ -28,13 +26,15 @@ class IndexController {
     }
 
     const attachments = req.files as Express.Multer.File[];
-    const defaultEmailService = useDefaultEmailService();
-    await defaultEmailService.sendContactEmail(
+    const database = getDatabase();
+
+    await database('feedback').insert({
       name,
       email,
       message,
-      attachments
-    );
+      attachments: JSON.stringify(attachments.map((a) => a.path)),
+    });
+
     return res.status(200).send();
   }
 }

src/lib/storage/jobs/helpers/deleteOldUploads.ts

@@ -44,8 +44,27 @@ const deleteDanglingUploads = async (db: Knex, storage: StorageHandler) => {
   }
 };
 
+const deleteResolvedFeedbackAttachments = async (
+  db: Knex,
+  storage: StorageHandler
+) => {
+  const resolvedFeedback = await db('feedback')
+    .select('attachments')
+    .where('is_acknowledged', true);
+
+  for (const feedback of resolvedFeedback) {
+    const attachments = JSON.parse(feedback.attachments);
+    for (const attachment of attachments) {
+      await storage.delete(attachment);
+    }
+  }
+
+  await db('feedback').where('is_acknowledged', true).delete();
+};
+
 export default async function deleteOldUploads(db: Knex) {
   const storage = new StorageHandler();
   await deleteNonSubScriberUploads(db, storage);
   await deleteDanglingUploads(db, storage);
+  await deleteResolvedFeedbackAttachments(db, storage);
 }

src/routes/DefaultRouter.ts

@@ -6,6 +6,7 @@ import IndexController from '../controllers/IndexController/IndexController';
 
 const upload = multer({
   limits: { fileSize: 25 * 1024 * 1024 },
+  dest: process.env.FEEDBACK_DIR || '~/',
 });
 
 const DefaultRouter = () => {