Merge branch 'rh389-feature/graphql-15-compat'

.circleci/config.yml

@@ -12,7 +12,7 @@ workflows:
           # definitions for field extensions in older @types/graphql versions
           matrix:
             parameters:
-              graphql-version: ["~0.13", "~14.0", "~14.5", "~14.6"]
+              graphql-version: ["~0.13", "~14.0", "~14.5", "~14.6", "~15.0"]
       - test-and-build:
           # Leave graphql-version unspecified to respect the lockfile and also run tsc
           name: test-and-build-with-typecheck

README.md

@@ -83,10 +83,6 @@ or write your own:
     schema definition (for example via GraphQL SDL)
 *   **[`fieldExtensionsEstimator`](src/estimators/fieldExtensions/README.md):** The field extensions estimator lets you set a numeric value or a custom estimator
     function in the field config extensions of your schema. 
-*   **[`fieldConfigEstimator`](src/estimators/fieldConfig/README.md):** (DEPRECATED) The field config estimator lets you set a numeric value or a custom estimator
-    function in the field config of your schema. 
-*   **[`legacyEstimator`](src/estimators/legacy/README.md):** (DEPRECATED) The legacy estimator implements the logic of previous versions. Can be used
-    to gradually migrate your codebase to new estimators. 
 *   PRs welcome...
 
 Consult the documentation of each estimator for information about how to use them. 

package.json

