feat: migrate custom params to valid strapi params._q (#23)

* feat: migrate custom params to valid strapi params._q

https://github.com/strapi/strapi/blob/develop/packages/core/core/src/services/document-service/repository.ts#L327

And allowelisted is the :sweep: variant here https://github.com/strapi/strapi/blob/develop/packages/core/core/src/services/document-service/transform/query.ts#L9

Starting from there it's not possible to get back our extra populateAll: true anymore.

Everything is hardcoded https://github.com/strapi/strapi/blob/develop/packages/core/utils/src/content-api-constants.ts#L7
https://github.com/strapi/strapi/blob/develop/packages/core/core/src/services/document-service/params.ts

Also remove the KoaJS Router state from the DB lifecycle, it doesn't
work inside the UI.

* fix: detect koa state and bind _q tag

* feat: improve readme

* fix: resolve lint error no unused imports

---------

Co-authored-by: Jan Fässler <git@faessler.be>

Author: dhoko

README.md

@@ -51,4 +51,4 @@ module.exports = {
 - The plugin provides a global middleware that intercepts requests with `?populate=all` and rewrites the query to trigger recursive population.
 - In the background, it builds a standard Strapi populate query as described in the [Strapi documentation](https://docs.strapi.io/cms/api/rest/populate-select).
 - You can control which relations are included using the relations config option.
-- Inside the document API, you can set `populate: '*'` and `populateAll: true` to make it work
+- Inside the document API, you can set `populate: '*'` and `_q: "populate-all"` to make it work ("populate-all" can be anywhere inside `_q`, we detect it via .includes)

sandbox/tests/populate-all.test.ts

@@ -21,4 +21,44 @@ describe("strapi-plugin-populate-all", () => {
       "category"
     );
   });
+
+  test("if everything is populated with populateAll=true", async () => {
+    const response = await strapiRequest.get(
+      "/api/articles?status=draft&populateAll=true"
+    );
+
+    // 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"
+    );
+  });
+
+  test("if everything is populated with ?populateAll", async () => {
+    const response = await strapiRequest.get(
+      "/api/articles?status=draft&populateAll"
+    );
+
+    // 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/bootstrap.ts

@@ -1,4 +1,5 @@
 import type { Core, UID } from "@strapi/strapi";
+import { PLUGIN_QUERY_DOCUMENT_TAG } from "./config";
 import { getPopulateQuery } from "./utils/getPopulateQuery";
 
 const bootstrap = ({ strapi }: { strapi: Core.Strapi }) => {
@@ -8,7 +9,11 @@ const bootstrap = ({ strapi }: { strapi: Core.Strapi }) => {
         event.action === "beforeFindMany" ||
         event.action === "beforeFindOne"
       ) {
-        if (strapi.requestContext.get()?.query?.populateAll) {
+        // There is a whitelist of keys we can use to detect our
+        // filter from the params
+        // https://github.com/strapi/strapi/blob/develop/packages/core/utils/src/content-api-constants.ts
+        // We cheat.
+        if (event.params._q?.includes(PLUGIN_QUERY_DOCUMENT_TAG)) {
           strapi.log.debug(
             `[populate-all] recursively populate ${event.model.uid}`
           );
@@ -17,6 +22,14 @@ const bootstrap = ({ strapi }: { strapi: Core.Strapi }) => {
           if (populateQuery?.populate) {
             event.params.populate = populateQuery.populate;
           }
+
+          // Clean our tag from the custom query.
+          const query = event.params._q.replace(PLUGIN_QUERY_DOCUMENT_TAG, "");
+          if (query.length > 0) {
+            event.params._q = query;
+          } else {
+            delete event.params._q;
+          }
         }
       }
     } catch (error) {

server/src/config/index.ts

@@ -1,3 +1,5 @@
+export const PLUGIN_QUERY_DOCUMENT_TAG = "populate-all";
+
 export default {
   default: {
     relations: true,

server/src/middlewares/index.ts

@@ -1,4 +1,5 @@
 import type { Context, Next } from "koa";
+import { PLUGIN_QUERY_DOCUMENT_TAG } from "../config";
 
 export default {
   /**
@@ -8,9 +9,18 @@ export default {
    * The bootstrap script later picks up `?populateAll=true` to apply the desired populate logic.
    */
   populateAll: async (ctx: Context, next: Next) => {
+    // always bind the tag so we can load the execpected populate hook
+    // populateAll=true or ?populateAll (value can be 'true' or null)
+    if (
+      (ctx.query.populateAll && ctx.query.populateAll !== "false") ||
+      ctx.query.populateAll === null
+    ) {
+      ctx.query._q = [ctx.query._q || "", PLUGIN_QUERY_DOCUMENT_TAG].join("");
+    }
+
     if (ctx.query.populate === "all") {
       ctx.query.populate = undefined;
-      ctx.query.populateAll = true;
+      ctx.query._q = [ctx.query._q || "", PLUGIN_QUERY_DOCUMENT_TAG].join("");
     }
     await next();
   },