Install and Run StandardJs Static Analysis

.github/workflows/azure-deploy-f24.yml

@@ -19,7 +19,7 @@ jobs:
       ./.github/workflows/test.yaml
 
   build-and-deploy:
-    if: github.repository == 'cmu-313/NodeBB'
+    if: github.repository == 'cmu-313/nodebb-f24-codebb'
     needs: lint-and-test
 
     runs-on: ubuntu-latest
@@ -30,11 +30,11 @@ jobs:
       - name: Set up Node.js version
         uses: actions/setup-node@v3
         with:
-          node-version: '20.x'
+          node-version: '20.17.0'
 
       - name: Set up NodeBB
         run: |
-          ./nodebb setup '{"url":"https://nodebb-f24.azurewebsites.net:443",
+          ./nodebb setup '{"url":"nodebb-codebb.azurewebsites.net:443",
             "admin:username": "admin",
             "admin:password": "${{ secrets.ADMIN_PASSWORD }}",
             "admin:password:confirm": "${{ secrets.ADMIN_PASSWORD }}",
@@ -43,12 +43,16 @@ jobs:
             "redis:host": "${{ secrets.REDIS_HOST }}",
             "redis:port": "6379",
             "redis:password": "${{ secrets.REDIS_PASSWORD }}" }'
+
+      - name: Install frontend repo
+        run: |
+          npm install https://github.com/CMU-313/nodebb-frontend-f24-codebb.git
 
       - name: 'Deploy to Azure Web App'
         id: deploy-to-webapp
         uses: azure/webapps-deploy@v2
         with:
-          app-name: 'nodebb-f24'
+          app-name: 'nodebb-codebb'
           slot-name: 'Production'
-          publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_BFAB97B1AB1441ACA7C63280F91AD3F3 }}
+          publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_20CFEB73ED1242B9B00348997130EDD9 }}
           package: .

.github/workflows/test.yaml

@@ -11,18 +11,18 @@ defaults:
     shell: bash
 
 permissions:
-  checks: write  # for coverallsapp/github-action to create new checks
-  contents: read  # for actions/checkout to fetch code
+  checks: write # for coverallsapp/github-action to create new checks
+  contents: read # for actions/checkout to fetch code
 
 jobs:
   test:
     runs-on: ubuntu-latest
     env:
-      TEST_ENV: 'production'
+      TEST_ENV: "production"
 
     services:
       redis:
-        image: 'redis:7.2.4'
+        image: "redis:7.2.4"
         # Set health checks to wait until redis has started
         options: >-
           --health-cmd "redis-cli ping"
@@ -85,3 +85,7 @@ jobs:
 
       - name: Test coverage
         uses: coverallsapp/github-action@v2
+
+      # Add StandardJS Linting Step
+      - name: Run StandardJS Linter
+        run: npx standard

.gitignore

@@ -72,4 +72,7 @@ link-plugins.sh
 test.sh
 
 .docker/**
-!**/.gitkeep
+!**/.gitkeep
+
+# Dump
+dump.rdb

.mocharc.yml

@@ -1,4 +1,4 @@
 reporter: dot
 timeout: 25000
 exit: true
-bail: true
+bail: false

README.md

