@graphql-inspector/action 3.4.13 → 3.4.14

package/cjs/commands/validate/src/index.js

@@ -8,7 +8,7 @@ const graphql_1 = require("graphql");
 const commands_1 = require("@graphql-inspector/commands");
 const core_1 = require("@graphql-inspector/core");
 const logger_1 = require("@graphql-inspector/logger");
-function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }) {
+function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, validateComplexityConfig, }) {
     let invalidDocuments = (0, core_1.validate)(schema, documents.map(doc => new graphql_1.Source((0, graphql_1.print)(doc.document), doc.location)), {
         strictFragments,
         maxDepth,
@@ -17,6 +17,7 @@ function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCou
         maxTokenCount,
         apollo,
         keepClientFields,
+        validateComplexityConfig,
     });
     if (!invalidDocuments.length) {
         logger_1.Logger.success('All documents are valid');
@@ -163,6 +164,25 @@ exports.default = (0, commands_1.createCommand)(api => {
                     describe: 'Output JSON file',
                     type: 'string',
                 },
+                maxComplexityScore: {
+                    describe: 'Fail on complexity score operations',
+                    type: 'number',
+                },
+                complexityScalarCost: {
+                    describe: 'Scalar cost config to use with maxComplexityScore',
+                    type: 'number',
+                    default: 1,
+                },
+                complexityObjectCost: {
+                    describe: 'Object cost config to use with maxComplexityScore',
+                    type: 'number',
+                    default: 2,
+                },
+                complexityDepthCostFactor: {
+                    describe: 'Depth cost factor config to use with maxComplexityScore',
+                    type: 'number',
+                    default: 1.5,
+                },
             });
         },
         handler(args) {
@@ -185,6 +205,16 @@ exports.default = (0, commands_1.createCommand)(api => {
                 const relativePaths = args.relativePaths || false;
                 const onlyErrors = args.onlyErrors || false;
                 const ignore = args.ignore || [];
+                const validateComplexityConfig = (() => {
+                    if (args.maxComplexityScore == null)
+                        return;
+                    return {
+                        maxComplexityScore: args.maxComplexityScore,
+                        complexityScalarCost: args.complexityScalarCost,
+                        complexityObjectCost: args.complexityObjectCost,
+                        complexityDepthCostFactor: args.complexityDepthCostFactor,
+                    };
+                })();
                 const schema = yield loaders.loadSchema(args.schema, {
                     headers,
                     token,
@@ -209,6 +239,7 @@ exports.default = (0, commands_1.createCommand)(api => {
                     output,
                     relativePaths,
                     onlyErrors,
+                    validateComplexityConfig,
                 });
             });
         },

package/cjs/core/src/validate/index.js

@@ -7,6 +7,7 @@ const document_js_1 = require("../ast/document.js");
 const apollo_js_1 = require("../utils/apollo.js");
 const graphql_js_1 = require("../utils/graphql.js");
 const alias_count_js_1 = require("./alias-count.js");
+const complexity_1 = require("./complexity");
 const directive_count_js_1 = require("./directive-count.js");
 const query_depth_js_1 = require("./query-depth.js");
 const token_count_js_1 = require("./token-count.js");
@@ -70,6 +71,22 @@ function validate(schema, sources, options) {
                 errors.push(depthError);
             }
         }
+        if (config.validateComplexityConfig) {
+            const complexityScoreError = (0, complexity_1.validateComplexity)({
+                source: doc.source,
+                doc: transformedDoc,
+                maxComplexityScore: config.validateComplexityConfig.maxComplexityScore,
+                config: {
+                    scalarCost: config.validateComplexityConfig.complexityScalarCost,
+                    objectCost: config.validateComplexityConfig.complexityObjectCost,
+                    depthCostFactor: config.validateComplexityConfig.complexityDepthCostFactor,
+                },
+                fragmentGraph: graph,
+            });
+            if (complexityScoreError) {
+                errors.push(complexityScoreError);
+            }
+        }
         if (config.maxAliasCount) {
             const aliasError = (0, alias_count_js_1.validateAliasCount)({
                 source: doc.source,

package/esm/commands/validate/src/index.js

@@ -5,7 +5,7 @@ import { print, Source } from 'graphql';
 import { createCommand, parseGlobalArgs, } from '@graphql-inspector/commands';
 import { validate as validateDocuments } from '@graphql-inspector/core';
 import { bolderize, chalk, Logger } from '@graphql-inspector/logger';
-export function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }) {
+export function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, validateComplexityConfig, }) {
     let invalidDocuments = validateDocuments(schema, documents.map(doc => new Source(print(doc.document), doc.location)), {
         strictFragments,
         maxDepth,
@@ -14,6 +14,7 @@ export function handler({ schema, documents, strictFragments, maxDepth, maxDirec
         maxTokenCount,
         apollo,
         keepClientFields,
+        validateComplexityConfig,
     });
     if (!invalidDocuments.length) {
         Logger.success('All documents are valid');
@@ -159,6 +160,25 @@ export default createCommand(api => {
                     describe: 'Output JSON file',
                     type: 'string',
                 },
+                maxComplexityScore: {
+                    describe: 'Fail on complexity score operations',
+                    type: 'number',
+                },
+                complexityScalarCost: {
+                    describe: 'Scalar cost config to use with maxComplexityScore',
+                    type: 'number',
+                    default: 1,
+                },
+                complexityObjectCost: {
+                    describe: 'Object cost config to use with maxComplexityScore',
+                    type: 'number',
+                    default: 2,
+                },
+                complexityDepthCostFactor: {
+                    describe: 'Depth cost factor config to use with maxComplexityScore',
+                    type: 'number',
+                    default: 1.5,
+                },
             });
         },
         handler(args) {
@@ -181,6 +201,16 @@ export default createCommand(api => {
                 const relativePaths = args.relativePaths || false;
                 const onlyErrors = args.onlyErrors || false;
                 const ignore = args.ignore || [];
+                const validateComplexityConfig = (() => {
+                    if (args.maxComplexityScore == null)
+                        return;
+                    return {
+                        maxComplexityScore: args.maxComplexityScore,
+                        complexityScalarCost: args.complexityScalarCost,
+                        complexityObjectCost: args.complexityObjectCost,
+                        complexityDepthCostFactor: args.complexityDepthCostFactor,
+                    };
+                })();
                 const schema = yield loaders.loadSchema(args.schema, {
                     headers,
                     token,
@@ -205,6 +235,7 @@ export default createCommand(api => {
                     output,
                     relativePaths,
                     onlyErrors,
+                    validateComplexityConfig,
                 });
             });
         },

package/esm/core/src/validate/index.js

@@ -4,6 +4,7 @@ import { readDocument } from '../ast/document.js';
 import { transformDocumentWithApollo, transformSchemaWithApollo } from '../utils/apollo.js';
 import { findDeprecatedUsages } from '../utils/graphql.js';
 import { validateAliasCount } from './alias-count.js';
+import { validateComplexity } from './complexity';
 import { validateDirectiveCount } from './directive-count.js';
 import { validateQueryDepth } from './query-depth.js';
 import { validateTokenCount } from './token-count.js';
@@ -67,6 +68,22 @@ export function validate(schema, sources, options) {
                 errors.push(depthError);
             }
         }
+        if (config.validateComplexityConfig) {
+            const complexityScoreError = validateComplexity({
+                source: doc.source,
+                doc: transformedDoc,
+                maxComplexityScore: config.validateComplexityConfig.maxComplexityScore,
+                config: {
+                    scalarCost: config.validateComplexityConfig.complexityScalarCost,
+                    objectCost: config.validateComplexityConfig.complexityObjectCost,
+                    depthCostFactor: config.validateComplexityConfig.complexityDepthCostFactor,
+                },
+                fragmentGraph: graph,
+            });
+            if (complexityScoreError) {
+                errors.push(complexityScoreError);
+            }
+        }
         if (config.maxAliasCount) {
             const aliasError = validateAliasCount({
                 source: doc.source,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-inspector/action",
-  "version": "3.4.13",
+  "version": "3.4.14",
   "description": "GraphQL Inspector functionality for GitHub Actions",
   "sideEffects": false,
   "dependencies": {
@@ -10,8 +10,8 @@
     "probot": "12.3.0",
     "tslib": "2.5.0",
     "@graphql-inspector/commands": "3.4.6",
-    "@graphql-inspector/core": "4.1.1",
-    "@graphql-inspector/github": "3.4.11"
+    "@graphql-inspector/core": "4.2.0",
+    "@graphql-inspector/github": "3.4.12"
   },
   "repository": {
     "type": "git",

package/typings/commands/validate/src/index.d.cts

@@ -1,8 +1,9 @@
 import { GraphQLSchema } from 'graphql';
+import { ValidateOperationComplexityConfig } from 'packages/core/src/validate/complexity';
 import { CommandFactory, GlobalArgs } from '@graphql-inspector/commands';
 import { Source as DocumentSource } from '@graphql-tools/utils';
 export { CommandFactory };
-export declare function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }: {
+export declare function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, validateComplexityConfig, }: {
     schema: GraphQLSchema;
     documents: DocumentSource[];
     failOnDeprecated: boolean;
@@ -18,6 +19,7 @@ export declare function handler({ schema, documents, strictFragments, maxDepth,
     relativePaths?: boolean;
     output?: string;
     silent?: boolean;
+    validateComplexityConfig?: ValidateOperationComplexityConfig;
 }): void;
 declare const _default: CommandFactory<{}, {
     schema: string;
@@ -36,5 +38,9 @@ declare const _default: CommandFactory<{}, {
     output?: string | undefined;
     silent?: boolean | undefined;
     ignore?: string[] | undefined;
+    maxComplexityScore?: number | undefined;
+    complexityScalarCost: number;
+    complexityObjectCost: number;
+    complexityDepthCostFactor: number;
 } & GlobalArgs>;
 export default _default;

package/typings/commands/validate/src/index.d.ts

@@ -1,8 +1,9 @@
 import { GraphQLSchema } from 'graphql';
+import { ValidateOperationComplexityConfig } from 'packages/core/src/validate/complexity';
 import { CommandFactory, GlobalArgs } from '@graphql-inspector/commands';
 import { Source as DocumentSource } from '@graphql-tools/utils';
 export { CommandFactory };
-export declare function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }: {
+export declare function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, validateComplexityConfig, }: {
     schema: GraphQLSchema;
     documents: DocumentSource[];
     failOnDeprecated: boolean;
@@ -18,6 +19,7 @@ export declare function handler({ schema, documents, strictFragments, maxDepth,
     relativePaths?: boolean;
     output?: string;
     silent?: boolean;
+    validateComplexityConfig?: ValidateOperationComplexityConfig;
 }): void;
 declare const _default: CommandFactory<{}, {
     schema: string;
@@ -36,5 +38,9 @@ declare const _default: CommandFactory<{}, {
     output?: string | undefined;
     silent?: boolean | undefined;
     ignore?: string[] | undefined;
+    maxComplexityScore?: number | undefined;
+    complexityScalarCost: number;
+    complexityObjectCost: number;
+    complexityDepthCostFactor: number;
 } & GlobalArgs>;
 export default _default;

package/typings/core/src/validate/complexity.d.cts

@@ -6,6 +6,12 @@ export type CalculateOperationComplexityConfig = {
     objectCost: number;
     depthCostFactor: number;
 };
+export type ValidateOperationComplexityConfig = {
+    maxComplexityScore: number;
+    complexityScalarCost: number;
+    complexityObjectCost: number;
+    complexityDepthCostFactor: number;
+};
 export declare function validateComplexity({ source, doc, maxComplexityScore, config, fragmentGraph, }: {
     source: Source;
     doc: DocumentNode;

package/typings/core/src/validate/complexity.d.ts

@@ -6,6 +6,12 @@ export type CalculateOperationComplexityConfig = {
     objectCost: number;
     depthCostFactor: number;
 };
+export type ValidateOperationComplexityConfig = {
+    maxComplexityScore: number;
+    complexityScalarCost: number;
+    complexityObjectCost: number;
+    complexityDepthCostFactor: number;
+};
 export declare function validateComplexity({ source, doc, maxComplexityScore, config, fragmentGraph, }: {
     source: Source;
     doc: DocumentNode;

package/typings/core/src/validate/index.d.cts

@@ -1,4 +1,5 @@
 import { GraphQLError, GraphQLSchema, Source } from 'graphql';
+import { ValidateOperationComplexityConfig } from './complexity';
 export interface InvalidDocument {
     source: Source;
     errors: GraphQLError[];
@@ -45,5 +46,10 @@ export interface ValidateOptions {
      * @default Infinity
      */
     maxTokenCount?: number;
+    /**
+     * Fails when complexity score exceeds maximum complexity score (including the referenced fragments).
+     * @default Infinity
+     */
+    validateComplexityConfig?: ValidateOperationComplexityConfig;
 }
 export declare function validate(schema: GraphQLSchema, sources: Source[], options?: ValidateOptions): InvalidDocument[];

package/typings/core/src/validate/index.d.ts

@@ -1,4 +1,5 @@
 import { GraphQLError, GraphQLSchema, Source } from 'graphql';
+import { ValidateOperationComplexityConfig } from './complexity';
 export interface InvalidDocument {
     source: Source;
     errors: GraphQLError[];
@@ -45,5 +46,10 @@ export interface ValidateOptions {
      * @default Infinity
      */
     maxTokenCount?: number;
+    /**
+     * Fails when complexity score exceeds maximum complexity score (including the referenced fragments).
+     * @default Infinity
+     */
+    validateComplexityConfig?: ValidateOperationComplexityConfig;
 }
 export declare function validate(schema: GraphQLSchema, sources: Source[], options?: ValidateOptions): InvalidDocument[];