fix: improve logging

Author: ProGM

dist/index.cjs.js

@@ -78,7 +78,6 @@ debug.adapter = (level, ...args) => {
   }
 };
 
-const IGNORED_KEYS = ['Symbol(', '_', '$', '#'];
 class Parser {
   resolved = {};
   constructor(data, included = []) {
@@ -134,25 +133,23 @@ class Parser {
     return instance;
   }
   wrapWhenPartial(instance, loadedElement) {
-    if (loadedElement.$_partial) {
-      return new Proxy(instance, {
-        get: function (target, prop) {
-          if (prop === "$_partial") {
-            return true;
-          }
-          if (prop in target) {
-            return target[prop];
-          }
-          const propString = prop.toString();
-          if (IGNORED_KEYS.some(k => propString.startsWith(k))) {
-            return undefined;
-          }
-          debug('error', `Trying to call property "${prop.toString()}" to a model that is not included. Add "${loadedElement.type}" to included models.`);
-          return undefined;
-        }
-      });
+    if (!loadedElement.$_partial) {
+      return instance;
     }
-    return instance;
+    return new Proxy(instance, {
+      get: function (target, prop) {
+        if (prop === "$_partial") {
+          return true;
+        }
+        const propString = prop.toString();
+        debug('error', `Trying to call property "${propString}" to a model that is not included. Add "${loadedElement.type}" to included models.`, {
+          model: instance,
+          property: propString,
+          type: 'ACCESSING_NOT_INCLUDED_MODEL'
+        });
+        return target[prop];
+      }
+    });
   }
   parseRelationships(instance, loadedElement, relsData, included) {
     for (const key in loadedElement.relationships) {

dist/index.esm.js

@@ -74,7 +74,6 @@ debug.adapter = (level, ...args) => {
   }
 };
 
-const IGNORED_KEYS = ['Symbol(', '_', '$', '#'];
 class Parser {
   resolved = {};
   constructor(data, included = []) {
@@ -130,25 +129,23 @@ class Parser {
     return instance;
   }
   wrapWhenPartial(instance, loadedElement) {
-    if (loadedElement.$_partial) {
-      return new Proxy(instance, {
-        get: function (target, prop) {
-          if (prop === "$_partial") {
-            return true;
-          }
-          if (prop in target) {
-            return target[prop];
-          }
-          const propString = prop.toString();
-          if (IGNORED_KEYS.some(k => propString.startsWith(k))) {
-            return undefined;
-          }
-          debug('error', `Trying to call property "${prop.toString()}" to a model that is not included. Add "${loadedElement.type}" to included models.`);
-          return undefined;
-        }
-      });
+    if (!loadedElement.$_partial) {
+      return instance;
     }
-    return instance;
+    return new Proxy(instance, {
+      get: function (target, prop) {
+        if (prop === "$_partial") {
+          return true;
+        }
+        const propString = prop.toString();
+        debug('error', `Trying to call property "${propString}" to a model that is not included. Add "${loadedElement.type}" to included models.`, {
+          model: instance,
+          property: propString,
+          type: 'ACCESSING_NOT_INCLUDED_MODEL'
+        });
+        return target[prop];
+      }
+    });
   }
   parseRelationships(instance, loadedElement, relsData, included) {
     for (const key in loadedElement.relationships) {

src/Parser.ts

@@ -6,8 +6,6 @@ import { Model } from "./Model";
 import { $registeredAttributes, $registeredModels, $registeredRelationships } from "./data";
 import { debug } from "./utils";
 
-const IGNORED_KEYS = ['Symbol(', '_', '$', '#'];
-
 export class Parser {
   readonly resolved: Record<string, Model> = {};
 
@@ -88,28 +86,25 @@ export class Parser {
   }
 
   wrapWhenPartial(instance: Model, loadedElement: JSONModel & { $_partial?: boolean }) {
-    if (loadedElement.$_partial) {
-      return new Proxy(
-        instance,
-        {
-          get: function<T extends object>(target: T, prop: keyof T) {
-            if (prop === "$_partial") {
-              return true;
-            }
-            if (prop in target) {
-              return target[prop];
-            }
-            const propString = prop.toString();
-            if (IGNORED_KEYS.some((k) => propString.startsWith(k))) {
-              return undefined;
-            }
-            debug('error', `Trying to call property "${prop.toString()}" to a model that is not included. Add "${loadedElement.type}" to included models.`);
-            return undefined;
-          },
-        })
+    if (!loadedElement.$_partial) {
+      return instance;
     }
-
-    return instance;
+    return new Proxy(
+      instance,
+      {
+        get: function<T extends object>(target: T, prop: keyof T) {
+          if (prop === "$_partial") {
+            return true;
+          }
+          const propString = prop.toString();
+          debug('error', `Trying to call property "${propString}" to a model that is not included. Add "${loadedElement.type}" to included models.`, {
+            model: instance,
+            property: propString,
+            type: 'ACCESSING_NOT_INCLUDED_MODEL'
+          });
+          return target[prop];
+        },
+      });
   }
 
   private parseRelationships(instance: Model, loadedElement: JSONModel, relsData: RegisteredAttribute | undefined, included: JSONModel[]) {

test/basic.spec.ts

@@ -94,6 +94,8 @@ test("returns a Proxy when accessing to a not included model", () => {
   expect(model.relatedPost?.content).toBe(undefined);
   expect(logs.at(-1)).toBe("Trying to call property \"content\" to a model that is not included. Add \"posts\" to included models.");
   expect((model.relatedPost as any)?.$_partial).toBe(true);
+  expect(model.relatedPost?.['name']).toBe(undefined);
+  expect(logs.at(-1)).toBe("Trying to call property \"name\" to a model that is not included. Add \"posts\" to included models.");
 });
 
 test("parses circular references", () => {