strapi-plugin-comments 2.0.0-beta.4 → 2.0.0-rc.1

package/server/services/admin.js

@@ -1,14 +1,12 @@
 'use strict';
 
 const { getPluginService, parseParams } = require('./../utils/functions');
-const { getAssociationModel } = require('./common');
-const { first, isEmpty, isNil, uniq, get } = require('lodash');
+const { isEmpty, isNil, isNumber, parseInt } = require('lodash');
 const PluginError = require('./../utils/error');
 const {
     getModelUid,
     getRelatedGroups,
     filterOurResolvedReports,
-    convertContentTypeNameToSlug
 } = require('./utils/functions');
 const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
 
@@ -25,8 +23,14 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
     // Config
     async config() {
         const entryLabel = this.getCommonService().getConfig('entryLabel');
+        const approvalFlow = this.getCommonService().getConfig('approvalFlow');
         return {
             entryLabel,
+            approvalFlow,
+            regex: Object.keys(REGEX).reduce((prev, curr) => ({
+                ...prev,
+                [curr]: REGEX[curr].toString(),
+            }), {}),
         };
     },
 
@@ -34,10 +38,18 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
     async findAll({ related, entity, ...query }) {
         const { _q, orderBy, pageSize = 10, page = 1, filters, ...rest } = parseParams(query);
 
+        const defaultWhere = {
+            $or: [
+                { removed: false },
+                { removed: null },
+            ],
+        };
+
         let params = {
             where: !isEmpty(filters) ? {
+                ...defaultWhere,
                 ...filters,
-            } : undefined,
+            } : { ...defaultWhere },
             offset: (page - 1)*pageSize, 
             limit: pageSize,
             orderBy: orderBy || [{ createdAt: 'desc' }],
@@ -59,6 +71,7 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
                 ...params, 
                 populate: {
                     authorUser: true,
+                    threadOf: true,
                     reports: {
                         where: { 
                             resolved: false
@@ -75,19 +88,27 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
             .map(_ => filterOurResolvedReports(this.getCommonService().sanitizeCommentEntity(_)))
             .map(_ => this.getCommonService().mergeRelatedEntityTo(_, relatedEntities));
 
+        const pageCount = Math.floor(total / pageSize);
         return {
             result,
             pagination: {
                 page: page,
                 pageSize: pageSize,
-                pageCount: Math.floor(total / pageSize) + 1,
+                pageCount: total % pageSize === 0 ? pageCount : pageCount + 1,
                 total,
             },
         };
     },
 
     // Find single comment
-    async findOneAndThread(id) {
+    async findOneAndThread(id, { removed, ...query }) {
+        const defaultWhere = !removed ? {
+            $or: [
+                { removed: false },
+                { removed: null },
+            ],
+        } : {};
+        
         const reportsPopulation = {
             reports: {
                 where: { 
@@ -98,7 +119,7 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
 
         const entity = await strapi.db.query(getModelUid('comment')).findOne({ 
             where: {
-                id
+                id,
             },
             populate: {
                 authorUser: true,
@@ -116,7 +137,8 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
         }
 
         const [relatedUid, relatedStringId] = getRelatedGroups(entity.related);
-        const relatedId = parseInt(relatedStringId, 10);
+        const parsedRelatedId = parseInt(relatedStringId);
+        const relatedId = isNumber(parsedRelatedId) ? parsedRelatedId : relatedStringId;
         const relatedEntity = await strapi.db.query(relatedUid).findOne({ 
             where: { id: relatedId }
         }).then(_ => ({
@@ -132,6 +154,8 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
         const entitiesOnSameLevel = await this.getCommonService()
             .findAllInHierarchy({
                 query: {
+                    ...defaultWhere,
+                    ...query,
                     threadOf: levelThreadId,
                     related: entity.related,
                 },
@@ -141,15 +165,14 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
                 startingFromId: levelThreadId,
                 isAdmin: true
             }, false);
-
-        const selectedEntity = this.getCommonService().sanitizeCommentEntity(entity);
+        const selectedEntity = this.getCommonService().sanitizeCommentEntity({
+            ...entity,
+            threadOf: entity.threadOf || null,
+        });
         
         return {
             entity: relatedEntity,
-            selected: {
-                ...selectedEntity,
-                threadOf: selectedEntity.threadOf ? selectedEntity.threadOf : null,
-            },
+            selected: selectedEntity,
             level: entitiesOnSameLevel,
         };
     },
@@ -167,9 +190,13 @@ const { APPROVAL_STATUS, REGEX } = require('./../utils/constants')
     // Block / Unblock a comment thread
     async blockCommentThread(id, forceStatus) {
         const existingEntity = await this.getCommonService().findOne({ id });
+        const status = !isNil(forceStatus) ? forceStatus : !existingEntity.blockedThread;
         const changedEntity = await strapi.db.query(getModelUid('comment')).update({ 
             where: { id },
-            data: { blockedThread: !isNil(forceStatus) ? forceStatus : !existingEntity.blockedThread }
+            data: { 
+                blocked: status,
+                blockedThread: status,
+            },
         });
         await this.blockNestedThreads(id, changedEntity.blockedThread);
 

package/server/services/client.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const config = require('./../config');
+const config = require('../config');
 const { getPluginService } = require('./../utils/functions');
-const { isNil, isEmpty } = require('lodash');
+const { isNil, isEmpty, isNumber, parseInt } = require('lodash');
 const PluginError = require('./../utils/error');
 const {
     isEqualEntity,
@@ -26,28 +26,28 @@ module.exports = ({ strapi }) => ({
 
     // Create a comment
     async create(relation, data, user = undefined) {
-        const { content, threadOf, related } = data;
-        const singleRelationFulfilled = related && REGEX.relatedUid.test(related);
-
-        if (relation !== related) {
-            throw new PluginError(400, `Insonsistent relation uid`);
-        }
-
+        const { content, threadOf } = data;
+        const singleRelationFulfilled = relation && REGEX.relatedUid.test(relation);
+        
         if(!singleRelationFulfilled) {
             throw new PluginError(400, `Field "related" got incorrect format, use format like "api::<collection name>.<content type name>:<entity id>"`);
         }
 
-        const [ uid, relatedStringId ] = getRelatedGroups(related);
-        const relatedId = parseInt(relatedStringId, 10);
+        const [ uid, relatedStringId ] = getRelatedGroups(relation);
+        const parsedRelatedId = parseInt(relatedStringId);
+        const relatedId = isNumber(parsedRelatedId) ? parsedRelatedId : relatedStringId;
 
         const relatedEntity = await strapi.db.query(uid).findOne(relatedId);
         if (!relatedEntity) {
             throw new PluginError(400, `Relation for field "related" does not exist. Check your payload please.`);
         }
 
-        const linkToThread = !isNil(threadOf) ? !!await this.getCommonService().findOne({
+        const isApprovalFlowEnabled = this.getCommonService().getConfig('approvalFlow', []).includes(uid) ||
+            relatedEntity.requireCommentsApproval;
+
+        const linkToThread = !isNil(threadOf) ? await this.getCommonService().findOne({
             id: threadOf,
-            related,
+            related: relation,
         }) : true;
         const validContext = isValidUserContext(user);
 
@@ -87,7 +87,8 @@ module.exports = ({ strapi }) => ({
                 throw new PluginError(400, 'Object: "author" is invalid. Check your payload');
             }
 
-            if (relatedEntity.requireCommentsApproval && data.approvalStatus !== APPROVAL_STATUS.PENDING) {
+            if (isApprovalFlowEnabled && 
+                (!isNil(data.approvalStatus) && (data.approvalStatus !== APPROVAL_STATUS.PENDING))) {
                 throw new PluginError(400, 'Invalid approval status');
             }
 
@@ -95,23 +96,23 @@ module.exports = ({ strapi }) => ({
                 data: {
                     ...rest,
                     ...authorData,
-                    related,
+                    related: relation,
+                    approvalStatus: isApprovalFlowEnabled ? APPROVAL_STATUS.PENDING : null,
                 }
             });
-            return this.getCommonService().sanitizeCommentEntity(entity);
+            return this.getCommonService().sanitizeCommentEntity({
+                ...entity,
+                threadOf: !isNil(threadOf) ? linkToThread : null,
+            });
         }
         throw new PluginError(400, 'No content received');
     },
 
     // Update a comment
     async update(id, relation, data, user) {
-        const { content, related } = data;
+        const { content } = data;
 
-        const singleRelationFulfilled = related && REGEX.relatedUid.test(related)
-
-        if (relation !== related) {
-            throw new PluginError(400, `Insonsistent relation uid`);
-        }
+        const singleRelationFulfilled = relation && REGEX.relatedUid.test(relation)
 
         if(!singleRelationFulfilled) {
             throw new PluginError(400, `Field "related" got incorrect format, use format like "api::<collection name>.<content type name>:<entity id>"`);
@@ -119,7 +120,7 @@ module.exports = ({ strapi }) => ({
 
         const existingEntity = await this.getCommonService().findOne({
             id,
-            related,
+            related: relation,
         });
         const validContext = isValidUserContext(user);
 
@@ -132,6 +133,7 @@ module.exports = ({ strapi }) => ({
                 const entity = await strapi.db.query(getModelUid('comment')).update({
                     where: { id },
                     data: { content },
+                    populate: { threadOf: true },
                 });
                 return this.getCommonService().sanitizeCommentEntity(entity);
             }
@@ -144,11 +146,11 @@ module.exports = ({ strapi }) => ({
         if (!isValidUserContext(user)) {
             throw resolveUserContextError(user);
         }
-		const existingEntity = await this.getCommonService().findOne({
+		const reportAgainstEntity = await this.getCommonService().findOne({
             id, 
             related: relation,
         });
-		if (existingEntity) {
+		if (reportAgainstEntity) {
             const entity = await strapi.db.query(getModelUid('comment-report')).create({
                 data: {
                     ...payload,
@@ -157,32 +159,46 @@ module.exports = ({ strapi }) => ({
                 }
             });
 			if (entity) {
+                const response = {
+                    ...entity,
+                    related: reportAgainstEntity,
+                };
                 try {
                     await this.sendAbuseReportEmail(entity.reason, entity.content); // Could also add some info about relation
+                    return response
                 } catch (err) {
-                    return entity;
+                    return response;
                 }
             } else {
                 throw new PluginError(500, 'Report cannot be created');
             }
-            return entity;
         }
         throw new PluginError(409, 'Action on that entity is not allowed');
     },
 
-    async markAsRemoved(relationId, commentId, authorId){
+    async markAsRemoved(id, relation, authorId){
         const entity = await this.getCommonService().findOne({
-          id: commentId,
-          related: relationId,
-          $or: [{ authorUser: authorId }, { authorId }],
+            id,
+            related: relation,
+            $or: [{ authorUser: authorId }, { authorId }],
         });
-        if (!entity){
-            throw strapi.errors.notFound('Entity not exist');
+
+        if (!entity) {
+            throw new PluginError(404, 'Entity not exist');
         }
-        return strapi.db.query(getModelUid('comment'))
-          .update({ id: commentId, relatedSlug: relationId }, { removed: true })
-          .then(({ id }) => this.markAsRemovedNested(id, true))
-          .then(() => ({ id: commentId }));
+
+        const removedEntity = await strapi.db.query(getModelUid('comment'))
+          .update({
+              where: { 
+                  id, 
+                  related: relation
+                },
+                data: { removed: true },
+                populate: { threadOf: true },
+          })
+        await this.markAsRemovedNested(id, true);
+
+        return this.getCommonService().sanitizeCommentEntity(removedEntity);
     },
 
 	async sendAbuseReportEmail(reason, content) {
@@ -221,7 +237,7 @@ module.exports = ({ strapi }) => ({
 		}
 	},
 
-    markAsRemovedNested(id, status){
+    async markAsRemovedNested(id, status){
         return this.getCommonService().modifiedNestedNestedComments(id, 'removed', status);
     },
 });

package/server/services/common.js

@@ -1,14 +1,14 @@
 'use strict';
 
-const { isArray, isEmpty, uniq, get, first } = require('lodash');
+const { isArray, isNumber, isObject, first, parseInt } = require('lodash');
 // const { sanitizeEntity } = require('strapi-utils');
 const PluginError = require('./../utils/error');
 const {
-    extractMeta,
     getModelUid,
     getRelatedGroups,
     buildNestedStructure,
-    filterOurResolvedReports
+    filterOurResolvedReports,
+    buildAuthorModel,
 } = require('./utils/functions');
 
 /**
@@ -16,62 +16,17 @@ const {
  */
 
 module.exports = ({ strapi }) => ({
-    getAssociationModel(ormModel, related) {
-        const relatedAssociation = ormModel.associations.find(_ => _.alias === 'related');
-        if (relatedAssociation) {
-            return relatedAssociation.related.find(rel => rel.collectionName === related);
-        }
-        return null;
-    },
-
-    getMorphModel() {
-        const ormModel = strapi.query(getModelUid('comment'));
-        return ormModel.model.morph;
-    },
-
-    isMongoDB(){
-        return strapi.query(getModelUid('comment'))?.model?.orm === 'mongoose';
-    },
-
-    getMorphData(query) {
-        return this
-          .getMorphModel()
-          .query(function () {
-              this.where(query);
-          })
-          .fetchAll()
-          .then((entities) => entities.map(entity => entity.toJSON()));
-    },
-
-    checkEntityRelation(uid, entityId) {
-        const result = parsedRelation.some(ref => {
-            const model = strapi.query(ref);
-            return model && model.associations.length &&
-              model.associations.some(_ => _.plugin === 'comments' && _.collection === 'comment');
-        });
-        if (!result) {
-            throw new PluginError(400, 'Comment not have relation to this type content type.');
-        }
-    },
 
-    getConfig(prop) {
+    getConfig(prop, defaultValue) {
         let queryProp = prop;
         if (prop && isArray(prop)) {
             queryProp = prop.join('.');
         }
-        return strapi.config.get(`plugin.comments${ queryProp ? '.' + queryProp : ''}`);
+        return strapi.config.get(`plugin.comments${ queryProp ? '.' + queryProp : ''}`) || defaultValue;
     },
 
     // Find comments in the flat structure
-    async findAllFlat({ query, populate = {} }, isAdmin = false, relatedEntity = null) {
-        const criteria = { 
-            ...query,
-            $or: [{ removed: { $null: true } }, { removed: false }],
-        }
-
-        if (isAdmin){
-            delete criteria.$or;
-        }
+    async findAllFlat({ query = {}, populate = {} }, relatedEntity = null) {
 
         const defaultPopulate = {
             authorUser: true,
@@ -80,7 +35,7 @@ module.exports = ({ strapi }) => ({
         const entries = await strapi.db.query(getModelUid('comment'))
         .findMany({
             where: {
-                ...criteria,
+                ...query,
             },
             populate: {
                 ...defaultPopulate,
@@ -122,9 +77,8 @@ module.exports = ({ strapi }) => ({
         populate = {},
         startingFromId = null,
         dropBlockedThreads = false,
-        isAdmin = false,
     }, relatedEntity) {
-        const entities = await this.findAllFlat({ query, populate }, isAdmin, relatedEntity);
+        const entities = await this.findAllFlat({ query, populate }, relatedEntity);
         return buildNestedStructure(entities, startingFromId, 'threadOf', dropBlockedThreads, false);
     },
 
@@ -135,24 +89,38 @@ module.exports = ({ strapi }) => ({
                 where: criteria
             }, ['related', 'reports']);
         if (!entity){
-            throw strapi.errors.notFound();
+            throw new PluginError(404, 'Not found');
         }
         return filterOurResolvedReports(this.sanitizeCommentEntity(entity));
     },
 
     // Find all related entiries
     async findRelatedEntitiesFor(entities = []) {
-        return Promise.all(uniq(entities.map(_ => _.related)).map(async _ => {
-            const [relatedUid, relatedStringId] = getRelatedGroups(_);
-            const relatedId = parseInt(relatedStringId, 10);
-            const relatedEntity = await strapi.db.query(relatedUid).findOne({ 
-                where: { id: relatedId }
-            });
-            return {
-                ...relatedEntity,
-                uid: relatedUid,
-            };
-        }))
+        const data = entities.reduce((acc, cur) => {
+                const [relatedUid, relatedStringId] = getRelatedGroups(cur.related);
+                const parsedRelatedId = parseInt(relatedStringId);
+                const relatedId = isNumber(parsedRelatedId) ? parsedRelatedId : relatedStringId;
+                return {
+                    ...acc,
+                    [relatedUid]: [...(acc[relatedUid] || []), relatedId]
+                };
+            },
+            {}
+        );
+        return Promise.all(
+            Object.entries(data)
+            .map(async ([relatedUid, relatedStringIds]) => 
+                strapi.db.query(relatedUid).findMany({ 
+                    where: { id: Array.from(new Set(relatedStringIds)) } 
+                }).then(relatedEntities => relatedEntities.map(_ => 
+                    ({
+                        ..._,
+                        uid: relatedUid,
+                    })
+                ))
+            )
+        )
+        .then(result => result.flat(2));
     },
 
     // Merge related entity with comment
@@ -187,7 +155,10 @@ module.exports = ({ strapi }) => ({
     },
 
     sanitizeCommentEntity: (entity) => ({
-        ...entity,
+        ...buildAuthorModel({
+            ...entity,
+            threadOf: isObject(entity.threadOf) ? buildAuthorModel(entity.threadOf) : entity.threadOf,
+        }),
 	}),
 
     // sanitizeCommentEntity: (entity) => ({