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

package/server/services/client.js

@@ -8,8 +8,6 @@ const {
     isEqualEntity,
     getModelUid,
     getRelatedGroups,
-    checkBadWords,
-    isValidUserContext,
     resolveUserContextError,
 } = require('./utils/functions');
 const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
@@ -49,7 +47,7 @@ module.exports = ({ strapi }) => ({
             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');
@@ -59,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)) {
@@ -83,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 && 
@@ -98,7 +92,10 @@ module.exports = ({ strapi }) => ({
                     ...authorData,
                     related: relation,
                     approvalStatus: isApprovalFlowEnabled ? APPROVAL_STATUS.PENDING : null,
-                }
+                },
+                populate: {
+                    authorUser: true,
+                },
             });
             return this.getCommonService().sanitizeCommentEntity({
                 ...entity,
@@ -109,41 +106,42 @@ module.exports = ({ strapi }) => ({
     },
 
     // Update a comment
-    async update(id, relation, data, user) {
+    async update(id, relation, data, user = undefined) {
         const { content } = data;
 
         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: 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 },
+                    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 reportAgainstEntity = await this.getCommonService().findOne({
@@ -173,18 +171,34 @@ module.exports = ({ strapi }) => ({
                 throw new PluginError(500, 'Report cannot be created');
             }
         }
-        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(id, relation, authorId){
-        const entity = await this.getCommonService().findOne({
-            id,
-            related: relation,
-            $or: [{ authorUser: authorId }, { authorId }],
-        });
+    async markAsRemoved(id, relation, authorId, user = undefined){
+        if (!this.getCommonService().isValidUserContext(user)) {
+            throw resolveUserContextError(user);
+        }
+
+        const author = user?.id || authorId;
 
-        if (!entity) {
-            throw new PluginError(404, 'Entity not exist');
+        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.`);
+        }
+
+        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'))
@@ -194,7 +208,7 @@ module.exports = ({ strapi }) => ({
                   related: relation
                 },
                 data: { removed: true },
-                populate: { threadOf: true },
+                populate: { threadOf: true, authorUser: true },
           })
         await this.markAsRemovedNested(id, true);
 

package/server/services/common.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const { isArray, isNumber, isObject, first, parseInt } = 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,
@@ -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
@@ -86,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');
         }
@@ -154,15 +159,32 @@ module.exports = ({ strapi }) => ({
         }
     },
 
-    sanitizeCommentEntity: (entity) => ({
-        ...buildAuthorModel({
-            ...entity,
-            threadOf: isObject(entity.threadOf) ? buildAuthorModel(entity.threadOf) : entity.threadOf,
-        }),
-	}),
-
-    // sanitizeCommentEntity: (entity) => ({
-    //     ...entity,
-    //     authorUser: sanitizeEntity(entity.authorUser, { model: strapi.plugins['users-permissions'].models.user }),
-	// }),
+    sanitizeCommentEntity(entity) {
+        return {
+            ...buildAuthorModel({
+                ...entity,
+                threadOf: isObject(entity.threadOf) ? buildAuthorModel(entity.threadOf) : entity.threadOf,
+            }),
+        };
+    },
+
+    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, isNil } = require('lodash');
+const { first, isObject, isEmpty } = require('lodash');
 
 const buildNestedStructure = (
   entities,
@@ -33,7 +32,7 @@ const buildNestedStructure = (
 
 module.exports = {
     isEqualEntity: (existing, data, user) => {
-        const { authorUser, author: existingAuthor } = existing;
+        const { author: existingAuthor } = existing;
         const { author } = data;
 
         // Disallow approval status change by Client
@@ -42,10 +41,10 @@ module.exports = {
         }
 
         // Make sure that author is exact the same
-        if (authorUser) {
-            const existingUserId = authorUser?.id || authorUser;
-            const receivedUserId = user?.id || author;
-            return existingUserId === receivedUserId;
+        if (user) {
+            const existingUserId = existingAuthor?.id || existingAuthor;
+            const receivedUserId = user?.id || author?.id;
+            return receivedUserId && (existingUserId === receivedUserId);
         }
         return existingAuthor.id === author?.id;
     },
@@ -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;
@@ -85,22 +69,27 @@ module.exports = {
 
     buildNestedStructure,
 
-    isValidUserContext: (user = {}) => {
-		const builtInContextEnabled = get(strapi.config, 'plugins.comments.enableUsers', false);
-        return builtInContextEnabled ? !isNil(user.id) : true;
-    },
-
     buildAuthorModel: (item) => {
         const { authorUser, authorId, authorName, authorEmail, authorAvatar, ...rest } = item;
-        const author = authorUser || {
-            id: authorId,
-            name: authorName,
-            email: authorEmail,
-            avatar: authorAvatar,
-        };
+        let author = {};
+        if (authorUser) {
+            author = {
+                id: authorUser.id,
+                name: authorUser.username,
+                email: authorUser.email,
+                avatar: authorUser.avatar,
+            };
+        } else if(authorId) {
+            author = {
+                id: authorId,
+                name: authorName,
+                email: authorEmail,
+                avatar: authorAvatar,
+            };
+        }
         return {
             ...rest,
-            author,
+            author: isEmpty(author) ? undefined : author,
         };
     },
 

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;
- 

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

@@ -1,147 +0,0 @@
-/**
- *
- * Entity Details
- *
- */
-
-import React, { useState } from 'react';
-import PropTypes from 'prop-types';
-import { useMutation, useQueryClient } from 'react-query';
-import { isEmpty, orderBy } from 'lodash';
-import { Badge } from '@strapi/design-system/Badge';
-import { Box } from '@strapi/design-system/Box';
-import { Button } from '@strapi/design-system/Button';
-import { Divider } from '@strapi/design-system/Divider';
-import { Flex } from '@strapi/design-system/Flex';
-import { Typography } from '@strapi/design-system/Typography';
-import { useNotification, useOverlayBlocker } from '@strapi/helper-plugin';
-import { getMessage, handleAPIError } from '../../utils';
-import { blockItem, blockItemThread, resolveReport } from '../../pages/utils/api';
-import { DiscussionThreadItemWarningsWrapper } from './styles';
-import ReportsReviewModal from '../ReportsReviewModal';
-import ReportsReviewTable from '../ReportsReviewTable';
-import pluginId from '../../pluginId';
-import { LockIcon, ReviewIcon } from '../icons';
-
-const DiscussionThreadItemWarnings = (item) => {
-    const { id, reports, gotThread, allowedActions: { canModerate, canAccessReports, canReviewReports }} = item;
-
-    const [reportsReviewVisible, setReportsReviewVisible] = useState(false);
-    const [blockButtonsDisabled, setBlockButtonsDisabled] = useState(false);
-
-    const toggleNotification = useNotification();
-    const queryClient = useQueryClient();
-    const { lockApp, unlockApp } = useOverlayBlocker();
-
-    const onSuccess = (message, stateAction = () => {}, indalidate = true) => async () => {
-        if (indalidate) {
-            await queryClient.invalidateQueries('get-details-data');
-        }
-        toggleNotification({
-            type: 'success',
-            message: `${pluginId}.${message}`,
-        });
-        stateAction(false);
-        unlockApp();
-    };
-
-    const onError = err => { handleAPIError(err, toggleNotification); };
-
-    const resolveReportMutation = useMutation(resolveReport, {
-        onSuccess: onSuccess('page.details.panel.discussion.warnings.reports.dialog.confirmation.success', () => {}, false),
-        onError,
-        refetchActive: false,
-    });
-
-    const blockItemMutation = useMutation(blockItem, {
-        onSuccess: onSuccess(
-            'page.details.actions.comment.block.confirmation.success', 
-            setReportsReviewVisible
-        ),
-        onError,
-        refetchActive: false,
-    });
-    const blockItemThreadMutation = useMutation(blockItemThread, {
-        onSuccess: onSuccess(
-            'page.details.actions.thread.block.confirmation.success', 
-            setReportsReviewVisible
-        ),
-        onError,
-        refetchActive: false,
-    });
-
-    const handleReportsReviewClick = () => setReportsReviewVisible(true);
-    const handleBlockItemClick = async () => {
-        lockApp();
-        blockItemMutation.mutate(id);
-    };
-    const handleBlockItemThreadClick = async () => {
-        lockApp();
-        blockItemThreadMutation.mutate(id);
-    };
-    const handleReportsReviewClose = async () => {
-        await queryClient.invalidateQueries('get-details-data')
-        setReportsReviewVisible(false);
-    };
-
-    const handleBlockButtonsStateChange = disabled => setBlockButtonsDisabled(disabled);
-
-    const isLoading = blockItemMutation.isLoading || blockItemThreadMutation.isLoading || resolveReportMutation.isLoading;
-    const openReports = reports?.filter(_ => !_.resolved);
-
-    if (isEmpty(reports) || isEmpty(openReports)) {
-        return null;
-    }
-
-    return (<>
-        { canAccessReports && (<DiscussionThreadItemWarningsWrapper as={Flex} direction="row" padding={2} background="danger100" borderColor="danger200" border={1} hasRadius>
-            <Box as={Flex} paddingRight={2} direction="row" grow={1}>
-                <Badge textColor="neutral0" backgroundColor="warning600">{ openReports.length }</Badge>
-                <Box paddingLeft={2}>
-                    <Typography textColor="warning600" fontWeight="bold">{getMessage(`page.details.panel.discussion.warnings.reports.description`, 'abuse reports')}</Typography>
-                </Box>
-            </Box>
-            <Button onClick={handleReportsReviewClick} variant="ghost" endIcon={<ReviewIcon />}>
-                { getMessage(`page.details.actions.comment.report.review`, 'review') }
-            </Button>
-        </DiscussionThreadItemWarningsWrapper>) }
-        { (canAccessReports || canReviewReports) && (<ReportsReviewModal 
-            isVisible={reportsReviewVisible}
-            isActionAsync={isLoading}
-            onClose={handleReportsReviewClose}
-            startActions={canModerate && (<>
-                <Button onClick={handleBlockItemClick} variant="danger-light" startIcon={<LockIcon />} disabled={blockButtonsDisabled}>
-                    { getMessage(`page.details.actions.comment.block`, 'Block comment') }
-                </Button>
-                { gotThread && (<Button onClick={handleBlockItemThreadClick} variant="danger" startIcon={<LockIcon />} disabled={blockButtonsDisabled}>
-                    { getMessage(`page.details.actions.thread.block`, 'Block thread') }
-                </Button>) }
-            </>)}
-            item={item}>
-                <Typography variant="sigma" textColor="neutral600" id="reports-list">
-                    { getMessage('page.details.panel.discussion.warnings.reports.list', 'List') }
-                </Typography>
-                <Box paddingTop={2} paddingBottom={6}>
-                    <Divider />
-                </Box>
-                <ReportsReviewTable
-                    commentId={id} 
-                    items={orderBy(reports, ['resolved', 'createdAt'], ['DESC', 'DESC'])} 
-                    mutation={resolveReportMutation}
-                    allowedActions={{ canAccessReports, canReviewReports }}
-                    onBlockButtonsStateChange={handleBlockButtonsStateChange}
-                />
-        </ReportsReviewModal>) }
-    </>);
-};
-
-DiscussionThreadItemWarnings.propTypes = {
-    allowedActions: PropTypes.shape({
-        canModerate: PropTypes.bool,
-        canAccessReports: PropTypes.bool,
-        canReviewReports: PropTypes.bool,
-    }),
-};
-
-export default DiscussionThreadItemWarnings;
- 

package/admin/src/components/DiscussionThreadItemWarnings/styles.js

@@ -1,7 +0,0 @@
-import styled from 'styled-components';
-import { Box } from '@strapi/design-system/Box';
-
-export const DiscussionThreadItemWarningsWrapper = styled(Box)`
-    width: 100%;
-    margin-top: .5rem;
-`;

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

@@ -1,9 +0,0 @@
-module.exports = ({ nexus }) => nexus.objectType({
-  name: "CommentAuthorUser",
-  definition(t) {
-    t.id("id")
-    t.nonNull.string("firstName")
-    t.string("lastName")
-    t.string("email")
-  }
-})