fix(loop): add check to prevent infinite loops (#8)

* fix(loop): add check to prevent infinite loops

* ci(test): build plugin for testing

Author: faessler

.github/workflows/test.yml

@@ -29,6 +29,10 @@ jobs:
           registry-url: 'https://registry.npmjs.org/'
           cache: 'npm'
 
+      - name: Prepare plugin
+        run: npm ci && npm run build
+        working-directory: ./
+
       - name: dotenv
         run: echo "${{ secrets.ENV_FILE }}" >> .env
 

sandbox/tests/populate-all.test.ts

@@ -2,10 +2,23 @@ import { describe, expect, test } from "@jest/globals";
 import { strapiRequest } from "./strapi";
 
 describe("strapi-plugin-populate-all", () => {
-  test.skip("if everything is populated", async () => {
+  test("if everything is populated", async () => {
     const response = await strapiRequest.get(
       "/api/articles?status=draft&populate=all"
     );
+
+    // request succeeds
     expect(response.statusCode).toBe(200);
+
+    // has first level of population
+    expect(response.body.data[0]).toHaveProperty("cover");
+    expect(response.body.data[0]).toHaveProperty("author");
+    expect(response.body.data[0]).toHaveProperty("category");
+    expect(response.body.data[0]).toHaveProperty("blocks");
+
+    // doesn't loop
+    expect(response.body.data[0].category.articles[0]).not.toHaveProperty(
+      "category"
+    );
   });
 });

server/src/utils/getPopulateQuery.ts

@@ -4,7 +4,8 @@ import type { UID } from "@strapi/strapi";
 const queryCache: Partial<Record<UID.Schema, any>> = {};
 
 export const getPopulateQuery = (
-  modelUid: UID.Schema
+  modelUid: UID.Schema,
+  parentsModelUids: UID.Schema[] = []
 ): { populate: object | true } | undefined => {
   try {
     // return cached query
@@ -13,6 +14,16 @@ export const getPopulateQuery = (
       return queryCache[modelUid];
     }
 
+    // prevent infinite loop
+    if (parentsModelUids.includes(modelUid)) {
+      strapi.log.debug(
+        `[populate-all] loop detected skipping population: ${modelUid}`
+      );
+      return { populate: {} };
+    } else {
+      parentsModelUids.push(modelUid);
+    }
+
     // build query
     const query = { populate: {} };
     const model = strapi.getModel(modelUid);
@@ -31,7 +42,7 @@ export const getPopulateQuery = (
         const components = Object.fromEntries(
           attribute.components.map((component) => [
             component,
-            getPopulateQuery(component),
+            getPopulateQuery(component, parentsModelUids),
           ])
         );
         query.populate[fieldName] = { on: components };
@@ -40,7 +51,10 @@ export const getPopulateQuery = (
 
       // component
       if (attribute.type === "component") {
-        query.populate[fieldName] = getPopulateQuery(attribute.component);
+        query.populate[fieldName] = getPopulateQuery(
+          attribute.component,
+          parentsModelUids
+        );
         continue;
       }
 
@@ -57,14 +71,20 @@ export const getPopulateQuery = (
           .config<boolean | string[]>("relations");
 
         if (relations === true) {
-          // @ts-expect-error target actually exists on attribute
-          query.populate[fieldName] = getPopulateQuery(attribute.target);
+          query.populate[fieldName] = getPopulateQuery(
+            // @ts-expect-error target actually exists on attribute
+            attribute.target,
+            parentsModelUids
+          );
           continue;
         }
         // @ts-expect-error target actually exists on attribute
         if (Array.isArray(relations) && relations.includes(attribute.target)) {
-          // @ts-expect-error target actually exists on attribute
-          query.populate[fieldName] = getPopulateQuery(attribute.target);
+          query.populate[fieldName] = getPopulateQuery(
+            // @ts-expect-error target actually exists on attribute
+            attribute.target,
+            parentsModelUids
+          );
           continue;
         }
       }