feat: implement cascading deletion utility for child resources

Author: kulikp1

adminforth/modules/configValidator.ts

@@ -30,6 +30,7 @@ import {
 import AdminForth from "adminforth";
 import { AdminForthConfigMenuItem } from "adminforth";
 import { afLogger } from "./logger.js";
+import {cascadeChildrenDelete} from './utils.js'
 import AdminForthRestAPI from './restApi.js';
 
 export default class ConfigValidator implements IConfigValidator {
@@ -282,9 +283,9 @@ export default class ConfigValidator implements IConfigValidator {
               return;
             }
 
-            const restApi = new AdminForthRestAPI (this.adminforth) 
-            await restApi.deleteWithCascade(res as AdminForthResource, recordId, { adminUser, response});
-
+            await connector.deleteRecord({ resource: res as AdminForthResource, recordId });
+            await cascadeChildrenDelete(res as AdminForthResource, recordId, { adminUser, response}, this.adminforth);
+            
             await Promise.all(
               (res.hooks.delete.afterSave).map(
                 async (hook) => {

adminforth/modules/restApi.ts

@@ -15,6 +15,8 @@ import {
   Filters,
 } from "../types/Back.js";
 
+import {cascadeChildrenDelete} from './utils.js'
+
 import { afLogger } from "./logger.js";
 
 import { ADMINFORTH_VERSION, listify, md5hash, getLoginPromptHTML } from './utils.js';
@@ -152,47 +154,6 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
       }
     }
   }
-  async deleteWithCascade(resource: AdminForthResource, primaryKey: string, context: {adminUser: any, response: any}): Promise<{ error: string | null }> {
-    const { adminUser, response } = context;
-
-    const record = await this.adminforth.connectors[resource.dataSource].getRecordByPrimaryKey(resource, primaryKey);
-
-    if (!record){ 
-      return {error: `Record with id ${primaryKey} not found`};
-    }
-
-    const childResources = this.adminforth.config.resources.filter(r =>r.columns.some(c => c.foreignResource?.resourceId === resource.resourceId));
-
-    for (const childRes of childResources) {
-      const foreignColumn = childRes.columns.find(c => c.foreignResource?.resourceId === resource.resourceId);
-
-      if (!foreignColumn?.foreignResource?.onDelete) continue;
-
-      const strategy = foreignColumn.foreignResource.onDelete;
-
-      const childRecords = await this.adminforth.resource(childRes.resourceId).list(Filters.EQ(foreignColumn.name, primaryKey));
-
-      const childPk = childRes.columns.find(c => c.primaryKey)?.name;
-      if (!childPk) continue;
-
-      if (strategy === 'cascade') {
-        for (const childRecord of childRecords) {
-          const childResult = await this.deleteWithCascade(childRes, childRecord[childPk], context);
-          if (childResult?.error) {
-            return childResult;
-          }
-        }
-      }
-
-      if (strategy === 'setNull') {
-        for (const childRecord of childRecords) {
-          await this.adminforth.resource(childRes.resourceId).update(childRecord[childPk], {[foreignColumn.name]: null});
-        }
-      }
-    }
-    const deleteResult = await this.adminforth.deleteResourceRecord({resource, record, adminUser, recordId: primaryKey, response});
-    return { error: deleteResult.error};
-  }
 
   registerEndpoints(server: IHttpServer) {
     server.endpoint({
@@ -1522,7 +1483,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
               return { error };
             }
 
-            const { error: cascadeError } = await this.deleteWithCascade(resource, body.primaryKey, {adminUser, response});
+            const { error: cascadeError } = await cascadeChildrenDelete(resource, body.primaryKey, {adminUser, response}, this.adminforth);
             if (cascadeError) {
               return { error: cascadeError };
             }

adminforth/modules/utils.ts

@@ -3,7 +3,7 @@ import { fileURLToPath } from 'url';
 import fs from 'fs';
 import Fuse from 'fuse.js';
 import crypto from 'crypto';
-import AdminForth, { AdminForthConfig, AdminForthResourceColumnInputCommon, Predicate } from '../index.js';
+import { AdminForthConfig, AdminForthResource, AdminForthResourceColumnInputCommon,Filters, IAdminForth, Predicate } from '../index.js';
 import { RateLimiterMemory, RateLimiterAbstract } from "rate-limiter-flexible";
 // @ts-ignore-next-line
 
@@ -479,3 +479,41 @@ export function slugifyString(str: string): string {
     .replace(/\s+/g, '-')
     .replace(/[^a-z0-9-_]/g, '-');
 }
+
+export async function cascadeChildrenDelete(resource: AdminForthResource, primaryKey: string, context: {adminUser: any, response: any}, adminforth: IAdminForth): Promise<{ error: string | null }> {
+    const { adminUser, response } = context;
+    
+    const childResources = adminforth.config.resources.filter(r =>r.columns.some(c => c.foreignResource?.resourceId === resource.resourceId));
+
+    for (const childRes of childResources) {
+      const foreignColumn = childRes.columns.find(c => c.foreignResource?.resourceId === resource.resourceId);
+
+      if (!foreignColumn?.foreignResource?.onDelete) continue;
+
+      const strategy = foreignColumn.foreignResource.onDelete;
+
+      const childRecords = await adminforth.resource(childRes.resourceId).list(Filters.EQ(foreignColumn.name, primaryKey));
+
+      const childPk = childRes.columns.find(c => c.primaryKey)?.name;
+      if (!childPk) continue;
+
+      if (strategy === 'cascade') {
+        for (const childRecord of childRecords) {
+          const childResult = await cascadeChildrenDelete(childRes, childRecord[childPk], context, adminforth);
+          const deleteChild = await adminforth.deleteResourceRecord({resource: childRes, record: childRecord, adminUser, recordId: childRecord[childPk], response});
+          if (deleteChild.error) return { error: deleteChild.error };
+          if (childResult?.error) {
+            return childResult;
+          }
+        }
+      }
+
+      if (strategy === 'setNull') {
+        for (const childRecord of childRecords) {
+          await adminforth.resource(childRes.resourceId).update(childRecord[childPk], {[foreignColumn.name]: null});
+        }
+      }
+    }
+
+    return { error: null };
+  }