fix(smart-tags): enable using Smart Tags with @foreignkey and @PrimaryKey (#586)

* Turn flow off

* Fix smart tags problem

Author: benjie

.flowconfig

@@ -3,6 +3,7 @@
 <PROJECT_ROOT>/packages/.*/index\.js\.flow
 <PROJECT_ROOT>/packages/.*/node8plus/.*\.flow
 <PROJECT_ROOT>/postgraphile
+<PROJECT_ROOT>/packages
 
 [include]
 

packages/graphile-build-pg/src/plugins/PgBasicsPlugin.js

@@ -321,6 +321,7 @@ export default (function PgBasicsPlugin(
     pgIgnoreIndexes = true, // TODO:v5: change this to false
     pgHideIndexWarnings = false,
     pgLegacyJsonUuid = false, // TODO:v5: remove this
+    pgAugmentIntrospectionResults,
   }
 ) {
   let pgOmit = baseOmit;
@@ -354,6 +355,7 @@ export default (function PgBasicsPlugin(
         pgField,
         sqlCommentByAddingTags,
         pgPrepareAndRun,
+        pgAugmentIntrospectionResults,
       });
     },
     ["PgBasics"]

packages/graphile-build-pg/src/plugins/PgIntrospectionPlugin.js

@@ -444,6 +444,20 @@ function smartCommentConstraints(introspectionResults) {
   });
 }
 
