diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000000..041802b4f1 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,9 @@ +{ + "useTabs": true, + "arrowParens": "always", + "endOfLine": "auto", + "singleQuote": true, + "tabWidth": 1, + "requirePragma": false, + "insertPragma": false +} \ No newline at end of file diff --git a/README.md b/README.md index 6ef180f625..3be8bc45a8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +Names: Alice Le, Anna Shi, Cass Ma, Evelynn Chen, Vicky Chen + +[![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) diff --git a/UserGuide.md b/UserGuide.md new file mode 100644 index 0000000000..ca7e573004 --- /dev/null +++ b/UserGuide.md @@ -0,0 +1,44 @@ +### 1. Feature Overview: + +Feature Name: Endorse Post +Purpose: This feature enables TAs and professors to endorse posts, notifying all viewers that the content has been approved or supported by a professor or TA. It offers students a clear and reliable indicator of posts containing verified, legitimate information that they should prioritize reading. +Coder: Evelynn Chen, Vicky Chen, and Alice Le + +### 2. Steps to test feature +Step 1: Sign into an authorized account (Professor or TA account) +Step 2: Enter and click into a published post +Step 3: Click on the Endorse button + + +### 3. Expected Result: +The endorse button on the post will no longer be available until someone unendorses the post by clicking on unendorse + (TA or Professor only) +Some sort of visual tag will appear on the post showing a TA or Professor has endorsed this post + +### Automated Tests + +### 1. Test Location +#### a. +**Location**: +- test/posts.js, lines [135-165](https://github.com/CMU-313/nodebb-f24-boba/blob/f24/test/posts.js#L135-L165) + +### 2. What is Being Tested +- **Tested Features**: The API for toggling the endorsed field for a Post. +- **Test Type**: Unit tests / back-end tests. + +### 3. Coverage Justification +- **Coverage Justification**: +The tests cover all use cases of toggling the boolean field endorsed. By default, a post is not endorsed, and only one request to endorse/unendorse at a time should be processed. + +#### b. +**Location**: +Location: test/posts/create.js in Alice/Feature-endorse branch + +### 2. What is Being Tested +**Tested Features**: The creation of posts with the endorsed attribute, verifying default behavior (where endorsed is set to false) and the initialization of endorsed to true as specified by the user. +**Test Type**: Unit tests and back-end validation tests ensure that the endorsed field is handled correctly during post creation. + +### 3. Why the Tests Are Sufficient +**Coverage Justification**: These tests cover critical scenarios around the endorsed attribute in post creation, ensuring both default and custom initialization works as intended. The default behavior test confirms that when endorsed is unspecified, the field defaults to false, maintaining standard post behavior. The specified behavior test validates that setting endorsed to true explicitly reflects in the backend data, demonstrating reliable customization. +**Edge Cases**: The tests handle potential edge cases, such as a null endorsed value or unexpected input, maintaining data integrity and preventing unauthorized attribute modification. +**Exclusion of Front-End Tests**: The tests are back-end focused, as UI interactions for post endorsement are manually validated. The primary emphasis remains on data accuracy in the database, which is critical for user-facing endorsement functionality. \ No newline at end of file diff --git a/dump.rdb b/dump.rdb new file mode 100644 index 0000000000..3186812fdd Binary files /dev/null and b/dump.rdb differ diff --git a/public/openapi/components/schemas/PostObject.yaml b/public/openapi/components/schemas/PostObject.yaml index ea91579cc6..78e53d85d4 100644 --- a/public/openapi/components/schemas/PostObject.yaml +++ b/public/openapi/components/schemas/PostObject.yaml @@ -22,6 +22,8 @@ PostObject: type: number votes: type: number + endorsed: + type: boolean timestampISO: type: string description: An ISO 8601 formatted date string (complementing `timestamp`) diff --git a/public/openapi/read/topic/topic_id.yaml b/public/openapi/read/topic/topic_id.yaml index f0fde1b6c0..0c9b3cba01 100644 --- a/public/openapi/read/topic/topic_id.yaml +++ b/public/openapi/read/topic/topic_id.yaml @@ -71,6 +71,8 @@ get: type: number downvotes: type: number + endorsed: + type: number bookmarks: type: number deleterUid: diff --git a/public/openapi/write/posts/pid.yaml b/public/openapi/write/posts/pid.yaml index 593a7acd01..d538000827 100644 --- a/public/openapi/write/posts/pid.yaml +++ b/public/openapi/write/posts/pid.yaml @@ -54,6 +54,8 @@ get: type: number votes: type: number + endorsed: + type: number timestampISO: type: string description: An ISO 8601 formatted date string (complementing `timestamp`) diff --git a/public/openapi/write/posts/pid/replies.yaml b/public/openapi/write/posts/pid/replies.yaml index b021eec14e..0adc11f762 100644 --- a/public/openapi/write/posts/pid/replies.yaml +++ b/public/openapi/write/posts/pid/replies.yaml @@ -51,6 +51,8 @@ get: type: number bookmarks: type: number + endorsed: + type: number deleterUid: type: number edited: diff --git a/public/src/admin/appearance/themes.js b/public/src/admin/appearance/themes.js index f2a023206f..bbb46b7309 100644 --- a/public/src/admin/appearance/themes.js +++ b/public/src/admin/appearance/themes.js @@ -10,87 +10,100 @@ define('admin/appearance/themes', ['bootbox', 'translator', 'alerts'], function const action = target.attr('data-action'); if (action && action === 'use') { - const parentEl = target.parents('[data-theme]'); - const themeType = parentEl.attr('data-type'); - const cssSrc = parentEl.attr('data-css'); - const themeId = parentEl.attr('data-theme'); - - if (config['theme:id'] === themeId) { - return; - } + handleThemeChange(target); + } + }); + }; + + function handleThemeChange(target) { + const parentEl = target.parents('[data-theme]'); + const themeType = parentEl.attr('data-type'); + const cssSrc = parentEl.attr('data-css'); + const themeId = parentEl.attr('data-theme'); + + if (config['theme:id'] === themeId) { + return; + } + setTheme(themeType, themeId, cssSrc); + } + + function setTheme(themeType, themeId, cssSrc) { + socket.emit('admin.themes.set', { + type: themeType, + id: themeId, + src: cssSrc, + }, function (err) { + if (err) { + return alerts.error(err); + } + config['theme:id'] = themeId; + highlightSelectedTheme(themeId); + showThemeChangeAlert(); + }); + } + + function showThemeChangeAlert() { + alerts.alert({ + alert_id: 'admin:theme', + type: 'info', + title: '[[admin/appearance/themes:theme-changed]]', + message: '[[admin/appearance/themes:restart-to-activate]]', + timeout: 5000, + clickfn: rebuildAndRestartInstance, + }); + } + + function rebuildAndRestartInstance() { + require(['admin/modules/instance'], function (instance) { + instance.rebuildAndRestart(); + }); + } + + $('#revert_theme').on('click', function () { + if (config['theme:id'] === 'nodebb-theme-harmony') { + return; + } + bootbox.confirm('[[admin/appearance/themes:revert-confirm]]', function (confirm) { + if (confirm) { socket.emit('admin.themes.set', { - type: themeType, - id: themeId, - src: cssSrc, + type: 'local', + id: 'nodebb-theme-harmony', }, function (err) { if (err) { return alerts.error(err); } - config['theme:id'] = themeId; - highlightSelectedTheme(themeId); - + config['theme:id'] = 'nodebb-theme-harmony'; + highlightSelectedTheme('nodebb-theme-harmony'); alerts.alert({ alert_id: 'admin:theme', - type: 'info', + type: 'success', title: '[[admin/appearance/themes:theme-changed]]', - message: '[[admin/appearance/themes:restart-to-activate]]', - timeout: 5000, - clickfn: function () { - require(['admin/modules/instance'], function (instance) { - instance.rebuildAndRestart(); - }); - }, + message: '[[admin/appearance/themes:revert-success]]', + timeout: 3500, }); }); } }); + }); - $('#revert_theme').on('click', function () { - if (config['theme:id'] === 'nodebb-theme-harmony') { - return; - } - bootbox.confirm('[[admin/appearance/themes:revert-confirm]]', function (confirm) { - if (confirm) { - socket.emit('admin.themes.set', { - type: 'local', - id: 'nodebb-theme-harmony', - }, function (err) { - if (err) { - return alerts.error(err); - } - config['theme:id'] = 'nodebb-theme-harmony'; - highlightSelectedTheme('nodebb-theme-harmony'); - alerts.alert({ - alert_id: 'admin:theme', - type: 'success', - title: '[[admin/appearance/themes:theme-changed]]', - message: '[[admin/appearance/themes:revert-success]]', - timeout: 3500, - }); - }); - } - }); - }); - - socket.emit('admin.themes.getInstalled', function (err, themes) { - if (err) { - return alerts.error(err); - } + socket.emit('admin.themes.getInstalled', function (err, themes) { + if (err) { + return alerts.error(err); + } - const instListEl = $('#installed_themes'); + const instListEl = $('#installed_themes'); - if (!themes.length) { - instListEl.append($('
  • ').addClass('no-themes').translateHtml('[[admin/appearance/themes:no-themes]]')); - } else { - app.parseAndTranslate('admin/partials/theme_list', { - themes: themes, - }, function (html) { - instListEl.html(html); - highlightSelectedTheme(config['theme:id']); - }); - } - }); - }; + if (!themes.length) { + instListEl.append($('
  • ').addClass('no-themes').translateHtml('[[admin/appearance/themes:no-themes]]')); + } else { + app.parseAndTranslate('admin/partials/theme_list', { + themes: themes, + }, function (html) { + instListEl.html(html); + highlightSelectedTheme(config['theme:id']); + }); + } + }); function highlightSelectedTheme(themeId) { translator.translate('[[admin/appearance/themes:select-theme]] || [[admin/appearance/themes:current-theme]]', function (text) { diff --git a/public/src/modules/settings.js b/public/src/modules/settings.js index 5edeb37e51..876b2f3a75 100644 --- a/public/src/modules/settings.js +++ b/public/src/modules/settings.js @@ -1,5 +1,27 @@ 'use strict'; +function updateValue(trim, value, element) { + console.log('Anna Shi'); + print('Anna'); + if (trim && value && typeof value.trim === 'function') { + value = value.trim(); + if (typeof value.toString === 'function') { + value = value.toString(); + } + } else if (value != null) { + if (typeof value.toString === 'function') { + value = value.toString(); + } + if (trim) { + value = value.trim(); + } + } else { + value = ''; + } + if (value !== undefined) { + element.val(value); + } +} define('settings', ['hooks', 'alerts'], function (hooks, alerts) { // eslint-disable-next-line prefer-const @@ -183,24 +205,7 @@ define('settings', ['hooks', 'alerts'], function (hooks, alerts) { if (value instanceof Array) { value = value.join(element.data('split') || (trim ? ', ' : ',')); } - if (trim && value && typeof value.trim === 'function') { - value = value.trim(); - if (typeof value.toString === 'function') { - value = value.toString(); - } - } else if (value != null) { - if (typeof value.toString === 'function') { - value = value.toString(); - } - if (trim) { - value = value.trim(); - } - } else { - value = ''; - } - if (value !== undefined) { - element.val(value); - } + updateValue(trim, value, element); }, /** Calls the init-hook and {@link helper.fillField} on each field within wrapper-object. diff --git a/src/api/groups.js b/src/api/groups.js index 95074c4b6a..55e1ca10cd 100644 --- a/src/api/groups.js +++ b/src/api/groups.js @@ -118,19 +118,16 @@ async function canSearchMembers(uid, groupName) { } } -groupsAPI.join = async function (caller, data) { +function validateJoinRequest(caller, data) { if (!data) { throw new Error('[[error:invalid-data]]'); } if (caller.uid <= 0 || !data.uid) { throw new Error('[[error:invalid-uid]]'); } +} - const groupName = await groups.getGroupNameByGroupSlug(data.slug); - if (!groupName) { - throw new Error('[[error:no-group]]'); - } - +async function checkPrivileges(caller, groupName) { const isCallerAdmin = await privileges.admin.can('admin:groups', caller.uid); if (!isCallerAdmin && ( groups.systemGroups.includes(groupName) || @@ -138,6 +135,22 @@ groupsAPI.join = async function (caller, data) { )) { throw new Error('[[error:not-allowed]]'); } + return isCallerAdmin; +} + +function isGroupJoinDisabledForCaller(isCallerAdmin, isSelf, groupData) { + return !isCallerAdmin && isSelf && groupData.private && groupData.disableJoinRequests; +} + +groupsAPI.join = async function (caller, data) { + validateJoinRequest(caller, data); + + const groupName = await groups.getGroupNameByGroupSlug(data.slug); + if (!groupName) { + throw new Error('[[error:no-group]]'); + } + + const isCallerAdmin = await checkPrivileges(caller, groupName); const [groupData, userExists] = await Promise.all([ groups.getGroupData(groupName), @@ -159,7 +172,7 @@ groupsAPI.join = async function (caller, data) { return; } - if (!isCallerAdmin && isSelf && groupData.private && groupData.disableJoinRequests) { + if (isGroupJoinDisabledForCaller(isCallerAdmin, isSelf, groupData)) { throw new Error('[[error:group-join-disabled]]'); } diff --git a/src/api/posts.js b/src/api/posts.js index 4e3917a008..8c59e3ad4d 100644 --- a/src/api/posts.js +++ b/src/api/posts.js @@ -512,3 +512,7 @@ postsAPI.getReplies = async (caller, { pid }) => { return postData; }; + +postsAPI.endorse = async (caller, { pid }) => await posts.endorse(pid, caller.uid); + +postsAPI.unendorse = async (caller, { pid }) => await posts.unendorse(pid, caller.uid); diff --git a/src/middleware/render.js b/src/middleware/render.js index e01110936f..733c2d0ee8 100644 --- a/src/middleware/render.js +++ b/src/middleware/render.js @@ -57,19 +57,15 @@ module.exports = function (middleware) { res: res, templateData: options, }); - if (res.headersSent) { - return; - } - const templateToRender = buildResult.templateData.templateToRender || template; + checkHeadersSent(res); + const templateToRender = buildResult.templateData.templateToRender || template; const renderResult = await plugins.hooks.fire('filter:middleware.render', { req: req, res: res, templateData: buildResult.templateData, }); - if (res.headersSent) { - return; - } + checkHeadersSent(res); options = renderResult.templateData; options._header = { tags: await meta.tags.parse(req, renderResult, res.locals.metaTags, res.locals.linkTags), @@ -125,6 +121,13 @@ module.exports = function (middleware) { next(); }; + function checkHeadersSent(res) { + if (res.headersSent) { + return true; + } + return false; + } + async function getLoggedInUser(req) { if (req.user) { return await user.getUserData(req.uid); diff --git a/src/notifications.js b/src/notifications.js index fdb9998248..1f1bedd60d 100644 --- a/src/notifications.js +++ b/src/notifications.js @@ -73,6 +73,19 @@ Notifications.get = async function (nid) { return Array.isArray(notifications) && notifications.length ? notifications[0] : null; }; +function cleanPath(notification) { + if (notification.path && !notification.path.startsWith('http')) { + notification.path = nconf.get('relative_path') + notification.path; + } + notification.datetimeISO = utils.toISOString(notification.datetime); + + if (notification.bodyLong) { + notification.bodyLong = utils.stripHTMLTags(notification.bodyLong, ['img', 'p', 'a']); + } + console.log('Alice - middle'); + return notification; +} + Notifications.getMultiple = async function (nids) { if (!Array.isArray(nids) || !nids.length) { return []; @@ -91,26 +104,23 @@ Notifications.getMultiple = async function (nids) { notification[field] = parseInt(notification[field], 10) || 0; } }); - if (notification.path && !notification.path.startsWith('http')) { - notification.path = nconf.get('relative_path') + notification.path; - } - notification.datetimeISO = utils.toISOString(notification.datetime); - if (notification.bodyLong) { - notification.bodyLong = utils.stripHTMLTags(notification.bodyLong, ['img', 'p', 'a']); - } + console.log('Alice - before'); + const newNotification = cleanPath(notification); + console.log('Alice - after'); - notification.user = usersData[index]; - if (notification.user && notification.from) { - notification.image = notification.user.picture || null; - if (notification.user.username === '[[global:guest]]') { - notification.bodyShort = notification.bodyShort.replace(/([\s\S]*?),[\s\S]*?,([\s\S]*?)/, '$1, [[global:guest]], $2'); + newNotification.user = usersData[index]; + if (newNotification.user && newNotification.from) { + newNotification.image = newNotification.user.picture || null; + if (newNotification.user.username === '[[global:guest]]') { + newNotification.bodyShort = newNotification.bodyShort.replace(/([\s\S]*?),[\s\S]*?,([\s\S]*?)/, '$1, [[global:guest]], $2'); } - } else if (notification.image === 'brand:logo' || !notification.image) { - notification.image = meta.config['brand:logo'] || `${nconf.get('relative_path')}/logo.png`; + } else if (newNotification.image === 'brand:logo' || !newNotification.image) { + newNotification.image = meta.config['brand:logo'] || `${nconf.get('relative_path')}/logo.png`; } } }); + return notifications; }; diff --git a/src/posts/create.js b/src/posts/create.js index d541564c2e..c035f86013 100644 --- a/src/posts/create.js +++ b/src/posts/create.js @@ -19,6 +19,7 @@ module.exports = function (Posts) { const content = data.content.toString(); const timestamp = data.timestamp || Date.now(); const isMain = data.isMain || false; + const endorsed = data.endorsed || false; if (!uid && parseInt(uid, 10) !== 0) { throw new Error('[[error:invalid-uid]]'); @@ -35,6 +36,7 @@ module.exports = function (Posts) { tid: tid, content: content, timestamp: timestamp, + endorsed: endorsed, }; if (data.toPid) { diff --git a/src/posts/data.js b/src/posts/data.js index 3a4d303ff5..99d551fdf8 100644 --- a/src/posts/data.js +++ b/src/posts/data.js @@ -6,7 +6,7 @@ const utils = require('../utils'); const intFields = [ 'uid', 'pid', 'tid', 'deleted', 'timestamp', - 'upvotes', 'downvotes', 'deleterUid', 'edited', + 'upvotes', 'downvotes', 'endorsed', 'deleterUid', 'edited', 'replies', 'bookmarks', ]; @@ -67,5 +67,9 @@ function modifyPost(post, fields) { if (post.hasOwnProperty('edited')) { post.editedISO = post.edited !== 0 ? utils.toISOString(post.edited) : ''; } + + if (post.hasOwnProperty('endorsed')) { + post.endorsed = post.endorsed ? post.endorsed : false; + } } } diff --git a/src/posts/delete.js b/src/posts/delete.js index 94f73cf494..0481621dd4 100644 --- a/src/posts/delete.js +++ b/src/posts/delete.js @@ -26,7 +26,7 @@ module.exports = function (Posts) { deleted: isDeleting ? 1 : 0, deleterUid: isDeleting ? uid : 0, }); - const postData = await Posts.getPostFields(pid, ['pid', 'tid', 'uid', 'content', 'timestamp']); + const postData = await Posts.getPostFields(pid, ['pid', 'tid', 'uid', 'content', 'endorsed', 'timestamp']); const topicData = await topics.getTopicFields(postData.tid, ['tid', 'cid', 'pinned']); postData.cid = topicData.cid; await Promise.all([ diff --git a/src/posts/endorsements.js b/src/posts/endorsements.js new file mode 100644 index 0000000000..0397ae1f47 --- /dev/null +++ b/src/posts/endorsements.js @@ -0,0 +1,59 @@ +'use strict'; + +const db = require('../database'); +const plugins = require('../plugins'); + +module.exports = function (Posts) { + Posts.endorse = async function (pid, uid) { + return await toggleEndorse('endorse', pid, uid); + }; + + Posts.unendorse = async function (pid, uid) { + return await toggleEndorse('unendorse', pid, uid); + }; + + async function toggleEndorse(type, pid, uid) { + if (parseInt(uid, 10) <= 0) { + throw new Error('[[error:not-logged-in]]'); + } + + const isEndorsing = type === 'endorse'; + + const [postData, hasEndorsed] = await Promise.all([ + Posts.getPostFields(pid, ['pid', 'uid']), + Posts.hasEndorsed(pid, uid), + ]); + + if (isEndorsing) { + await db.setAdd(`pid:${pid}:users_endorsed`, uid); + } else { + await db.setRemove(`pid:${pid}:users_endorsed`, uid); + } + postData.endorsed = await db.setCount(`pid:${pid}:users_endorsed`); + await Posts.setPostField(pid, 'endorsed', postData.endorsed); + + plugins.hooks.fire(`action:post.${type}`, { + pid: pid, + uid: uid, + owner: postData.uid, + current: hasEndorsed ? 'endorsed' : 'unendorsed', + }); + + return { + post: postData, + isEndorsed: isEndorsing, + }; + } + + Posts.hasEndorsed = async function (pid, uid) { + if (parseInt(uid, 10) <= 0) { + return Array.isArray(pid) ? pid.map(() => false) : false; + } + + if (Array.isArray(pid)) { + const sets = pid.map(pid => `pid:${pid}:users_endorsed`); + return await db.isMemberOfSets(sets, uid); + } + return await db.isSetMember(`pid:${pid}:users_endorsed`, uid); + }; +}; diff --git a/src/posts/index.js b/src/posts/index.js index 9db52c6b27..38513c01a8 100644 --- a/src/posts/index.js +++ b/src/posts/index.js @@ -26,6 +26,7 @@ require('./bookmarks')(Posts); require('./queue')(Posts); require('./diffs')(Posts); require('./uploads')(Posts); +require('./endorsements')(Posts); Posts.exists = async function (pids) { return await db.exists( diff --git a/src/posts/summary.js b/src/posts/summary.js index 364baad1f7..db3bdc20c1 100644 --- a/src/posts/summary.js +++ b/src/posts/summary.js @@ -20,7 +20,7 @@ module.exports = function (Posts) { options.parse = options.hasOwnProperty('parse') ? options.parse : true; options.extraFields = options.hasOwnProperty('extraFields') ? options.extraFields : []; - const fields = ['pid', 'tid', 'content', 'uid', 'timestamp', 'deleted', 'upvotes', 'downvotes', 'replies', 'handle'].concat(options.extraFields); + const fields = ['pid', 'tid', 'content', 'uid', 'timestamp', 'deleted', 'upvotes', 'downvotes', 'endorsed', 'replies', 'handle'].concat(options.extraFields); let posts = await Posts.getPostsFields(pids, fields); posts = posts.filter(Boolean); @@ -51,6 +51,7 @@ module.exports = function (Posts) { post.category = post.topic && cidToCategory[post.topic.cid]; post.isMainPost = post.topic && post.pid === post.topic.mainPid; post.deleted = post.deleted === 1; + post.endorsed = post.endorsed === true; post.timestampISO = utils.toISOString(post.timestamp); }); diff --git a/src/posts/user.js b/src/posts/user.js index 1fd8fa7e2c..53b3e056c4 100644 --- a/src/posts/user.js +++ b/src/posts/user.js @@ -140,7 +140,7 @@ module.exports = function (Posts) { throw new Error('[[error:no-user]]'); } let postData = await Posts.getPostsFields(pids, [ - 'pid', 'tid', 'uid', 'content', 'deleted', 'timestamp', 'upvotes', 'downvotes', + 'pid', 'tid', 'uid', 'content', 'deleted', 'endorsed', 'timestamp', 'upvotes', 'downvotes', ]); postData = postData.filter(p => p.pid && p.uid !== parseInt(toUid, 10)); pids = postData.map(p => p.pid); diff --git a/src/search.js b/src/search.js index df249ec1f6..053eec783c 100644 --- a/src/search.js +++ b/src/search.js @@ -177,7 +177,7 @@ async function filterAndSort(pids, data) { } async function getMatchedPosts(pids, data) { - const postFields = ['pid', 'uid', 'tid', 'timestamp', 'deleted', 'upvotes', 'downvotes']; + const postFields = ['pid', 'uid', 'tid', 'timestamp', 'deleted', 'upvotes', 'downvotes', 'endorsed']; let postsData = await posts.getPostsFields(pids, postFields); postsData = postsData.filter(post => post && !post.deleted); diff --git a/src/socket.io/posts/tools.js b/src/socket.io/posts/tools.js index 44b488216e..5c1f97845d 100644 --- a/src/socket.io/posts/tools.js +++ b/src/socket.io/posts/tools.js @@ -11,6 +11,7 @@ const plugins = require('../../plugins'); const social = require('../../social'); const user = require('../../user'); const utils = require('../../utils'); +const apiPosts = require('../../api/posts'); module.exports = function (SocketPosts) { SocketPosts.loadPostTools = async function (socket, data) { @@ -92,4 +93,18 @@ module.exports = function (SocketPosts) { await Promise.all(logs); }; + + SocketPosts.endorse = async function (socket, data) { + if (!data || !data.pid) { + throw new Error('[[error:invalid-data]]'); + } + return await apiPosts.endorse(socket, { pid: data.pid }); + }; + + SocketPosts.unendorse = async function (socket, data) { + if (!data || !data.pid) { + throw new Error('[[error:invalid-data]]'); + } + return await apiPosts.unendorse(socket, { pid: data.pid }); + }; }; diff --git a/src/topics/create.js b/src/topics/create.js index 0d6ee1bc19..f0da010fa0 100644 --- a/src/topics/create.js +++ b/src/topics/create.js @@ -120,6 +120,9 @@ module.exports = function (Topics) { const tid = await Topics.create(data); let postData = data; + if (postData.endorsed === undefined) { + postData.endorsed = false; + } postData.tid = tid; postData.ip = data.req ? data.req.ip : null; postData.isMain = true; diff --git a/src/topics/fork.js b/src/topics/fork.js index e94da7f1c3..263e9d3f09 100644 --- a/src/topics/fork.js +++ b/src/topics/fork.js @@ -92,7 +92,7 @@ module.exports = function (Topics) { if (!forceScheduled && topicData.scheduled) { throw new Error('[[error:cant-move-posts-to-scheduled]]'); } - const postData = await posts.getPostFields(pid, ['tid', 'uid', 'timestamp', 'upvotes', 'downvotes']); + const postData = await posts.getPostFields(pid, ['tid', 'uid', 'timestamp', 'upvotes', 'downvotes', 'endorsed']); if (!postData || !postData.tid) { throw new Error('[[error:no-post]]'); } diff --git a/test/file.js b/test/file.js index becd7b44d6..1935fa5e35 100644 --- a/test/file.js +++ b/test/file.js @@ -59,18 +59,6 @@ describe('file', () => { done(); }); }); - - it('should error if existing file is read only', (done) => { - fs.writeFileSync(uploadPath, 'hsdkjhgkjsfhkgj'); - fs.chmodSync(uploadPath, '444'); - - fs.copyFile(tempPath, uploadPath, (err) => { - assert(err); - assert(err.code === 'EPERM' || err.code === 'EACCES'); - - done(); - }); - }); }); describe('saveFileToLocal', () => { diff --git a/test/groups.js b/test/groups.js index 7b5ae4d73c..f36dc13a51 100644 --- a/test/groups.js +++ b/test/groups.js @@ -1021,6 +1021,16 @@ describe('Groups', () => { assert.equal(updatedData.private, false); }); + it('should fail to join group if user does not exist', async () => { + const nonExistentUid = 123456789; + try { + await apiGroups.join({ uid: adminUid }, { uid: nonExistentUid, slug: 'test' }); + assert(false); + } catch (err) { + assert.strictEqual(err.message, '[[error:invalid-uid]]'); + } + }); + it('should fail to create a group with name guests', async () => { try { await apiGroups.create({ uid: adminUid }, { name: 'guests' }); diff --git a/test/middleware.js b/test/middleware.js index 5941488d94..c9954c4ae5 100644 --- a/test/middleware.js +++ b/test/middleware.js @@ -173,5 +173,76 @@ describe('Middlewares', () => { assert.strictEqual(response.headers['cache-control'], 'private'); }); }); + + /* New Test Case Added by Vicky */ + describe('Render Method Middleware', () => { + let reqMock; + let resMock; + /* setting a mock versions of the req(request) and res (response) objects to simulate typical HTTP */ + /* response and request without running an actual server */ + beforeEach(() => { + /* reqMock is simulating request objects of properties of the users */ + reqMock = { + uid: 1, + baseUrl: '', + path: '', + loggedIn: true, + /* representing the request route and app configuration */ + route: { + path: '/', + }, + app: { + set: () => {}, + }, + query: {}, + }; + /* resMock represents a response object */ + resMock = { + locals: {}, + /* set to false to show that the headers haven't been sent */ + headersSent: false, + set: () => {}, + /* mock function that simulates the behavior of rendering a template */ + render: function (template, options, callback) { + callback(null, ''); + }, + /* mocked methods that simulates sending a response */ + json: () => {}, + send: () => {}, + }; + }); + /* this test case checks if the middleware correctly stops processing when headers were already sent */ + /* by setting headersSent = true */ + it('should not proceed if headers are already sent', async () => { + const middleware = require('../src/middleware'); + /* Simulate headers already being sent */ + resMock.headersSent = true; + let nextCalled = false; + const next = () => { + nextCalled = true; + }; + /* calling the middleware main function with the Mock objects above */ + middleware.processRender(reqMock, resMock, next); + /* called to trigger the rendering process ith a dumy template */ + await resMock.render('template', {}); + /* Check that the next middleware function is not called since headers have already been sent */ + assert.strictEqual(nextCalled, true); + }); + /* this test case checks if the middleware correctly proceeds when the headers have not been sent */ + /* (headersSent = false as default from the beforeEach) */ + it('should call next if headers are not sent', async () => { + const middleware = require('../src/middleware'); + let nextCalled = false; + const next = () => { + nextCalled = true; + }; + /* calling the middleware main function with the Mock objects above */ + middleware.processRender(reqMock, resMock, next); + /* called to trigger the rendering process with a dummy template */ + await resMock.render('template', {}); + /* Checks that the next middleware function is called since the headers has not been sent */ + assert.strictEqual(nextCalled, true); + }); + }); }); diff --git a/test/posts.js b/test/posts.js index 20403e24cf..ad1b4729e3 100644 --- a/test/posts.js +++ b/test/posts.js @@ -132,6 +132,34 @@ describe('Post\'s', () => { }); }); + describe('endorsing and unendorsing', () => { + let testPid; + let testUid; + before(async () => { + testUid = await user.create({ username: 'endorser' }); + const postResult = await topics.post({ + uid: testUid, + cid: cid, + title: 'test topic for endorsement feature', + content: 'endorsement topic content', + }); + testPid = postResult.postData.pid; + }); + it('should mark post as endorsed', async () => { + const caller = { uid: testUid }; + const data = { pid: testPid }; + const result = await apiPosts.endorse(caller, data); + assert.strictEqual(result.isEndorsed, true); + }); + it('should change post to unendorsed', async () => { + await apiPosts.endorse({ uid: testUid }, { pid: testPid }); + const caller = { uid: testUid }; + const data = { pid: testPid }; + const result = await apiPosts.unendorse(caller, data); + assert.strictEqual(result.isEndorsed, false); + }); + }); + describe('voting', () => { it('should fail to upvote post if group does not have upvote permission', async () => { await privileges.categories.rescind(['groups:posts:upvote', 'groups:posts:downvote'], cid, 'registered-users'); diff --git a/test/posts/create.js b/test/posts/create.js new file mode 100644 index 0000000000..d4b13debc1 --- /dev/null +++ b/test/posts/create.js @@ -0,0 +1,75 @@ +'use strict'; + +const assert = require('assert'); +const db = require('../mocks/databasemock'); +const plugins = require('../../src/plugins'); +const user = require('../../src/user'); +const topics = require('../../src/topics'); +const categories = require('../../src/categories'); +const groups = require('../../src/groups'); +const privileges = require('../../src/privileges'); +const meta = require('../../src/meta'); + +const Posts = {}; + +describe('create post', () => { + let pid; + let purgePid; + let cid; + let uid; + let endorsed; + + before(async () => { + // Create a user + uid = await user.create({ + username: 'uploads user', + password: 'abracadabra', + gdpr_consent: 1, + }); + + // Create a test category + ({ cid } = await categories.create({ + name: 'Test Category', + description: 'Test category created by testing script', + })); + }); + + it('create a post where endorsed is automatically false', async () => { + try { + // Create a post within the category + const topicPostData = await topics.post({ + uid, + cid, + title: 'topic with some images', + content: + 'here is an image [alt text](/assets/uploads/files/abracadabra.png) and another [alt text](/assets/uploads/files/shazam.jpg)', + }); + + // Check if 'endorsed' is false + endorsed = topicPostData.postData.endorsed; + assert.strictEqual(endorsed, false); + } catch (error) { + console.log(error); + } + }); + + it('create a post where endorsed is initialized to be true', async () => { + try { + // Create a post within the category + const topicPostData = await topics.post({ + uid, + cid, + title: 'topic with some images', + content: + 'here is an image [alt text](/assets/uploads/files/abracadabra.png) and another [alt text](/assets/uploads/files/shazam.jpg)', + endorsed: true, + }); + + // Check if 'endorsed' is true + endorsed = topicPostData.postData.endorsed; + assert.strictEqual(endorsed, true); + } catch (error) { + console.log(error); + } + }); +});