User Story 2, Best Response Backend and Frontend

public/openapi/components/schemas/PostObject.yaml

@@ -22,6 +22,9 @@ PostObject:
       type: number
     votes:
       type: number
+    best:
+      type: boolean
+      description: Indicates whether this post is marked as the best response
     timestampISO:
       type: string
       description: An ISO 8601 formatted date string (complementing `timestamp`)

public/openapi/components/schemas/TopicObject.yaml

@@ -213,6 +213,8 @@ TopicObjectSlim:
           type: number
         viewcount:
           type: number
+        bestResponse:
+          type: number
         postercount:
           type: number
         scheduled:

public/openapi/write/posts/pid.yaml

@@ -64,6 +64,9 @@ get:
                     type: boolean
                   downvoted:
                     type: boolean
+                  best:
+                    type: boolean
+                    description: Indicates whether this post is marked as the best response
 put:
   tags:
     - posts

public/openapi/write/posts/pid/best.yaml

@@ -0,0 +1,57 @@
+tags:
+  - posts
+summary: Mark a post as the best response
+description: This operation marks a post as the best response for a topic.
+parameters:
+  - in: path
+    name: pid
+    required: true
+    schema:
+      type: string
+    description: The post ID to be marked as the best response.
+    example: "1"
+responses:
+  '200':
+    description: Post successfully marked as best response
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            status:
+              type: string
+              description: Status message
+              example: "success"
+            response:
+              type: object
+              properties:
+                pid:
+                  type: number
+                  description: Post ID
+                  example: 1
+                isBest:
+                  type: boolean
+                  description: Indicates if this post is marked as best
+                  example: true
+  '400':
+    description: Invalid request (post ID not found, etc.)
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            status:
+              type: string
+              description: Error message
+              example: "Invalid post ID"
+  '403':
+    description: Unauthorized to mark this post as best
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            status:
+              type: string
+              description: Error message
+              example: "Unauthorized"

public/src/client/topic/best-response.js

@@ -0,0 +1,97 @@
+'use strict';
+
+define('forum/topic/best-response', [
+	'postSelect', 'alerts', 'api',
+], function (postSelect, alerts, api) {
+	const BestResponse = {};
+	let modal;
+	let markBtn;
+	let purgeBtn;
+	let tid;
+
+	BestResponse.init = function () {
+		tid = ajaxify.data.tid;
+
+		$(window).off('action:ajaxify.end', onAjaxifyEnd).on('action:ajaxify.end', onAjaxifyEnd);
+
+		if (modal) {
+			return;
+		}
+		app.parseAndTranslate('modals/best-response', {}, function (html) {
+			modal = html;
+
+			$('body').append(modal);
+
+			markBtn = modal.find('#markResponse_posts_confirm');
+			purgeBtn = modal.find('#purge_posts_confirm');
+
+			modal.find('#markResponse_posts_cancel').on('click', closeModal);
+
+			postSelect.init(function () {
+				checkButtonEnable();
+				showPostsSelected();
+			});
+			showPostsSelected();
+
+			markBtn.on('click', function () {
+				if (postSelect.pids.length === 1) {
+					markBestResponse(markBtn, pid => `/posts/${pid}/best`);
+				}
+			});
+		});
+	};
+
+	function onAjaxifyEnd() {
+		if (ajaxify.data.template.name !== 'topic' || ajaxify.data.tid !== tid) {
+			closeModal();
+			$(window).off('action:ajaxify.end', onAjaxifyEnd);
+		}
+	}
+
+	// Function to mark a post as the best response
+	function markBestResponse(btn, route) {
+		btn.attr('disabled', true);
+		const postId = postSelect.pids[0]; // Get the selected post ID
+		// Call the API to mark the post as the best using PUT
+		api.put(route(postId), { postId: postId }) // Send the selected post ID to the server
+			.then(() => { // Removed unused 'response' parameter
+				alerts.success('Post marked as best response!');
+				closeModal();
+			})
+			.catch((error) => {
+				console.error('Error marking post as best response:', error);
+				alerts.error('Failed to mark post as best response.');
+			})
+			.finally(() => {
+				btn.removeAttr('disabled');
+			});
+	}
+
+	function showPostsSelected() {
+		if (postSelect.pids.length) {
+			modal.find('#pids').translateHtml('[[topic:fork-pid-count, ' + postSelect.pids.length + ']]');
+		} else {
+			modal.find('#pids').translateHtml('[[topic:fork-no-pids]]');
+		}
+	}
+
+	function checkButtonEnable() {
+		if (postSelect.pids.length === 1) {
+			markBtn.removeAttr('disabled');
+			purgeBtn.removeAttr('disabled');
+		} else {
+			markBtn.attr('disabled', true);
+			purgeBtn.attr('disabled', true);
+		}
+	}
+
+	function closeModal() {
+		if (modal) {
+			modal.remove();
+			modal = null;
+			postSelect.disable();
+		}
+	}
+
+	return BestResponse;
+});

public/src/client/topic/threadTools.js

@@ -110,6 +110,17 @@ define('forum/topic/threadTools', [
 			});
 		});
 
