@graphcommerce/graphql-codegen-relay-optimizer-plugin 2.101.2 → 2.102.2

package/dist/main/index.d.ts

@@ -0,0 +1,4 @@
+import { PluginFunction } from '@graphql-codegen/plugin-helpers';
+export interface RelayOptimizerPluginConfig {
+}
+export declare const plugin: PluginFunction<RelayOptimizerPluginConfig>;

package/dist/main/index.js

@@ -0,0 +1,88 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.plugin = void 0;
+var graphql_1 = require("graphql");
+var relay_compiler_1 = require("relay-compiler");
+var CompilerContext_1 = __importDefault(require("relay-compiler/lib/core/CompilerContext"));
+var IRPrinter_1 = require("relay-compiler/lib/core/IRPrinter");
+var Schema_1 = require("relay-compiler/lib/core/Schema");
+var ApplyFragmentArgumentTransform_1 = require("relay-compiler/lib/transforms/ApplyFragmentArgumentTransform");
+var FlattenTransform_1 = require("relay-compiler/lib/transforms/FlattenTransform");
+var InlineFragmentsTransform_1 = require("relay-compiler/lib/transforms/InlineFragmentsTransform");
+var SkipRedundantNodesTransform_1 = require("relay-compiler/lib/transforms/SkipRedundantNodesTransform");
+function isFragment(documentFile) {
+    var name = false;
+    (0, graphql_1.visit)(documentFile.document, {
+        enter: {
+            FragmentDefinition: function () {
+                name = true;
+            },
+        },
+    });
+    return name;
+}
+var plugin = function (schema, documents, _config) {
+    var isFrag = documents.every(function (d) { return isFragment(d); });
+    if (isFrag)
+        return { content: '' };
+    // @TODO way for users to define directives they use, otherwise relay will throw an unknown directive error
+    // Maybe we can scan the queries and add them dynamically without users having to do some extra stuff
+    // transformASTSchema creates a new schema instance instead of mutating the old one
+    var adjustedSchema = (0, Schema_1.create)((0, graphql_1.printSchema)(schema)).extend([
+        /* GraphQL */ "\n      directive @connection(key: String!, filter: [String!]) on FIELD\n      directive @client on FIELD\n    ",
+    ]);
+    var documentAsts = documents.reduce(function (prev, v) { var _a, _b; return __spreadArray(__spreadArray([], prev, true), ((_b = (_a = v.document) === null || _a === void 0 ? void 0 : _a.definitions) !== null && _b !== void 0 ? _b : []), true); }, []);
+    var relayDocuments = relay_compiler_1.Parser.transform(adjustedSchema, documentAsts);
+    var fragmentCompilerContext = new CompilerContext_1.default(adjustedSchema).addAll(relayDocuments);
+    var fragmentDocuments = fragmentCompilerContext
+        .applyTransforms([
+        ApplyFragmentArgumentTransform_1.transform,
+        (0, FlattenTransform_1.transformWithOptions)({ flattenAbstractTypes: false }),
+        SkipRedundantNodesTransform_1.transform,
+    ])
+        .documents()
+        .filter(function (doc) { return doc.kind === 'Fragment'; });
+    var queryCompilerContext = new CompilerContext_1.default(adjustedSchema)
+        .addAll(relayDocuments)
+        .applyTransforms([
+        ApplyFragmentArgumentTransform_1.transform,
+        InlineFragmentsTransform_1.transform,
+        (0, FlattenTransform_1.transformWithOptions)({ flattenAbstractTypes: false }),
+        SkipRedundantNodesTransform_1.transform,
+    ]);
+    var newQueryDocuments = queryCompilerContext.documents().map(function (doc) { return ({
+        location: 'optimized by relay',
+        document: (0, graphql_1.parse)((0, IRPrinter_1.print)(adjustedSchema, doc)),
+    }); });
+    var newDocuments = [];
+    if (newQueryDocuments.length === 0) {
+        return { content: '' };
+    }
+    if (newQueryDocuments.length === 1) {
+        newDocuments = newQueryDocuments;
+    }
+    else {
+        newDocuments = __spreadArray(__spreadArray([], fragmentDocuments.map(function (doc) { return ({
+            location: 'optimized by relay',
+            document: (0, graphql_1.parse)((0, IRPrinter_1.print)(adjustedSchema, doc)),
+        }); }), true), newQueryDocuments, true);
+    }
+    documents.splice(0, documents.length);
+    documents.push.apply(documents, newDocuments);
+    return {
+        content: '',
+    };
+};
+exports.plugin = plugin;

package/dist/module/index.d.ts

@@ -0,0 +1,4 @@
+import { PluginFunction } from '@graphql-codegen/plugin-helpers';
+export interface RelayOptimizerPluginConfig {
+}
+export declare const plugin: PluginFunction<RelayOptimizerPluginConfig>;

