strapi-plugin-comments 2.0.4 → 2.0.8

package/README.md

@@ -84,7 +84,7 @@ In our minimum support we're following [official Node.js releases timelines](htt
 
 **Supported Strapi versions**:
 
-- Strapi v4.0.7 (recently tested)
+- Strapi v4.1.0 (recently tested)
 - Strapi v4.x
 
 > This plugin is designed for **Strapi v4** and is not working with v3.x. To get version for **Strapi v3** install version [v1.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-comments/tree/strapi-v3).
@@ -109,6 +109,8 @@ To setup amend default plugin configuration we recommend to put following snippe
     module.exports = ({ env }) => ({
         //...
         comments: {
+          enabled: true,
+          config: {
             badWords: false,
             moderatorRoles: ["Authenticated"],
             approvalFlow: ['api::page.page'],
@@ -122,6 +124,7 @@ To setup amend default plugin configuration we recommend to put following snippe
             gql: { 
               // ...
             },
+          },
         },
         //...
     });
@@ -144,8 +147,8 @@ All you need to do is to install and enable `@strapi/plugin-graphql` for you ins
 ```json
   {
     // ...
-    gql: {
-      auth: true, // Default: false
+    "gql": {
+      "auth": true, // Default: false
     },
     // ...
   }
@@ -226,10 +229,10 @@ Return a hierarchical tree structure of comments for specified instance of Conte
 [
     {
         // -- Comment Model fields ---,
-        children: [
+        "children": [
             {
                 // -- Comment Model fields ---,
-                children: [
+                "children": [
                     // ...
                 ]
             },
@@ -255,7 +258,8 @@ Return a flat structure of comments for specified instance of Content Type like
 **Example response body**
 
 ```json
