feat: use middleware instead of db hooks to remove comments (#339)

* feat: use middleware instead of db hooks to remove comments

* chore: use correct lockfile

* feat: filter uid without api prefix

Author: mateusz-kleszcz

admin/src/components/CommentStatusFilters/index.tsx

@@ -17,11 +17,14 @@ const getFilter = (filterName: string | undefined) => {
   switch (filterName) {
     case COMMENT_STATUS.BLOCKED:
       return {
-        $or: [{ blocked: { $eq: true } }, { blockedThread: { $eq: true } }],
+        $or: [
+          { blocked: true },
+          { blockedThread: true },
+        ],
       };
     case COMMENT_STATUS.REMOVED:
       return {
-        $or: [{ blocked: { $eq: true } }, { blockedThread: { $eq: true } }],
+        removed: true,
       };
     case COMMENT_STATUS.OPEN:
       return {
@@ -31,9 +34,9 @@ const getFilter = (filterName: string | undefined) => {
       return {};
     default:
       return {
-        approvalStatus: { $eq: filterName },
+        approvalStatus: filterName,
       };
-  }
+  };
 };
 
 export const CommentsStatusFilters = () => {

server/src/bootstrap.ts

@@ -1,7 +1,6 @@
 import { StrapiContext } from './@types';
 import { setupGQL } from './graphql';
 import permissions from './permissions';
-import { getPluginService } from './utils/getPluginService';
 
 export default async ({ strapi }: StrapiContext) => {
   if (strapi.plugin('graphql')) {
@@ -54,20 +53,4 @@ export default async ({ strapi }: StrapiContext) => {
   ];
 
   await strapi.admin.services.permission.actionProvider.registerMany(actions);
-
-  const commonService = getPluginService(strapi, 'common');
-  strapi.db.lifecycles.subscribe({
-    afterDelete: async (event) => {
-      const uid = event.model.uid;
-      const { documentId, locale } = event.result;
-      const relation = [uid, documentId].join(':');
-      await commonService.perRemove(relation, locale);
-    },
-    afterCreate: async (event) => {
-      const uid = event.model.uid;
-      const { documentId, locale } = event.result;
-      const relation = [uid, documentId].join(':');
-      await commonService.perRestore(relation, locale);
-    }
-  });
 };

server/src/register/index.ts

@@ -1,9 +1,19 @@
 import { StrapiContext } from '../@types';
 import { registerCustomFields } from './custom-fields';
+import { getPluginService } from '../utils/getPluginService';
 
 const register = (context: StrapiContext) => {
   registerCustomFields(context);
-};
 
+  const commonService = getPluginService(context.strapi, 'common');
+  context.strapi.documents.use(async (ctx, next) => {
+    if (ctx.action === 'delete' && ctx.uid.startsWith('api::')) {
+      const { params: { locale, documentId }, uid } = ctx;
+      const relation = [uid, documentId].join(":");
+      await commonService.perRemove(relation, locale);
+    }
+    return next();
+  });
+};
 
-export default register;
+export default register;

server/src/services/__tests__/common.service.test.ts

@@ -605,23 +605,5 @@ describe('common.service', () => {
       expect(result).toEqual({ count: 2});
       expect(mockCommentRepository.updateMany).toHaveBeenCalled();
     });
-
-    it('should resolve comments from deleted if related entry is restore', async () => {
-      const strapi = getStrapi();
-      const service = getService(strapi);
-      const mockComments = [
-        { id: 1, related: 'api::test.test:1', locale: 'en' },
-        { id: 1, related: 'api::test.test:1', locale: 'en' }
-      ];
-      const mockRelatedEntities = { uid: 'api::test.test', documentId: '1', locale: 'en', title: 'Test Title 1' };
-
-      mockCommentRepository.findMany.mockResolvedValue(mockComments)
-      mockCommentRepository.updateMany.mockResolvedValue({ count: 2 });
-
-      const result = await service.perRestore([mockRelatedEntities.uid, mockRelatedEntities.documentId].join(':'));
-
-      expect(result).toEqual({ count: 2});
-      expect(mockCommentRepository.updateMany).toHaveBeenCalled();
-    });
   });
 });

server/src/services/common.service.ts

@@ -367,21 +367,6 @@ const commonService = ({ strapi }: StrapiContext) => ({
     });
   },
 
-  async perRestore(related: string, locale?: string) {
-    const defaultLocale = await strapi.plugin('i18n')?.service('locales').getDefaultLocale() || null;
-    return getCommentRepository(strapi)
-    .updateMany({
-      where: {
-        related,
-        $or: [{ locale }, defaultLocale === locale ? { locale: { $eq: null } } : null].filter(Boolean)
-      },
-      data: {
-        removed: false,
-      }
-    });
-  },
-
-
   registerLifecycleHook(/*{ callback, contentTypeName, hookName }*/) {
   },