+		// Code for best response, attempt 1.
+		// code segment above references delete-posts.js, will make a file for
+		// best response
+		// Code links successfully to topic-menu-list.tpl when using [component="topic/best-response"] below
+		topicContainer.on('click', '[component="topic/best-response"]', function () {
+			// Modify code below
+			require(['forum/topic/best-response'], function (BestPost) {
+				BestPost.init();
+			});
+		});
+
 		topicContainer.on('click', '[component="topic/fork"]', function () {
 			require(['forum/topic/fork'], function (fork) {
 				fork.init();

src/api/posts.js

@@ -98,6 +98,22 @@ async function validatePost(data, meta, contentLen, caller) {
 	}
 }
 
+// Correct indentation for the block around line 102
+postsAPI.markAsBestResponse = async function (caller, data) {
+	if (!data || !data.pid) {
+		throw new Error('[[error:invalid-data]]');
+	}
+	try {
+		// Mark the post as best response
+		await posts.markPostAsBest(data.pid);
+		// Return a success message
+		return { message: 'Post marked as best response!' };
+	} catch (error) {
+		// Handle any errors that may occur during the process
+		throw new Error('[[error:could-not-mark-best-response]]');
+	}
+};
+
 postsAPI.edit = async function (caller, data) {
 	if (!data || !data.pid || (meta.config.minimumPostLength !== 0 && !data.content)) {
 		throw new Error('[[error:invalid-data]]');

src/controllers/write/posts.js

@@ -8,6 +8,7 @@ const posts = require('../../posts');
 const api = require('../../api');
 const helpers = require('../helpers');
 
+
 const Posts = module.exports;
 
 Posts.redirectByIndex = async (req, res, next) => {
@@ -99,6 +100,49 @@ Posts.delete = async (req, res) => {
 	helpers.formatApiResponse(200, res);
 };
 
+// Add function to mark post as best response
+Posts.markAsBestResponse = async (req, res) => {
+	const postId = req.params.pid; // Get the post ID from the request parameters
+
+	try {
+		// Retrieve the post data, including the topic ID (tid) associated with the post
+		const post = await posts.getPostData(postId); // Retrieve full post data
+		const { tid } = post; // Destructure tid from the post object
+
+		// Print the post object for debugging
+		console.log('Post object:', post);
+
+		// Fetch all post IDs related to the topic
+		const allPostIds = await db.getSortedSetRange(`tid:${tid}:posts`, 0, -1); // Get all post IDs in the topic
+
+		// Prepare an array of promises for updating the 'best' field
+		const updatePromises = allPostIds.map(async (pid) => {
+			if (pid === postId) {
+				// Set the 'best' field to true for the selected post
+				await db.setObjectField(`post:${pid}`, 'best', true);
+				console.log(`Post ${pid} is marked as best:`, await posts.getPostData(pid));
+			} else {
+				// Set the 'best' field to false for all other posts
+				await db.setObjectField(`post:${pid}`, 'best', false);
+				console.log(`Post ${pid} is NOT marked as best:`, await posts.getPostData(pid));
+			}
+		});
+
+		// Wait for all updates to complete
+		await Promise.all(updatePromises);
+
+		// Set the bestResponse field to the postId in the topic data
+		await db.setObjectField(`topic:${tid}`, 'bestResponse', postId);
+
+		// Return a success response
+		helpers.formatApiResponse(200, res, { message: 'Post marked as best response!' });
+	} catch (error) {
+		// Handle any errors that may occur during the process
+		console.error('Error marking post as best response:', error);
+		helpers.formatApiResponse(400, res, error);
+	}
+};
+
 Posts.move = async (req, res) => {
 	await api.posts.move(req, {
 		pid: req.params.pid,

src/posts/create.js

@@ -34,7 +34,8 @@ module.exports = function (Posts) {
 			tid: tid,
 			content: data.content,
 			timestamp: timestamp,
-			anonymous: data.isAnonymous,
+			anonymous: data.isAnonymous || false,
+			best: data.best || false,
 		};
 
 		if (data.toPid) {

src/posts/edit.js

@@ -125,6 +125,7 @@ module.exports = function (Posts) {
 			uid: postData.uid,
 			mainPid: data.pid,
 			timestamp: rescheduling(data, topicData) ? data.timestamp : topicData.timestamp,
+			bestResponse: data.bestResponse || topicData.bestResponse, // Include bestResponse in the update
 		};
 		if (title) {
 			newTopicData.title = title;
@@ -174,6 +175,7 @@ module.exports = function (Posts) {
 			tags: tags,
 			oldTags: topicData.tags,
 			rescheduled: rescheduling(data, topicData),
+			bestResponse: data.bestResponse || topicData.bestResponse, // Include bestResponse in the update
 		};
 	}
 

src/posts/index.js

@@ -26,6 +26,8 @@ require('./bookmarks')(Posts);
 require('./queue')(Posts);
 require('./diffs')(Posts);
 require('./uploads')(Posts);
+require('./markPostAsBest')(Posts);
+
 
 Posts.exists = async function (pids) {
 	return await db.exists(