@graphql-inspector/core 3.1.0 → 3.1.3

package/README.md

@@ -36,17 +36,17 @@ import {
   Change,
   InvalidDocument,
   SimilarMap,
-  SchemaCoverage,
-} from '@graphql-inspector/core';
+  SchemaCoverage
+} from '@graphql-inspector/core'
 
 // diff
-const changes: Change[] = diff(schemaA, schemaB);
+const changes: Change[] = diff(schemaA, schemaB)
 // validate
-const invalid: InvalidDocument[] = validate(documentsGlob, schema);
+const invalid: InvalidDocument[] = validate(documentsGlob, schema)
 // similar
-const similar: SimilarMap = similar(schema, typename, threshold);
+const similar: SimilarMap = similar(schema, typename, threshold)
 // coverage
-const schemaCoverage: SchemaCoverage = coverage(schema, documents);
+const schemaCoverage: SchemaCoverage = coverage(schema, documents)
 // ...
 ```
 

package/dist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Kamil Kisiela
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/README.md

@@ -0,0 +1,55 @@
+# GraphQL Inspector
+
+[![CircleCI](https://circleci.com/gh/kamilkisiela/graphql-inspector.svg?style=shield&circle-token=d1cd06aba321ee2b7bf8bd2041104643639463b0)](https://circleci.com/gh/kamilkisiela/graphql-inspector)
+[![npm version](https://badge.fury.io/js/@graphql-inspector/core.svg)](https://npmjs.com/package/@graphql-inspector/core)
+
+**GraphQL Inspector** ouputs a list of changes between two GraphQL schemas. Every change is precisely explained and marked as breaking, non-breaking or dangerous.
+It helps you validate documents and fragments against a schema and even find similar or duplicated types.
+
+## Features
+
+Major features:
+
+- **Compares schemas**
+- **Finds breaking or dangerous changes**
+- **Validates documents against a schema**
+- **Finds similar / duplicated types**
+- **Schema coverage based on documents**
+- **Serves a GraphQL server with faked data and GraphQL Playground**
+
+GraphQL Inspector has a **CLI** and also a **programatic API**, so you can use it however you want to and even build tools on top of it.
+
+## Installation
+
+```bash
+yarn add @graphql-inspector/core
+```
+
+## Examples
+
+```typescript
+import {
+  diff,
+  validate,
+  similar,
+  coverage,
+  Change,
+  InvalidDocument,
+  SimilarMap,
+  SchemaCoverage
+} from '@graphql-inspector/core'
+
+// diff
+const changes: Change[] = diff(schemaA, schemaB)
+// validate
+const invalid: InvalidDocument[] = validate(documentsGlob, schema)
+// similar
+const similar: SimilarMap = similar(schema, typename, threshold)
+// coverage
+const schemaCoverage: SchemaCoverage = coverage(schema, documents)
+// ...
+```
+
+## License
+
+[MIT](https://github.com/kamilkisiela/graphql-inspector/blob/master/LICENSE) © Kamil Kisiela

package/{diff → dist/diff}/rules/index.d.ts

@@ -2,3 +2,4 @@ export * from './dangerous-breaking';
 export * from './suppress-removal-of-deprecated-field';
 export * from './ignore-description-changes';
 export * from './consider-usage';
+export * from './safe-unreachable';

package/{index.d.ts → dist/index.d.ts}

@@ -1,4 +1,4 @@
-export { diff, DiffRule, Rule, CompletionArgs, CompletionHandler, UsageHandler } from './diff';
+export { diff, DiffRule, Rule, CompletionArgs, CompletionHandler, UsageHandler, } from './diff';
 export { validate, InvalidDocument } from './validate';
 export { similar, SimilarMap } from './similar';
 export * from './coverage';

package/{index.js → dist/index.js}

@@ -20,7 +20,21 @@ function isEqual(a, b) {
         if (a.length !== b.length)
             return false;
         for (var index = 0; index < a.length; index++) {
-            if (a[index] !== b[index]) {
+            if (!isEqual(a[index], b[index])) {
+                return false;
+            }
+        }
+        return true;
+    }
+    if (typeof a === 'object' && typeof b === 'object') {
+        const aRecord = a;
+        const bRecord = b;
+        const aKeys = Object.keys(aRecord);
+        const bKeys = Object.keys(bRecord);
+        if (aKeys.length !== bKeys.length)
+            return false;
+        for (const key of aKeys) {
+            if (!isEqual(aRecord[key], bRecord[key])) {
                 return false;
             }
         }
@@ -35,7 +49,7 @@ function isVoid(a) {
     return typeof a === 'undefined' || a === null;
 }
 function diffArrays(a, b) {
-    return a.filter((c) => !b.some((d) => d === c));
+    return a.filter((c) => !b.some((d) => isEqual(d, c)));
 }
 function compareLists(oldList, newList, callbacks) {
     const oldMap = keyMap(oldList, ({ name }) => name);
@@ -86,7 +100,7 @@ function isDeprecated(fieldOrEnumValue) {
     if (fieldOrEnumValue.deprecationReason != null) {
         return true;
     }
-    if ((_b = (_a = fieldOrEnumValue.astNode) === null || _a === void 0 ? void 0 : _a.directives) === null || _b === void 0 ? void 0 : _b.some(directive => directive.name.value === "deprecated")) {
+    if ((_b = (_a = fieldOrEnumValue.astNode) === null || _a === void 0 ? void 0 : _a.directives) === null || _b === void 0 ? void 0 : _b.some((directive) => directive.name.value === 'deprecated')) {
         return true;
     }
     return false;
@@ -204,6 +218,75 @@ function removeDirectives(node, directiveNames) {
     }
     return node;
 }
+function getReachableTypes(schema) {
+    const reachableTypes = new Set();
+    const collect = (type) => {
+        const typeName = type.name;
+        if (reachableTypes.has(typeName)) {
+            return;
+        }
+        reachableTypes.add(typeName);
+        if (graphql.isScalarType(type)) {
+            return;
+        }
+        else if (graphql.isInterfaceType(type) || graphql.isObjectType(type)) {
+            if (graphql.isInterfaceType(type)) {
+                const { objects, interfaces } = schema.getImplementations(type);
+                for (const child of objects) {
+                    collect(child);
+                }
+                for (const child of interfaces) {
+                    collect(child);
+                }
+            }
+            const fields = type.getFields();
+            for (const fieldName in fields) {
+                const field = fields[fieldName];
+                collect(resolveOutputType(field.type));
+                const args = field.args;
+                for (const argName in args) {
+                    const arg = args[argName];
+                    collect(resolveInputType(arg.type));
+                }
+            }
+        }
+        else if (graphql.isUnionType(type)) {
+            const types = type.getTypes();
+            for (const child of types) {
+                collect(child);
+            }
+        }
+        else if (graphql.isInputObjectType(type)) {
+            const fields = type.getFields();
+            for (const fieldName in fields) {
+                const field = fields[fieldName];
+                collect(resolveInputType(field.type));
+            }
+        }
+    };
+    for (const type of [
+        schema.getQueryType(),
+        schema.getMutationType(),
+        schema.getSubscriptionType(),
+    ]) {
+        if (type) {
+            collect(type);
+        }
+    }
+    return reachableTypes;
+}
+function resolveOutputType(output) {
+    if (graphql.isListType(output) || graphql.isNonNullType(output)) {
+        return resolveOutputType(output.ofType);
+    }
+    return output;
+}
+function resolveInputType(input) {
+    if (graphql.isListType(input) || graphql.isNonNullType(input)) {
+        return resolveInputType(input.ofType);
+    }
+    return input;
+}
 
 (function (ChangeType) {
     // Argument
@@ -573,7 +656,7 @@ function changesInEnum(oldEnum, newEnum, addChange) {
                     addChange(enumValueDeprecationReasonChanged(newEnum, oldValue, newValue));
                 }
             }
-        }
+        },
     });
 }
 
@@ -970,10 +1053,7 @@ function wordLetterPairs(str) {
     return flattenDeep(pairs);
 }
 function safeString(obj) {
-    if (obj != null && typeof obj.toString === 'function') {
-        return `${obj}`;
-    }
-    return inspect(obj);
+    return inspect(obj).replace(/\[Object\: null prototype\] /g, '');
 }
 
 function fieldArgumentDescriptionChanged(type, field, oldArg, newArg) {
@@ -1081,7 +1161,7 @@ function changesInField(type, oldField, newField, addChange) {
         },
         onMutual(arg) {
             changesInArgument(type, oldField, arg.oldVersion, arg.newVersion, addChange);
-        }
+        },
     });
 }
 
@@ -1344,12 +1424,26 @@ const considerUsage = ({ changes, config, }) => tslib.__awaiter(void 0, void 0,
     });
 });
 
+const safeUnreachable = ({ changes, oldSchema }) => {
+    const reachable = getReachableTypes(oldSchema);
+    return changes.map((change) => {
+        if (change.criticality.level === exports.CriticalityLevel.Breaking && change.path) {
+            const [typeName] = parsePath(change.path);
+            if (!reachable.has(typeName)) {
+                return Object.assign(Object.assign({}, change), { criticality: Object.assign(Object.assign({}, change.criticality), { level: exports.CriticalityLevel.NonBreaking }), message: 'Unreachable from root' });
+            }
+        }
+        return change;
+    });
+};
+
 const rules = /*#__PURE__*/Object.freeze({
     __proto__: null,
     dangerousBreaking: dangerousBreaking,
     suppressRemovalOfDeprecatedField: suppressRemovalOfDeprecatedField,
     ignoreDescriptionChanges: ignoreDescriptionChanges,
-    considerUsage: considerUsage
+    considerUsage: considerUsage,
+    safeUnreachable: safeUnreachable
 });
 
 const DiffRule = rules;

package/{index.mjs → dist/index.mjs}

@@ -1,5 +1,5 @@
 import { __awaiter } from 'tslib';
-import { Kind, TypeInfo, visit, visitWithTypeInfo, GraphQLError, getNamedType, isWrappingType, isListType, isNonNullType, isInterfaceType, isEnumType, isUnionType, isInputObjectType, isObjectType, isScalarType, parse, extendSchema, print, validate as validate$1, printType } from 'graphql';
+import { Kind, TypeInfo, visit, visitWithTypeInfo, GraphQLError, getNamedType, isScalarType, isInterfaceType, isObjectType, isUnionType, isInputObjectType, isListType, isNonNullType, isWrappingType, isEnumType, parse, extendSchema, print, validate as validate$1, printType } from 'graphql';
 import inspect from 'object-inspect';
 import { DepGraph } from 'dependency-graph';
 
@@ -14,7 +14,21 @@ function isEqual(a, b) {
         if (a.length !== b.length)
             return false;
         for (var index = 0; index < a.length; index++) {
-            if (a[index] !== b[index]) {
+            if (!isEqual(a[index], b[index])) {
+                return false;
+            }
+        }
+        return true;
+    }
+    if (typeof a === 'object' && typeof b === 'object') {
+        const aRecord = a;
+        const bRecord = b;
+        const aKeys = Object.keys(aRecord);
+        const bKeys = Object.keys(bRecord);
+        if (aKeys.length !== bKeys.length)
+            return false;
+        for (const key of aKeys) {
+            if (!isEqual(aRecord[key], bRecord[key])) {
                 return false;
             }
         }
@@ -29,7 +43,7 @@ function isVoid(a) {
     return typeof a === 'undefined' || a === null;
 }
 function diffArrays(a, b) {
-    return a.filter((c) => !b.some((d) => d === c));
+    return a.filter((c) => !b.some((d) => isEqual(d, c)));
 }
 function compareLists(oldList, newList, callbacks) {
     const oldMap = keyMap(oldList, ({ name }) => name);
@@ -80,7 +94,7 @@ function isDeprecated(fieldOrEnumValue) {
     if (fieldOrEnumValue.deprecationReason != null) {
         return true;
     }
-    if ((_b = (_a = fieldOrEnumValue.astNode) === null || _a === void 0 ? void 0 : _a.directives) === null || _b === void 0 ? void 0 : _b.some(directive => directive.name.value === "deprecated")) {
+    if ((_b = (_a = fieldOrEnumValue.astNode) === null || _a === void 0 ? void 0 : _a.directives) === null || _b === void 0 ? void 0 : _b.some((directive) => directive.name.value === 'deprecated')) {
         return true;
     }
     return false;
@@ -198,6 +212,75 @@ function removeDirectives(node, directiveNames) {
     }
     return node;
 }
+function getReachableTypes(schema) {
+    const reachableTypes = new Set();
+    const collect = (type) => {
+        const typeName = type.name;
+        if (reachableTypes.has(typeName)) {
+            return;
+        }
+        reachableTypes.add(typeName);
+        if (isScalarType(type)) {
+            return;
+        }
+        else if (isInterfaceType(type) || isObjectType(type)) {
+            if (isInterfaceType(type)) {
+                const { objects, interfaces } = schema.getImplementations(type);
+                for (const child of objects) {
+                    collect(child);
+                }
+                for (const child of interfaces) {
+                    collect(child);
+                }
+            }
+            const fields = type.getFields();
+            for (const fieldName in fields) {
+                const field = fields[fieldName];
+                collect(resolveOutputType(field.type));
+                const args = field.args;
+                for (const argName in args) {
+                    const arg = args[argName];
+                    collect(resolveInputType(arg.type));
+                }
+            }
+        }
+        else if (isUnionType(type)) {
+            const types = type.getTypes();
+            for (const child of types) {
+                collect(child);
+            }
+        }
+        else if (isInputObjectType(type)) {
+            const fields = type.getFields();
+            for (const fieldName in fields) {
+                const field = fields[fieldName];
+                collect(resolveInputType(field.type));
+            }
+        }
+    };
+    for (const type of [
+        schema.getQueryType(),
+        schema.getMutationType(),
+        schema.getSubscriptionType(),
+    ]) {
+        if (type) {
+            collect(type);
+        }
+    }
+    return reachableTypes;
+}
+function resolveOutputType(output) {
+    if (isListType(output) || isNonNullType(output)) {
+        return resolveOutputType(output.ofType);
+    }
+    return output;
+}
+function resolveInputType(input) {
+    if (isListType(input) || isNonNullType(input)) {
+        return resolveInputType(input.ofType);
+    }
+    return input;
+}
 
 var ChangeType;
 (function (ChangeType) {
@@ -569,7 +652,7 @@ function changesInEnum(oldEnum, newEnum, addChange) {
                     addChange(enumValueDeprecationReasonChanged(newEnum, oldValue, newValue));
                 }
             }
-        }
+        },
     });
 }
 
@@ -966,10 +1049,7 @@ function wordLetterPairs(str) {
     return flattenDeep(pairs);
 }
 function safeString(obj) {
-    if (obj != null && typeof obj.toString === 'function') {
-        return `${obj}`;
-    }
-    return inspect(obj);
+    return inspect(obj).replace(/\[Object\: null prototype\] /g, '');
 }
 
 function fieldArgumentDescriptionChanged(type, field, oldArg, newArg) {
@@ -1077,7 +1157,7 @@ function changesInField(type, oldField, newField, addChange) {
         },
         onMutual(arg) {
             changesInArgument(type, oldField, arg.oldVersion, arg.newVersion, addChange);
-        }
+        },
     });
 }
 
@@ -1340,12 +1420,26 @@ const considerUsage = ({ changes, config, }) => __awaiter(void 0, void 0, void 0
     });
 });
 
+const safeUnreachable = ({ changes, oldSchema }) => {
+    const reachable = getReachableTypes(oldSchema);
+    return changes.map((change) => {
+        if (change.criticality.level === CriticalityLevel.Breaking && change.path) {
+            const [typeName] = parsePath(change.path);
+            if (!reachable.has(typeName)) {
+                return Object.assign(Object.assign({}, change), { criticality: Object.assign(Object.assign({}, change.criticality), { level: CriticalityLevel.NonBreaking }), message: 'Unreachable from root' });
+            }
+        }
+        return change;
+    });
+};
+
 const rules = /*#__PURE__*/Object.freeze({
     __proto__: null,
     dangerousBreaking: dangerousBreaking,
     suppressRemovalOfDeprecatedField: suppressRemovalOfDeprecatedField,
     ignoreDescriptionChanges: ignoreDescriptionChanges,
-    considerUsage: considerUsage
+    considerUsage: considerUsage,
+    safeUnreachable: safeUnreachable
 });
 
 const DiffRule = rules;

package/dist/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@graphql-inspector/core",
+  "version": "3.1.3",
+  "description": "Tooling for GraphQL. Compare GraphQL Schemas, check documents, find breaking changes, find similar types.",
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
+  },
+  "dependencies": {
+    "dependency-graph": "0.11.0",
+    "object-inspect": "1.10.3",
+    "tslib": "^2.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "kamilkisiela/graphql-inspector",
+    "directory": "packages/core"
+  },
+  "keywords": [
+    "graphql",
+    "graphql-inspector",
+    "tools"
+  ],
+  "author": {
+    "name": "Kamil Kisiela",
+    "email": "kamil.kisiela@gmail.com",
+    "url": "https://github.com/kamilkisiela"
+  },
+  "license": "MIT",
+  "main": "index.js",
+  "module": "index.mjs",
+  "typings": "index.d.ts",
+  "typescript": {
+    "definition": "index.d.ts"
+  },
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs"
+    },
+    "./*": {
+      "require": "./*.js",
+      "import": "./*.mjs"
+    }
+  }
+}

package/{utils → dist/utils}/compare.d.ts

@@ -3,7 +3,6 @@ export declare function isEqual<T>(a: T, b: T): boolean;
 export declare function isNotEqual<T>(a: T, b: T): boolean;
 export declare function isVoid<T>(a: T): boolean;
 export declare function diffArrays<T>(a: T[] | readonly T[], b: T[] | readonly T[]): T[];
-export declare function unionArrays<T>(a: T[] | readonly T[], b: T[] | readonly T[]): T[];
 export declare function compareLists<T extends {
     name: string;
 }>(oldList: readonly T[], newList: readonly T[], callbacks?: {

package/{utils → dist/utils}/isDeprecated.d.ts

@@ -1,2 +1,2 @@
-import { GraphQLEnumValue, GraphQLField } from "graphql";
+import { GraphQLEnumValue, GraphQLField } from 'graphql';
 export declare function isDeprecated(fieldOrEnumValue: GraphQLField<any, any> | GraphQLEnumValue): boolean;

package/package.json

@@ -1,46 +1,52 @@
 {
   "name": "@graphql-inspector/core",
-  "version": "3.1.0",
+  "version": "3.1.3",
   "description": "Tooling for GraphQL. Compare GraphQL Schemas, check documents, find breaking changes, find similar types.",
-  "sideEffects": false,
-  "peerDependencies": {
-    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
-  },
-  "dependencies": {
-    "dependency-graph": "0.11.0",
-    "object-inspect": "1.10.3",
-    "tslib": "^2.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "kamilkisiela/graphql-inspector",
-    "directory": "packages/core"
-  },
   "keywords": [
     "graphql",
     "graphql-inspector",
     "tools"
   ],
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
+  "typings": "dist/index.d.ts",
+  "typescript": {
+    "definition": "dist/index.d.ts"
+  },
   "author": {
     "name": "Kamil Kisiela",
     "email": "kamil.kisiela@gmail.com",
     "url": "https://github.com/kamilkisiela"
   },
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
-  "typescript": {
-    "definition": "index.d.ts"
+  "repository": {
+    "type": "git",
+    "url": "kamilkisiela/graphql-inspector",
+    "directory": "packages/core"
   },
-  "exports": {
-    ".": {
-      "require": "./index.js",
-      "import": "./index.mjs"
-    },
-    "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
-    }
+  "peerDependencies": {
+    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
+  },
+  "dependencies": {
+    "dependency-graph": "0.11.0",
+    "object-inspect": "1.10.3",
+    "tslib": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/object-inspect": "1.8.0"
+  },
+  "scripts": {
+    "prepack": "bob prepack"
   }
 }

package/utils/testing.ts

@@ -0,0 +1,11 @@
+// import { findDangerousChanges } from 'graphql';
+
+import { Change } from '../src/diff/changes/change';
+
+export function findChangesByPath(changes: Change[], path: string) {
+  return changes.filter((c) => c.path === path);
+}
+
+export function findFirstChangeByPath(changes: Change[], path: string) {
+  return findChangesByPath(changes, path)[0];
+}