Improvements around @interface mode:relational (#438)

.changeset/healthy-radios-allow.md

@@ -0,0 +1,7 @@
+---
+"graphile-build-pg": patch
+"postgraphile": patch
+---
+
+When using `@interface mode:relational`, don't add pointless relationships from
+concrete type back to abstract or from abstract to related concrete types.

.changeset/light-knives-relax.md

@@ -0,0 +1,6 @@
+---
+"graphile-build-pg": patch
+"postgraphile": patch
+---
+
+Fix spurious error relating to connection for `@interface type:relational`

.changeset/neat-zebras-sleep.md

@@ -0,0 +1,5 @@
+---
+"graphile": patch
+---
+
+Fix bug in `graphile behavior debug` command relating to `pgCodecRelation`

.changeset/proud-kangaroos-add.md

@@ -0,0 +1,9 @@
+---
+"graphile-build-pg": patch
+"graphile-build": patch
+"postgraphile": patch
+"graphile-config": patch
+---
+
+Plugin name now automatically used in `provides` for every hook, allowing
+ordering hooks before/after their equivalents in other plugins.

graphile-build/graphile-build-pg/src/plugins/PgPolymorphismPlugin.ts

@@ -602,6 +602,53 @@ export const PgPolymorphismPlugin: GraphileConfig.Plugin = {
           ];
         },
       },
+      pgCodecRelation: {
+        provides: ["inferred"],
+        after: ["default", "PgRelationsPlugin"],
+        before: ["override"],
+        callback(behavior, entity, build) {
+          const {
+            input: {
+              pgRegistry: { pgRelations },
+            },
+          } = build;
+          const { localCodec, remoteResource, isUnique, isReferencee } = entity;
+          const remoteCodec = remoteResource.codec;
+
+          // Hide relation from a concrete type back to the abstract root table.
+          if (
+            isUnique &&
+            !isReferencee &&
+            remoteCodec.polymorphism?.mode === "relational"
+          ) {
+            const localTypeName = build.inflection.tableType(localCodec);
+            const polymorphicTypeDefinitionEntry = Object.entries(
+              remoteCodec.polymorphism.types,
+            ).find(([, val]) => val.name === localTypeName);
+            if (polymorphicTypeDefinitionEntry) {
+              const [, { relationName }] = polymorphicTypeDefinitionEntry;
+              const relation = pgRelations[remoteCodec.name]?.[relationName];
+              if (
+                arraysMatch(relation.remoteAttributes, entity.localAttributes)
+              ) {
+                return [behavior, "-connection -list -single"];
+              }
+            }
+          }
+
+          // Hide relation from abstract root table to related elements
+          if (isReferencee && localCodec.polymorphism?.mode === "relational") {
+            const relations = Object.values(localCodec.polymorphism.types).map(
+              (t) => pgRelations[localCodec.name]?.[t.relationName],
+            );
+            if (relations.includes(entity)) {
+              return [behavior, "-connection -list -single"];
+            }
+          }
+
+          return behavior;
+        },
+      },
     },
     hooks: {
       init(_, build, _context) {
@@ -703,18 +750,18 @@ export const PgPolymorphismPlugin: GraphileConfig.Plugin = {
                       }),
                       `PgPolymorphismPlugin single table type for ${codec.name}`,
                     );
+                    build.registerCursorConnection({
+                      typeName: tableTypeName,
+                      connectionTypeName:
+                        inflection.connectionType(tableTypeName),
+                      edgeTypeName: inflection.edgeType(tableTypeName),
+                      scope: {
+                        isPgConnectionRelated: true,
+                        pgCodec: codec,
+                      },
+                      nonNullNode: pgForbidSetofFunctionsToReturnNull,
+                    });
                   }
