Implement Bug Archive Feature in Admin Dashboard - User Story 2

public/openapi/read/admin/bug-archive.yaml

@@ -0,0 +1,34 @@
+openapi: 3.0.0
+info:
+  title: Bug Archive API
+  version: 1.0.0
+paths:
+  /api/admin/dashboard/bug-archive:
+    get:
+      summary: Retrieve the bug archive
+      responses:
+        '200':
+          description: A list of bugs in the archive
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  archive:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        title:
+                          type: string
+                        description:
+                          type: string
+                        submittedBy:
+                          type: string
+                        dateSubmitted:
+                          type: string
+                          format: date
+        '400':
+          description: Bad request
+        '500':
+          description: Internal server error

public/src/admin/dashboard/bug-archive.js

@@ -0,0 +1,52 @@
+'use strict';
+
+define('admin/dashboard/bug-archive', ['hooks'], (hooks) => {
+	const ACP = {};
+
+	ACP.init = () => {
+		// Fetch the bug data and update the table
+		ACP.updateTable();
+		hooks.onPage('action:admin.dashboard.updateGraph', ACP.updateTable);
+
+		// Add event listener for the button click
+		const submitButton = document.getElementById('submit-bug-feedback');
+		if (submitButton) {
+			submitButton.addEventListener('click', () => {
+				ACP.updateTable();
+			});
+		} else {
+			console.error('Submit button not found');
+		}
+	};
+
+	ACP.updateTable = () => {
+		if (window.fetch) {
+			const url = `${config.relative_path}/api/admin/get-bug-archive`;
+			fetch(url, { credentials: 'include' })
+				.then((response) => {
+					if (!response.ok) {
+						throw new Error('Network response was not ok');
+					}
+					return response.json();
+				})
+				.then((payload) => {
+					app.parseAndTranslate(ajaxify.data.template.name, 'bugs', payload, (html) => {
+						const tbodyEl = document.querySelector('.bugs-list tbody');
+						if (tbodyEl) {
+							tbodyEl.innerHTML = '';
+							tbodyEl.append(...html.map((idx, el) => el));
+						} else {
+							console.error('Table body element not found');
+						}
+					});
+				})
+				.catch((error) => {
+					console.error('Error fetching bug archive:', error);
+				});
+		} else {
+			console.error('Fetch API not supported');
+		}
+	};
+
+	return ACP;
+});

src/controllers/admin/dashboard.js

@@ -26,6 +26,9 @@ dashboardController.get = async function (req, res) {
 		getLastRestart(),
 		user.isAdministrator(req.uid),
 		getPopularSearches(),
+		// getBugArchive()
+		// bug method
+		// this.submitBug(req, res)
 	]);
 	const version = nconf.get('version');
 
@@ -389,3 +392,40 @@ dashboardController.getSearches = async (req, res) => {
 		endDate: req.query.end ? validator.escape(String(req.query.end)) : null,
 	});
 };
+
+// In-memory storage for submitted bugs
+const bugArchive = [];
+
+// Submit Bug Handler
+exports.submitBug = async (req, res) => {
+	const { title, description } = req.body;
+
+	if (!title || !description) {
+		return res.status(400).json({ message: 'Title and description are required' });
+	}
+
+	try {
+		const bug = { title, description, dateSubmitted: new Date().toISOString() };
+		bugArchive.push(bug);
+		res.status(200).json({ message: 'Bug submitted successfully' });
+	} catch (error) {
+		res.status(500).json({ message: 'Failed to submit bug', error });
+	}
+};
+
+// Get Bug Archive Handler
+exports.getBugArchive = async (req, res) => {
+	console.log('im hereeeeeeeeeeee');
+	try {
+		// Render the 'bug-archive' template with the in-memory bug data
+		res.render('admin/dashboard/bug-archive', {
+			archive: bugArchive,
+		});
+	} catch (err) {
+		// Handle any errors that occur during the retrieval process
+		res.status(500).send(err.message);
+	}
+};
+
+
+