-[
+{
+  "data": [
     {
         // -- Comment Model fields ---
     },
@@ -263,7 +267,13 @@ Return a flat structure of comments for specified instance of Content Type like
         // -- Comment Model fields ---
     },
     // ...
-]
+  ],
+  "meta": {
+    "pagination": {
+      // payload based on Strapi REST Pagination specification
+    }
+  }
+}
 ```
 
 **Possible response codes**

package/__mocks__/initSetup.js

@@ -1,14 +1,32 @@
-const { get, set } = require('lodash');
+const { get, set, isEmpty } = require('lodash');
 
-module.exports = (config = {}, toStore = false) => {
-  const mock = {
-    db: toStore ? {
-      plugin: {
-        comments: {
-          config: { ...config },
-        },
+module.exports = (config = {}, toStore = false, database = {}) => {
+  const dbConfig = toStore ? {
+    plugin: {
+      comments: {
+        config: { ...config },
       },
-    }: {},
+    },
+  }: {};
+
+  let mock = {
+    db: {
+      query: (uid) => {
+        const [handler, rest] = uid.split('::');
+        const [collection] = rest.split('.');
+        const values = get(mock.db, `${handler}.${collection}.records`, []);
+        return {
+          findOne: async () => new Promise(resolve => resolve(values[0])),
+          findMany: async () => new Promise(resolve => resolve(values)),
+          findWithCount: async () => new Promise(resolve => resolve([values, values.length])),
+          count: async () => new Promise(resolve => resolve(values.length)),
+          create: async (value) => new Promise(resolve => resolve(value)), 
+          update: async (value) => new Promise(resolve => resolve(value)), 
+          delete: async (value) => new Promise(resolve => resolve(value)),
+        };
+      },
+      ...dbConfig,
+    },
     getRef: function() {
       return this;
     },
@@ -78,5 +96,13 @@ module.exports = (config = {}, toStore = false) => {
       }
     }
   };
+
+  if (!isEmpty(database)) {
+    Object.keys(database).forEach((uid) => {
+      const [handler, collection] = uid.split('::');
+      set(mock.db, `${handler}.${collection}.records`, database[uid]);
+    });
+  }
+
   return mock;
 };

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

@@ -0,0 +1,18 @@
+/**
+ *
+ * Form Switch
+ *
+ */
+
+ import React from 'react';
+ import { Stack } from '@strapi/design-system/Stack';
+ import { Typography } from '@strapi/design-system/Typography';
+import { StyledSwitch } from './styles';
+
+const FormSwitch = ({ label, hint, ...props }) => (<Stack size={1}>
+    { label && (<Typography variant="pi" as="label" fontWeight="bold" textColor="neutral800">{ label }</Typography>) }
+    <StyledSwitch label={label} { ...props } />
+    { hint && (<Typography variant="pi" as="label" textColor="neutral600">{ hint }</Typography>) }
+</Stack>);
+
+export default FormSwitch;

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

@@ -0,0 +1,8 @@
+import styled from 'styled-components';
+import { Switch } from '@strapi/design-system/Switch';
+
+export const StyledSwitch = styled(Switch)`
+    &>div>span {
+        font-size: 12px;
+    }
+`;

package/admin/src/pages/Settings/index.js

@@ -1,7 +1,7 @@
 import React, { useRef, useMemo, useState } from 'react';
 import { useQuery } from 'react-query';
 import { Formik } from 'formik';
-import { capitalize, first, orderBy, isEmpty, isEqual } from 'lodash';
+import { capitalize, first, orderBy, isEmpty, isEqual, isNil } from 'lodash';
 import {
 	CheckPermissions,
 	LoadingIndicatorPage,
@@ -12,22 +12,20 @@ import {
 	useFocusWhenNavigate,
 	useOverlayBlocker,
 } from '@strapi/helper-plugin';
+import { Accordion, AccordionToggle, AccordionContent, AccordionGroup } from '@strapi/design-system/Accordion';
 import { Main } from '@strapi/design-system/Main';
 import { ContentLayout, HeaderLayout } from '@strapi/design-system/Layout';
 import { Button } from '@strapi/design-system/Button';
 import { Box } from '@strapi/design-system/Box';
 import { Stack } from '@strapi/design-system/Stack';
+import { Switch } from '@strapi/design-system/Switch';
 import { Typography } from '@strapi/design-system/Typography';
 import { Grid, GridItem } from '@strapi/design-system/Grid';
 import { ToggleInput } from '@strapi/design-system/ToggleInput';
 import { Select, Option } from '@strapi/design-system/Select';
 import { useNotifyAT } from '@strapi/design-system/LiveRegions';
-import {
-  Card,
-  CardBody,
-  CardContent,
-} from '@strapi/design-system/Card';
-import { Check, Refresh, Play } from '@strapi/icons';
+import { Tooltip } from '@strapi/design-system/Tooltip';
+import { Check, Refresh, Play, Information } from '@strapi/icons';
 
 import pluginPermissions from '../../permissions';
 import useConfig from '../../hooks/useConfig';
@@ -35,6 +33,7 @@ import { fetchAllContentTypes, fetchRoles } from './utils/api';
 import { getMessage, parseRegExp } from '../../utils';
 import ConfirmationDialog from '../../components/ConfirmationDialog';
 import { RestartAlert } from './components/RestartAlert/styles';
+import FormSwitch from '../../components/FormSwitch';
 
 
 const Settings = () => {
@@ -58,6 +57,7 @@ const Settings = () => {
 
 	const [restoreConfigmationVisible, setRestoreConfigmationVisible] = useState(false);
 	const [restartRequired, setRestartRequired] = useState(false);
+	const [contentTypeExpanded, setContentTypeExpanded] = useState(undefined);
 
 	const { fetch, restartMutation, submitMutation, restoreMutation } = useConfig(toggleNotification);
 	const { data: configData, isLoading: isConfigLoading, err: configErr } = fetch;
@@ -109,7 +109,7 @@ const Settings = () => {
 		.filter(_ => _) || [];
 	const entryLabel = configData?.entryLabel || {};
 	const approvalFlow = configData?.approvalFlow || [];
-	const badWords = configData?.badWords || undefined;
+	const badWords = isNil(configData?.badWords) ? true : configData?.badWords;
 	const isGQLPluginEnabled = configData?.isGQLPluginEnabled;
 	const gqlAuthEnabled = configData?.gql?.auth || undefined;
 	const moderatorRoles = configData?.moderatorRoles
@@ -166,6 +166,8 @@ const Settings = () => {
 	};
 	const handleRestartDiscard = () => setRestartRequired(false);
 
+	const handleSetContentTypeExpanded = key => setContentTypeExpanded(key === contentTypeExpanded ? undefined : key);
+
 	const boxDefaultProps = {
 		background: "neutral0",
 		hasRadius: true,
@@ -201,7 +203,7 @@ const Settings = () => {
 							}
 						/>
 						<ContentLayout>
-							<Stack size={6}>
+							<Stack size={4}>
 								{ restartRequired && (
 									<RestartAlert 
 										closeLabel={getMessage('page.settings.actions.restart.alert.cancel')} 
@@ -234,6 +236,72 @@ const Settings = () => {
 														(<Option key={uid} value={uid}>{displayName}</Option>))}
 												</Select>
 											</GridItem>
+											{ !isEmpty(values.enabledCollections) && (
+											<GridItem col={12}>
+												<AccordionGroup 
+													label={getMessage('page.settings.form.contentTypesSettings.label')} 
+													labelAction={<Tooltip description={getMessage('page.settings.form.contentTypesSettings.tooltip')}>
+														<Information aria-hidden={true} />
+													</Tooltip>}>
+													{ orderBy(values.enabledCollections).map(uid => {
+														const { schema: { displayName, attributes = {} } } = allCollections.find(_ => _.uid === uid);
+														const stringAttributes = Object.keys(attributes).filter(_ => attributes[_].type === 'string');
+														const key = `collectionSettings-${uid}`;
+														return (<Accordion 
+															expanded={contentTypeExpanded === key} 
+															toggle={() => handleSetContentTypeExpanded(key)} 
+															key={key} 
+															id={key} 
+															size="S">
+															<AccordionToggle title={displayName} togglePosition="left" />
+															<AccordionContent>
+																<Box padding={6}>
+																	<Stack size={4}>
+																		<FormSwitch 
+																			name={`collectionSettings-${uid}-approvalFlow`}
+																			label={getMessage('page.settings.form.approvalFlow.label')}
+																			hint={getMessage({
+																				id: 'page.settings.form.approvalFlow.hint',
+																				props: { name: displayName },
+																			})}
+																			selected={values.approvalFlow.includes(uid)}
+																			onChange={() => setFieldValue('approvalFlow', changeApprovalFlowFor(uid, values.approvalFlow, !values.approvalFlow.includes(uid)), [])} 
+																			onLabel={getMessage('compontents.toogle.enabled')}
+																			offLabel={getMessage('compontents.toogle.disabled')}
+																			disabled={restartRequired}
+																			visibleLabels />
+																		{ !isEmpty(stringAttributes) && (<Select
+																			name={`collectionSettings-${uid}-entryLabel`}
+																			label={getMessage('page.settings.form.entryLabel.label')}
+																			placeholder={getMessage('page.settings.form.entryLabel.placeholder')}
+																			hint={getMessage('page.settings.form.entryLabel.hint')}
+																			onClear={() => setFieldValue('entryLabel', changeEntryLabelFor(uid, values.entryLabel))}
+																			value={values.entryLabel[uid] || []}
+																			onChange={(value) => setFieldValue('entryLabel', changeEntryLabelFor(uid, values.entryLabel, value))}
+																			multi
+																			withTags
+																			disabled={restartRequired}
+																		>
+																			{ stringAttributes.map(key => 
+																				(<Option key={`collectionSettings-${uid}-entryLabel-${key}`} value={key}>{ capitalize(key.split('_').join(' ')) }</Option>))}
+																		</Select>) }
+																	</Stack>
+																</Box>
+															</AccordionContent>
+														</Accordion>);
+												})}
+												</AccordionGroup>
+											</GridItem>)}
+										</Grid>
+									</Stack>
+								</Box>
+
+								<Box {...boxDefaultProps}>
+									<Stack size={4}>
+										<Typography variant="delta" as="h2">
+											{getMessage('page.settings.section.additional')}
+										</Typography>
+										<Grid gap={4}>
 											<GridItem col={6} xs={12}>
 												<Select
 													name="moderatorRoles"
@@ -278,64 +346,12 @@ const Settings = () => {
 										</Grid>
 									</Stack>
 								</Box>
-								{ !isEmpty(values.enabledCollections) && (<Box {...boxDefaultProps}>
-									<Stack size={4}>
-										<Typography variant="delta" as="h2">
-											{getMessage('page.settings.section.collections')}
-										</Typography>
-										<Grid gap={4}>
-											{ orderBy(values.enabledCollections).map(uid => {
-												const { schema: { displayName, attributes = {} } } = allCollections.find(_ => _.uid === uid);
-												const stringAttributes = Object.keys(attributes).filter(_ => attributes[_].type === 'string');
-												return (<GridItem key={`collectionSettings-${uid}`} col={6} s={12} xs={12}>
-													<Card background="primary100" borderColor="primary200">
-														<CardBody>
-															<CardContent style={{ width: '100%' }}>
-																<Stack size={4}>
-																	<Typography variant="epsilon" fontWeight="semibold" as="h3">{ displayName }</Typography>
-																	<ToggleInput
-																		name={`collectionSettings-${uid}-approvalFlow`}
-																		label={getMessage('page.settings.form.approvalFlow.label')}
-																		hind={getMessage({
-																			id: 'page.settings.form.approvalFlow.hint',
-																			params: { name: displayName },
-																		})}
-																		checked={values.approvalFlow.includes(uid)}
-																		onChange={({ target: { checked } }) => setFieldValue('approvalFlow', changeApprovalFlowFor(uid, values.approvalFlow, checked), [])}
-																		onLabel={getMessage('compontents.toogle.enabled')}
-																		offLabel={getMessage('compontents.toogle.disabled')}
-																		disabled={restartRequired}
-																	/>
-																	{ !isEmpty(stringAttributes) && (<Select
-																		name={`collectionSettings-${uid}-entryLabel`}
-																		label={getMessage('page.settings.form.entryLabel.label')}
-																		placeholder={getMessage('page.settings.form.entryLabel.placeholder')}
-																		hint={getMessage('page.settings.form.entryLabel.hint')}
-																		onClear={() => setFieldValue('entryLabel', changeEntryLabelFor(uid, values.entryLabel))}
-																		value={values.entryLabel[uid] || []}
-																		onChange={(value) => setFieldValue('entryLabel', changeEntryLabelFor(uid, values.entryLabel, value))}
-																		multi
-																		withTags
-																		disabled={restartRequired}
-																	>
-																		{ stringAttributes.map(key => 
-																			(<Option key={`collectionSettings-${uid}-entryLabel-${key}`} value={key}>{ capitalize(key.split('_').join(' ')) }</Option>))}
-																	</Select>) }
-																</Stack>
-															</CardContent>
-														</CardBody>
-													</Card>
-												</GridItem>);
-											})}
-										</Grid>
-									</Stack>
-								</Box>)}
 
 								<CheckPermissions permissions={pluginPermissions.settingsChange}>
 									<Box {...boxDefaultProps}>
 										<Stack size={4}>
 											<Stack size={2}>
-												<Typography variant="delta" textColor="danger700" as="h2">
+												<Typography variant="delta" as="h2">
 													{getMessage('page.settings.section.restore')}
 												</Typography>
 												<Typography variant="pi"as="h4">

package/admin/src/translations/en.json

@@ -85,15 +85,17 @@
     "page.settings.header.title": "Comments",
     "page.settings.header.description": "Configure your comments moderation capabilities",
     "page.settings.actions.submit": "Save",
-    "page.settings.actions.restore": "Restore",
+    "page.settings.actions.restore": "Restore default settings",
     "page.settings.actions.restart": "Restart Strapi",
     "page.settings.section.general": "General configuration",
-    "page.settings.section.collections": "Collection(s) configuration",
-    "page.settings.section.restore": "Restore default configuration",
+    "page.settings.section.additional": "Additional configuration",
+    "page.settings.section.restore": "Restore default settings",
     "page.settings.section.restore.subtitle": "Discarding all of applied settings and getting back to plugin default ones. Use reasonable.",
-    "page.settings.form.enabledCollections.label": "Enable Comments for Collection(s)",
+    "page.settings.form.enabledCollections.label": "Enable comments only for",
     "page.settings.form.enabledCollections.placeholder": "Select one or more collection",
-    "page.settings.form.enabledCollections.hint": "If none of collection is selected, feature are enabled for any of exsiting",
+    "page.settings.form.enabledCollections.hint": "If none is selected, all the content types are enabled",
+    "page.settings.form.contentTypesSettings.label": "Content types",
+    "page.settings.form.contentTypesSettings.tooltip": "Custom configuration per content type",
     "page.settings.form.moderatorRoles.label": "Send significant notifications to",
     "page.settings.form.moderatorRoles.placeholder": "Select one or more roles",
     "page.settings.form.moderatorRoles.hint": "Roles which are going to be notified by the plugin about significant actions to perform",
@@ -101,8 +103,8 @@
     "page.settings.form.badWords.hint": "If enabled, every post / update of comment is going to be checked against bad wording",
     "page.settings.form.gqlAuth.label": "GraphQL queries authorization",
     "page.settings.form.gqlAuth.hint": "If enabled, GraphQL API queries & mutations can be triggered only by Authenticated Strapi users. Otherwise API remains open.",
-    "page.settings.form.approvalFlow.label": "Enable approval flow",
-    "page.settings.form.approvalFlow.hint": "Comments for \"{name}\" are going to be taken through manual approval flow",
+    "page.settings.form.approvalFlow.label": "Approval flow",
+    "page.settings.form.approvalFlow.hint": "Comments associated with content type \"{name}\" are going to be taken through manual approval flow",
     "page.settings.form.entryLabel.label": "Title fields",
     "page.settings.form.entryLabel.placeholder": "Select at least one or leave empty to apply defaults",
     "page.settings.form.entryLabel.hint": "If left empty title rendering is going to take following ordered fields: \"Title\", \"Subject\" & \"Name\"",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "2.0.4",
+  "version": "2.0.8",
   "description": "Strapi - Comments plugin",
   "strapi": {
     "name": "comments",
@@ -18,8 +18,8 @@
     "url": "https://github.com/VirtusLab-Open-Source/strapi-plugin-comments"
   },
   "dependencies": {
-    "@strapi/utils": "^4.0.7",
-    "@strapi/plugin-graphql": "^4.0.7",
+    "@strapi/utils": "^4.1.0",
+    "@strapi/plugin-graphql": "^4.1.0",
     "bad-words": "^3.0.4"
   },
   "devDependencies": {

package/server/controllers/client.js

@@ -13,9 +13,15 @@ module.exports = {
   async findAllFlat(ctx) {
     const { params = {}, query, sort, pagination } = ctx;
     const { relation } = parseParams(params);
+
+    const { sort: querySort, pagination: queryPagination, ...filterQuery } = query || {};
+
+
+console.log(filterQuery);
+
     try {
       return this.getService('common')
-        .findAllFlat(flatInput(relation, query, sort, pagination));
+        .findAllFlat(flatInput(relation, filterQuery, sort || querySort, pagination || queryPagination));
     } catch (e) {
       throwError(ctx, e);
     }
@@ -24,10 +30,13 @@ module.exports = {
   async findAllInHierarchy(ctx) {
     const { params = {}, query, sort } = ctx;
     const { relation } = parseParams(params);
+
+    const { sort: querySort, ...filterQuery } = query || {};
+
     try {
       return await this.getService('common')
         .findAllInHierarchy({
-          ...flatInput(relation, query, sort),
+          ...flatInput(relation, filterQuery, sort || querySort),
           dropBlockedThreads: true,
         });
     } catch (e) {

package/server/controllers/utils/__tests__/parsers.test.js

@@ -0,0 +1,94 @@
+const { flatInput } = require('../parsers');
+
+jest.mock
+
+describe('Test Comments controller parsers utils', () => {
+  
+  describe('Flat Input properties', () => {
+    const relation = 'api::test.relation';
+    const filters = {
+      content: {
+        '$eq': 'Test'
+      }
+    };
+    const sort = {
+      createdAt: 'desc'
+    };
+    const pagination = {
+      page: 3,
+      pageSize: 5,
+    };
+
+    test('Should contain default property \'populate\'', () => {
+      expect(flatInput()).toHaveProperty(['populate', 'threadOf', 'populate', 'authorUser'], true);
+    });
+
+    test('Should assign relation to \'query\'', () => {
+      expect(flatInput(relation)).toHaveProperty(['query', 'related'], relation);
+    });
+
+    test('Should assign filters to \'query\'', () => {
+      const result = flatInput(relation, filters);
+      expect(result).toHaveProperty(['query', 'content', '$eq'], filters.content['$eq']);
+    });
+
+    test('Should assign not allow to overwrite \'removed\' in $or operator', () => {
+      const overwrittenOrOperator = {
+        $or: [{ removed: true }, { removed: false }, { removed: null }]
+      };
+      const result = flatInput(relation, overwrittenOrOperator);
+      expect(result).toHaveProperty(['query', '$or', 0, 'removed', '$null'], true);
+      expect(result).toHaveProperty(['query', '$or', 1, 'removed'], false);
+    });
+
+    test('Should assign sort', () => {
+      const result = flatInput(relation, filters, sort);
+      expect(result).toHaveProperty(['sort', 'createdAt'], sort.createdAt);
+    });
+
+    test('Should assign pagination', () => {
+      const result = flatInput(relation, filters, sort, pagination);
+      expect(result).toHaveProperty(['pagination', 'page'], pagination.page);
+      expect(result).toHaveProperty(['pagination', 'pageSize'], pagination.pageSize);
+    });
+
+    test('Should build complex output', () => {
+      const day = 24 * 60 * 60 * 1000;
+      const now = Date.now().toString();
+      const oneDayBefore = new Date(Date.now().valueOf() - day).toString();
+      const complexFilters = {
+        '$or': [{
+          createdAt: {
+            '$lte':  oneDayBefore
+          }
+        }, {
+          createdAt: {
+            '$eq':  now
+          }
+        }],
+        content: {
+          '$contains': 'Test'
+        }
+      };
+
+      const complexSort = [{
+        createdAt: 'desc'
+      }, {
+        title: 'asc'
+      }];
+
+      const result = flatInput(relation, complexFilters, complexSort, pagination);
+
+      expect(result).toHaveProperty(['query', 'related'], relation);
+      expect(result).toHaveProperty(['query', '$or', 0, 'createdAt', '$lte'], oneDayBefore);
+      expect(result).toHaveProperty(['query', '$or', 1, 'createdAt', '$eq'], now);
+      expect(result).toHaveProperty(['query', '$or', 2, 'removed', '$null'], true);
+      expect(result).toHaveProperty(['query', '$or', 3, 'removed'], false);
+      expect(result).toHaveProperty(['query', 'content', '$contains'], complexFilters.content['$contains']);
+      expect(result).toHaveProperty(['sort', 0, 'createdAt'], complexSort[0].createdAt);
+      expect(result).toHaveProperty(['sort', 1, 'title'], complexSort[1].title);
+      expect(result).toHaveProperty(['pagination', 'page'], pagination.page);
+      expect(result).toHaveProperty(['pagination', 'pageSize'], pagination.pageSize);
+    });
+  });
+});

package/server/controllers/utils/parsers.js

@@ -2,20 +2,22 @@
 
 module.exports = {
     flatInput(relation, query, sort, pagination) {
-        return {
-            query: {
-              ...query,
-              $or: [{ removed: { $null: true } }, { removed: false }],
-              related: relation,
+      const filters = query?.filters || query;
+      const orOperator = (filters?.$or || []).filter(_ => !Object.keys(_).includes('removed'));
+      return {
+          query: {
+            ...filters,
+            $or: [...orOperator, { removed: { $null: true } }, { removed: false }],
+            related: relation,
+          },
+          populate: {
+            threadOf: {
+              populate: { authorUser: true },
             },
-            populate: {
-              threadOf: {
-                populate: { authorUser: true },
-              },
-            },
-            pagination,
-            sort,
-          };
+          },
+          pagination,
+          sort,
+        };
     },
   
 };

package/server/graphql/queries/findAllFlat.js

@@ -10,7 +10,7 @@ module.exports = ({ strapi, nexus }) => {
 	const { args } = getService('internals');
 
 	return {
-		type: nonNull(list('CommentSingle')),
+		type: 'ResponseFindAll',
 		args: {
 			relation: nonNull(stringArg()),
 			filters: getPluginService('gql').buildContentTypeFilters(contentType),

package/server/graphql/types/index.js

@@ -11,6 +11,9 @@ const typesFactories = [
 	require('./report'),
 	require('./report-reason'),
 	require('./create-report'),
+	require('./response-pagination'),
+	require('./response-meta'),
+	require('./response-find-all'),
 ];
 
 module.exports = context => typesFactories.map(factory => factory(context));

package/server/graphql/types/response-find-all.js

@@ -0,0 +1,7 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "ResponseFindAll",
+  definition(t) {
+    t.list.field("data", { type: 'CommentSingle' })
+    t.field("meta", { type: 'ResponseMeta' })
+  }
+})

package/server/graphql/types/response-meta.js

@@ -0,0 +1,6 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "ResponseMeta",
+  definition(t) {
+    t.field("pagination", { type: 'ResponsePagination' })
+  }
+})

package/server/graphql/types/response-pagination.js

@@ -0,0 +1,11 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "ResponsePagination",
+  definition(t) {
+    t.int('page')
+    t.int('pageSize')
+    t.int('pageCount')
+    t.int('total')
+    t.int('start')
+    t.int('limit')
+  }
+})

package/server/services/__tests__/common.test.js

@@ -5,9 +5,9 @@ const { getPluginService } = require('../../utils/functions');
 jest.mock
 
 
-const setup = function(config) {
+const setup = function(config, toStore, database) {
   Object.defineProperty(global, 'strapi', {
-    value: require('../../../__mocks__/initSetup')(config),
+    value: require('../../../__mocks__/initSetup')(config, toStore, database),
     writable: true,
   });
 }
@@ -242,5 +242,158 @@ describe('Test Comments service functions utils', () => {
         }
       });
     });
+
+    describe('Merge related entity', () => {
+      beforeEach(() => setup({ enabledCollections: [uid] }));
+      const collection = 'api::collection.test';
+      const related = `${collection}:1`;
+      const comment = {
+        id: 1,
+        content: 'ABC',
+        threadOf: null,
+        related,
+        authorId: 1,
+        authorName: 'Joe Doe',
+        authorEmail: 'joe@example.com'
+      };
+      const relatedEntity = { id: 1, title: 'Test', uid: collection};
+
+      
+      test('Should merge related entity', async () => {
+        const result = await getPluginService('common').mergeRelatedEntityTo(comment, [relatedEntity]);
+        expect(result).toHaveProperty('id', 1);
+        expect(result).not.toHaveProperty('related', related);
+        expect(result).toHaveProperty(['related', 'title'], relatedEntity.title);
+      });
+    });
+
+    describe('Client API', () => {
+      const collection = 'api::collection.test';
+      const related = `${collection}:1`;
+      const db = [{
+        id: 1,
+        content: 'ABC',
+        threadOf: null,
+        related,
+        authorId: 1,
+        authorName: 'Joe Doe',
+        authorEmail: 'joe@example.com'
+      }, {
+        id: 2,
+        content: 'DEF',
+        threadOf: 1,
+        related,
+        authorId: 1,
+        authorName: 'Joe Doe',
+        authorEmail: 'joe@example.com',
+        blockedThread: true,
+      }, {
+        id: 3,
+        content: 'GHJ',
+        threadOf: null,
+        related,
+        authorId: 1,
+        authorName: 'Joe Doe',
+        authorEmail: 'joe@example.com'
+      }, {
+        id: 4,
+        content: 'IKL',
+        threadOf: 2,
+        related,
+        authorId: 1,
+        authorName: 'Joe Doe',
+        authorEmail: 'joe@example.com',
+      }];
+      const relatedEntity = { id: 1, title: 'Test', uid: collection};
+
+      beforeEach(() => setup({ enabledCollections: [collection] }, true, {
+        'plugins::comments': db,
+        'api::collection': [relatedEntity, { id: 2, title: 'Test 2', uid: collection }],
+      }));
+
+      describe('findAllFlat', () => {
+        test('Should return proper structure', async () => {
+          const result = await getPluginService('common').findAllFlat({ query: { related }}, relatedEntity);
+          expect(result).toHaveProperty('data');
+          expect(result).not.toHaveProperty('meta');
+          expect(result.data.length).toBe(4);
+          expect(result).toHaveProperty(['data', 0, 'content'], db[0].content);
+          expect(result).toHaveProperty(['data', 3, 'content'], db[3].content);
+        });
+  
+        test('Should return structure with pagination', async () => {
+          const result = await getPluginService('common').findAllFlat({ query: { related }, pagination: { page: 1, pageSize: 5 }}, relatedEntity);
+          expect(result).toHaveProperty('data');
+          expect(result).toHaveProperty('meta');
+          expect(result.data.length).toBe(4);
+          expect(result).toHaveProperty(['data', 0, 'content'], db[0].content);
+          expect(result).toHaveProperty(['data', 0, 'author']);
+          expect(result).toHaveProperty(['data', 0, 'author', 'id'], db[0].authorId);
+          expect(result).toHaveProperty(['data', 0, 'author', 'name'], db[0].authorName);
+          expect(result).toHaveProperty(['data', 0, 'author', 'email'], db[0].authorEmail);
+          expect(result).toHaveProperty(['data', 3, 'content'], db[3].content);
+          expect(result).toHaveProperty(['meta', 'pagination', 'page'], 1);
+          expect(result).toHaveProperty(['meta', 'pagination', 'pageSize'], 5);
+        });
+      });
+
+      describe('findAllInHierarchy', () => {
+        test('Should return nested structure starting for root', async () => {
+          const result = await getPluginService('common').findAllInHierarchy({ query: { related }}, relatedEntity);
+          expect(result).not.toHaveProperty('data');
+          expect(result).not.toHaveProperty('meta');
+          expect(result.length).toBe(2);
+          expect(result).toHaveProperty([0, 'content'], db[0].content);
+          expect(result).toHaveProperty([0, 'children']);
+          expect(result[0].children.length).toBe(1);
+          expect(result).toHaveProperty([0, 'children', 0, 'content'], 'DEF');
+          expect(result).toHaveProperty([0, 'children', 0, 'children']);
+          expect(result[0].children[0].children.length).toBe(1);
+          expect(result).toHaveProperty([0, 'children', 0, 'children', 0, 'content'], 'IKL');
+          expect(result).toHaveProperty([1, 'content'], db[2].content);
+        });
+
+        test('Should return nested structure starting for comment id: 1', async () => {
+          const result = await getPluginService('common').findAllInHierarchy({ query: { related }, startingFromId: 1}, relatedEntity);
+          expect(result).not.toHaveProperty('data');
+          expect(result).not.toHaveProperty('meta');
+          expect(result.length).toBe(1);
+          expect(result).toHaveProperty([0, 'content'], db[1].content);
+          expect(result).toHaveProperty([0, 'children']);
+          expect(result[0].children.length).toBe(1);
+          expect(result).toHaveProperty([0, 'children', 0, 'content'], 'IKL');
+        });
+
+        test('Should return nested structure starting for comment id: 1 without blocked comments', async () => {
+          const result = await getPluginService('common').findAllInHierarchy({ query: { related }, startingFromId: 1, dropBlockedThreads: true}, relatedEntity);
+          expect(result).not.toHaveProperty('data');
+          expect(result).not.toHaveProperty('meta');
+          expect(result.length).toBe(1);
+          expect(result).toHaveProperty([0, 'content'], db[1].content);
+          expect(result).toHaveProperty([0, 'children']);
+          expect(result[0].children.length).toBe(0);
+        });
+      });
+
+      describe('findOne', () => {
+        test('Should return proper structure', async () => {
+          const result = await getPluginService('common').findOne({ related });
+          expect(result).toHaveProperty('id', db[0].id);
+          expect(result).toHaveProperty('content', db[0].content);
+          expect(result).toHaveProperty(['author', 'id'], db[0].authorId);
+          expect(result).toHaveProperty(['author', 'name'], db[0].authorName);
+          expect(result).toHaveProperty(['author', 'email'], db[0].authorEmail);
+        });
+      });
+
+      describe('findRelatedEntitiesFor', () => {
+        test('Should return proper structure', async () => {
+          const result = await getPluginService('common').findRelatedEntitiesFor(db);
+          expect(result).toHaveProperty([0, 'id'], relatedEntity.id);
+          expect(result).toHaveProperty([0, 'title'], relatedEntity.title);
+          expect(result).toHaveProperty([0, 'uid'], relatedEntity.uid);
+        });
+      });
+    });
   });
 });

package/server/services/common.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const BadWordsFilter = require('bad-words');
-const { isArray, isNumber, isObject, isNil, isString, first, parseInt, set, get } = require('lodash');
+const { isArray, isNumber, isObject, isNil, isString, isEmpty, first, parseInt, set, get } = require('lodash');
 const { REGEX, CONFIG_PARAMS } = require('../utils/constants');
 const PluginError = require('./../utils/error');
 const {
@@ -68,12 +68,35 @@ module.exports = ({ strapi }) => ({
             };
         }
 
+        let meta = {};
         if (pagination && isObject(pagination)) {
-            const { page = 1, pageSize = 10 } = pagination;
+            const parsedPagination = Object.keys(pagination).reduce((prev, curr) => ({
+                ...prev,
+                [curr]: parseInt(pagination[curr]),
+            }), {});
+            const { page, pageSize = 10, limit, start = 0 } = parsedPagination
+            const paginationByPage = !isNil(page);
+
             queryExtension = {
                 ...queryExtension,
-                offset: (page - 1) * pageSize,
-                limit: pageSize,
+                offset: paginationByPage ? (page - 1) * pageSize : start,
+                limit: paginationByPage ? pageSize : limit,
+            };
+
+            const metaPagination = paginationByPage ? {
+                pagination: {
+                    page,
+                    pageSize,
+                },
+            } : {
+                pagination: {
+                    start,
+                    limit,
+                },
+            };
+
+            meta = {
+                ...metaPagination,
             };
         }
         
@@ -89,6 +112,26 @@ module.exports = ({ strapi }) => ({
             ...queryExtension,
         });
 
+        if (pagination?.withCount && (pagination.withCount === 'true' || pagination.withCount === true)) {
+            const total = await strapi.db.query(getModelUid('comment'))
+                .count({
+                    where: {
+                        ...query,
+                    }
+                });
+            const pageCount = Math.floor(total / meta.pagination.pageSize);
+            meta = {
+                ...meta,
+                pagination: {
+                    ...meta.pagination,
+                    pageCount: !isNil(meta.pagination.page) ? 
+                        total % meta.pagination.pageSize === 0 ? pageCount : pageCount + 1 : 
+                        undefined,
+                    total,
+                },
+            };
+        }
+
         const entriesWithThreads = await Promise.all(entries.map(async _ => {
             const [nestedEntries, count] = await strapi.db.query(getModelUid('comment'))
                 .findWithCount({ 
@@ -100,6 +143,8 @@ module.exports = ({ strapi }) => ({
         }));
 
         const relatedEntities = relatedEntity !== null ? [relatedEntity] : await this.findRelatedEntitiesFor([...entries]);
+        const hasRelatedEntitiesToMap = relatedEntities.filter(_ => _).length > 0;
+
         const result = entries
             .map(_ => {
                 const threadedItem = entriesWithThreads.find(item => item.id === _.id);
@@ -111,10 +156,12 @@ module.exports = ({ strapi }) => ({
                 });
             });
 
-        if (relatedEntities.filter(_ => _).length > 0) {
-            return result.map(_ => this.mergeRelatedEntityTo(_, relatedEntities));
-        }
-        return result;    
+        return {
+            data: hasRelatedEntitiesToMap ?
+                result.map(_ => this.mergeRelatedEntityTo(_, relatedEntities)) :
+                result,
+            ...(isEmpty(meta) ? {} : { meta }),
+        };   
     },
 
     // Find comments and create relations tree structure
@@ -126,7 +173,7 @@ module.exports = ({ strapi }) => ({
         dropBlockedThreads = false,
     }, relatedEntity) {
         const entities = await this.findAllFlat({ query, populate, sort }, relatedEntity);
-        return buildNestedStructure(entities, startingFromId, 'threadOf', dropBlockedThreads, false);
+        return buildNestedStructure(entities?.data, startingFromId, 'threadOf', dropBlockedThreads, false);
     },
 
     // Find single comment