strapi-plugin-comments 2.0.0-rc.2 → 2.0.0

package/admin/src/translations/en.json

@@ -7,12 +7,12 @@
     "nav.item.discover": "Discover",
     "nav.item.reports": "Reports",
     "nav.item.settings": "Settings",
-    "page.common.item.status.OPEN": "OPEN",
-    "page.common.item.status.BLOCKED": "BLOCKED",
-    "page.common.item.status.APPROVED": "APPROVED",
-    "page.common.item.status.TO_REVIEW": "TO REVIEW ({count, number})",
-    "page.common.item.status.REJECTED": "REJECTED",
-    "page.common.item.status.REMOVED": "REMOVED BY AUTHOR",
+    "page.common.item.status.OPEN": "Open",
+    "page.common.item.status.BLOCKED": "Blocked",
+    "page.common.item.status.APPROVED": "Approved",
+    "page.common.item.status.TO_REVIEW": "To review ({count, number})",
+    "page.common.item.status.REJECTED": "Rejected",
+    "page.common.item.status.REMOVED": "Removed by author",
     "page.updates.header": "Recent updates",
     "page.discover.header": "Discover threads",
     "page.discover.header.count": "entries found",
@@ -47,17 +47,17 @@
     "page.details.panel.discussion.warnings.reports.dialog.content": "Content",
     "page.details.panel.discussion.warnings.reports.dialog.createdAt": "Issue date",
     "page.details.panel.discussion.warnings.reports.dialog.status": "Status",
-    "page.details.panel.discussion.warnings.reports.dialog.status.OPEN": "OPEN",
-    "page.details.panel.discussion.warnings.reports.dialog.status.RESOLVED": "RESOLVED",
+    "page.details.panel.discussion.warnings.reports.dialog.status.OPEN": "Open",
+    "page.details.panel.discussion.warnings.reports.dialog.status.RESOLVED": "Resolved",
     "page.details.panel.discussion.warnings.reports.dialog.actions": "Actions",
     "page.details.panel.discussion.warnings.reports.dialog.actions.resolve": "Resolve",
     "page.details.panel.discussion.warnings.reports.dialog.confirmation.success": "Open report has been resolved",
-    "page.details.panel.discussion.status.blocked": "BLOCKED",
+    "page.details.panel.discussion.status.blocked": "Blocked",
     "page.details.panel.entity": "Entity details",
     "page.details.panel.status": "Discussion is",
-    "page.details.panel.status.open": "OPEN",
-    "page.details.panel.status.blocked": "BLOCKED",
-    "page.details.panel.status.pending": "PENDING",
+    "page.details.panel.status.open": "Open",
+    "page.details.panel.status.blocked": "Blocked",
+    "page.details.panel.status.pending": "Pending",
     "page.details.panel.loading": "Fetching entity...",
     "page.details.actions.comment.block": "Block comment",
     "page.details.actions.comment.block.confirmation.header": "Moderation: Block comment",
@@ -77,9 +77,7 @@
     "page.details.actions.comment.approve.confirmation.success": "Comment has been approved",
     "page.details.actions.comment.reject.confirmation.success": "Comment has been rejected",
     "page.details.filters.label": "View",
-    "page.details.filters.removed.visibility": "Comments visibility",
-    "page.details.filters.removed.show": "Show removed",
-    "page.details.filters.removed.hide": "Hide removed",
+    "page.details.filters.removed.visibility": "Show removed comments",
     "page.coming.soon": "Wait for what is coming soon...",
     "compontents.confirmation.dialog.header": "Confirmation",
     "compontents.confirmation.dialog.description": "Do you really want to perform this action?",

package/admin/src/utils/resolveCommentStatus.js

