Reduce warnings and improve backwards compatibility of new behavior s…

…ystem (#2207)
graphile · Oct 7, 2024 · 5d58edd · 5d58edd
2 parents 10ed7e8 + 0b1f7b5
commit 5d58edd
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 14 deletions.
diff --git a/.changeset/olive-moles-sniff.md b/.changeset/olive-moles-sniff.md
@@ -0,0 +1,6 @@
+---
+"graphile-build-pg": patch
+"graphile-build": patch
+---
+
+Fix overwhelming logs and errors being output by the new behavior system
diff --git a/graphile-build/graphile-build-pg/src/plugins/PgBasicsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgBasicsPlugin.ts
@@ -197,7 +197,12 @@ export const PgBasicsPlugin: GraphileConfig.Plugin = {
         select: {
           description:
             "can select this resource/column/etc. Note this does not necessarily mean you can do `select * from users` but it might mean that it's possible to see details about a `users` when it's returned by a function or similar. (In this case the `codec` has `select` but the `resource` has `-select`.)",
-          entities: ["pgCodec", "pgResource"],
+          entities: [
+            "pgCodec",
+            "pgCodecAttribute",
+            "pgCodecRelation",
+            "pgResource",
+          ],
         },
         insert: {
           description: "can insert into this resource/column/etc",
@@ -229,15 +234,30 @@ export const PgBasicsPlugin: GraphileConfig.Plugin = {
         },
         list: {
           description: "should we use a list field for this?",
-          entities: ["pgCodec", "pgResource", "pgResourceUnique"],
+          entities: [
+            "pgCodec",
+            "pgCodecRelation",
+            "pgResource",
+            "pgResourceUnique",
+          ],
         },
         "resource:connection": {
           description: "should we use a connection field for this?",
-          entities: ["pgCodec", "pgResource", "pgResourceUnique"],
+          entities: [
+            "pgCodec",
+            "pgCodecRelation",
+            "pgResource",
+            "pgResourceUnique",
+          ],
         },
         "resource:list": {
           description: "should we use a list field for this?",
-          entities: ["pgCodec", "pgResource", "pgResourceUnique"],
+          entities: [
+            "pgCodec",
+            "pgCodecRelation",
+            "pgResource",
+            "pgResourceUnique",
+          ],
         },
         "resource:array": {
           description:
@@ -246,7 +266,12 @@ export const PgBasicsPlugin: GraphileConfig.Plugin = {
         },
         "resource:single": {
           description: "can we get one of this thing?",
-          entities: ["pgCodec", "pgResource", "pgResourceUnique"],
+          entities: [
+            "pgCodec",
+            "pgCodecRelation",
+            "pgResource",
+            "pgResourceUnique",
+          ],
         },
       },
     },

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgIndexBehaviorsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgIndexBehaviorsPlugin.ts
@@ -96,7 +96,7 @@ export const PgIndexBehaviorsPlugin: GraphileConfig.Plugin = {
       add: {
         // HACK: this impacts a community plugin and isn't part of core.
         manyToMany: {
-          entities: [],
+          entities: ["pgResource", "pgCodecRelation"],
           description: "(Legacy support hack - many-to-many relationship)",
         },
       },

diff --git a/graphile-build/graphile-build/src/behavior.ts b/graphile-build/graphile-build/src/behavior.ts
@@ -61,11 +61,31 @@ const getEntityBehaviorHooks = (
       } else {
         // noop
       }
-    } else {
+    } else if (rhs.inferred || rhs.override) {
       const hook = rhs[type];
       if (hook) {
         result[entityType as keyof GraphileBuild.BehaviorEntities] = hook;
       }
+    } else {
+      console.warn(
+        `Plugin ${
+          plugin.name
+        } is using a deprecated or unsupported form of 'plugin.schema.entityBehavior[${JSON.stringify(
+          entityType,
+        )}]' definition - if this is an object it should have only the keys 'inferred' and/or 'override'. This changed in graphile-build@5.0.0-beta.25.`,
+      );
+      const rhsAny = rhs as any;
+      if (rhsAny.callback) {
+        if (rhsAny.provides?.includes?.("override")) {
+          if (type === "override") {
+            result[entityType as keyof GraphileBuild.BehaviorEntities] = rhsAny;
+          }
+        } else {
+          if (type === "inferred") {
+            result[entityType as keyof GraphileBuild.BehaviorEntities] = rhsAny;
+          }
+        }
+      }
     }
   }
   return result;
@@ -318,7 +338,7 @@ export class Behavior {
     filter: TFilter,
   ): boolean | undefined {
     if (!this.behaviorRegistry[filter]) {
-      console.trace(
+      console.warn(
         `Behavior '${filter}' is not registered; please be sure to register it within a plugin via \`plugin.schema.behaviorRegistry.add[${JSON.stringify(
           filter,
         )}] = { description: "...", entities: [${JSON.stringify(
@@ -340,7 +360,7 @@ export class Behavior {
           entities[entityType] && stringMatches(bhv, filter),
       )
     ) {
-      console.trace(
+      console.warn(
         `Behavior '${filter}' is not registered for entity type '${entityType}'; it's only expected to be used with '${Object.keys(
           this.behaviorRegistry[filter].entities,
         ).join(
@@ -895,6 +915,8 @@ export function isValidBehaviorString(
   );
 }
 
+const warnedBehaviors: string[] = [];
+
 /*
  * 1. Take each behavior from inferred
  * 2. Find the matching behaviors from preferences
@@ -963,11 +985,13 @@ function multiplyBehavior(
       });
     }
     if (final.length === 0) {
-      console.warn(
-        `No matches for behavior '${infEntry.scope.join(
-          ":",
-        )}' - please ensure that this behavior is registered for entity type '${entityType}'`,
-      );
+      const behavior = infEntry.scope.join(":");
+      if (!warnedBehaviors.includes(behavior)) {
+        warnedBehaviors.push(behavior);
+        console.warn(
+          `No matches for behavior '${behavior}' - please ensure that this behavior is registered for entity type '${entityType}'`,
+        );
+      }
     }
     return final;
   });