Address a number of TODO items

.changeset/calm-zebras-own.md

@@ -0,0 +1,7 @@
+---
+"graphile-build-pg": patch
+"postgraphile": patch
+---
+
+Ability to control via behaviors whether the record type is selectable on CRUD
+mutation payloads.

.changeset/dry-moons-hunt.md

@@ -0,0 +1,7 @@
+---
+"graphile-build-pg": patch
+"postgraphile": patch
+---
+
+Add `filterBy` and `orderBy` behaviors for each codec type (array, range,
+composite, binary, scalar) to allow simpler global customization.

.changeset/fluffy-taxis-fold.md

@@ -0,0 +1,7 @@
+---
+"graphile-build-pg": patch
+"postgraphile": patch
+---
+
+Incorrect ordering of behaviors `orderBy:array`/`orderBy:range` fixed ->
+`array:attribute:orderBy`/`range:attribute:orderBy`.

.changeset/itchy-weeks-wink.md

@@ -0,0 +1,9 @@
+---
+"graphile-build-pg": patch
+"graphile-build": patch
+"graphile-utils": patch
+"postgraphile": patch
+---
+
+Introduce TypeScript CIF gatherConfig() to help typing the `gather` phase for
+plugins.

.changeset/serious-weeks-occur.md

@@ -0,0 +1,6 @@
+---
+"eslint-plugin-graphile-export": patch
+"graphile-export": patch
+---
+
+More docs for graphile-export

.changeset/shaggy-crabs-watch.md

@@ -0,0 +1,8 @@
+---
+"graphile-build-pg": patch
+"postgraphile": patch
+"@dataplan/pg": patch
+---
+
+Add support for `bytea` datatype using new `Base64EncodedBinary` scalar in
+GraphQL.

.changeset/shaggy-frogs-drop.md

@@ -0,0 +1,6 @@
+---
+"graphile-build-pg": patch
+---
+
+Fix constraint finding for polymorphism (was theoretically possible to find the
+wrong constraint).

grafast/dataplan-pg/src/codecs.ts

@@ -167,7 +167,7 @@ function t<TFromJavaScript = any, TFromPostgres = string>(): <
   undefined
 > {
   return (oid, type, options = {}) => {
-    const { castFromPg, listCastFromPg, fromPg, toPg } = options;
+    const { castFromPg, listCastFromPg, fromPg, toPg, isBinary } = options;
     return {
       name: type,
       sqlType: sql.identifier(...type.split(".")),
@@ -178,6 +178,7 @@ function t<TFromJavaScript = any, TFromPostgres = string>(): <
       castFromPg,
       listCastFromPg,
       executor: null,
+      isBinary,
     };
   };
 }
@@ -854,6 +855,7 @@ type Cast<TFromJavaScript = any, TFromPostgres = string> = {
   listCastFromPg?(frag: SQL): SQL;
   toPg?: PgEncode<TFromJavaScript>;
   fromPg?: PgDecode<TFromJavaScript, TFromPostgres>;
+  isBinary?: boolean;
 };
 
 /**
@@ -1020,6 +1022,28 @@ export const TYPES = {
     fromPg: parseHstore,
     toPg: stringifyHstore,
   }),
+  bytea: t<Buffer>()("17", "bytea", {
+    fromPg(str) {
+      // The bytea type supports two formats for input and output: “hex”
+      // format and PostgreSQL's historical “escape” format. Both of these
+      // are always accepted on input. The output format depends on the
+      // configuration parameter bytea_output; the default is hex.
+      // -- https://www.postgresql.org/docs/current/datatype-binary.html
+      if (str.startsWith("\\x")) {
+        // Hex format
+        return Buffer.from(str.substring(2), "hex");
+      } else {
+        // ENHANCE: consider supporting this
+        throw new Error(
+          `PostgreSQL bytea escape format is currently unsupported, please use \`bytea_output = 'hex'\` in your PostgreSQL configuration.`,
+        );
+      }
+    },
+    toPg(data: Buffer) {
+      return `\\x${data.toString("hex")}`;
+    },
+    isBinary: true,
+  }),
 } as const;
 exportAs("@dataplan/pg", TYPES, "TYPES");
 for (const [name, codec] of Object.entries(TYPES)) {
@@ -1037,9 +1061,8 @@ export function getCodecByPgCatalogTypeName(pgCatalogTypeName: string) {
     case "bool":
       return TYPES.boolean;
 
-    // TODO!
-    //case "bytea":
-    //  return TYPES.bytea; // oid: 17
+    case "bytea":
+      return TYPES.bytea; // oid: 17
 
     case "char":
       return TYPES.char;

grafast/dataplan-pg/src/interfaces.ts

@@ -198,6 +198,11 @@ export interface PgCodec<
    */
   isAnonymous?: boolean;
 
