strapi-plugin-comments 2.0.0-beta.6 → 2.0.0

package/server/graphql/types/report.js

@@ -0,0 +1,11 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "Report",
+  definition(t) {
+    t.id("id")
+    t.nonNull.string("content")
+    t.field("reason", { type: 'ReportReason' })
+    t.field("related", { type: 'CommentSingle' })
+    t.string("createdAt")
+    t.string("updatedAt")
+  }
+})

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

@@ -0,0 +1,9 @@
+module.exports = ({ nexus }) => nexus.inputObjectType({
+  name: "UpdateComment",
+  definition(t) {
+    t.id("id")
+    t.nonNull.string("content")
+    t.nonNull.string("relation")
+    t.field("author", { type: 'IdentifyCommentAuthor' })
+  }
+})

package/server/register.js

@@ -1,5 +1,7 @@
 'use strict';
 
 module.exports = ({ strapi }) => {
-  // registeration phase
+  if (strapi.plugin('graphql')) {
+    require('./graphql')({ strapi });
+  }
 };

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

@@ -1,7 +1,7 @@
 'use strict';
 
 const { getPluginService, parseParams } = require('./../utils/functions');
-const { isEmpty, isNil } = require('lodash');
+const { isEmpty, isNil, isNumber, parseInt } = require('lodash');
 const PluginError = require('./../utils/error');
 const {
     getModelUid,
@@ -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){
@@ -137,7 +142,8 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
         }
 
         const [relatedUid, relatedStringId] = getRelatedGroups(entity.related);
-        const relatedId = parseInt(relatedStringId, 10);
+        const parsedRelatedId = parseInt(relatedStringId);
+        const relatedId = isNumber(parsedRelatedId) ? parsedRelatedId : relatedStringId;
         const relatedEntity = await strapi.db.query(relatedUid).findOne({ 
             where: { id: relatedId }
         }).then(_ => ({
@@ -158,21 +164,18 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
                     threadOf: levelThreadId,
                     related: entity.related,
                 },
-                populate: {
-                    ...reportsPopulation,
-                },
+                ...defaultPopulate,
                 startingFromId: levelThreadId,
                 isAdmin: true
             }, false);
-
-        const selectedEntity = this.getCommonService().sanitizeCommentEntity(entity);
+        const selectedEntity = this.getCommonService().sanitizeCommentEntity({
+            ...entity,
+            threadOf: entity.threadOf || null,
+        });
         
         return {
             entity: relatedEntity,
-            selected: {
-                ...selectedEntity,
-                threadOf: selectedEntity.threadOf ? selectedEntity.threadOf : null,
-            },
+            selected: selectedEntity,
             level: entitiesOnSameLevel,
         };
     },

package/server/services/client.js

@@ -2,14 +2,12 @@
 
 const config = require('../config');
 const { getPluginService } = require('./../utils/functions');
-const { isNil, isEmpty } = require('lodash');
+const { isNil, isEmpty, isNumber, parseInt } = require('lodash');
 const PluginError = require('./../utils/error');
 const {
     isEqualEntity,
     getModelUid,
     getRelatedGroups,
-    checkBadWords,
-    isValidUserContext,
     resolveUserContextError,
 } = require('./utils/functions');
 const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
