feat(utils): add makePgSmartTagsPlugin (#541)

Author: benjie

packages/graphile-build-pg/src/index.d.ts

@@ -9,6 +9,8 @@ import {
   PgExtension,
   PgIndex,
   PgIntrospectionResultsByKind,
+  PgEntity,
+  PgEntityKind,
 } from "./plugins/PgIntrospectionPlugin";
 
 export {
@@ -21,6 +23,8 @@ export {
   PgExtension,
   PgIndex,
   PgIntrospectionResultsByKind,
+  PgEntity,
+  PgEntityKind,
 };
 
 export function formatSQLForDebugging(sql: string): string;

packages/graphile-build-pg/src/index.js

@@ -1,6 +1,8 @@
 // @flow
 import PgBasicsPlugin from "./plugins/PgBasicsPlugin";
-import PgIntrospectionPlugin from "./plugins/PgIntrospectionPlugin";
+import PgIntrospectionPlugin, {
+  PgEntityKind,
+} from "./plugins/PgIntrospectionPlugin";
 import PgTypesPlugin from "./plugins/PgTypesPlugin";
 import PgJWTPlugin from "./plugins/PgJWTPlugin";
 import PgTablesPlugin from "./plugins/PgTablesPlugin";
@@ -81,6 +83,9 @@ export const defaultPlugins = [
 
 export { inflections };
 
+// TypeScript compatibility
+export { PgEntityKind };
+
 export {
   PgBasicsPlugin,
   PgIntrospectionPlugin,

packages/graphile-build-pg/src/plugins/PgIntrospectionPlugin.d.ts

@@ -1,7 +1,17 @@
 import { SchemaBuilder, Options } from "graphile-build";
+export enum PgEntityKind {
+  NAMESPACE = "namespace",
+  PROCEDURE = "procedure",
+  CLASS = "class",
+  TYPE = "type",
+  ATTRIBUTE = "attribute",
+  CONSTRAINT = "constraint",
+  EXTENSION = "extension",
+  INDEX = "index",
+}
 
 export interface PgNamespace {
-  kind: "namespace";
+  kind: PgEntityKind.NAMESPACE;
   id: string;
   name: string;
   comment: string | void;
@@ -10,7 +20,7 @@ export interface PgNamespace {
 }
 
 export interface PgProc {
-  kind: "procedure";
+  kind: PgEntityKind.PROCEDURE;
   id: string;
   name: string;
   comment: string | void;
@@ -34,7 +44,7 @@ export interface PgProc {
 }
 
 export interface PgClass {
-  kind: "class";
+  kind: PgEntityKind.CLASS;
   id: string;
   name: string;
   comment: string | void;
@@ -63,7 +73,7 @@ export interface PgClass {
 }
 
 export interface PgType {
-  kind: "type";
+  kind: PgEntityKind.TYPE;
   id: string;
   name: string;
   comment: string | void;
@@ -87,7 +97,7 @@ export interface PgType {
 }
 
 export interface PgAttribute {
-  kind: "attribute";
+  kind: PgEntityKind.ATTRIBUTE;
   classId: string;
   num: number;
   name: string;
@@ -111,7 +121,7 @@ export interface PgAttribute {
 }
 
 export interface PgConstraint {
-  kind: "constraint";
+  kind: PgEntityKind.CONSTRAINT;
   id: string;
   name: string;
   type: string;
@@ -131,7 +141,7 @@ export interface PgConstraint {
 }
 
 export interface PgExtension {
-  kind: "extension";
+  kind: PgEntityKind.EXTENSION;
   id: string;
   name: string;
   namespaceId: string;
@@ -145,7 +155,7 @@ export interface PgExtension {
 }
 
 export interface PgIndex {
-  kind: "index";
+  kind: PgEntityKind.INDEX;
   id: string;
   name: string;
   namespaceName: string;

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

@@ -1054,3 +1054,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",
+};

packages/graphile-utils/src/index.ts

@@ -19,6 +19,7 @@ export {
   Resolvers,
   ExtensionDefinition,
 } from "./makeExtendSchemaPlugin";
+export * from "./makePgSmartTagsPlugin";
 export {
   embed,
   gql,

packages/graphile-utils/src/introspectionHelpers.ts

@@ -0,0 +1,68 @@
+import {
+  PgClass,
+  PgEntityKind,
+  PgConstraint,
+  PgAttribute,
+  PgEntity,
+  PgProc,
+} from "graphile-build-pg";
+import parseIdentifierParts from "./parseIdentifierParts";
+
+export function isAttribute(obj: PgEntity): obj is PgAttribute {
+  return obj.kind === PgEntityKind.ATTRIBUTE;
+}
+
+export function isConstraint(obj: PgEntity): obj is PgConstraint {
+  return obj.kind === PgEntityKind.CONSTRAINT;
+}
+
+export function isClass(obj: PgEntity): obj is PgClass {
+  return obj.kind === PgEntityKind.CLASS;
+}
+
+export function isProcedure(obj: PgEntity): obj is PgProc {
+  return obj.kind === PgEntityKind.PROCEDURE;
+}
+
+export function entityIsIdentifiedBy(
+  obj: PgEntity,
+  identifier: string
+): boolean {
+  const parts = parseIdentifierParts(identifier);
+  if (parts.length === 1) {
+    const [expectedName] = parts;
+    return obj.name === expectedName;
+  } else if (parts.length === 2) {
+    const [parentName, expectedName] = parts;
+    if (isAttribute(obj) || isConstraint(obj)) {
+      // Parent is a table
+      return obj.name === expectedName && obj.class.name === parentName;
+    } else if (isClass(obj) || isProcedure(obj)) {
+      // Parent is a schema
+      return obj.name === expectedName && obj.namespaceName === parentName;
+    } else {
+      throw new Error(
+        `Type '${obj.kind}' not supported by makeSmartCommentsPlugin`
+      );
+    }
+  } else if (parts.length === 3) {
+    const [grandparentName, parentName, expectedName] = parts;
+    if (isAttribute(obj) || isConstraint(obj)) {
+      // Parent is a table, grandparent is a schema
+      return (
+        obj.name === expectedName &&
+        obj.class.name === parentName &&
+        obj.class.namespaceName === grandparentName
+      );
+    } else {
+      // Parent is a schema; grandparent doesn't make sense
+      throw new Error(
+        `Identifier '${identifier}' does not make sense for a '${obj.kind}' entity`
+      );
+    }
+  } else {
+    throw new Error(
+      `makeSmartCommentsPlugin did not know how to interpret match '${identifier}'`
+    );
+  }
+}