package/dist/module/index.js

@@ -0,0 +1,78 @@
+import { parse, printSchema, visit } from 'graphql';
+import { Parser as RelayParser } from 'relay-compiler';
+import CompilerContext from 'relay-compiler/lib/core/CompilerContext';
+import { print as relayPrint } from 'relay-compiler/lib/core/IRPrinter';
+import { create as relayCreate } from 'relay-compiler/lib/core/Schema';
+import { transform as applyFragmentArgumentTransform } from 'relay-compiler/lib/transforms/ApplyFragmentArgumentTransform';
+import { transformWithOptions as flattenTransformWithOptions } from 'relay-compiler/lib/transforms/FlattenTransform';
+import { transform as inlineFragmentsTransform } from 'relay-compiler/lib/transforms/InlineFragmentsTransform';
+import { transform as skipRedundantNodesTransform } from 'relay-compiler/lib/transforms/SkipRedundantNodesTransform';
+function isFragment(documentFile) {
+    let name = false;
+    visit(documentFile.document, {
+        enter: {
+            FragmentDefinition: () => {
+                name = true;
+            },
+        },
+    });
+    return name;
+}
+export const plugin = (schema, documents, _config) => {
+    const isFrag = documents.every((d) => isFragment(d));
+    if (isFrag)
+        return { content: '' };
+    // @TODO way for users to define directives they use, otherwise relay will throw an unknown directive error
+    // Maybe we can scan the queries and add them dynamically without users having to do some extra stuff
+    // transformASTSchema creates a new schema instance instead of mutating the old one
+    const adjustedSchema = relayCreate(printSchema(schema)).extend([
+        /* GraphQL */ `
+      directive @connection(key: String!, filter: [String!]) on FIELD
+      directive @client on FIELD
+    `,
+    ]);
+    const documentAsts = documents.reduce((prev, v) => { var _a, _b; return [...prev, ...((_b = (_a = v.document) === null || _a === void 0 ? void 0 : _a.definitions) !== null && _b !== void 0 ? _b : [])]; }, []);
+    const relayDocuments = RelayParser.transform(adjustedSchema, documentAsts);
+    const fragmentCompilerContext = new CompilerContext(adjustedSchema).addAll(relayDocuments);
+    const fragmentDocuments = fragmentCompilerContext
+        .applyTransforms([
+        applyFragmentArgumentTransform,
+        flattenTransformWithOptions({ flattenAbstractTypes: false }),
+        skipRedundantNodesTransform,
+    ])
+        .documents()
+        .filter((doc) => doc.kind === 'Fragment');
+    const queryCompilerContext = new CompilerContext(adjustedSchema)
+        .addAll(relayDocuments)
+        .applyTransforms([
+        applyFragmentArgumentTransform,
+        inlineFragmentsTransform,
+        flattenTransformWithOptions({ flattenAbstractTypes: false }),
+        skipRedundantNodesTransform,
+    ]);
+    const newQueryDocuments = queryCompilerContext.documents().map((doc) => ({
+        location: 'optimized by relay',
+        document: parse(relayPrint(adjustedSchema, doc)),
+    }));
+    let newDocuments = [];
+    if (newQueryDocuments.length === 0) {
+        return { content: '' };
+    }
+    if (newQueryDocuments.length === 1) {
+        newDocuments = newQueryDocuments;
+    }
+    else {
+        newDocuments = [
+            ...fragmentDocuments.map((doc) => ({
+                location: 'optimized by relay',
+                document: parse(relayPrint(adjustedSchema, doc)),
+            })),
+            ...newQueryDocuments,
+        ];
+    }
+    documents.splice(0, documents.length);
+    documents.push(...newDocuments);
+    return {
+        content: '',
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphcommerce/graphql-codegen-relay-optimizer-plugin",
-  "version": "2.101.2",
+  "version": "2.102.2",
   "description": "GraphQL Code Generator plugin for optimizing your GraphQL queries relay style.",
   "license": "MIT",
   "main": "dist/main/index.js",
@@ -20,13 +20,13 @@
     "relay-compiler": "12.0.0"
   },
   "devDependencies": {
-    "@graphcommerce/eslint-config-pwa": "^3.0.2",
+    "@graphcommerce/eslint-config-pwa": "^3.0.4",
     "@graphcommerce/prettier-config-pwa": "^3.0.2",
     "@graphql-codegen/testing": "1.17.7",
-    "@types/jest": "27.0.1",
+    "@types/jest": "27.0.2",
     "@types/relay-compiler": "8.0.1",
     "graphql": "^15.6.0",
-    "jest": "27.2.2",
+    "jest": "27.2.4",
     "ts-jest": "27.0.5",
     "typescript": "^4.4.3"
   },
@@ -35,7 +35,8 @@
     "dev": "tsc --preserveWatchOutput --watch --sourceMap --outDir dist/main",
     "build:module": "tsc --target es2017 --outDir dist/module",
     "build:main": "tsc --target es5 --outDir dist/main",
-    "build": "yarn build:module && yarn build:main"
+    "build": "yarn build:module && yarn build:main",
+    "prepack": "yarn build"
   },
   "prettier": "@graphcommerce/prettier-config-pwa",
   "browserslist": [
@@ -52,8 +53,9 @@
   },
   "files": [
     "dist/**/*",
+    "src",
     "LICENSE",
     "README.md"
   ],