@@ -34,7 +32,8 @@ module.exports = ({ strapi }) => ({
         }
 
         const [ uid, relatedStringId ] = getRelatedGroups(relation);
-        const relatedId = parseInt(relatedStringId, 10);
+        const parsedRelatedId = parseInt(relatedStringId);
+        const relatedId = isNumber(parsedRelatedId) ? parsedRelatedId : relatedStringId;
 
         const relatedEntity = await strapi.db.query(uid).findOne(relatedId);
         if (!relatedEntity) {
@@ -44,11 +43,11 @@ module.exports = ({ strapi }) => ({
         const isApprovalFlowEnabled = this.getCommonService().getConfig('approvalFlow', []).includes(uid) ||
             relatedEntity.requireCommentsApproval;
 
-        const linkToThread = !isNil(threadOf) ? !!await this.getCommonService().findOne({
+        const linkToThread = !isNil(threadOf) ? await this.getCommonService().findOne({
             id: threadOf,
             related: relation,
         }) : true;
-        const validContext = isValidUserContext(user);
+        const validContext = this.getCommonService().isValidUserContext(user);
 
         if (!linkToThread) {
             throw new PluginError(400, 'Thread does not exist');
@@ -58,16 +57,12 @@ module.exports = ({ strapi }) => ({
             throw resolveUserContextError(user);
         }
 
-        if (checkBadWords(content) && singleRelationFulfilled) {
-            const { author, authorUser, ...rest } = data;
+        if (this.getCommonService().checkBadWords(content) && singleRelationFulfilled) {
+            const { author = {}, ...rest } = data;
             let authorData = {};
             if (validContext && user) {
                 authorData = {
-                    authorUser: user?.id || authorUser,
-                };
-            } else if (authorUser) {
-                authorData = {
-                    authorUser,
+                    authorUser: user?.id,
                 };
             } else {
                 if (author.email && !REGEX.email.test(author.email)) {
@@ -82,8 +77,8 @@ module.exports = ({ strapi }) => ({
                 };
             }
             
-            if (!isEmpty(authorData) && !authorData.authorId) {
-                throw new PluginError(400, 'Object: "author" is invalid. Check your payload');
+            if (!isEmpty(authorData) && !(authorData.authorId || authorData.authorUser)) {
+                throw new PluginError(400, `Not able to recognise author of a comment. Make sure you've provided "author" property in a payload or authenticated your request properly.`);
             }
 
             if (isApprovalFlowEnabled && 
@@ -97,59 +92,63 @@ module.exports = ({ strapi }) => ({
                     ...authorData,
                     related: relation,
                     approvalStatus: isApprovalFlowEnabled ? APPROVAL_STATUS.PENDING : null,
-                }
+                },
+                populate: {
+                    authorUser: true,
+                },
+            });
+            return this.getCommonService().sanitizeCommentEntity({
+                ...entity,
+                threadOf: !isNil(threadOf) ? linkToThread : null,
             });
-            return this.getCommonService().sanitizeCommentEntity(entity);
         }
         throw new PluginError(400, 'No content received');
     },
 
     // Update a comment
-    async update(id, relation, data, user) {
-        const { content, related } = data;
+    async update(id, relation, data, user = undefined) {
+        const { content } = data;
 
-        const singleRelationFulfilled = related && REGEX.relatedUid.test(related)
-
-        if (relation !== related) {
-            throw new PluginError(400, `Insonsistent relation uid`);
-        }
+        const singleRelationFulfilled = relation && REGEX.relatedUid.test(relation)
 
         if(!singleRelationFulfilled) {
-            throw new PluginError(400, `Field "related" got incorrect format, use format like "api::<collection name>.<content type name>:<entity id>"`);
+            throw new PluginError(400, `Request property "relation" got incorrect format, use format like "api::<collection name>.<content type name>:<entity id>"`);
         }
 
         const existingEntity = await this.getCommonService().findOne({
             id,
-            related,
+            related: relation,
         });
-        const validContext = isValidUserContext(user);
+
+        const validContext = this.getCommonService().isValidUserContext(user);
 
         if (!validContext) {
             throw resolveUserContextError(user);
         }
 
         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 },
+                    populate: { threadOf: true, authorUser: true },
                 });
                 return this.getCommonService().sanitizeCommentEntity(entity);
             }
         }
-        throw new PluginError(409, 'Action on that entity is not allowed');
+        throw new PluginError(403, `You're not allowed to take an action on that entity. Make sure you've provided "author" property in a payload or authenticated your request properly.`);
     },
 
     // Report abuse in comment
-	async reportAbuse(id, relation, payload, user) {
-        if (!isValidUserContext(user)) {
+	async reportAbuse(id, relation, payload, user = undefined) {
+        if (!this.getCommonService().isValidUserContext(user)) {
             throw resolveUserContextError(user);
         }
-		const existingEntity = await this.getCommonService().findOne({
+		const reportAgainstEntity = await this.getCommonService().findOne({
             id, 
             related: relation,
         });
-		if (existingEntity) {
+		if (reportAgainstEntity) {
             const entity = await strapi.db.query(getModelUid('comment-report')).create({
                 data: {
                     ...payload,
@@ -158,39 +157,62 @@ module.exports = ({ strapi }) => ({
                 }
             });
 			if (entity) {
+                const response = {
+                    ...entity,
+                    related: reportAgainstEntity,
+                };
                 try {
                     await this.sendAbuseReportEmail(entity.reason, entity.content); // Could also add some info about relation
+                    return response
                 } catch (err) {
-                    return entity;
+                    return response;
                 }
             } else {
                 throw new PluginError(500, 'Report cannot be created');
             }
-            return entity;
         }
-        throw new PluginError(409, 'Action on that entity is not allowed');
+        throw new PluginError(403, `You're not allowed to take an action on that entity. Make sure that comment exist or you've authenticated your request properly.`);
     },
 
-    async markAsRemoved(relationId, commentId, authorId){
-        const entity = await this.getCommonService().findOne({
-          id: commentId,
-          related: relationId,
-          $or: [{ authorUser: authorId }, { authorId }],
-        });
-        if (!entity){
-            throw new PluginError(404, 'Entity not exist');
+    async markAsRemoved(id, relation, authorId, user = undefined){
+        if (!this.getCommonService().isValidUserContext(user)) {
+            throw resolveUserContextError(user);
+        }
+
+        const author = user?.id || authorId;
+
+        if (!author) {
+            throw new PluginError(403, `You're not allowed to take an action on that entity. Make sure that you've provided proper "authorId" or authenticated your request properly.`);
         }
 
-        return strapi.db.query(getModelUid('comment'))
+        let entity;
+        try {
+            const byAuthor = user?.id ? {
+                authorUser: author
+            } : {
+                authorId: author
+            }
+            entity = await this.getCommonService().findOne({
+                id,
+                related: relation,
+                ...byAuthor,
+            });
+        } catch(e) {
+            throw new PluginError(404, `Entity does not exist or you're not allowed to take an action on it`);
+        }
+
+        const removedEntity = await strapi.db.query(getModelUid('comment'))
           .update({
               where: { 
-                  id: commentId, 
-                  related: relationId
+                  id, 
+                  related: relation
                 },
-                data: { removed: true }
+                data: { removed: true },
+                populate: { threadOf: true, authorUser: true },
           })
-          .then(({ id }) => this.markAsRemovedNested(id, true))
-          .then(() => ({ id: commentId }));
+        await this.markAsRemovedNested(id, true);
+
+        return this.getCommonService().sanitizeCommentEntity(removedEntity);
     },
 
 	async sendAbuseReportEmail(reason, content) {
@@ -229,7 +251,7 @@ module.exports = ({ strapi }) => ({
 		}
 	},
 
-    markAsRemovedNested(id, status){
+    async markAsRemovedNested(id, status){
         return this.getCommonService().modifiedNestedNestedComments(id, 'removed', status);
     },
 });

package/server/services/common.js

@@ -1,13 +1,14 @@
 'use strict';
 
-const { isArray, uniq, first } = require('lodash');
-// const { sanitizeEntity } = require('strapi-utils');
+const BadWordsFilter = require('bad-words');
+const { isArray, isNumber, isObject, isNil, first, parseInt } = require('lodash');
 const PluginError = require('./../utils/error');
 const {
     getModelUid,
     getRelatedGroups,
     buildNestedStructure,
-    filterOurResolvedReports
+    filterOurResolvedReports,
+    buildAuthorModel,
 } = require('./utils/functions');
 
 /**
@@ -21,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
@@ -85,8 +87,12 @@ module.exports = ({ strapi }) => ({
     async findOne(criteria) {
         const entity = await strapi.db.query(getModelUid('comment'))
             .findOne({
-                where: criteria
-            }, ['related', 'reports']);
+                where: criteria,
+                populate: {
+                    reports: true,
+                    authorUser: true,
+                },
+            });
         if (!entity){
             throw new PluginError(404, 'Not found');
         }
@@ -97,9 +103,11 @@ module.exports = ({ strapi }) => ({
     async findRelatedEntitiesFor(entities = []) {
         const data = entities.reduce((acc, cur) => {
                 const [relatedUid, relatedStringId] = getRelatedGroups(cur.related);
+                const parsedRelatedId = parseInt(relatedStringId);
+                const relatedId = isNumber(parsedRelatedId) ? parsedRelatedId : relatedStringId;
                 return {
                     ...acc,
-                    [relatedUid]: [...(acc[relatedUid] || []), parseInt(relatedStringId, 10)]
+                    [relatedUid]: [...(acc[relatedUid] || []), relatedId]
                 };
             },
             {}
@@ -151,12 +159,32 @@ module.exports = ({ strapi }) => ({
         }
     },
 
-    sanitizeCommentEntity: (entity) => ({
-        ...entity,
-	}),
+    sanitizeCommentEntity(entity) {
+        return {
+            ...buildAuthorModel({
+                ...entity,
+                threadOf: isObject(entity.threadOf) ? buildAuthorModel(entity.threadOf) : entity.threadOf,
+            }),
+        };
+    },
+
+    isValidUserContext(user) {
+        return user ? !isNil(user?.id) : true;
+    },
 
-    // sanitizeCommentEntity: (entity) => ({
-    //     ...entity,
-    //     authorUser: sanitizeEntity(entity.authorUser, { model: strapi.plugins['users-permissions'].models.user }),
-	// }),
+    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;
+    },
 });