@@ -4,10 +4,6 @@ import { COMMENT_STATUS } from './constants';
 const resolveCommentStatus = ({ removed, blocked, blockedThread, approvalStatus, reviewFlowEnabled }) => {
     const gotApprovalFlow = !isNil(approvalStatus);
 
-    if (reviewFlowEnabled) {
-        return COMMENT_STATUS.TO_REVIEW;
-    }
-
     if (removed) {
         return COMMENT_STATUS.REMOVED;
     } 
@@ -15,6 +11,10 @@ const resolveCommentStatus = ({ removed, blocked, blockedThread, approvalStatus,
     if (blocked || blockedThread) {
         return COMMENT_STATUS.BLOCKED;
     } 
+
+    if (reviewFlowEnabled) {
+        return COMMENT_STATUS.TO_REVIEW;
+    }
     
     if (gotApprovalFlow) {
         const status = approvalStatus.toUpperCase();

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "2.0.0-rc.2",
+  "version": "2.0.0",
   "description": "Strapi - Comments plugin",
   "strapi": {
     "name": "comments",
-    "description": "Comments & audience engagement",
+    "displayName": "Comments",
+    "description": "Powerful Strapi based comments moderation tool for you and your users",
     "kind": "plugin"
   },
   "scripts": {
@@ -16,15 +17,16 @@
     "url": "https://github.com/VirtusLab-Open-Source/strapi-plugin-comments"
   },
   "dependencies": {
-    "@strapi/utils": "^4.0.6",
-    "@strapi/plugin-graphql": "^4.0.6",
+    "@strapi/utils": "^4.0.7",
+    "@strapi/plugin-graphql": "^4.0.7",
     "bad-words": "^3.0.4"
   },
   "devDependencies": {
     "codecov": "^3.7.2",
     "jest": "^26.0.1",
     "jest-cli": "^26.0.1",
-    "jest-styled-components": "^7.0.2"
+    "jest-styled-components": "^7.0.2",
+    "koa": "2.13.3"
   },
   "peerDependencies": {
     "@strapi/strapi": "4.x"

package/server/controllers/utils/__tests__/functions.test.js

@@ -1,6 +1,6 @@
-const PluginError = require('../../../services/utils/error');
+const PluginError = require('../../../utils/error');
 const ctx = require('koa/lib/context');
-const { parseParams, throwError } = require('../functions');
+const { throwError } = require('../functions');
 
 jest.mock
 

package/server/graphql/types/comment-nested.js

@@ -6,6 +6,7 @@ module.exports = ({ nexus }) => nexus.objectType({
     t.boolean("blocked")
     t.boolean("blockedThread")
     t.string("approvalStatus")
+    t.boolean("removed")
     t.field("threadOf", { type: 'CommentSingle' })
     t.list.field("children", { type: 'CommentNested' })
     t.field("author", { type: 'CommentAuthor' })

package/server/services/__tests__/common.test.js

@@ -0,0 +1,165 @@
+const PluginError = require('../../utils/error');
+const { getPluginService } = require('../../utils/functions');
+
+jest.mock
+
+
+const setup = function(config) {
+  Object.defineProperty(global, 'strapi', {
+    value: require('../../../__mocks__/initSetup')(config),
+    writable: true,
+  });
+}
+
+afterEach(() => {
+  Object.defineProperty(global, 'strapi', {});
+})
+
+describe('Test Comments service functions utils', () => {
+
+  describe('Get plugin config', () => {
+    beforeEach(() => setup({
+      test: 'sample',
+    }));
+
+    test('Should return config value', () => {
+      expect(getPluginService('common').getConfig('test')).toEqual('sample');
+    });
+
+    test('Should return default config prop value if not set', () => {
+      expect(getPluginService('common').getConfig('another', 'defaultValue')).toEqual('defaultValue');
+    });
+  });
+
+  describe('Validate user context', () => {
+    beforeEach(() => setup());
+
+    test('Should context be valid', () => {
+      expect(getPluginService('common').isValidUserContext({ id: 1 })).toEqual(true);
+    });
+
+    test('Should context be invalid', () => {
+      expect(getPluginService('common').isValidUserContext({ })).toEqual(false);
+    });
+
+    test('Should use fallback', () => {
+      expect(getPluginService('common').isValidUserContext()).toEqual(true);
+    });
+  });
+
+  describe('Sanitize comments entity', () => {
+    beforeEach(() => setup());
+
+    const sample = {
+      id: 1,
+      content: 'Test text',
+      blocked: false,
+      removed: true,
+    };
+
+    const authorSample = {
+      id: 1,
+      username: 'Joe Doe',
+      email: 'test@example.com',
+      password: 'xxx',
+    };
+
+    const authorGenericSample = {
+      authorId: 1,
+      authorName: 'Joe Doe',
+      authorEmail: 'test@example.com',
+    };
+
+    const outputAuthorSample = {
+      id: 1,
+      name: 'Joe Doe',
+      email: 'test@example.com',
+    };
+
+    test('Should return exact the same value', () => {
+      const input = { ...sample };
+      const output = getPluginService('common').sanitizeCommentEntity(input);
+      expect(output).toHaveProperty('id', input.id);
+      expect(output).toHaveProperty('content', input.content);
+      expect(output).toHaveProperty('blocked', input.blocked);
+      expect(output).toHaveProperty('removed', input.removed);
+    });
+
+    test('Should return entity with \'author\' property for generic author', () => {
+      const input = {
+        ...sample,
+        ...authorGenericSample,
+      };
+      const output = getPluginService('common').sanitizeCommentEntity(input);
+
+      expect(output).toHaveProperty('author');
+      expect(output).toHaveProperty('author.id', input.authorId);
+      expect(output).toHaveProperty('author.id', outputAuthorSample.id);
+      expect(output).toHaveProperty('author.name', input.authorName);
+      expect(output).toHaveProperty('author.name', outputAuthorSample.name);
+      expect(output).toHaveProperty('author.email', input.authorEmail);
+      expect(output).toHaveProperty('author.email', outputAuthorSample.email);
+
+      expect(output).not.toHaveProperty('authorId');
+      expect(output).not.toHaveProperty('authorName');
+      expect(output).not.toHaveProperty('authorEmail');
+    });
+
+    test('Should return entity with \'author\' property for Strapi author', () => {
+      const input = {
+        ...sample,
+        authorUser: authorSample,
+      };
+      const output = getPluginService('common').sanitizeCommentEntity(input);
+
+      expect(output).toHaveProperty('author');
+      expect(output).toHaveProperty('author.id', input.authorUser.id);
+      expect(output).toHaveProperty('author.id', outputAuthorSample.id);
+      expect(output).toHaveProperty('author.name', input.authorUser.username);
+      expect(output).toHaveProperty('author.name', outputAuthorSample.name);
+      expect(output).toHaveProperty('author.email', input.authorUser.email);
+      expect(output).toHaveProperty('author.email', outputAuthorSample.email);
+
+      expect(output).not.toHaveProperty('authorUser');
+
+      expect(output).not.toHaveProperty('author.password');
+    });
+  });
+
+  describe('Bad Words filtering', () => {
+    beforeEach(() => setup());
+
+    const text = 'Lorem ipsum dolor sit fuck amet';
+
+    test('Should find bad words usage and throw error PluginError', () => {
+      expect.assertions(7);
+      try {
+        getPluginService('common').checkBadWords(text);
+      } catch (e) {
+        expect(getPluginService('common').getConfig('badWords')).toEqual(undefined);
+        expect(e).toBeInstanceOf(PluginError);
+        expect(e).toHaveProperty('status', 400);
+        expect(e).toHaveProperty('name', 'Strapi:Plugin:Comments');
+        expect(e).toHaveProperty('message', 'Bad language used! Please polite your comment...');
+        expect(e).toHaveProperty('payload');
+        expect(e.payload).toEqual(expect.objectContaining({
+          content: {
+            original: text,
+            filtered: text.replace('fuck', '****'),
+          }
+        }));
+      }
+    });
+  });
+
+  describe('Bad Words filtering', () => {
+    beforeEach(() => setup({ badWords: false }));
+
+    const text = 'Lorem ipsum dolor sit fuck amet';
+
+    test('Should skip bad words filtering because of configuration change', () => {
+      expect(getPluginService('common').getConfig('badWords')).toEqual(false);
+      expect(getPluginService('common').checkBadWords(text)).toEqual(text);
+    });
+  });
+});

package/server/services/client.js

@@ -8,7 +8,6 @@ const {
     isEqualEntity,
     getModelUid,
     getRelatedGroups,
-    checkBadWords,
     resolveUserContextError,
 } = require('./utils/functions');
 const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
@@ -58,7 +57,7 @@ module.exports = ({ strapi }) => ({
             throw resolveUserContextError(user);
         }
 
-        if (checkBadWords(content) && singleRelationFulfilled) {
+        if (this.getCommonService().checkBadWords(content) && singleRelationFulfilled) {
             const { author = {}, ...rest } = data;
             let authorData = {};
             if (validContext && user) {
@@ -128,7 +127,7 @@ module.exports = ({ strapi }) => ({
         }
 
         if (isEqualEntity(existingEntity, data, user) && content) {
-            if (checkBadWords(content)) {
+            if (this.getCommonService().checkBadWords(content)) {
                 const entity = await strapi.db.query(getModelUid('comment')).update({
                     where: { id },
                     data: { content },

package/server/services/common.js

@@ -1,7 +1,7 @@
 'use strict';
 
+const BadWordsFilter = require('bad-words');
 const { isArray, isNumber, isObject, isNil, first, parseInt } = require('lodash');
-// const { sanitizeEntity } = require('strapi-utils');
 const PluginError = require('./../utils/error');
 const {
     getModelUid,
@@ -22,7 +22,8 @@ module.exports = ({ strapi }) => ({
         if (prop && isArray(prop)) {
             queryProp = prop.join('.');
         }
-        return strapi.config.get(`plugin.comments${ queryProp ? '.' + queryProp : ''}`) || defaultValue;
+        const result = strapi.config.get(`plugin.comments${ queryProp ? '.' + queryProp : ''}`);
+        return isNil(result) ? defaultValue : result;
     },
 
     // Find comments in the flat structure
@@ -170,4 +171,20 @@ module.exports = ({ strapi }) => ({
     isValidUserContext(user) {
         return user ? !isNil(user?.id) : true;
     },
+
+    checkBadWords(content) {
+        const config = this.getConfig('badWords', true);
+        if (config) {
+            const filter = new BadWordsFilter(isObject(config) ? config : undefined);
+            if (content && filter.isProfane(content)) {
+                throw new PluginError(400, 'Bad language used! Please polite your comment...', {
+                    content: {
+                        original: content,
+                        filtered: content && filter.clean(content),
+                    },
+                });
+            }
+        }
+        return content;
+    },
 });

package/server/services/utils/__tests__/functions.test.js

@@ -1,86 +1,22 @@
-const PluginError = require('../error');
-const { checkBadWords, extractMeta, isValidUserContext, resolveUserContextError } = require('../functions');
+const PluginError = require('../../../utils/error');
+const { resolveUserContextError, getModelUid } = require('../functions');
 
 beforeEach(() => {
   Object.defineProperty(global, 'strapi', {
-    value: {
-      plugins: {
-        comments: {
-          package: require('../../../package.json'),
-          services: {
-            comments: require('../../comments'),
-          },
-          models: {
-            comment: require('../../../models/comment.settings.json'),
-            report: require('../../../models/report.settings.json'),
-          }
-        }
-      },
-      config: {
-        plugins: {
-          comments: {
-            enableUsers: false,
-          }
-        }
-      }
-    },
+    value: require('../../../../__mocks__/initSetup')(),
     writable: true,
   });
 })
 
-describe('Test Comments service functions utils', () => {
-
-  describe('Bad Words filtering', () => {
-    const text = 'Lorem ipsum dolor sit fuck amet';
-
-    test('Should find bad words usage and throw error PluginError', () => {
-      expect.assertions(6);
-      try {
-        checkBadWords(text);
-      } catch (e) {
-        expect(e).toBeInstanceOf(PluginError);
-        expect(e).toHaveProperty('status', 400);
-        expect(e).toHaveProperty('name', 'Strapi:Plugin:Comments');
-        expect(e).toHaveProperty('message', 'Bad language used! Please polite your comment...');
-        expect(e).toHaveProperty('payload');
-        expect(e.payload).toEqual(expect.objectContaining({
-          content: {
-            original: text,
-            filtered: text.replace('fuck', '****'),
-          }
-        }));
-      }
-    });
-
-    test('Should skip bad words filtering because of configuration change', () => {
-      global.strapi.config.plugins.comments.badWords = false;
-
-      expect(checkBadWords(text)).toEqual(text);
-    });
-  });
-
-  describe('Extracting metadata', () => {
-    test('Should extract plugin metadata properly', () => {
-      const { model, service, plugin, pluginName } = extractMeta(strapi.plugins);
-
-      expect(model).toHaveProperty('info.name', 'comment');
-      expect(service).toHaveProperty('findAll');
-      expect(Object.keys(plugin)).toEqual(expect.arrayContaining(['package', 'services', 'models']));
-      expect(pluginName).toBe('comments');
-    });
-  });
+describe('Test service functions utils', () => {
 
-  describe('Validating user context', () => {
-    test('Context should be skipped based on config', () => {
-      global.strapi.config.plugins.comments.enableUsers = false;
-      expect(isValidUserContext(undefined)).toEqual(true);
-      expect(isValidUserContext({ id: 1 })).toEqual(true);
+  describe('Getting models uid\'s ', () => {
+    test('Should get comments uid', () => {
+      expect(getModelUid('comment')).toBe('plugins::comments.comment');
     });
 
-    test('Context should be verified based on input', () => {
-      global.strapi.config.plugins.comments.enableUsers = true;
-      expect(isValidUserContext(undefined)).toEqual(false);
-      expect(isValidUserContext({ id: 1 })).toEqual(true);
+    test('Should get report uid', () => {
+      expect(getModelUid('comment-report')).toBe('plugins::comments.comment-report');
     });
   });
 

package/server/services/utils/functions.js

@@ -1,7 +1,6 @@
-const BadWordsFilter = require('bad-words');
 const PluginError = require('./../../utils/error');
 const { REGEX } = require('./../../utils/constants')
-const { first, get, isObject, isEmpty } = require('lodash');
+const { first, isObject, isEmpty } = require('lodash');
 
 const buildNestedStructure = (
   entities,
@@ -63,21 +62,6 @@ module.exports = {
         reports: (item.reports || []).filter(report => !report.resolved),
     } : item),
 
-    checkBadWords: content => {
-        const config = get(strapi.config, 'plugins.comments.badWords', true);
-        if (config) {
-            const filter = new BadWordsFilter(isObject(config) ? config : undefined);
-            if (content && filter.isProfane(content)) {
-                throw new PluginError(400, 'Bad language used! Please polite your comment...', {
-                    content: {
-                        original: content,
-                        filtered: content && filter.clean(content),
-                    },
-                });
-            }
-        }
-        return content;
-    },
     convertContentTypeNameToSlug: str => {
         const plainConversion = str.replace(/[A-Z]/g, letter => `-${letter.toLowerCase()}`);
         return first(plainConversion) === '-' ? plainConversion.slice(1, plainConversion.length) : plainConversion;

package/server/utils/__tests__/functions.test.js

@@ -0,0 +1,17 @@
+const { getPluginService } = require('../functions');
+
+beforeEach(() => {
+  Object.defineProperty(global, 'strapi', {
+    value: require('../../../__mocks__/initSetup')(),
+    writable: true,
+  });
+})
+
+describe('Test plugin functions utils', () => {
+
+  describe('Get plugin service', () => {
+    test('Should get common service', () => {
+      expect(getPluginService('common')).toHaveProperty('findAllFlat');
+    });
+  });
+});

package/admin/src/components/DiscussionThreadItemMeta/index.js

@@ -1,42 +0,0 @@
-/**
- *
- * Entity Details
- *
- */
-
-import React from 'react';
-import PropTypes from 'prop-types';
-import { useIntl } from 'react-intl';
-import { Box } from '@strapi/design-system/Box';
-import { Flex } from '@strapi/design-system/Flex';
-import { Stack } from '@strapi/design-system/Stack';
-import { Typography } from '@strapi/design-system/Typography';
-
-const DiscussionThreadItemMeta = ({ author, createdAt, updatedAt }) => {
-
-    const { formatDate } = useIntl();
-
-    const dateTime = formatDate(updatedAt || createdAt, { dateStyle: 'short', timeStyle: 'short' });
-    const { name } = author;
-
-    return (<Flex as={Box} paddingTop={2} direction="row">
-        <Stack size={2} horizontal style={{ flexGrow: 1, justifyContent: 'space-between'}}>
-            <Typography variant="pi" fontWeight="bold">{ name }</Typography>
-            <Typography variant="pi">{ dateTime }</Typography>
-        </Stack>
-    </Flex>);
-};
-
-DiscussionThreadItemMeta.propTypes = {
-    author: PropTypes.shape({
-        id: PropTypes.oneOfType(PropTypes.string, PropTypes.number).isRequired,
-        name: PropTypes.string.isRequired,
-        email: PropTypes.string,
-        avatar: PropTypes.string,
-    }).isRequired,
-    createdAt: PropTypes.string.isRequired,
-    updatedAt: PropTypes.string,
-};
-
-export default DiscussionThreadItemMeta;
-