strapi-plugin-comments 2.0.0-beta.7 → 2.0.1

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/content-types/comment.js

@@ -48,10 +48,6 @@ module.exports = {
       target: 'plugin::users-permissions.user',
       configurable: false,
     },
-    authorType: {
-      type: 'string',
-      configurable: false
-    },
     authorId: {
       type: 'string',
       configurable: false

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "2.0.0-beta.7",
+  "version": "2.0.1",
   "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": {
+    "publish": "npm publish --tag latest",
     "test:unit": "jest --verbose --coverage"
   },
   "repository": {
@@ -15,15 +17,16 @@
     "url": "https://github.com/VirtusLab-Open-Source/strapi-plugin-comments"
   },
   "dependencies": {
-    "@strapi/utils": "^4.0.5",
-    "@strapi/plugin-graphql": "^4.0.5",
+    "@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/client.js

@@ -82,14 +82,19 @@ module.exports = {
   },
 
   async removeComment(ctx) {
-    const { params: { relationId, commentId }, query: { authorId } } = ctx;
-    if (authorId) {
+    const { 
+      params: { relationId, commentId }, 
+      query: { authorId },
+      state: { user },
+    } = ctx;
+    if (authorId || user?.id) {
       try {
         return await this.getService()
           .markAsRemoved(
             commentId,
             relationId,
             authorId,
+            user
           );
       } catch (e) {
         if (!e.isBoom) {

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/controllers/utils/parsers.js

@@ -9,7 +9,9 @@ module.exports = {
               related: relation,
             },
             populate: {
-              threadOf: true,
+              threadOf: {
+                populate: { authorUser: true },
+              },
             },
           };
     },

package/server/graphql/mutations/createAbuseReport.js

@@ -10,11 +10,16 @@ module.exports = ({ nexus }) => {
 		args: {
 			input: nonNull('CreateReport'),
 		},
-		async resolve(obj, args) {
+		async resolve(obj, args, ctx) {
 			const { input } = args;
+			const { state: { user } = {} } = ctx;
 			const { commentId, relation, ...body } = input;
-			return await getPluginService('client')
-				.reportAbuse(commentId, relation, body);
+			try {
+				return await getPluginService('client')
+					.reportAbuse(commentId, relation, body, user);
+			} catch(e) {
+				throw new Error(e);
+			}
 		},
 	};
 }

package/server/graphql/mutations/createComment.js

@@ -10,11 +10,16 @@ module.exports = ({ nexus }) => {
 		args: {
 			input: nonNull('CreateComment'),
 		},
-		async resolve(obj, args) {
+		async resolve(obj, args, ctx) {
 			const { input } = args;
+			const { state: { user } = {} } = ctx;
 			const { relation, ...body } = input;
-			return await getPluginService('client')
-				.create(relation, body);
+			try {
+				return await getPluginService('client')
+					.create(relation, body, user);
+			} catch(e) {
+				throw new Error(e);
+			}
 		},
 	};
 }

package/server/graphql/mutations/removeComment.js

@@ -10,11 +10,16 @@ module.exports = ({ nexus }) => {
 		args: {
 			input: nonNull('RemoveComment'),
 		},
-		async resolve(obj, args) {
+		async resolve(obj, args, ctx) {
 			const { input } = args;
+			const { state: { user } = {} } = ctx;
 			const { id, relation, author } = input;
-			return await getPluginService('client')
-				.markAsRemoved(id, relation, author?.id);
+			try {
+				return await getPluginService('client')
+					.markAsRemoved(id, relation, author?.id, user);
+			} catch(e) {
+				throw new Error(e);
+			}
 		},
 	};
 }

package/server/graphql/mutations/updateComment.js

@@ -10,11 +10,16 @@ module.exports = ({ nexus }) => {
 		args: {
 			input: nonNull('UpdateComment'),
 		},
-		async resolve(obj, args) {
+		async resolve(obj, args, ctx) {
 			const { input } = args;
+			const { state: { user } = {} } = ctx;
 			const { id, relation, ...body } = input;
-			return await getPluginService('client')
-				.update(id, relation, body);
+			try {
+				return await getPluginService('client')
+					.update(id, relation, body, user);
+			} catch(e) {
+				throw new Error(e);
+			}
 		},
 	};
 }

package/server/graphql/resolvers-config.js

@@ -1,10 +1,15 @@
 'use strict'
 
-module.exports = ({ }) => ({
-	'Query.findAllFlat': { auth: false },
-	'Query.findAllInHierarchy': { auth: false },
-	'Mutation.createComment': { auth: false },
-	'Mutation.updateComment': { auth: false },
-	'Mutation.removeComment': { auth: false },
-	'Mutation.createAbuseReport': { auth: false },
-});
+const { getPluginService } = require("../utils/functions");
+
+module.exports = () => {
+	const auth = getPluginService('common').getConfig('gql.auth', false);
+	return {
+		'Query.findAllFlat': { auth },
+		'Query.findAllInHierarchy': { auth },
+		'Mutation.createComment': { auth },
+		'Mutation.updateComment': { auth },
+		'Mutation.removeComment': { auth },
+		'Mutation.createAbuseReport': { auth },
+	};
+};

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

@@ -6,9 +6,9 @@ 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("authorUser", { type: 'CommentAuthorUser' })
     t.field("author", { type: 'CommentAuthor' })
     t.string("createdAt")
     t.string("updatedAt")

package/server/graphql/types/comment.js

@@ -8,7 +8,6 @@ module.exports = ({ nexus }) => nexus.objectType({
     t.boolean("removed")
     t.string("approvalStatus")
     t.field("threadOf", { type: 'CommentSingle' })
-    t.field("authorUser", { type: 'CommentAuthorUser' })
     t.field("author", { type: 'CommentAuthor' })
     t.string("createdAt")
     t.string("updatedAt")

package/server/graphql/types/create-comment-author.js

@@ -1,7 +1,7 @@
 module.exports = ({ nexus }) => nexus.inputObjectType({
   name: "CreateCommentAuthor",
   definition(t) {
-    t.nonNull.string("id")
+    t.nonNull.id("id")
     t.nonNull.string("name")
     t.string("email")
     t.string("avatar")

package/server/graphql/types/identify-comment-author.js

@@ -1,6 +1,6 @@
 module.exports = ({ nexus }) => nexus.inputObjectType({
   name: "IdentifyCommentAuthor",
   definition(t) {
-    t.nonNull.string("id")
+    t.nonNull.id("id")
   }
 })

package/server/graphql/types/index.js

@@ -3,7 +3,6 @@ const typesFactories = [
 	require('./comment'),
 	require('./comment-nested'),
 	require('./comment-author'),
-	require('./comment-author-user'),
 	require('./create-comment'),
 	require('./create-comment-author'),
 	require('./update-comment'),

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/admin.js

@@ -117,19 +117,24 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
             }
         };
 
-        const entity = await strapi.db.query(getModelUid('comment')).findOne({ 
-            where: {
-                id,
-            },
+        const defaultPopulate = {
             populate: {
                 authorUser: true,
                 threadOf: {
                     populate: { 
+                        authorUser: true,
                         ...reportsPopulation
                     },
                 },
                 ...reportsPopulation,
             },
+        }
+
+        const entity = await strapi.db.query(getModelUid('comment')).findOne({ 
+            where: {
+                id,
+            },
+            ...defaultPopulate,
         });
 
         if (!entity){
@@ -159,9 +164,7 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
                     threadOf: levelThreadId,
                     related: entity.related,
                 },
-                populate: {
-                    ...reportsPopulation,
-                },
+                ...defaultPopulate,
                 startingFromId: levelThreadId,
                 isAdmin: true
             }, false);