src/routes/admin.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const helpers = require('./helpers');
+// const { csrfSynchronisedProtection } = require('../middleware/csrf');
 
 module.exports = function (app, name, middleware, controllers) {
 	const middlewares = [middleware.pluginHooks];
@@ -12,6 +13,8 @@ module.exports = function (app, name, middleware, controllers) {
 	helpers.setupAdminPageRoute(app, `/${name}/dashboard/users`, middlewares, controllers.admin.dashboard.getUsers);
 	helpers.setupAdminPageRoute(app, `/${name}/dashboard/topics`, middlewares, controllers.admin.dashboard.getTopics);
 	helpers.setupAdminPageRoute(app, `/${name}/dashboard/searches`, middlewares, controllers.admin.dashboard.getSearches);
+	// route to the admin dashboard / bug archive button
+	helpers.setupAdminPageRoute(app, `/${name}/dashboard/bug-archive`, middlewares, controllers.admin.dashboard.getBugArchive);
 
 	helpers.setupAdminPageRoute(app, `/${name}/manage/categories`, middlewares, controllers.admin.categories.getAll);
 	helpers.setupAdminPageRoute(app, `/${name}/manage/categories/:category_id`, middlewares, controllers.admin.categories.get);
@@ -61,12 +64,25 @@ module.exports = function (app, name, middleware, controllers) {
 
 
 function apiRoutes(router, name, middleware, controllers) {
+	// Define the endpoint for fetching the bug archive
+	router.get(`/api/${name}/get-bug-archive`, middleware.ensureLoggedIn, helpers.tryRoute(controllers.admin.dashboard.getBugArchive));
+
+	// Define the endpoint for submitting bugs
+	router.post(`/api/${name}/submit-bug`, [], helpers.tryRoute(controllers.admin.dashboard.submitBug));
+	router.get(`/api/${name}/submit-bug`, [], helpers.tryRoute(controllers.admin.dashboard.submitBug));
+
+
 	router.get(`/api/${name}/config`, middleware.ensureLoggedIn, helpers.tryRoute(controllers.admin.getConfig));
 	router.get(`/api/${name}/users/csv`, middleware.ensureLoggedIn, helpers.tryRoute(controllers.admin.users.getCSV));
 	router.get(`/api/${name}/groups/:groupname/csv`, middleware.ensureLoggedIn, helpers.tryRoute(controllers.admin.groups.getCSV));
 	router.get(`/api/${name}/analytics`, middleware.ensureLoggedIn, helpers.tryRoute(controllers.admin.dashboard.getAnalytics));
 	router.get(`/api/${name}/advanced/cache/dump`, middleware.ensureLoggedIn, helpers.tryRoute(controllers.admin.cache.dump));
 
+	// router.get(`/api/${name}/get-bug-archive`, middleware.ensureLoggedIn,
+	// helpers.tryRoute(controllers.admin.dashboard.getBugArchive));
+	// router.post(`/api/${name}/submit-bug`, helpers.tryRoute(controllers.admin.dashboard.submitBug));
+	// router.get(`/api/${name}/submit-bug`,  helpers.tryRoute(controllers.admin.dashboard.submitBug));
+
 	const multipart = require('connect-multiparty');
 	const multipartMiddleware = multipart();
 
@@ -80,4 +96,16 @@ function apiRoutes(router, name, middleware, controllers) {
 	router.post(`/api/${name}/uploadOgImage`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadOgImage));
 	router.post(`/api/${name}/upload/file`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadFile));
 	router.post(`/api/${name}/uploadDefaultAvatar`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadDefaultAvatar));
+
+	// Define the endpoint for submitting bugs
+	// router.post(`/api/${name}/submit-bug`, middlewares, helpers.tryRoute(controllers.admin.dashboard.submitBug));
+
+	// router.post(`/api/${name}/settings`, middleware.ensureLoggedIn, helpers.tryRoute(controllers.admin.settings.set));
+
+	// Define the endpoint for fetching the bug archive
+	// router.get(`/api/${name}/get-bug-archive`,
+	// middlewares, helpers.tryRoute(controllers.admin.dashboard.getBugArchive));
+	// router.get(`/api/${name}/get-bug-archive`, middlewares, helpers.tryRoute(controllers.admin.getConfig));
 }
+
+