Remove nullableBoundary LP; replace with executable boundaries

.changeset/violet-jars-exercise.md

@@ -0,0 +1,11 @@
+---
+"graphile-build": patch
+"graphile-build-pg": patch
+"postgraphile": patch
+"@dataplan/pg": patch
+---
+
+Start migrating away from `applyPlan`/`inputPlan`, when adding an argument to a
+field you can now augment the field's plan resolver via
+`context.addToPlanResolver` hook. Use this and other changes to move handling of
+orderBy to runtime from plantime.

grafast/dataplan-json/src/steps/jsonParse.ts

@@ -5,7 +5,7 @@ import type {
   GrafastResultsList,
   PromiseOrDirect,
 } from "grafast";
-import { access, ExecutableStep, exportAs } from "grafast";
+import { access, exportAs, Step } from "grafast";
 
 export type JSONValue =
   | string
@@ -19,9 +19,7 @@ export type JSONValue =
  * This plan accepts as JSON string as its only input and will result in the
  * parsed JSON object (or array, boolean, string, etc).
  */
-export class JSONParseStep<
-  TJSON extends JSONValue,
-> extends ExecutableStep<TJSON> {
+export class JSONParseStep<TJSON extends JSONValue> extends Step<TJSON> {
   static $$export = {
     moduleName: "@dataplan/json",
     exportName: "JSONParseStep",
@@ -30,7 +28,7 @@ export class JSONParseStep<
   // promise.
   isSyncAndSafe = false;
 
-  constructor($stringPlan: ExecutableStep<string | null>) {
+  constructor($stringPlan: Step<string | null>) {
     super();
     this.addDependency($stringPlan);
   }
@@ -85,7 +83,7 @@ export class JSONParseStep<
  * parsed JSON object (or array, boolean, string, etc).
  */
 export function jsonParse<TJSON extends JSONValue>(
-  $string: ExecutableStep<string | null>,
+  $string: Step<string | null>,
 ): JSONParseStep<TJSON> {
   return new JSONParseStep<TJSON>($string);
 }

grafast/dataplan-pg/__tests__/helpers.ts

@@ -49,8 +49,19 @@ import {
  * We go beyond what Jest snapshots allow; so we have to manage it ourselves.
  * If UPDATE_SNAPSHOTS is set then we'll write updated snapshots, otherwise
  * we'll do the default behaviour of comparing to existing snapshots.
+ *
+ * Set UPDATE_SNAPSHOTS=1 to update all snapshots. Alternatively, set it to a
+ * comma separated list of snapshot types to update.
  */
-export const UPDATE_SNAPSHOTS = process.env.UPDATE_SNAPSHOTS === "1";
+const { UPDATE_SNAPSHOTS } = process.env;
+const updateSnapshotExtensions = UPDATE_SNAPSHOTS?.split(",");
+function shouldUpdateSnapshot(filePath: string) {
+  // Never update snapshots in CI
+  if (process.env.CI) return false;
+  if (UPDATE_SNAPSHOTS === "1") return true;
+  if (!updateSnapshotExtensions) return false;
+  return updateSnapshotExtensions.some((e) => filePath.endsWith(e));
+}
 
 const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
@@ -391,7 +402,7 @@ async function snapshot(actual: string, filePath: string) {
   } catch (e) {
     /* noop */
   }
-  if (expected == null || UPDATE_SNAPSHOTS) {
+  if (expected == null || shouldUpdateSnapshot(filePath)) {
     if (expected !== actual) {
       console.warn(`Updated snapshot in '${filePath}'`);
       await fsp.writeFile(filePath, actual);

grafast/dataplan-pg/__tests__/mutations/basics/create-relational-post-default-description.deopt.mermaid

@@ -21,31 +21,35 @@ graph TD
     Constant11{{"Constant[11∈0] ➊<br />ᐸ2ᐳ"}}:::plan
     Constant34{{"Constant[34∈0] ➊<br />ᐸ'My Relational Post'ᐳ"}}:::plan
     Constant35{{"Constant[35∈0] ➊<br />ᐸ'Such a great post.'ᐳ"}}:::plan
-    PgInsertSingle17[["PgInsertSingle[17∈1] ➊<br />ᐸrelational_posts(id,title,note)ᐳ"]]:::sideeffectplan
+    PgInsertSingle18[["PgInsertSingle[18∈1] ➊<br />ᐸrelational_posts(id,title,description,note)ᐳ"]]:::sideeffectplan
     PgClassExpression16{{"PgClassExpression[16∈1] ➊<br />ᐸ__relation...ems__.”id”ᐳ"}}:::plan
-    Object15 & PgClassExpression16 & Constant34 & Constant35 --> PgInsertSingle17
+    Object15 & PgClassExpression16 & Constant34 & Constant35 --> PgInsertSingle18
     PgInsertSingle12[["PgInsertSingle[12∈1] ➊<br />ᐸrelational_items(type,author_id)ᐳ"]]:::sideeffectplan
     Object15 & Constant10 & Constant11 --> PgInsertSingle12
-    PgInsertSingle12 --> PgClassExpression16
-    PgClassExpression21{{"PgClassExpression[21∈1] ➊<br />ᐸ__relational_posts__ᐳ"}}:::plan
-    PgInsertSingle17 --> PgClassExpression21
-    PgSelect23[["PgSelect[23∈2] ➊<br />ᐸrelational_postsᐳ"]]:::plan
-    PgClassExpression22{{"PgClassExpression[22∈2] ➊<br />ᐸ(__relatio...ts__).”id”ᐳ"}}:::plan
-    Object15 & PgClassExpression22 --> PgSelect23
-    PgInsertSingle17 --> PgClassExpression22
-    First27{{"First[27∈2] ➊"}}:::plan
-    PgSelectRows28[["PgSelectRows[28∈2] ➊"]]:::plan
+    PgSelect25[["PgSelect[25∈1] ➊<br />ᐸrelational_postsᐳ"]]:::plan
+    PgClassExpression24{{"PgClassExpression[24∈1] ➊<br />ᐸ(__relatio...ts__).”id”ᐳ"}}:::plan
+    Object15 & PgClassExpression24 --> PgSelect25
+    Access17{{"Access[17∈1] ➊<br />ᐸ12.tᐳ"}}:::plan
+    Access17 --> PgClassExpression16
+    PgInsertSingle12 --> Access17
+    PgClassExpression22{{"PgClassExpression[22∈1] ➊<br />ᐸ__relational_posts__ᐳ"}}:::plan
+    Access23{{"Access[23∈1] ➊<br />ᐸ18.tᐳ"}}:::plan
+    Access23 --> PgClassExpression22
+    PgInsertSingle18 --> Access23
+    Access23 --> PgClassExpression24
+    First27{{"First[27∈1] ➊"}}:::plan
+    PgSelectRows28[["PgSelectRows[28∈1] ➊"]]:::plan
     PgSelectRows28 --> First27
-    PgSelect23 --> PgSelectRows28
-    PgSelectSingle29{{"PgSelectSingle[29∈2] ➊<br />ᐸrelational_postsᐳ"}}:::plan
+    PgSelect25 --> PgSelectRows28
+    PgSelectSingle29{{"PgSelectSingle[29∈1] ➊<br />ᐸrelational_postsᐳ"}}:::plan
     First27 --> PgSelectSingle29
-    PgClassExpression30{{"PgClassExpression[30∈3] ➊<br />ᐸ__relation...sts__.”id”ᐳ"}}:::plan
+    PgClassExpression30{{"PgClassExpression[30∈1] ➊<br />ᐸ__relation...sts__.”id”ᐳ"}}:::plan
     PgSelectSingle29 --> PgClassExpression30
-    PgClassExpression31{{"PgClassExpression[31∈3] ➊<br />ᐸ__relation...__.”title”ᐳ"}}:::plan
+    PgClassExpression31{{"PgClassExpression[31∈1] ➊<br />ᐸ__relation...__.”title”ᐳ"}}:::plan
     PgSelectSingle29 --> PgClassExpression31
-    PgClassExpression32{{"PgClassExpression[32∈3] ➊<br />ᐸ__relation...scription”ᐳ"}}:::plan
+    PgClassExpression32{{"PgClassExpression[32∈1] ➊<br />ᐸ__relation...scription”ᐳ"}}:::plan
     PgSelectSingle29 --> PgClassExpression32
-    PgClassExpression33{{"PgClassExpression[33∈3] ➊<br />ᐸ__relation...s__.”note”ᐳ"}}:::plan
+    PgClassExpression33{{"PgClassExpression[33∈1] ➊<br />ᐸ__relation...s__.”note”ᐳ"}}:::plan
     PgSelectSingle29 --> PgClassExpression33
 
     %% define steps
@@ -54,16 +58,8 @@ graph TD
     Bucket0("Bucket 0 (root)"):::bucket
     classDef bucket0 stroke:#696969
     class Bucket0,__Value2,__Value4,Constant10,Constant11,Access13,Access14,Object15,Constant34,Constant35 bucket0
-    Bucket1("Bucket 1 (mutationField)<br />Deps: 15, 10, 11, 34, 35<br /><br />1: PgInsertSingle[12]<br />2: PgClassExpression[16]<br />3: PgInsertSingle[17]<br />4: <br />ᐳ: PgClassExpression[21]"):::bucket
+    Bucket1("Bucket 1 (mutationField)<br />Deps: 15, 10, 11, 34, 8, 35<br /><br />1: PgInsertSingle[12]<br />2: Access[17]<br />3: PgClassExpression[16]<br />4: PgInsertSingle[18]<br />5: <br />ᐳ: 23, 22, 24<br />6: PgSelect[25]<br />7: PgSelectRows[28]<br />ᐳ: 27, 29, 30, 31, 32, 33"):::bucket
     classDef bucket1 stroke:#00bfff
-    class Bucket1,PgInsertSingle12,PgClassExpression16,PgInsertSingle17,PgClassExpression21 bucket1
-    Bucket2("Bucket 2 (nullableBoundary)<br />Deps: 17, 15, 21<br /><br />ROOT PgClassExpression{1}ᐸ__relational_posts__ᐳ[21]<br />1: <br />ᐳ: PgClassExpression[22]<br />2: PgSelect[23]<br />3: PgSelectRows[28]<br />ᐳ: First[27], PgSelectSingle[29]"):::bucket
-    classDef bucket2 stroke:#7f007f
-    class Bucket2,PgClassExpression22,PgSelect23,First27,PgSelectRows28,PgSelectSingle29 bucket2
-    Bucket3("Bucket 3 (nullableBoundary)<br />Deps: 29<br /><br />ROOT PgSelectSingle{2}ᐸrelational_postsᐳ[29]"):::bucket
-    classDef bucket3 stroke:#ffa500
-    class Bucket3,PgClassExpression30,PgClassExpression31,PgClassExpression32,PgClassExpression33 bucket3
+    class Bucket1,PgInsertSingle12,PgClassExpression16,Access17,PgInsertSingle18,PgClassExpression22,Access23,PgClassExpression24,PgSelect25,First27,PgSelectRows28,PgSelectSingle29,PgClassExpression30,PgClassExpression31,PgClassExpression32,PgClassExpression33 bucket1
     Bucket0 --> Bucket1
-    Bucket1 --> Bucket2
-    Bucket2 --> Bucket3
     end

grafast/dataplan-pg/__tests__/mutations/basics/create-relational-post-default-description.mermaid

@@ -21,31 +21,35 @@ graph TD
     Constant11{{"Constant[11∈0] ➊<br />ᐸ2ᐳ"}}:::plan
     Constant34{{"Constant[34∈0] ➊<br />ᐸ'My Relational Post'ᐳ"}}:::plan
     Constant35{{"Constant[35∈0] ➊<br />ᐸ'Such a great post.'ᐳ"}}:::plan
-    PgInsertSingle17[["PgInsertSingle[17∈1] ➊<br />ᐸrelational_posts(id,title,note)ᐳ"]]:::sideeffectplan
+    PgInsertSingle18[["PgInsertSingle[18∈1] ➊<br />ᐸrelational_posts(id,title,description,note)ᐳ"]]:::sideeffectplan
     PgClassExpression16{{"PgClassExpression[16∈1] ➊<br />ᐸ__relation...ems__.”id”ᐳ"}}:::plan
-    Object15 & PgClassExpression16 & Constant34 & Constant35 --> PgInsertSingle17
+    Object15 & PgClassExpression16 & Constant34 & Constant35 --> PgInsertSingle18
     PgInsertSingle12[["PgInsertSingle[12∈1] ➊<br />ᐸrelational_items(type,author_id)ᐳ"]]:::sideeffectplan
     Object15 & Constant10 & Constant11 --> PgInsertSingle12
-    PgInsertSingle12 --> PgClassExpression16
-    PgClassExpression21{{"PgClassExpression[21∈1] ➊<br />ᐸ__relational_posts__ᐳ"}}:::plan
-    PgInsertSingle17 --> PgClassExpression21
-    PgSelect23[["PgSelect[23∈2] ➊<br />ᐸrelational_postsᐳ"]]:::plan
-    PgClassExpression22{{"PgClassExpression[22∈2] ➊<br />ᐸ(__relatio...ts__).”id”ᐳ"}}:::plan
-    Object15 & PgClassExpression22 --> PgSelect23
-    PgInsertSingle17 --> PgClassExpression22
-    First27{{"First[27∈2] ➊"}}:::plan
-    PgSelectRows28[["PgSelectRows[28∈2] ➊"]]:::plan
+    PgSelect25[["PgSelect[25∈1] ➊<br />ᐸrelational_postsᐳ"]]:::plan
+    PgClassExpression24{{"PgClassExpression[24∈1] ➊<br />ᐸ(__relatio...ts__).”id”ᐳ"}}:::plan
+    Object15 & PgClassExpression24 --> PgSelect25
+    Access17{{"Access[17∈1] ➊<br />ᐸ12.tᐳ"}}:::plan
+    Access17 --> PgClassExpression16
+    PgInsertSingle12 --> Access17
+    PgClassExpression22{{"PgClassExpression[22∈1] ➊<br />ᐸ__relational_posts__ᐳ"}}:::plan
+    Access23{{"Access[23∈1] ➊<br />ᐸ18.tᐳ"}}:::plan
+    Access23 --> PgClassExpression22
+    PgInsertSingle18 --> Access23
+    Access23 --> PgClassExpression24
+    First27{{"First[27∈1] ➊"}}:::plan
+    PgSelectRows28[["PgSelectRows[28∈1] ➊"]]:::plan
     PgSelectRows28 --> First27
-    PgSelect23 --> PgSelectRows28
-    PgSelectSingle29{{"PgSelectSingle[29∈2] ➊<br />ᐸrelational_postsᐳ"}}:::plan
+    PgSelect25 --> PgSelectRows28
+    PgSelectSingle29{{"PgSelectSingle[29∈1] ➊<br />ᐸrelational_postsᐳ"}}:::plan
     First27 --> PgSelectSingle29
-    PgClassExpression30{{"PgClassExpression[30∈3] ➊<br />ᐸ__relation...sts__.”id”ᐳ"}}:::plan
+    PgClassExpression30{{"PgClassExpression[30∈1] ➊<br />ᐸ__relation...sts__.”id”ᐳ"}}:::plan
     PgSelectSingle29 --> PgClassExpression30
-    PgClassExpression31{{"PgClassExpression[31∈3] ➊<br />ᐸ__relation...__.”title”ᐳ"}}:::plan
+    PgClassExpression31{{"PgClassExpression[31∈1] ➊<br />ᐸ__relation...__.”title”ᐳ"}}:::plan
     PgSelectSingle29 --> PgClassExpression31
-    PgClassExpression32{{"PgClassExpression[32∈3] ➊<br />ᐸ__relation...scription”ᐳ"}}:::plan
+    PgClassExpression32{{"PgClassExpression[32∈1] ➊<br />ᐸ__relation...scription”ᐳ"}}:::plan
     PgSelectSingle29 --> PgClassExpression32
-    PgClassExpression33{{"PgClassExpression[33∈3] ➊<br />ᐸ__relation...s__.”note”ᐳ"}}:::plan
+    PgClassExpression33{{"PgClassExpression[33∈1] ➊<br />ᐸ__relation...s__.”note”ᐳ"}}:::plan
     PgSelectSingle29 --> PgClassExpression33
 
     %% define steps
@@ -54,16 +58,8 @@ graph TD
     Bucket0("Bucket 0 (root)"):::bucket
     classDef bucket0 stroke:#696969
     class Bucket0,__Value2,__Value4,Constant10,Constant11,Access13,Access14,Object15,Constant34,Constant35 bucket0
-    Bucket1("Bucket 1 (mutationField)<br />Deps: 15, 10, 11, 34, 35<br /><br />1: PgInsertSingle[12]<br />2: PgClassExpression[16]<br />3: PgInsertSingle[17]<br />4: <br />ᐳ: PgClassExpression[21]"):::bucket
+    Bucket1("Bucket 1 (mutationField)<br />Deps: 15, 10, 11, 34, 8, 35<br /><br />1: PgInsertSingle[12]<br />2: Access[17]<br />3: PgClassExpression[16]<br />4: PgInsertSingle[18]<br />5: <br />ᐳ: 23, 22, 24<br />6: PgSelect[25]<br />7: PgSelectRows[28]<br />ᐳ: 27, 29, 30, 31, 32, 33"):::bucket
     classDef bucket1 stroke:#00bfff
-    class Bucket1,PgInsertSingle12,PgClassExpression16,PgInsertSingle17,PgClassExpression21 bucket1
-    Bucket2("Bucket 2 (nullableBoundary)<br />Deps: 17, 15, 21<br /><br />ROOT PgClassExpression{1}ᐸ__relational_posts__ᐳ[21]<br />1: <br />ᐳ: PgClassExpression[22]<br />2: PgSelect[23]<br />3: PgSelectRows[28]<br />ᐳ: First[27], PgSelectSingle[29]"):::bucket
-    classDef bucket2 stroke:#7f007f
-    class Bucket2,PgClassExpression22,PgSelect23,First27,PgSelectRows28,PgSelectSingle29 bucket2
-    Bucket3("Bucket 3 (nullableBoundary)<br />Deps: 29<br /><br />ROOT PgSelectSingle{2}ᐸrelational_postsᐳ[29]"):::bucket
-    classDef bucket3 stroke:#ffa500
-    class Bucket3,PgClassExpression30,PgClassExpression31,PgClassExpression32,PgClassExpression33 bucket3
+    class Bucket1,PgInsertSingle12,PgClassExpression16,Access17,PgInsertSingle18,PgClassExpression22,Access23,PgClassExpression24,PgSelect25,First27,PgSelectRows28,PgSelectSingle29,PgClassExpression30,PgClassExpression31,PgClassExpression32,PgClassExpression33 bucket1
     Bucket0 --> Bucket1
-    Bucket1 --> Bucket2
-    Bucket2 --> Bucket3
     end