-                  build.registerCursorConnection({
-                    typeName: tableTypeName,
-                    connectionTypeName:
-                      inflection.connectionType(tableTypeName),
-                    edgeTypeName: inflection.edgeType(tableTypeName),
-                    scope: {
-                      isPgConnectionRelated: true,
-                      pgCodec: codec,
-                    },
-                    nonNullNode: pgForbidSetofFunctionsToReturnNull,
-                  });
                 }
               } else if (polymorphism.mode === "union") {
                 const interfaceTypeName = inflection.tableType(codec);

graphile-build/graphile-build/src/behavior.ts

@@ -28,7 +28,7 @@ const getEntityBehaviorHooks = (plugin: GraphileConfig.Plugin) => {
         string
       > = {
         provides: ["default"],
-        before: ["inferred"],
+        before: ["inferred", "override"],
         callback: (behavior) => [lhs, behavior],
       };
       entry[1] = hook;

postgraphile/postgraphile/__tests__/schema/v4/js-reserved.1.graphql

@@ -560,11 +560,6 @@ type CreateRelationalStatusPayload {
   """
   query: Query
 
-  """
-  Reads a single `RelationalItem` that is related to this `RelationalStatus`.
-  """
-  relationalItemById: RelationalItem
-
   """The `RelationalStatus` that was created by this mutation."""
   relationalStatus: RelationalStatus
 
@@ -600,11 +595,6 @@ type CreateRelationalTopicPayload {
   """
   query: Query
 
-  """
-  Reads a single `RelationalItem` that is related to this `RelationalTopic`.
-  """
-  relationalItemById: RelationalItem
-
   """The `RelationalTopic` that was created by this mutation."""
   relationalTopic: RelationalTopic
 
@@ -1294,11 +1284,6 @@ type DeleteRelationalStatusPayload {
   """
   query: Query
 
-  """
-  Reads a single `RelationalItem` that is related to this `RelationalStatus`.
-  """
-  relationalItemById: RelationalItem
-
   """The `RelationalStatus` that was deleted by this mutation."""
   relationalStatus: RelationalStatus
 
@@ -1347,11 +1332,6 @@ type DeleteRelationalTopicPayload {
   """
   query: Query
 
-  """
-  Reads a single `RelationalItem` that is related to this `RelationalTopic`.
-  """
-  relationalItemById: RelationalItem
-
   """The `RelationalTopic` that was deleted by this mutation."""
   relationalTopic: RelationalTopic
 
@@ -3346,16 +3326,6 @@ interface RelationalItem {
   buildingByConstructor: Building
   constructor: String
   id: Int!
-
-  """
-  Reads a single `RelationalStatus` that is related to this `RelationalItem`.
-  """
-  relationalStatusById: RelationalStatus
-
-  """
-  Reads a single `RelationalTopic` that is related to this `RelationalItem`.
-  """
-  relationalTopicById: RelationalTopic
   type: ItemType!
 }
 
@@ -3426,11 +3396,6 @@ type RelationalStatus implements Node & RelationalItem {
   nodeId: ID!
   note: String
 
-  """
-  Reads a single `RelationalItem` that is related to this `RelationalStatus`.
-  """
-  relationalItemById: RelationalItem
-
   """
   Reads a single `RelationalStatus` that is related to this `RelationalStatus`.
   """
@@ -3540,11 +3505,6 @@ type RelationalTopic implements Node & RelationalItem {
   """
   nodeId: ID!
 
-  """
-  Reads a single `RelationalItem` that is related to this `RelationalTopic`.
-  """
-  relationalItemById: RelationalItem
-
   """
   Reads a single `RelationalStatus` that is related to this `RelationalTopic`.
   """
@@ -4385,11 +4345,6 @@ type UpdateRelationalStatusPayload {
   """
   query: Query
 
-  """
-  Reads a single `RelationalItem` that is related to this `RelationalStatus`.
-  """
-  relationalItemById: RelationalItem
-
   """The `RelationalStatus` that was updated by this mutation."""
   relationalStatus: RelationalStatus
 
@@ -4447,11 +4402,6 @@ type UpdateRelationalTopicPayload {
   """
   query: Query
 
-  """
-  Reads a single `RelationalItem` that is related to this `RelationalTopic`.
-  """
-  relationalItemById: RelationalItem
-
   """The `RelationalTopic` that was updated by this mutation."""
   relationalTopic: RelationalTopic