strapi-plugin-comments 2.0.0-rc.2 → 2.0.3

package/server/services/common.js

@@ -1,7 +1,8 @@
 'use strict';
 
-const { isArray, isNumber, isObject, isNil, first, parseInt } = require('lodash');
-// const { sanitizeEntity } = require('strapi-utils');
+const BadWordsFilter = require('bad-words');
+const { isArray, isNumber, isObject, isNil, isString, first, parseInt, set, get } = require('lodash');
+const { REGEX, CONFIG_PARAMS } = require('../utils/constants');
 const PluginError = require('./../utils/error');
 const {
     getModelUid,
@@ -9,6 +10,7 @@ const {
     buildNestedStructure,
     filterOurResolvedReports,
     buildAuthorModel,
+    buildConfigQueryProp,
 } = require('./utils/functions');
 
 /**
@@ -17,21 +19,64 @@ const {
 
 module.exports = ({ strapi }) => ({
 
-    getConfig(prop, defaultValue) {
-        let queryProp = prop;
-        if (prop && isArray(prop)) {
-            queryProp = prop.join('.');
+    async getConfig(prop, defaultValue, useLocal = false) {
+        const queryProp = buildConfigQueryProp(prop);
+        const pluginStore = await this.getPluginStore();
+        const config = await pluginStore.get({ key: 'config' });
+
+        let result;
+        if (config && !useLocal) {
+            result = queryProp ? get(config, queryProp) : config;;
+        } else {
+            result = this.getLocalConfig(queryProp, defaultValue);
         }
-        return strapi.config.get(`plugin.comments${ queryProp ? '.' + queryProp : ''}`) || defaultValue;
+        return isNil(result) ? defaultValue : result;
+    },
+
+    async getPluginStore() {
+        return strapi.store({ type: 'plugin', name: 'comments' });
+    },
+
+    getLocalConfig(prop, defaultValue) {
+        const queryProp = buildConfigQueryProp(prop);
+        const result = strapi.config.get(`plugin.comments${ queryProp ? '.' + queryProp : ''}`);
+        return isNil(result) ? defaultValue : result;
     },
 
     // Find comments in the flat structure
-    async findAllFlat({ query = {}, populate = {} }, relatedEntity = null) {
+    async findAllFlat({ 
+        query = {}, 
+        populate = {}, 
+        sort, 
+        pagination }, relatedEntity = null) {
 
         const defaultPopulate = {
             authorUser: true,
         };
 
+        let queryExtension = {};
+
+        if (sort && (isString(sort) || isArray(sort))) {
+            queryExtension = {
+                ...queryExtension,
+                orderBy: (isString(sort) ? [sort] : sort)
+                .map(_ => REGEX.sorting.test(_) ? _ : `${_}:asc`)
+                .reduce((prev, curr) => {
+                    const [type = 'asc', ...parts] = curr.split(':').reverse();
+                    return { ...set(prev, parts.reverse().join('.'), type) };
+                }, {})
+            };
+        }
+
+        if (pagination && isObject(pagination)) {
+            const { page = 1, pageSize = 10 } = pagination;
+            queryExtension = {
+                ...queryExtension,
+                offset: (page - 1) * pageSize,
+                limit: pageSize,
+            };
+        }
+        
         const entries = await strapi.db.query(getModelUid('comment'))
         .findMany({
             where: {
@@ -41,6 +86,7 @@ module.exports = ({ strapi }) => ({
                 ...defaultPopulate,
                 ...populate,
             },
+            ...queryExtension,
         });
 
         const entriesWithThreads = await Promise.all(entries.map(async _ => {
@@ -75,10 +121,11 @@ module.exports = ({ strapi }) => ({
     async findAllInHierarchy ({
         query,
         populate = {},
+        sort,
         startingFromId = null,
         dropBlockedThreads = false,
     }, relatedEntity) {
-        const entities = await this.findAllFlat({ query, populate }, relatedEntity);
+        const entities = await this.findAllFlat({ query, populate, sort }, relatedEntity);
         return buildNestedStructure(entities, startingFromId, 'threadOf', dropBlockedThreads, false);
     },
 
@@ -93,7 +140,7 @@ module.exports = ({ strapi }) => ({
                 },
             });
         if (!entity){
-            throw new PluginError(404, 'Not found');
+            throw new PluginError(404, 'Comment does not exist. Check your payload please.');
         }
         return filterOurResolvedReports(this.sanitizeCommentEntity(entity));
     },
@@ -115,7 +162,7 @@ module.exports = ({ strapi }) => ({
             Object.entries(data)
             .map(async ([relatedUid, relatedStringIds]) => 
                 strapi.db.query(relatedUid).findMany({ 
-                    where: { id: Array.from(new Set(relatedStringIds)) } 
+                    where: { id: Array.from(new Set(relatedStringIds)) },
                 }).then(relatedEntities => relatedEntities.map(_ => 
                     ({
                         ..._,
@@ -170,4 +217,32 @@ module.exports = ({ strapi }) => ({
     isValidUserContext(user) {
         return user ? !isNil(user?.id) : true;
     },
+
+    async parseRelationString(relation) {
+        const [ uid, relatedStringId ] = getRelatedGroups(relation);
+        const parsedRelatedId = parseInt(relatedStringId);
+        const relatedId = isNumber(parsedRelatedId) ? parsedRelatedId : relatedStringId;
+
+        const enabledCollections = await this.getConfig(CONFIG_PARAMS.ENABLED_COLLECTIONS, []);
+        if (!enabledCollections.includes(uid)) {
+            throw new PluginError(403, `Action not allowed for collection '${uid}'. Use one of: ${ enabledCollections.join(', ') }`);
+        }
+        return [ uid, relatedId];
+    },
+
+    async checkBadWords(content) {
+        const config = await this.getConfig(CONFIG_PARAMS.BAD_WORDS, 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, buildConfigQueryProp } = 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';
+describe('Test service functions utils', () => {
 
-    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', '****'),
-          }
-        }));
-      }
+  describe('Getting models uid\'s ', () => {
+    test('Should get comments uid', () => {
+      expect(getModelUid('comment')).toBe('plugins::comments.comment');
     });
 
-    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('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);
-    });
-
-    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');
     });
   });
 
@@ -103,4 +39,15 @@ describe('Test Comments service functions utils', () => {
       }
     });
   });
+
+  describe('Building config query props', () => {
+    test('Should return prop as is', () => {
+      expect(buildConfigQueryProp('my.sample.prop')).toBe('my.sample.prop');
+    });
+
+    test('Should build query prop with \'.\'', () => {
+      expect(buildConfigQueryProp(['my', 'sample', 'prop'])).toBe('my.sample.prop');
+    });
+  });
+  
 });

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, isEmpty } = require('lodash');
+const { first, isObject, isArray, isEmpty } = require('lodash');
 
 const buildNestedStructure = (
   entities,
@@ -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;
@@ -109,6 +93,14 @@ module.exports = {
         };
     },
 
+    buildConfigQueryProp(prop) {
+        let queryProp = prop;
+        if (prop && isArray(prop)) {
+            queryProp = prop.join('.');
+        }
+        return queryProp;
+    },
+
     resolveUserContextError: user => {
         if (user) {
             throw new PluginError(401, 'Not authenticated');

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

@@ -1,3 +1,11 @@
+const CONFIG_PARAMS = {
+  ENABLED_COLLECTIONS: 'enabledCollections',
+  APPROVAL_FLOW: 'approvalFlow',
+  ENTRY_LABEL: 'entryLabel',
+  MODERATOR_ROLES: 'moderatorRoles',
+  BAD_WORDS: 'badWords',
+};
+
 const APPROVAL_STATUS = {
   PENDING: "PENDING",
   APPROVED: "APPROVED",
@@ -8,9 +16,11 @@ 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 = {
+  CONFIG_PARAMS,
   APPROVAL_STATUS,
   REGEX,
 };

package/strapi-server.js

@@ -4,7 +4,7 @@ const { isArray, isEmpty, isString } = require('lodash');
 
 const server = require('./server');
 const contentTypes = require('./content-types');
-const { REGEX } = require('./server/utils/constants');
+const { REGEX, CONFIG_PARAMS } = require('./server/utils/constants');
 
 module.exports = () => ({
     ...server,
@@ -15,24 +15,31 @@ module.exports = () => ({
         ...server.config.default,
       }),
       validator: (config) => { 
+        // Check enabledCollections values
+        const enabledCollectionsValid = config[CONFIG_PARAMS.ENABLED_COLLECTIONS]
+          .filter(_ => !REGEX.uid.test(_)).length === 0;
+        if (!enabledCollectionsValid) {
+          throw new Error(`'enabledCollections' must contain Content Types identifiers in the format like 'api::<collection name>.<content type name>'`);
+        }
+
         // Check moderatorRoles values
-        const moderatorRolesValid = config.moderatorRoles
+        const moderatorRolesValid = config[CONFIG_PARAMS.MODERATOR_ROLES]
           .filter(_ => !isString(_)).length === 0;
         if (!moderatorRolesValid) {
           throw new Error(`'moderatorRoles' must roles keys`);
         }
 
         // Check approvalFlow values
-        const approvalFlowValid = config.approvalFlow
+        const approvalFlowValid = config[CONFIG_PARAMS.APPROVAL_FLOW]
           .filter(_ => !REGEX.uid.test(_)).length === 0;
         if (!approvalFlowValid) {
           throw new Error(`'approvalFlow' must contain Content Types identifiers in the format like 'api::<collection name>.<content type name>'`);
         }
 
         // Check entryLabel keys and values
-        const entryLabelKeysValid = Object.keys(config.entryLabel)
+        const entryLabelKeysValid = Object.keys(config[CONFIG_PARAMS.ENTRY_LABEL])
           .filter(_ => _ !== '*')
-          .filter(_ => !(REGEX.uid.test(_) && isArray(config.entryLabel[_]) && !isEmpty(config.entryLabel[_]))).length === 0;
+          .filter(_ => !(REGEX.uid.test(_) && isArray(config[CONFIG_PARAMS.ENTRY_LABEL][_]) && !isEmpty(config[CONFIG_PARAMS.ENTRY_LABEL][_]))).length === 0;
 
         if (!entryLabelKeysValid) {
           throw new Error(`'entryLabel' must contain records in the format like 'api::<collection name>.<content type name>': ['Field1', 'field_2']`);

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