graphile-build-pg 4.4.5 → 4.5.3

package/node8plus/plugins/PgIntrospectionPlugin.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.PgEntityKind = exports.default = void 0;
 
 var _withPgClient = _interopRequireWildcard(require("../withPgClient"));
 
@@ -233,6 +233,21 @@ 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;
+  }
+};
 
 var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
   pgConfig,
@@ -243,13 +258,12 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
   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>}
+   */
   async function introspect() {
     // Perform introspection
     if (!Array.isArray(schemas)) {
@@ -257,17 +271,7 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
     }
 
     const cacheKey = `PgIntrospectionPlugin-introspectionResultsByKind-v${_package.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((await persistentMemoizeWithKey(cacheKey, () => (0, _withPgClient.default)(pgConfig, async pgClient => {
+    const introspectionResultsByKind = deepClone((await persistentMemoizeWithKey(cacheKey, () => (0, _withPgClient.default)(pgConfig, async pgClient => {
       const versionResult = await pgClient.query("show server_version_num;");
       const serverVersionNum = parseInt(versionResult.rows[0].server_version_num, 10);
       const introspectionQuery = (0, _introspectionQuery.makeIntrospectionQuery)(serverVersionNum, {
@@ -331,6 +335,12 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
       }
     }
 
+    return introspectionResultsByKind;
+  }
+
+  function introspectionResultsFromRaw(rawResults, pgAugmentIntrospectionResults) {
+    const introspectionResultsByKind = deepClone(rawResults);
+
     const xByY = (arrayOfX, attrKey) => arrayOfX.reduce((memo, x) => {
       memo[x[attrKey]] = x;
       return memo;
@@ -382,6 +392,10 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
       });
     };
 
+    const augment = introspectionResults => {
+      [pgAugmentIntrospectionResults, smartCommentConstraints].forEach(fn => fn ? fn(introspectionResults) : null);
+    };
+
     augment(introspectionResultsByKind);
     relate(introspectionResultsByKind.class, "namespace", "namespaceId", introspectionResultsByKind.namespaceById, true // Because it could be a type defined in a different namespace - which is fine so long as we don't allow querying it directly
     );
@@ -452,7 +466,7 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
     return introspectionResultsByKind;
   }
 
-  let introspectionResultsByKind = await introspect();
+  let rawIntrospectionResultsByKind = await introspect();
   let listener;
 
   class Listener {
@@ -462,7 +476,7 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
         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) {
@@ -479,7 +493,7 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
       this._start();
     }
 
-    async _start() {
+    async _start(isReconnect = false) {
       if (this.stopped) {
         return;
       } // Connect to DB
@@ -527,7 +541,9 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
           } // Trigger re-introspection on server reconnect
 
 
-          this._handleChange();
+          if (isReconnect) {
+            this._handleChange();
+          }
         }
       } catch (e) {
         // If something goes wrong, disconnect and try again after a short delay
@@ -554,7 +570,7 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
       setTimeout(() => {
         if (!this.stopped) {
           // Listen for further changes
-          this._start();
+          this._start(true);
         }
       }, 2000);
     } // eslint-disable-next-line flowtype/no-weak-types
@@ -641,6 +657,8 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
     }
   });
   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
@@ -654,7 +672,19 @@ var PgIntrospectionPlugin = async function PgIntrospectionPlugin(builder, {
       pgIntrospectionResultsByKind: introspectionResultsByKind
     });
   }, ["PgIntrospection"], [], ["PgBasics"]);
-};
+}; // TypeScript compatibility
+
 
 exports.default = PgIntrospectionPlugin;
+const PgEntityKind = {
+  NAMESPACE: "namespace",
+  PROCEDURE: "procedure",
+  CLASS: "class",
+  TYPE: "type",
+  ATTRIBUTE: "attribute",
+  CONSTRAINT: "constraint",
+  EXTENSION: "extension",
+  INDEX: "index"
+};
+exports.PgEntityKind = PgEntityKind;
 //# sourceMappingURL=PgIntrospectionPlugin.js.map

package/node8plus/plugins/PgIntrospectionPlugin.js.flow

@@ -71,9 +71,9 @@ export type PgClass = {
   namespace: PgNamespace,
   type: PgType,
   tags: { [string]: string },
-  attributes: [PgAttribute],
-  constraints: [PgConstraint],
-  foreignConstraints: [PgConstraint],
+  attributes: Array<PgAttribute>,
+  constraints: Array<PgConstraint>,
+  foreignConstraints: Array<PgConstraint>,
   primaryKeyConstraint: ?PgConstraint,
   aclSelectable: boolean,
   aclInsertable: boolean,
@@ -142,9 +142,9 @@ export type PgConstraint = {
   comment: ?string,
   description: ?string,
   keyAttributeNums: Array<number>,
-  keyAttributes: [PgAttribute],
+  keyAttributes: Array<PgAttribute>,
   foreignKeyAttributeNums: Array<number>,
-  foreignKeyAttributes: [PgAttribute],
+  foreignKeyAttributes: Array<PgAttribute>,
   namespace: PgNamespace,
   isIndexed: ?boolean,
   tags: { [string]: string },
@@ -182,6 +182,7 @@ export type PgIndex = {
   isReplicaIdentity: boolean,
   isValid: boolean,
   */
+  isPartial: boolean,
   attributeNums: Array<number>,
   attributePropertiesAsc: ?Array<boolean>,
   attributePropertiesNullsFirst: ?Array<boolean>,
@@ -199,6 +200,25 @@ export type PgEntity =
   | PgExtension
   | PgIndex;
 
+export type PgIntrospectionResultsByKind = {
+  __pgVersion: number,
+  attribute: PgAttribute[],
+  attributeByClassIdAndNum: {
+    [classId: string]: { [num: string]: PgAttribute },
+  },
+  class: PgClass[],
+  classById: { [classId: string]: PgClass },
+  constraint: PgConstraint[],
+  extension: PgExtension[],
+  extensionById: { [extId: string]: PgExtension },
+  index: PgIndex[],
+  namespace: PgNamespace[],
+  namespaceById: { [namespaceId: string]: PgNamespace },
+  procedure: PgProc[],
+  type: PgType[],
+  typeById: { [typeId: string]: PgType },
+};
+
 function readFile(filename, encoding) {
   return new Promise((resolve, reject) => {
     rawReadFile(filename, encoding, (err, res) => {
@@ -424,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,
   {
@@ -435,29 +469,20 @@ export default (async function PgIntrospectionPlugin(
     pgIncludeExtensionResources = false,
     pgLegacyFunctionsOnly = false,
     pgSkipInstallingWatchFixtures = false,
-    pgAugmentIntrospectionResults,
     pgOwnerConnectionString,
   }
 ) {
-  const augment = introspectionResults => {
-    [pgAugmentIntrospectionResults, smartCommentConstraints].forEach(fn =>
-      fn ? fn(introspectionResults) : null
-    );
-  };
-  async function introspect() {
+  /**
+   * @summary introspect database and get the table/view/constraints.
+   * @returns {Promise<PgIntrospectionResultsByKind>}
+   */
+  async function introspect(): Promise<PgIntrospectionResultsByKind> {
     // Perform introspection
     if (!Array.isArray(schemas)) {
       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(
@@ -555,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) => {
@@ -626,6 +659,11 @@ export default (async function PgIntrospectionPlugin(
       });
     };
 
+    const augment = introspectionResults => {
+      [pgAugmentIntrospectionResults, smartCommentConstraints].forEach(fn =>
+        fn ? fn(introspectionResults) : null
+      );
+    };
     augment(introspectionResultsByKind);
 
     relate(
@@ -802,7 +840,7 @@ export default (async function PgIntrospectionPlugin(
     return introspectionResultsByKind;
   }
 
-  let introspectionResultsByKind = await introspect();
+  let rawIntrospectionResultsByKind = await introspect();
 
   let listener;
 
@@ -818,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) {
@@ -837,7 +875,7 @@ export default (async function PgIntrospectionPlugin(
       this._start();
     }
 
-    async _start() {
+    async _start(isReconnect = false) {
       if (this.stopped) {
         return;
       }
@@ -897,7 +935,9 @@ export default (async function PgIntrospectionPlugin(
           }
 
           // Trigger re-introspection on server reconnect
-          this._handleChange();
+          if (isReconnect) {
+            this._handleChange();
+          }
         }
       } catch (e) {
         // If something goes wrong, disconnect and try again after a short delay
@@ -925,7 +965,7 @@ export default (async function PgIntrospectionPlugin(
       setTimeout(() => {
         if (!this.stopped) {
           // Listen for further changes
-          this._start();
+          this._start(true);
         }
       }, 2000);
     }
@@ -1011,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
@@ -1028,3 +1072,15 @@ export default (async function PgIntrospectionPlugin(
     ["PgBasics"]
   );
 }: Plugin);
+
+// TypeScript compatibility
+export const PgEntityKind = {
+  NAMESPACE: "namespace",
+  PROCEDURE: "procedure",
+  CLASS: "class",
+  TYPE: "type",
+  ATTRIBUTE: "attribute",
+  CONSTRAINT: "constraint",
+  EXTENSION: "extension",
+  INDEX: "index",
+};