Merge pull request #100 from Four-Lights-NL/fix/model-resolving-not-working

fix(deep-populate): gracefully handle missing model

Author: trijpstra-fourlights

package-lock.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.11.0",
+  "version": "1.11.1-rc.0",
   "keywords": [
     "strapi",
     "strapi-plugin",

package.json

@@ -7,6 +7,7 @@ import isEqual from "lodash/isEqual"
 import type { PopulateParams } from "./populate"
 
 import { version } from "../../../package.json"
+import log from "../utils/log"
 import { getConfig } from "./deep-populate/utils"
 
 type SetPopulateParams = PopulateParams &
@@ -46,14 +47,19 @@ export default ({ strapi }: { strapi: Core.Strapi }) => ({
 
     const entry = await documentService.findFirst({ filters: { hash: { $eq: hash } } })
 
-    return entry
-      ? await documentService.update({
-          documentId: entry.documentId,
-          data: { populate, dependencies: dependencies.join(",") } as Partial<
-            Modules.Documents.Params.Data.Input<"plugin::deep-populate.cache">
-          >,
-        })
-      : await documentService.create({ data: { hash, params, populate, dependencies: dependencies.join(",") } })
+    try {
+      return entry
+        ? await documentService.update({
+            documentId: entry.documentId,
+            data: { populate, dependencies: dependencies.join(",") } as Partial<
+              Modules.Documents.Params.Data.Input<"plugin::deep-populate.cache">
+            >,
+          })
+        : await documentService.create({ data: { hash, params, populate, dependencies: dependencies.join(",") } })
+    } catch (error: unknown) {
+      log.error("[Plugin: Deep Populate] Failed to save cached entry", { error })
+      return
+    }
   },
   async clear(params: PopulateParams) {
     const entry = await strapi

server/src/services/cache.ts

@@ -11,6 +11,7 @@ import type { ContentTypeConfigAllow } from "../../config"
 import type { PopulateParams } from "../populate"
 import type { PopulateComponentProps, PopulateDynamicZoneProps, PopulateProps, PopulateRelationProps } from "./types"
 
+import log from "../../utils/log"
 import { sanitizeObject } from "../../utils/sanitizeObject"
 import { getConfig, getRelations, hasValue, isEmpty } from "./utils"
 
@@ -26,6 +27,16 @@ async function _populateComponent<TContentType extends UID.ContentType, TSchema
 }: PopulateComponentProps<TContentType, TSchema>) {
   const componentLookup = lookup.length === 0 ? [attrName] : [...lookup, inDynamicZone ? "on" : "populate", attrName]
 
+  if (strapi.getModel(schema) === undefined) {
+    log.warn(
+      inDynamicZone
+        ? `The dynamic zone '${lookup[lookup.length - 1]}' is referencing a non-existing component '${schema}'. You should fix this.`
+        : `Could not find component: '${schema}'`,
+      { lookup },
+    )
+    return true
+  }
+
   const componentPopulate = populate
   set(componentPopulate, componentLookup, { populate: "*" })
 
@@ -198,7 +209,13 @@ async function _populate<TContentType extends UID.ContentType, TSchema extends U
 }: PopulateProps<TContentType, TSchema>) {
   const newPopulate = {}
 
-  let relations = getRelations(strapi.getModel(schema))
+  const model = strapi.getModel(schema)
+  if (!model) {
+    strapi.log.warn(`[Plugin: Deep Populate] Could not find model for contentType: '${schema}'`)
+    strapi.log.warn("Please create a bug report and share the troublesome contentType.")
+    return {}
+  }
+  let relations = getRelations(model)
   let currentPopulate = cloneDeep(populate)
 
   // Make sure we won't revisit this documentId from nested children

server/src/services/deep-populate/index.ts

@@ -0,0 +1,8 @@
+import { name as pkgName } from "../../../package.json"
+
+export const error = (msg, context = undefined) => strapi.log.error(`[${pkgName}] ${msg}`, context)
+export const warn = (msg, context = undefined) => strapi.log.warn(`[${pkgName}] ${msg}`, context)
+export const info = (msg, context = undefined) => strapi.log.info(`[${pkgName}] ${msg}`, context)
+export const debug = (msg, context = undefined) => strapi.log.debug(`[${pkgName}] ${msg}`, context)
+
+export default { error, warn, info, debug }