+  /**
+   * True if this type is a binary type (e.g. bytea)
+   */
+  isBinary?: boolean;
+
   /**
    * If this is a composite type, the attributes it supports.
    */

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

@@ -18,7 +18,7 @@ import {
   recordCodec,
   TYPES,
 } from "@dataplan/pg";
-import { EXPORTABLE } from "graphile-build";
+import { EXPORTABLE, gatherConfig } from "graphile-build";
 import type { PgAttribute, PgClass, PgType } from "pg-introspection";
 import sql from "pg-sql2";
 
@@ -274,8 +274,7 @@ export const PgCodecsPlugin: GraphileConfig.Plugin = {
     },
   },
 
-  // TODO: refactor TypeScript so this isn't necessary; maybe via `makePluginGatherConfig`?
-  gather: <GraphileConfig.PluginGatherConfig<"pgCodecs", State>>{
+  gather: gatherConfig({
     namespace: "pgCodecs",
     initialState: (): State => ({
       codecByTypeIdByDatabaseName: new Map(),
@@ -289,7 +288,7 @@ export const PgCodecsPlugin: GraphileConfig.Plugin = {
           info.state.codecByClassIdByDatabaseName.set(serviceName, map);
         }
         if (map.has(classId)) {
-          return map.get(classId);
+          return map.get(classId)!;
         }
 
         const promise = (async () => {
@@ -355,7 +354,7 @@ export const PgCodecsPlugin: GraphileConfig.Plugin = {
                   (attributeAttribute.attidentity != null &&
                     attributeAttribute.attidentity !== "") ||
                   attributeAttribute.getType()?.typdefault != null,
-                // TODO: identicalVia,
+                // PERF: identicalVia,
                 extensions: {
                   tags,
                 },
@@ -467,7 +466,7 @@ export const PgCodecsPlugin: GraphileConfig.Plugin = {
           info.state.codecByTypeIdByDatabaseName.set(serviceName, map);
         }
         if (map.has(typeId)) {
-          return map.get(typeId);
+          return map.get(typeId)!;
         }
 
         const promise = (async (): Promise<PgCodec | null> => {
@@ -871,7 +870,7 @@ export const PgCodecsPlugin: GraphileConfig.Plugin = {
         }
       },
     },
-  },
+  }),
 
   schema: {
     hooks: {
@@ -1080,6 +1079,7 @@ export const PgCodecsPlugin: GraphileConfig.Plugin = {
               pgUseCustomNetworkScalars !== false
                 ? inflection.builtin("MacAddress8")
                 : "String",
+            bytea: inflection.builtin("Base64EncodedBinary"),
           };
           for (const rawKey in typeNameByTYPESKey) {
             const key = rawKey as keyof typeof typeNameByTYPESKey;
@@ -1464,7 +1464,7 @@ export const PgCodecsPlugin: GraphileConfig.Plugin = {
               }
             } else {
               // We have no idea what this is or how to handle it.
-              // TODO: add some default handling, like "behavesLike = TYPES.string"?
+              // TODO: add some default handling, like "behavesLike = TYPES.text"?
               console.warn(
                 `PgCodec '${codec.name}' not understood, please set 'domainOfCodec' to indicate the underlying behaviour the type should have when exposed to GraphQL`,
               );

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

@@ -2,6 +2,7 @@ import "./PgTablesPlugin.js";
 import "graphile-config";
 
 import type {
+  PgCodec,
   PgCodecWithAttributes,
   PgConditionStep,
   PgSelectParsedCursorStep,
@@ -44,7 +45,7 @@ export const PgConditionArgumentPlugin: GraphileConfig.Plugin = {
   schema: {
     entityBehavior: {
       pgCodec: "select filter",
-      pgCodecAttribute: "filterBy",
+      pgCodecAttribute: "filterBy -binary:attribute:filterBy",
       pgResource: {
         provides: ["default"],
         before: ["inferred", "override"],
@@ -119,16 +120,36 @@ export const PgConditionArgumentPlugin: GraphileConfig.Plugin = {
                   // PgNodeIdAttributesPlugin for similar approach for NodeIDs)
                   return Object.entries(attributes).reduce(
                     (memo, [attributeName, attribute]) => {
-                      if (
-                        !build.behavior.pgCodecAttributeMatches(
-                          [codec, attributeName],
-                          "attribute:filterBy",
-                        )
-                      ) {
-                        return memo;
+                      const behaviors: string[] = [];
+                      function walk(codec: PgCodec) {
+                        if (codec.arrayOfCodec) {
+                          behaviors.push("array:attribute:filterBy");
+                          walk(codec.arrayOfCodec);
+                        } else if (codec.rangeOfCodec) {
+                          behaviors.push("range:attribute:filterBy");
+                          walk(codec.rangeOfCodec);
+                        } else if (codec.domainOfCodec) {
+                          // No need to add a behavior for domain
+                          walk(codec.domainOfCodec);
+                        } else if (codec.attributes) {
+                          behaviors.push("composite:attribute:filterBy");
+                        } else if (codec.isBinary) {
+                          behaviors.push("binary:attribute:filterBy");
+                        } else {
+                          behaviors.push("scalar:attribute:filterBy");
+                        }
+                      }
+                      walk(attribute.codec);
+                      for (const behavior of behaviors) {
+                        if (
+                          !build.behavior.pgCodecAttributeMatches(
+                            [codec, attributeName],
+                            behavior,
+                          )
+                        ) {
+                          return memo;
+                        }
                       }
-
-                      // TODO: add `attribute:filterBy:array`/`:range` ?
 
                       const fieldName = inflection.attribute({
                         attributeName,

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

@@ -1,5 +1,6 @@
 import type { PgCodecExtensions, PgEnumCodec, PgEnumValue } from "@dataplan/pg";
 import { enumCodec } from "@dataplan/pg";
+import { gatherConfig } from "graphile-build";
 import type {
   Introspection,
   PgAttribute,
@@ -64,7 +65,7 @@ interface State {
   codecByPgConstraint: Map<PgConstraint, PgEnumCodec>;
   codecByPgAttribute: Map<PgAttribute, PgEnumCodec>;
 }
-interface Cache {}
+const EMPTY_OBJECT = Object.freeze({});
 
 // TODO: Assert the attributes are text
 /*
@@ -116,8 +117,11 @@ export const PgEnumTablesPlugin: GraphileConfig.Plugin = {
     },
   },
 
-  gather: <GraphileConfig.PluginGatherConfig<"pgEnumTables", State, Cache>>{
+  gather: gatherConfig({
     namespace: "pgEnumTables",
+    initialCache() {
+      return EMPTY_OBJECT;
+    },
     initialState: (): State => ({
       codecByPgConstraint: new Map(),
       codecByPgAttribute: new Map(),
@@ -337,7 +341,7 @@ Original error: ${e.message}
         }
       },
     },
-  },
+  }),
 };
 
 function isEnumConstraint(

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

@@ -1,5 +1,6 @@
 import type { PromiseOrDirect } from "grafast";
 import type { GatherPluginContext } from "graphile-build";
+import { gatherConfig } from "graphile-build";
 import type {
   Introspection,
   PgAttribute,
@@ -35,7 +36,8 @@ declare global {
 interface State {
   fakeId: number;
 }
-interface Cache {}
+const EMPTY_OBJECT = Object.freeze({});
+type Cache = typeof EMPTY_OBJECT;
 
 export const PgFakeConstraintsPlugin: GraphileConfig.Plugin = {
   name: "PgFakeConstraintsPlugin",
@@ -44,10 +46,13 @@ export const PgFakeConstraintsPlugin: GraphileConfig.Plugin = {
   version: version,
   after: ["smart-tags"],
 
-  gather: {
+  gather: gatherConfig({
     namespace: "pgFakeConstraints",
     helpers: {},
-    initialState: () => ({
+    initialCache(): Cache {
+      return EMPTY_OBJECT;
+    },
+    initialState: (): State => ({
       fakeId: 0,
     }),
     hooks: {
@@ -101,7 +106,7 @@ export const PgFakeConstraintsPlugin: GraphileConfig.Plugin = {
         }
       },
     },
-  } as GraphileConfig.PluginGatherConfig<"pgFakeConstraints", State, Cache>,
+  }),
 };
 
 function parseConstraintSpec(rawSpec: string) {