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

package/server/services/graphql.js

@@ -0,0 +1,190 @@
+'use strict';
+
+const { has, propEq, isNil, isDate, isObject } = require('lodash/fp');
+const { inputObjectType } = require('nexus');
+
+const virtualScalarAttributes = ['id'];
+
+module.exports = ({ strapi }) => {
+  const { service: getService } = strapi.plugin('graphql');
+
+  const rootLevelOperators = () => {
+    const { operators } = strapi.plugin('graphql').service('builders').filters;
+
+    return [operators.and, operators.or, operators.not];
+  };
+
+  const buildContentTypeFilters = contentType => {
+    const utils = strapi.plugin('graphql').service('utils');
+    const extension = strapi.plugin('graphql').service('extension');
+
+    const { getFiltersInputTypeName, getScalarFilterInputTypeName } = utils.naming;
+    const { isStrapiScalar, isRelation } = utils.attributes;
+
+    const { attributes } = contentType;
+
+    const filtersTypeName = getFiltersInputTypeName(contentType);
+
+    return inputObjectType({
+      name: filtersTypeName,
+
+      definition(t) {
+        const validAttributes = Object.entries(attributes).filter(([attributeName]) =>
+          extension
+            .shadowCRUD(contentType.uid)
+            .field(attributeName)
+            .hasFiltersEnabeld()
+        );
+
+        const isIDFilterEnabled = extension
+          .shadowCRUD(contentType.uid)
+          .field('id')
+          .hasFiltersEnabeld();
+        // Add an ID filter to the collection types
+        if (contentType.kind === 'collectionType' && isIDFilterEnabled) {
+          t.field('id', { type: getScalarFilterInputTypeName('ID') });
+        }
+
+        // Add every defined attribute
+        for (const [attributeName, attribute] of validAttributes) {
+          // Handle scalars
+          if (isStrapiScalar(attribute)) {
+            addScalarAttribute(t, attributeName, attribute);
+          }
+
+          // Handle relations
+          else if (isRelation(attribute)) {
+            addRelationalAttribute(t, attributeName, attribute);
+          }
+        }
+
+        // Conditional clauses
+        for (const operator of rootLevelOperators()) {
+          operator.add(t, filtersTypeName);
+        }
+      },
+    });
+  };
+
+  const addScalarAttribute = (builder, attributeName, attribute) => {
+    const { naming, mappers } = strapi.plugin('graphql').service('utils');
+
+    const gqlType = mappers.strapiScalarToGraphQLScalar(attribute.type);
+
+    builder.field(attributeName, { type: naming.getScalarFilterInputTypeName(gqlType) });
+  };
+
+  const addRelationalAttribute = (builder, attributeName, attribute) => {
+    const utils = strapi.plugin('graphql').service('utils');
+    const extension = strapi.plugin('graphql').service('extension');
+    const { getFiltersInputTypeName } = utils.naming;
+    const { isMorphRelation } = utils.attributes;
+
+    const model = strapi.getModel(attribute.target);
+
+    // If there is no model corresponding to the attribute configuration
+    // or if the attribute is a polymorphic relation, then ignore it
+    if (!model || isMorphRelation(attribute)) return;
+
+    // If the target model is disabled, then ignore it too
+    if (extension.shadowCRUD(model.uid).isDisabled()) return;
+
+    builder.field(attributeName, { type: getFiltersInputTypeName(model) });
+  };
+
+  const recursivelyReplaceScalarOperators = data => {
+    const { operators } = getService('builders').filters;
+
+    if (Array.isArray(data)) {
+      return data.map(recursivelyReplaceScalarOperators);
+    }
+
+    // Note: We need to make an exception for date since GraphQL
+    // automatically cast date strings to date instances in args
+    if (isDate(data) || !isObject(data)) {
+      return data;
+    }
+
+    const result = {};
+
+    for (const [key, value] of Object.entries(data)) {
+      const isOperator = !!operators[key];
+
+      const newKey = isOperator ? operators[key].strapiOperator : key;
+
+      result[newKey] = recursivelyReplaceScalarOperators(value);
+    }
+
+    return result;
+  };
+
+  const graphQLFiltersToStrapiQuery = (filters, contentType = {}) => {
+    const { isStrapiScalar, isMedia, isRelation } = getService('utils').attributes;
+    const { operators } = getService('builders').filters;
+
+    const ROOT_LEVEL_OPERATORS = [operators.and, operators.or, operators.not];
+
+    // Handle unwanted scenario where there is no filters defined
+    if (isNil(filters)) {
+      return {};
+    }
+
+    // If filters is a collection, then apply the transformation to every item of the list
+    if (Array.isArray(filters)) {
+      return filters.map(filtersItem =>
+        graphQLFiltersToStrapiQuery(filtersItem, contentType)
+      );
+    }
+
+    const resultMap = {};
+    const { attributes } = contentType;
+
+    const isAttribute = attributeName => {
+      return virtualScalarAttributes.includes(attributeName) || has(attributeName, attributes);
+    };
+
+    for (const [key, value] of Object.entries(filters)) {
+      // If the key is an attribute, update the value
+      if (isAttribute(key)) {
+        const attribute = attributes[key];
+
+        // If it's a scalar attribute
+        if (virtualScalarAttributes.includes(key) || isStrapiScalar(attribute)) {
+          // Replace (recursively) every GraphQL scalar operator with the associated Strapi operator
+          resultMap[key] = recursivelyReplaceScalarOperators(value);
+        }
+
+        // If it's a deep filter on a relation
+        else if (isRelation(attribute) || isMedia(attribute)) {
+          // Fetch the model from the relation
+          const relModel = strapi.getModel(attribute.target);
+
+          // Recursively apply the mapping to the value using the fetched model,
+          // and update the value within `resultMap`
+          resultMap[key] = graphQLFiltersToStrapiQuery(value, relModel);
+        }
+      }
+
+      // Handle the case where the key is not an attribute (operator, ...)
+      else {
+        const rootLevelOperator = ROOT_LEVEL_OPERATORS.find(propEq('fieldName', key));
+
+        // If it's a root level operator (AND, NOT, OR, ...)
+        if (rootLevelOperator) {
+          const { strapiOperator } = rootLevelOperator;
+
+          // Transform the current value recursively and add it to the resultMap
+          // object using the strapiOperator equivalent of the GraphQL key
+          resultMap[strapiOperator] = graphQLFiltersToStrapiQuery(value, contentType);
+        }
+      }
+    }
+
+    return resultMap;
+  };
+
+  return {
+    buildContentTypeFilters,
+    graphQLFiltersToStrapiQuery,
+  };
+};

