strapi-plugin-comments 2.0.0-rc.1 → 2.0.2

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/server/utils/constants.js

@@ -8,6 +8,7 @@ const REGEX = {
   uid: /^(?<type>[a-z0-9-]+)\:{2}(?<api>[a-z0-9-]+)\.{1}(?<contentType>[a-z0-9-]+)$/i,
   relatedUid: /^(?<uid>[a-z0-9-]+\:{2}[a-z0-9-]+\.[a-z0-9-]+)\:{1}(?<id>[a-z0-9-]+)$/i,
   email: /\S+@\S+\.\S+/,
+  sorting: /^(?<path>[a-z0-9-_\:\.]+)\:+(asc|desc)$/i
 };
 
 module.exports = {

package/.circleci/config.yml

@@ -1,48 +0,0 @@
-version: 2.1
-orbs:
-  codecov: codecov/codecov@1.1.1
-jobs:
-  build-and-test:
-    environment:
-      CODECOV_TOKEN: 02e2d4e8-88c4-4e5d-99da-a9a2888634c6
-    docker:
-      - image: circleci/node:12.13.0
-    working_directory: ~/repo
-    steps:
-      - checkout
-      - run:
-          name: set GIT name and email
-          command: |
-            git config --global -l
-            git config --global user.email "$GIT_COMMITTER_EMAIL"
-            git config --global user.name "$GIT_COMMITTER_NAME"
-            git config --global -l
-      - restore_cache:
-          keys:
-            # when lock file changes, use increasingly general patterns to restore cache
-            - strapi-plugin-comments-v2-{{ checksum "yarn.lock" }}
-            - strapi-plugin-comments-
-      - run:
-          name: Echo versions
-          command: |
-            node --version
-            yarn --version
-      - run:
-          name: Install
-          command: |
-            yarn install
-      - run:
-          name: Test
-          command: |
-            yarn test:unit
-      - codecov/upload:
-          flags: unittest
-          file:
-      - save_cache:
-          paths:
-            - ./node_modules
-          key: strapi-plugin-comments-v2-{{ checksum "yarn.lock" }}
-workflows:
-    build-and-test:
-      jobs:
-        - build-and-test

package/.eslintrc

@@ -1,35 +0,0 @@
-{
-  "parserOptions": {
-    "jsx": true,
-    "useJSXTextNode": true,
-    "sourceType": "module"
-  },
-  "plugins": ["react-hooks", "import"],
-  "rules": {
-    "no-console": "warn",
-    "curly": "warn",
-    "prefer-template": "warn",
-
-    "react-hooks/rules-of-hooks": "error",
-    "react-hooks/exhaustive-deps": "error",
-
-    "import/no-default-export": "warn",
-    "import/newline-after-import": "warn",
-    "import/order": [
-      "warn",
-      {
-        "newlines-between": "always",
-        "alphabetize": { "order": "asc" },
-        "pathGroupsExcludedImportTypes": ["builtin"],
-        "groups": [
-          "builtin",
-          "external",
-          "internal",
-          "parent",
-          "sibling",
-          "index"
-        ]
-      }
-    ]
-  }
-}

package/.github/pull_request_template.md

@@ -1,13 +0,0 @@
-## Ticket
-
-https://github.com/VirtusLab/strapi-plugin-comments/issues/-<your-ticket-#>
-
-## Summary
-
-What does this PR do/solve? 
-
-> PRs should be as small as they need to be, if this section starts becoming a novel you should _seriously_ consider breaking it up into multiple PRs
-
-## Test Plan
-
-How are you testing the work you're submitting?

package/.nvmrc

@@ -1 +0,0 @@
-v14.17.3

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/codecov.yml

@@ -1,4 +0,0 @@
-comment:
-  branches:
-    - master
-    - feat/strapi-v4

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")
-  }
-})