+/* The argument to this must not contain cyclic references! */
+const deepClone = value => {
+  if (Array.isArray(value)) {
+    return value.map(val => deepClone(val));
+  } else if (typeof value === "object" && value) {
+    return Object.keys(value).reduce((memo, k) => {
+      memo[k] = deepClone(value[k]);
+      return memo;
+    }, {});
+  } else {
+    return value;
+  }
+};
+
 export default (async function PgIntrospectionPlugin(
   builder,
   {
@@ -455,15 +469,9 @@ export default (async function PgIntrospectionPlugin(
     pgIncludeExtensionResources = false,
     pgLegacyFunctionsOnly = false,
     pgSkipInstallingWatchFixtures = false,
-    pgAugmentIntrospectionResults,
     pgOwnerConnectionString,
   }
 ) {
-  const augment = introspectionResults => {
-    [pgAugmentIntrospectionResults, smartCommentConstraints].forEach(fn =>
-      fn ? fn(introspectionResults) : null
-    );
-  };
   /**
    * @summary introspect database and get the table/view/constraints.
    * @returns {Promise<PgIntrospectionResultsByKind>}
@@ -474,14 +482,7 @@ export default (async function PgIntrospectionPlugin(
       throw new Error("Argument 'schemas' (array) is required");
     }
     const cacheKey = `PgIntrospectionPlugin-introspectionResultsByKind-v${version}`;
-    const cloneResults = obj => {
-      const result = Object.keys(obj).reduce((memo, k) => {
-        memo[k] = Array.isArray(obj[k]) ? obj[k].map(v => ({ ...v })) : obj[k];
-        return memo;
-      }, {});
-      return result;
-    };
-    const introspectionResultsByKind = cloneResults(
+    const introspectionResultsByKind = deepClone(
       await persistentMemoizeWithKey(cacheKey, () =>
         withPgClient(pgConfig, async pgClient => {
           const versionResult = await pgClient.query(
@@ -579,6 +580,14 @@ export default (async function PgIntrospectionPlugin(
         console.warn("⚠️ WARNING⚠️  " + errorMessage); // eslint-disable-line no-console
       }
     }
+    return introspectionResultsByKind;
+  }
+
+  function introspectionResultsFromRaw(
+    rawResults,
+    pgAugmentIntrospectionResults
+  ) {
+    const introspectionResultsByKind = deepClone(rawResults);
 
     const xByY = (arrayOfX, attrKey) =>
       arrayOfX.reduce((memo, x) => {
@@ -650,6 +659,11 @@ export default (async function PgIntrospectionPlugin(
       });
     };
 
+    const augment = introspectionResults => {
+      [pgAugmentIntrospectionResults, smartCommentConstraints].forEach(fn =>
+        fn ? fn(introspectionResults) : null
+      );
+    };
     augment(introspectionResultsByKind);
 
     relate(
@@ -826,7 +840,7 @@ export default (async function PgIntrospectionPlugin(
     return introspectionResultsByKind;
   }
 
-  let introspectionResultsByKind = await introspect();
+  let rawIntrospectionResultsByKind = await introspect();
 
   let listener;
 
@@ -842,7 +856,7 @@ export default (async function PgIntrospectionPlugin(
         async () => {
           debug(`Schema change detected: re-inspecting schema...`);
           try {
-            introspectionResultsByKind = await introspect();
+            rawIntrospectionResultsByKind = await introspect();
             debug(`Schema change detected: re-inspecting schema complete`);
             triggerRebuild();
           } catch (e) {
@@ -1037,6 +1051,10 @@ export default (async function PgIntrospectionPlugin(
   builder.hook(
     "build",
     build => {
+      const introspectionResultsByKind = introspectionResultsFromRaw(
+        rawIntrospectionResultsByKind,
+        build.pgAugmentIntrospectionResults
+      );
       if (introspectionResultsByKind.__pgVersion < 90500) {
         // TODO:v5: remove this workaround
         // This is a bit of a hack, but until we have plugin priorities it's the

packages/graphile-utils/src/makePgSmartTagsPlugin.ts

@@ -1,5 +1,9 @@
-import { Build, Plugin } from "graphile-build";
-import { PgEntityKind, PgEntity } from "graphile-build-pg";
+import { Plugin } from "graphile-build";
+import {
+  PgEntityKind,
+  PgEntity,
+  PgIntrospectionResultsByKind,
+} from "graphile-build-pg";
 import { inspect } from "util";
 import { entityIsIdentifiedBy } from "./introspectionHelpers";
 
@@ -116,39 +120,57 @@ export function makePgSmartTagsPlugin(
       );
     }
 
-    builder.hook("build", (build: Build) => {
-      const { pgIntrospectionResultsByKind } = build;
-      rules.forEach((rule, idx) => {
-        const relevantIntrospectionResults: PgEntity[] =
-          pgIntrospectionResultsByKind[rule.kind];
-
-        let hits = 0;
-        relevantIntrospectionResults.forEach(entity => {
-          if (!rule.match(entity)) {
-            return;
-          }
-          hits++;
-          if (rule.tags) {
-            // Overwrite relevant tags
-            Object.assign(entity.tags, rule.tags);
-          }
-          if (rule.description != null) {
-            // Overwrite comment if specified
-            entity.description = rule.description;
+    builder.hook(
+      "build",
+      build => {
+        const oldPgAugmentIntrospectionResults =
+          build.pgAugmentIntrospectionResults;
+        build.pgAugmentIntrospectionResults = (
+          inIntrospectionResult: PgIntrospectionResultsByKind
+        ): PgIntrospectionResultsByKind => {
+          let pgIntrospectionResultsByKind = inIntrospectionResult;
+          if (oldPgAugmentIntrospectionResults) {
+            pgIntrospectionResultsByKind = oldPgAugmentIntrospectionResults(
+              pgIntrospectionResultsByKind
+            );
           }
-        });
+          rules.forEach((rule, idx) => {
+            const relevantIntrospectionResults: PgEntity[] =
+              pgIntrospectionResultsByKind[rule.kind];
 
-        // Let people know if their rules don't match; it's probably a mistake.
-        if (hits === 0) {
-          console.warn(
-            `WARNING: there were no matches for makePgSmartTagsPlugin rule ${idx} - ${inspect(
-              rawRules[idx]
-            )}`
-          );
-        }
-      });
-      return build;
-    });
+            let hits = 0;
+            relevantIntrospectionResults.forEach(entity => {
+              if (!rule.match(entity)) {
+                return;
+              }
+              hits++;
+              if (rule.tags) {
+                // Overwrite relevant tags
+                Object.assign(entity.tags, rule.tags);
+              }
+              if (rule.description != null) {
+                // Overwrite comment if specified
+                entity.description = rule.description;
+              }
+            });
+
+            // Let people know if their rules don't match; it's probably a mistake.
+            if (hits === 0) {
+              console.warn(
+                `WARNING: there were no matches for makePgSmartTagsPlugin rule ${idx} - ${inspect(
+                  rawRules[idx]
+                )}`
+              );
+            }
+          });
+          return pgIntrospectionResultsByKind;
+        };
+        return build;
+      },
+      [],
+      ["PgIntrospection"],
+      ["PgBasics"]
+    );
   };
   return plugin;
 }