package/server/services/index.js

@@ -3,9 +3,11 @@
 const adminServices = require('./admin');
 const clientServices = require('./client');
 const commonServices = require('./common');
+const graphQLService = require('./graphql');
 
 module.exports = {
   admin: adminServices,
   client: clientServices,
   common: commonServices,
+  gql: graphQLService,
 };

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,12 +1,11 @@
-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,
   id = null,
-  field = 'parent',
+  field = 'threadOf',
   dropBlockedThreads = false,
   blockNestedThreads = false,
 ) =>
@@ -33,7 +32,7 @@ const buildNestedStructure = (
 
 module.exports = {
     isEqualEntity: (existing, data, user) => {
-        const { authorUser, authorId } = existing;
+        const { author: existingAuthor } = existing;
         const { author } = data;
 
         // Disallow approval status change by Client
@@ -42,12 +41,12 @@ 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 authorId === author?.id;
+        return existingAuthor.id === author?.id;
     },
 
     getRelatedGroups: related => related.split(REGEX.relatedUid).filter(s => s && s.length > 0),
@@ -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,9 +69,28 @@ 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;
+        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: isEmpty(author) ? undefined : author,
+        };
     },
 
     resolveUserContextError: user => {

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,31 +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 { Typography } from '@strapi/design-system/Typography';
-
-const DiscussionThreadItemMeta = ({ authorName, authorEmail, createdAt, updatedAt }) => {
-
-    const { formatDate } = useIntl();
-
-    const dateTime = formatDate(updatedAt || createdAt, { dateStyle: 'short', timeStyle: 'short' });
-
-    return (<Flex as={Box} paddingTop={2} direction="row" justifyContent="space-between">
-        <Typography variant="pi" fontWeight="bold">{ authorName }</Typography>
-        <Typography variant="pi">{ dateTime }</Typography>
-    </Flex>);
-};
-
-DiscussionThreadItemMeta.propTypes = {
-
-};
-
-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;
-`;