@@ -1,3 +1,4 @@
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/ithVU1OO)
 # ![NodeBB](public/images/sm-card.png)
 
 [![Workflow](https://github.com/CMU-313/NodeBB/actions/workflows/test.yaml/badge.svg)](https://github.com/CMU-313/NodeBB/actions/workflows/test.yaml)

UserGuide.md

@@ -0,0 +1,54 @@
+# USER GUIDE FOR NEW FEATURES:
+
+### Endorse Feature:
+
+Video Demo:
+[Endorse Demo](public/EndorseVideo.mp4)
+
+- To use the endorse you must be logged in as an admin user
+- Once logged in as an admin select a group and edit its setting
+- In the admin group settings page, toggle on the “Allow Endorse” checkbox and save this change
+- Go to a topic and find a post
+- On the post click on the upvote button
+- Refresh the page and there will be a message next to the timestamp stating 
+  that the post has been endorsed by an instructor and there will also be a 
+  message when you click on the number of people who voted stating the same
+  message
+- Removing the upvote and refreshing the page will cause these messages to 
+  disappear
+- To user test this feature you can try logging in as non-admin users and 
+  upvote posts to ensure that the endorsement message is not displayed after
+  upovting.  Then login as an admin and upvote the post to ensure it works 
+  for admins.  Also try removing the upvote as an admin to make sure the 
+  message goes away.  Note that the page must be refreshed after the upvote
+  action in order to see changes.
+
+
+### Endorse Testing:
+- Testing for endorse can be found in [test/topics.js](test/topics.js#L2508) 
+- These tests ensure that when admins upvote the boolean showendorse is set to true 
+  and if they are not an admin then showendorse is kept as false
+- These tests are sufficient as they cover the possible scnearios of both admin and 
+  non-admin users upvoting.
+
+### Search Feature:
+
+Video: 
+[Search Demo](public/SearchScreenshot.mov)
+
+- To use the search feature you must be logged in
+- Once logged in, navigate to any category (Announcements, General Discussion, Comments, Blog)
+- Add at least 2 new topics if there are no topics present.
+- Find the search bar next to the New Topic Button in the tool bar.
+- Enter a query: type in any keyword found in a topic you created. Only posts with the keyword in it will be displayed.
+- If the keyword does not exist in any content or title, a message No topics match the search term \_\_\_ will be displayed.
+- If the search query is in the content, a small snippet will show under the topic, with the query term bolded.
+- Clicking on results will take you directly to post.
+- To user test this feature try searching for a common keyword and ensure
+  relevant posts show up. You can also create a new post and search for a term that exists in the post to verify. Search for a word that does not exist and ensure "No topics match the search term" message displays.
+
+#### Search Testing:
+
+- Testing backend changes can be found in [test/categories.js](test/categories.js#L140)
+- Added tests to getCategoryTopics tests, which was the only backend function changed, to ensure that each topic has a content field and that the content fields have no html tags.
+- Otherwise, no other backend changes were made for Search that can be tested. 

public/language/ar/admin/manage/groups.json

@@ -32,6 +32,7 @@
 	"edit.label-color": "Group Label Color",
 	"edit.text-color": "Group Text Color",
 	"edit.show-badge": "Show Badge",
+	"edit.show-endorse": "Allow Endorse",
 	"edit.private-details": "If enabled, joining of groups requires approval from a group owner.",
 	"edit.private-override": "Warning: Private groups is disabled at system level, which overrides this option.",
 	"edit.disable-join": "Disable join requests",

public/language/en-GB/groups.json

@@ -49,6 +49,7 @@
 	"details.change-text-colour": "Change Text Colour",
 	"details.badge-text": "Badge Text",
 	"details.userTitleEnabled": "Show Badge",
+	"details.endorseEnabled": "Allow Endorse",
 	"details.private-help": "If enabled, joining of groups requires approval from a group owner",
 	"details.hidden": "Hidden",
 	"details.hidden-help": "If enabled, this group will not be found in the groups listing, and users will have to be invited manually",

public/openapi/components/schemas/GroupObject.yaml

@@ -19,6 +19,8 @@ GroupFullObject:
       description: Same as userTitle but with translation tokens escaped, used to display raw userTitle in group management
     userTitleEnabled:
       type: number
+    endorseEnabled:
+      type: number
     description:
       type: string
       description: The group description
@@ -170,6 +172,8 @@ GroupDataObject:
       description: Same as userTitle but with translation tokens escaped, used to display raw userTitle in group management
     userTitleEnabled:
       type: number
+    endorseEnabled:
+      type: number
     description:
       type: string
       description: The group description

public/openapi/components/schemas/TopicObject.yaml

@@ -176,6 +176,10 @@ TopicObject:
         tid:
           type: number
           description: A topic identifier
+        content:
+          type: string
+          nullable: true
+          description: Content of the original topic post for showing search previews.
         thumb:
           type: string
         pinExpiry:

public/openapi/read/admin/manage/groups.yaml

@@ -50,6 +50,8 @@ get:
                           type: string
                         userTitleEnabled:
                           type: number
+                        endorseEnabled:
+                          type: number
                         disableJoinRequests:
                           type: number
                         disableLeave:
@@ -88,6 +90,7 @@ get:
                         - cover:url
                         - cover:position
                         - userTitleEnabled
+                        - endorseEnabled
                         - disableJoinRequests
                         - disableLeave
                         - nameEncoded

public/openapi/read/groups.yaml

@@ -42,6 +42,8 @@ get:
                           type: number
                         userTitleEnabled:
                           type: number
+                        endorseEnabled:
+                          type: number
                         disableJoinRequests:
                           type: number
                         disableLeave:

public/openapi/read/topic/topic_id.yaml

@@ -184,6 +184,8 @@ get:
                           type: boolean
                         downvoted:
                           type: boolean
+                        showendorse:
+                          type: boolean
                         replies:
                           type: object
                           properties:

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

@@ -36,4 +36,6 @@ get:
                     type: array
                   downvoters:
                     type: array
+                  showEndorse:
+                    type: boolean
 

public/src/admin/manage/group.js

@@ -107,6 +107,7 @@ define('admin/manage/group', [
 				labelColor: changeGroupLabelColor.val(),
 				textColor: changeGroupTextColor.val(),
 				userTitleEnabled: $('#group-userTitleEnabled').is(':checked'),
+				endorseEnabled: $('#group-endorseEnabled').is(':checked'),
 				private: $('#group-private').is(':checked'),
 				hidden: $('#group-hidden').is(':checked'),
 				memberPostCids: $('#memberPostCids').val(),

public/src/client/category.js

@@ -50,6 +50,8 @@ define('forum/category', [
 			},
 		});
 
+		handleTopicSearch();
+
 		hooks.fire('action:topics.loaded', { topics: ajaxify.data.topics });
 		hooks.fire('action:category.loaded', { cid: ajaxify.data.cid });
 	};
@@ -112,6 +114,60 @@ define('forum/category', [
 		});
 	}
 
+	// Search for topics in the category based on the search term.
+	function handleTopicSearch() {
+		const searchEl = $('[component="topic-search"]');
+		const topicEls = $('[component="category/topic"]');
+
+		if (!searchEl.length) {
+			return;
+		}
+
+		searchEl.on('keyup', function () {
+			const searchTerm = searchEl.val().toLowerCase();
+
+			topicEls.each(function () {
+				const topicEl = $(this);
+				const titleEl = topicEl.find('[component="topic/header"] a');
+				const title = titleEl.text().toLowerCase();
+				const titleMatch = title.indexOf(searchTerm) !== -1;
+				const contentEl = topicEl.find('[component="topic/hidden-content"]');
+				const content = contentEl.text().toLowerCase();
+				const contentIdx = content.indexOf(searchTerm);
+				const hasMatch = (titleMatch || (contentIdx !== -1));
+				const searchContentEl = topicEl.find('[component="topic/search-content"]');
+
+				// Hide topics that don't match the search term in their title or their content
+				topicEl.toggleClass('hidden', !hasMatch);
+
+				// Use topic/search-content placeholder to display the 100 character preview around the search term.
+				// Only do this if the search is more than 2 characters
+				if (contentIdx !== -1 && searchTerm.length >= 2) {
+					const start = Math.max(0, contentIdx - 50);
+					const end = Math.min(content.length, contentIdx + searchTerm.length + 50);
+					const snippet = content.substring(start, end);
+
+					// Make the search term come out bold in the search preview
+					const highlightedSnippet = snippet.replace(searchTerm, `<strong>${searchTerm}</strong>`);
+					searchContentEl.html(`...${highlightedSnippet}...`);
+				} else {
+					searchContentEl.html('');
+				}
+			});
+
+			// Show the alert for no matches if there are no matched topics, otherwise keep it hidden.
+			const visibleTopics = topicEls.filter(':not(.hidden)');
+			const alertComponent = $('[component="category/topic/no-matches"]');
+			if (visibleTopics.length === 0) {
+				alertComponent.removeClass('hidden');
+				alertComponent.html(`No topics match the search term ${searchTerm}.`);
+			} else {
+				alertComponent.addClass('hidden');
+				alertComponent.html('');
+			}
+		});
+	}
+
 	Category.toTop = function () {
 		navigator.scrollTop(0);
 	};

src/api/posts.js

@@ -335,13 +335,25 @@ postsAPI.getVoters = async function (caller, data) {
 		user.getUsersFields(downvoteUids, ['username', 'userslug', 'picture']),
 	]);
 
+	let hasAdminUpvoted = false;
+
+	const uidPromises = upvoteUids.map(uid => groups.isMemberOfGroups(uid, ['administrators']));
+	const results = await Promise.all(uidPromises);
+	for (const isAdmin of results) {
+		if (isAdmin[0]) {
+			hasAdminUpvoted = true;
+			break; // Exit loop as soon as an admin is found
+		}
+	}
+
 	return {
 		upvoteCount: upvoters.length,
 		downvoteCount: downvoters.length,
 		showUpvotes: showUpvotes,
 		showDownvotes: showDownvotes,
 		upvoters: upvoters,
 		downvoters: downvoters,
+		showEndorse: hasAdminUpvoted,
 	};
 };
 

src/categories/topics.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const sanitizeHtml = require('sanitize-html');
 const db = require('../database');
 const topics = require('../topics');
 const plugins = require('../plugins');
@@ -17,6 +18,16 @@ module.exports = function (Categories) {
 		let topicsData = await topics.getTopicsByTids(tids, data.uid);
 		topicsData = await user.blocks.filter(data.uid, topicsData);
 
+		// Add actual post content to the topicsData to show search previews
+		const mainPosts = await topics.getMainPosts(tids, data.uid);
+		topicsData.forEach((topic, idx) => {
+			// Clean all html, allowing no tags or attributes
+			topic.content = sanitizeHtml(mainPosts[idx].content, {
+				allowedTags: [],
+				allowedAttributes: {},
+			});
+		});
+
 		if (!topicsData.length) {
 			return { topics: [], uid: data.uid };
 		}

src/groups/create.js

@@ -34,6 +34,7 @@ module.exports = function (Groups) {
 			createtime: timestamp,
 			userTitle: data.userTitle || data.name,
 			userTitleEnabled: parseInt(data.userTitleEnabled, 10) === 1 ? 1 : 0,
+			endorseEnabled: parseInt(data.endorseEnabled, 10) === 1 ? 1 : 0,
 			description: data.description || '',
 			memberCount: memberCount,
 			hidden: isHidden ? 1 : 0,

src/groups/data.js

@@ -10,7 +10,7 @@ const translator = require('../translator');
 
 const intFields = [
 	'createtime', 'memberCount', 'hidden', 'system', 'private',
-	'userTitleEnabled', 'disableJoinRequests', 'disableLeave',
+	'userTitleEnabled', 'disableJoinRequests', 'disableLeave', 'endorseEnabled',
 ];
 
 module.exports = function (Groups) {
@@ -71,6 +71,7 @@ function modifyGroup(group, fields) {
 
 		escapeGroupData(group);
 		group.userTitleEnabled = ([null, undefined].includes(group.userTitleEnabled)) ? 1 : group.userTitleEnabled;
+		group.endorseEnabled = ([null, undefined].includes(group.endorseEnabled)) ? 1 : group.endorseEnabled;
 		group.labelColor = validator.escape(String(group.labelColor || '#000000'));
 		group.textColor = validator.escape(String(group.textColor || '#ffffff'));
 		group.icon = validator.escape(String(group.icon || ''));