@@ -20,7 +20,7 @@
     "lodash.get": "^4.4.2"
   },
   "peerDependencies": {
-    "graphql": "^0.13.0 || ^14.0.0"
+    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0"
   },
   "files": [
     "dist",
@@ -41,14 +41,13 @@
   "devDependencies": {
     "@types/assert": "^1.4.6",
     "@types/chai": "^4.2.11",
-    "@types/graphql": "^0.13.0 || ^14.0.0",
     "@types/lodash.get": "^4.4.6",
     "@types/mocha": "^7.0.2",
     "@typescript-eslint/eslint-plugin": "^2.27.0",
     "@typescript-eslint/parser": "^2.27.0",
     "chai": "^4.2.0",
     "eslint": "^6.8.0",
-    "graphql": "^0.13.0 || ^14.0.0",
+    "graphql": "^14.5.0 || ^15.0.0",
     "mocha": "^7.1.1",
     "rimraf": "^3.0.2",
     "ts-node": "^8.8.2",

src/QueryComplexity.ts

@@ -29,10 +29,6 @@ import {
   getNamedType,
   GraphQLError
 } from 'graphql';
-import {
-  simpleEstimator,
-  legacyEstimator
-} from './estimators';
 
 declare module 'graphql/type/definition' {
   export interface GraphQLField<TSource, TContext, TArgs = { [argName: string]: any }> {
@@ -72,7 +68,7 @@ export interface QueryComplexityOptions {
   createError?: (max: number, actual: number) => GraphQLError,
 
   // An array of complexity estimators to use for estimating the complexity
-  estimators?: Array<ComplexityEstimator>;
+  estimators: Array<ComplexityEstimator>;
 }
 
 function queryComplexityMessage(max: number, actual: number): string {
@@ -91,7 +87,7 @@ export function getComplexity(options: {
 }): number {
   const typeInfo = new TypeInfo(options.schema);
 
-  const context = new ValidationContext(options.schema, options.query, typeInfo);
+  const context = new ValidationContext(options.schema, options.query, typeInfo, () => null);
   const visitor = new QueryComplexity(context, {
     // Maximum complexity does not matter since we're only interested in the calculated complexity.
     maximumComplexity: Infinity,
@@ -127,17 +123,7 @@ export default class QueryComplexity {
 
     this.includeDirectiveDef = this.context.getSchema().getDirective('include');
     this.skipDirectiveDef = this.context.getSchema().getDirective('skip');
-
-    if (!options.estimators) {
-      console.warn(
-        'DEPRECATION WARNING: Estimators should be configured in the queryComplexity options.'
-      );
-    }
-
-    this.estimators = options.estimators || [
-      legacyEstimator(),
-      simpleEstimator()
-    ];
+    this.estimators = options.estimators
 
     this.OperationDefinition = {
       enter: this.onOperationDefinitionEnter,
@@ -178,7 +164,7 @@ export default class QueryComplexity {
     if (typeof this.options.operationName === 'string' && this.options.operationName !== operation.name.value) {
       return;
     }
-    
+
     if (this.options.onComplete) {
       this.options.onComplete(this.complexity);
     }

src/__tests__/QueryComplexity-test.ts

@@ -5,7 +5,6 @@
 import {
   parse,
   TypeInfo,
-  ValidationContext,
   visit,
   visitWithTypeInfo,
 } from 'graphql';
@@ -18,8 +17,9 @@ import ComplexityVisitor, {getComplexity} from '../QueryComplexity';
 import {
   simpleEstimator,
   directiveEstimator,
-  fieldConfigEstimator,
+  fieldExtensionsEstimator,
 } from '../index';
+import { CompatibleValidationContext } from './fixtures/CompatibleValidationContext';
 
 describe('QueryComplexity analysis', () => {
   const typeInfo = new TypeInfo(schema);
@@ -135,7 +135,7 @@ describe('QueryComplexity analysis', () => {
 
     const complexity = getComplexity({
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({defaultComplexity: 1})
       ],
       schema,
@@ -154,7 +154,7 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
@@ -173,11 +173,11 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({
           defaultComplexity: 1
         })
@@ -203,11 +203,11 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({
           defaultComplexity: 1
         })
@@ -230,11 +230,11 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({
           defaultComplexity: 1
         })
@@ -257,11 +257,11 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({
           defaultComplexity: 1
         })
@@ -284,11 +284,11 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({
           defaultComplexity: 1
         })
@@ -310,11 +310,11 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({
           defaultComplexity: 1
         })
@@ -332,11 +332,11 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({
           defaultComplexity: 1
         })
@@ -353,11 +353,11 @@ describe('QueryComplexity analysis', () => {
             requiredArgs
         }
       `);
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({
           defaultComplexity: 1
         })
@@ -374,7 +374,7 @@ describe('QueryComplexity analysis', () => {
             scalar
         }
       `);
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: []
@@ -393,11 +393,11 @@ describe('QueryComplexity analysis', () => {
             scalar
         }
       `);
-    const context = new ValidationContext(schema, ast, typeInfo);
+    const context = new CompatibleValidationContext(schema, ast, typeInfo);
     const visitor = new ComplexityVisitor(context, {
       maximumComplexity: 100,
       estimators: [
-        fieldConfigEstimator()
+        fieldExtensionsEstimator()
       ]
     });
     visit(ast, visitWithTypeInfo(typeInfo, visitor));
@@ -463,7 +463,7 @@ describe('QueryComplexity analysis', () => {
 
     const complexity1 = getComplexity({
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({defaultComplexity: 1})
       ],
       schema,
@@ -473,7 +473,7 @@ describe('QueryComplexity analysis', () => {
 
     const complexity2 = getComplexity({
       estimators: [
-        fieldConfigEstimator(),
+        fieldExtensionsEstimator(),
         simpleEstimator({defaultComplexity: 1})
       ],
       schema,

src/__tests__/fixtures/CompatibleValidationContext.ts

@@ -0,0 +1,28 @@
+import { GraphQLError, TypeInfo, ValidationContext } from "graphql";
+import { GraphQLSchema } from "graphql/type/schema";
+import { DocumentNode } from "graphql/language/ast";
+
+/**
+ * This class is used to test that validation errors are raised correctly
+ *
+ * A compatibility layer is necessary to support graphql versions since 15.0.0
+ * *as well as* versions prior to 14.5.0 with the same test, because older
+ * versions of `ValidationContext` only expose a `getErrors` API and newer
+ * versions only expose the `onError` API via a fourth constructor argument.
+ *
+ * Once we drop support for versions older than 14.5.0 this layer will no
+ * longer be necessary and tests may use `ValidationContext` directly using the
+ * `onError` API.
+ */
+export class CompatibleValidationContext extends ValidationContext {
+    private errors: GraphQLError[] = []
+
+    constructor(schema: GraphQLSchema, ast: DocumentNode, typeInfo: TypeInfo) {
+        super(schema, ast, typeInfo, err => this.errors.push(err));
+    }
+
+    getErrors(): ReadonlyArray<GraphQLError> {
+        // @ts-ignore
+        return super.getErrors ? super.getErrors() : this.errors
+    }
+}

src/__tests__/fixtures/schema.ts

@@ -21,18 +21,22 @@ const Item: GraphQLObjectType = new GraphQLObjectType({
   fields: () => ({
     variableList: {
       type: Item,
-      complexity: (args: ComplexityEstimatorArgs) => args.childComplexity * (args.args.count || 10),
+      extensions: {
+        complexity: (args: ComplexityEstimatorArgs) => args.childComplexity * (args.args.count || 10)
+      },
       args: {
         count: {
           type: GraphQLInt
         }
       }
     },
     scalar: { type: GraphQLString },
-    complexScalar: { type: GraphQLString, complexity: 20 },
+    complexScalar: { type: GraphQLString, extensions: { complexity: 20 } },
     variableScalar: {
       type: Item,
-      complexity: (args: ComplexityEstimatorArgs) => 10 * (args.args.count || 10),
+      extensions: {
+        complexity: (args: ComplexityEstimatorArgs) => 10 * (args.args.count || 10)
+      },
       args: {
         count: {
           type: GraphQLInt
@@ -97,7 +101,9 @@ const Query = new GraphQLObjectType({
     name: { type: GraphQLString },
     variableList: {
       type: Item,
-      complexity: (args: ComplexityEstimatorArgs) => args.childComplexity * (args.args.count || 10),
+      extensions: {
+        complexity: (args: ComplexityEstimatorArgs) => args.childComplexity * (args.args.count || 10)
+      },
       args: {
         count: {
           type: GraphQLInt
@@ -107,11 +113,13 @@ const Query = new GraphQLObjectType({
     interface: {type: NameInterface},
     enum: {type: EnumType},
     scalar: { type: GraphQLString },
-    complexScalar: { type: GraphQLString, complexity: 20 },
+    complexScalar: { type: GraphQLString, extensions: { complexity: 20 } },
     union: { type: Union },
     variableScalar: {
       type: Item,
-      complexity: (args: ComplexityEstimatorArgs) => 10 * (args.args.count || 10),
+      extensions: {
+        complexity: (args: ComplexityEstimatorArgs) => 10 * (args.args.count || 10)
+      },
       args: {
         count: {
           type: GraphQLInt