-  "gitHead": "c1aca21f6830cb9e4ec906e0f3f905623d977918"
+  "gitHead": "cf2b61fa96aca043ff841b018334ca8c28e5e6cf"
 }

package/src/__tests__/index.spec.ts

@@ -0,0 +1,149 @@
+/* eslint-disable @typescript-eslint/ban-ts-ignore */
+import '@graphql-codegen/testing'
+
+import { Types } from '@graphql-codegen/plugin-helpers'
+import { buildSchema, parse, print, ASTNode } from 'graphql'
+import { plugin } from '..'
+
+const testSchema = buildSchema(/* GraphQL */ `
+  type Avatar {
+    id: ID!
+    url: String!
+  }
+
+  type User {
+    id: ID!
+    login: String!
+    avatar(height: Int!, width: Int!): Avatar
+  }
+
+  type Query {
+    user: User!
+    users: [User!]!
+  }
+`)
+
+// eslint-disable-next-line jest/expect-expect
+it('can be called', async () => {
+  const testDocument = parse(/* GraphQL */ `
+    query user {
+      user {
+        id
+      }
+    }
+  `)
+  await plugin(testSchema, [{ document: testDocument }], {})
+})
+
+// eslint-disable-next-line jest/expect-expect
+it('can be called with queries that include connection fragments', async () => {
+  const testDocument = parse(/* GraphQL */ `
+    query user {
+      users @connection(key: "foo") {
+        id
+      }
+    }
+  `)
+  await plugin(testSchema, [{ document: testDocument }], {})
+})
+
+it('can inline @argumentDefinitions/@arguments annotated fragments', async () => {
+  const fragmentDocument = parse(/* GraphQL */ `
+    fragment UserLogin on User
+    @argumentDefinitions(
+      height: { type: "Int", defaultValue: 10 }
+      width: { type: "Int", defaultValue: 10 }
+    ) {
+      id
+      login
+      avatar(width: $width, height: $height) {
+        id
+        url
+      }
+    }
+  `)
+  const queryDocument = parse(/* GraphQL */ `
+    query user {
+      users {
+        ...UserLogin @arguments(height: 30, width: 30)
+      }
+    }
+  `)
+  const input: Types.DocumentFile[] = [{ document: fragmentDocument }, { document: queryDocument }]
+  await plugin(testSchema, input, {})
+  const queryDoc = input.find((doc) => doc.document?.definitions[0].kind === 'OperationDefinition')
+
+  expect(queryDoc).toBeDefined()
+  expect(print(queryDoc?.document as ASTNode)).toBeSimilarStringTo(/* GraphQL */ `
+    query user {
+      users {
+        id
+        login
+        avatar(width: 30, height: 30) {
+          id
+          url
+        }
+      }
+    }
+  `)
+})
+
+it('handles unions with interfaces the correct way', async () => {
+  const schema = buildSchema(/* GraphQL */ `
+    type User {
+      id: ID!
+      login: String!
+    }
+
+    interface Error {
+      message: String!
+    }
+
+    type UserNotFoundError implements Error {
+      message: String!
+    }
+
+    type UserBlockedError implements Error {
+      message: String!
+    }
+
+    union UserResult = User | UserNotFoundError | UserBlockedError
+
+    type Query {
+      user: UserResult!
+    }
+  `)
+
+  const queryDocument = parse(/* GraphQL */ `
+    query user {
+      user {
+        ... on User {
+          id
+          login
+        }
+        ... on Error {
+          message
+        }
+      }
+    }
+  `)
+
+  const input: Types.DocumentFile[] = [{ document: queryDocument }]
+  await plugin(schema, input, {})
+  const queryDoc = input.find((doc) => doc.document?.definitions[0].kind === 'OperationDefinition')
+
+  expect(queryDoc).toBeDefined()
+  expect(print(queryDoc?.document as ASTNode)).toBeSimilarStringTo(/* GraphQL */ `
+    query user {
+      user {
+        ... on User {
+          id
+          login
+        }
+        ... on Error {
+          message
+        }
+      }
+    }
+  `)
+})

package/src/index.ts

@@ -0,0 +1,104 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { Types, PluginFunction } from '@graphql-codegen/plugin-helpers'
+import { GraphQLSchema, parse, printSchema, DefinitionNode, visit } from 'graphql'
+
+import { Parser as RelayParser } from 'relay-compiler'
+import CompilerContext from 'relay-compiler/lib/core/CompilerContext'
+import { print as relayPrint } from 'relay-compiler/lib/core/IRPrinter'
+import { create as relayCreate } from 'relay-compiler/lib/core/Schema'
+
+import { transform as applyFragmentArgumentTransform } from 'relay-compiler/lib/transforms/ApplyFragmentArgumentTransform'
+import { transformWithOptions as flattenTransformWithOptions } from 'relay-compiler/lib/transforms/FlattenTransform'
+import { transform as inlineFragmentsTransform } from 'relay-compiler/lib/transforms/InlineFragmentsTransform'
+import { transform as skipRedundantNodesTransform } from 'relay-compiler/lib/transforms/SkipRedundantNodesTransform'
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface RelayOptimizerPluginConfig {}
+
+function isFragment(documentFile: Types.DocumentFile) {
+  let name = false
+
+  visit(documentFile.document!, {
+    enter: {
+      FragmentDefinition: () => {
+        name = true
+      },
+    },
+  })
+  return name
+}
+
+export const plugin: PluginFunction<RelayOptimizerPluginConfig> = (
+  schema: GraphQLSchema,
+  documents: Types.DocumentFile[],
+  _config: RelayOptimizerPluginConfig,
+) => {
+  const isFrag = documents.every((d) => isFragment(d))
+
+  if (isFrag) return { content: '' }
+
+  // @TODO way for users to define directives they use, otherwise relay will throw an unknown directive error
+  // Maybe we can scan the queries and add them dynamically without users having to do some extra stuff
+  // transformASTSchema creates a new schema instance instead of mutating the old one
+  const adjustedSchema = relayCreate(printSchema(schema)).extend([
+    /* GraphQL */ `
+      directive @connection(key: String!, filter: [String!]) on FIELD
+      directive @client on FIELD
+    `,
+  ])
+
+  const documentAsts = documents.reduce(
+    (prev, v) => [...prev, ...(v.document?.definitions ?? [])],
+    [] as DefinitionNode[],
+  )
+
+  const relayDocuments = RelayParser.transform(adjustedSchema, documentAsts)
+
+  const fragmentCompilerContext = new CompilerContext(adjustedSchema).addAll(relayDocuments)
+
+  const fragmentDocuments = fragmentCompilerContext
+    .applyTransforms([
+      applyFragmentArgumentTransform,
+      flattenTransformWithOptions({ flattenAbstractTypes: false }),
+      skipRedundantNodesTransform,
+    ])
+    .documents()
+    .filter((doc) => doc.kind === 'Fragment')
+
+  const queryCompilerContext = new CompilerContext(adjustedSchema)
+    .addAll(relayDocuments)
+    .applyTransforms([
+      applyFragmentArgumentTransform,
+      inlineFragmentsTransform,
+      flattenTransformWithOptions({ flattenAbstractTypes: false }),
+      skipRedundantNodesTransform,
+    ])
+
+  const newQueryDocuments: Types.DocumentFile[] = queryCompilerContext.documents().map((doc) => ({
+    location: 'optimized by relay',
+    document: parse(relayPrint(adjustedSchema, doc)),
+  }))
+
+  let newDocuments: Types.DocumentFile[] = []
+  if (newQueryDocuments.length === 0) {
+    return { content: '' }
+  }
+  if (newQueryDocuments.length === 1) {
+    newDocuments = newQueryDocuments
+  } else {
+    newDocuments = [
+      ...fragmentDocuments.map((doc) => ({
+        location: 'optimized by relay',
+        document: parse(relayPrint(adjustedSchema, doc)),
+      })),
+      ...newQueryDocuments,
+    ]
+  }
+
+  documents.splice(0, documents.length)
+  documents.push(...newDocuments)
+
+  return {
+    content: '',
+  }
+}

package/src/tyes.d.ts

@@ -0,0 +1,12 @@
+declare module 'relay-compiler/lib/core/Schema' {
+  export function create(schema: string): import('relay-compiler').Schema
+}
+
+declare module 'relay-compiler/lib/core/IRPrinter' {
+  export function print(schema: import('relay-compiler').Schema, document: any): string
+}
+
+declare module 'relay-compiler/lib/core/CompilerContext' {
+  let CompilerContext: typeof import('relay-compiler').CompilerContext
+  export = CompilerContext
+}