3949001373

Build Type

github

Committed by GitHub

Commit Message

Merge 84c8b172c into 2b11d4c8a

Pull Request Pull Request #147: Apollo 4 plugin implementation

Run Details

200 of 215 branches covered (93.02%)

Branch coverage included in aggregate %.

20 of 20 new or added lines in 3 files covered. (100.0%)

2 existing lines in 1 file now uncovered.

326 of 335 relevant lines covered (97.31%)

356.83 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.65

/index.js

const {
  GraphQLNonNull,
  GraphQLList,
  TypeInfo,
  ValidationContext,
  visit,
  visitWithTypeInfo,
  separateOperations,
  GraphQLError
} = require('graphql')
const QueryValidationVisitor = require('./lib/query-validation-visitor.js')
const { getDirective, mapSchema, MapperKind } = require('@graphql-tools/utils')
const { getConstraintTypeObject, getScalarType } = require('./lib/type-utils')
const { constraintDirectiveTypeDefs } = require('./lib/type-defs')

function constraintDirective () {
  const constraintTypes = {}

  function getConstraintType (fieldName, type, notNull, directiveArgumentMap, list, listNotNull) {
  // Names must match /^[_a-zA-Z][_a-zA-Z0-9]*$/ as per graphql-js
    let uniqueTypeName
    if (directiveArgumentMap.uniqueTypeName) {
      uniqueTypeName = directiveArgumentMap.uniqueTypeName.replace(/\W/g, '')
    } else {
      uniqueTypeName =
                `${fieldName}_${list ? 'List_' : ''}${listNotNull ? 'ListNotNull_' : ''}${
                  type.name
                }_${notNull ? 'NotNull_' : ''}` +
                Object.entries(directiveArgumentMap)
                  .map(([key, value]) => {
                    if (
                      key === 'min' ||
                            key === 'max' ||
                            key === 'exclusiveMin' ||
                            key === 'exclusiveMax' ||
                            key === 'multipleOf'
                    ) {
                      return `${key}_${value.toString().replace(/\W/g, 'dot')}`
                    }
                    return `${key}_${value.toString().replace(/\W/g, '')}`
                  })
                  .join('_')
    }
    const key = Symbol.for(uniqueTypeName)
    let constraintType = constraintTypes[key]
    if (constraintType) return constraintType
    constraintType = getConstraintTypeObject(fieldName, type, uniqueTypeName, directiveArgumentMap)
    if (notNull) {
      constraintType = new GraphQLNonNull(constraintType)
    }
    if (list) {
      constraintType = new GraphQLList(constraintType)
      if (listNotNull) {
        constraintType = new GraphQLNonNull(constraintType)
      }
    }
    constraintTypes[key] = constraintType

    return constraintType
  }

  function wrapType (fieldConfig, directiveArgumentMap) {
    const result = getScalarType(fieldConfig.type)
    const fieldName = fieldConfig.astNode.name.value
    fieldConfig.type = getConstraintType(
      fieldName,
      result.scalarType,
      result.scalarNotNull,
      directiveArgumentMap,
      result.list,
      result.listNotNull
    )
  }

  return (schema) =>
    mapSchema(schema, {
      [MapperKind.FIELD]: (fieldConfig) => {
        const directiveArgumentMap = getDirective(schema, fieldConfig, 'constraint')?.[0]

        if (directiveArgumentMap) {
          wrapType(fieldConfig, directiveArgumentMap)

          return fieldConfig
        }
      },
      [MapperKind.ARGUMENT]: (fieldConfig) => {
        const directiveArgumentMap = getDirective(schema, fieldConfig, 'constraint')?.[0]

        if (directiveArgumentMap) {
          wrapType(fieldConfig, directiveArgumentMap)

          return fieldConfig
        }
      }
    })
}

function validateQuery (schema, query, variables, operationName) {
  const typeInfo = new TypeInfo(schema)

  const errors = []
  const context = new ValidationContext(
    schema,
    query,
    typeInfo,
    (error) => errors.push(error)
  )
  const visitor = new QueryValidationVisitor(context, {
    variables,
    operationName
  })

  visit(query, visitWithTypeInfo(typeInfo, visitor))

  return errors
}

function createApolloQueryValidationPlugin ({ schema }) {
  return {
    async requestDidStart () {
      return ({
        async didResolveOperation ({ request, document }) {
          const query = request.operationName
            ? separateOperations(document)[request.operationName]
            : document

          const errors = validateQuery(
            schema,
            query,
            request.variables,
            request.operationName
          )
          if (errors.length > 0) {
            throw errors.map(err => {
              const { UserInputError } = require('apollo-server-errors')
              return new UserInputError(err.message, { field: err.fieldName, context: err.context })
            })
          }
        }
      })
    }
  }
}

function createEnvelopQueryValidationPlugin () {
  return {
    onExecute ({ args, setResultAndStopExecution }) {
      const errors = validateQuery(args.schema, args.document, args.variableValues, args.operationName)
      if (errors.length > 0) {
        setResultAndStopExecution({ errors: errors.map(err => { return new GraphQLError(err.message, err, { code: err.code, field: err.fieldName, context: err.context, exception: err.originalError }) }) })
      }
    }
  }
}

function createQueryValidationRule (options) {
  return (context) => {
    return new QueryValidationVisitor(context, options)
  }
}

module.exports = { constraintDirective, constraintDirectiveTypeDefs, validateQuery, createApolloQueryValidationPlugin, createEnvelopQueryValidationPlugin, createQueryValidationRule }

1	const {
2	GraphQLNonNull,
3	GraphQLList,
4	TypeInfo,
5	ValidationContext,
6	visit,
7	visitWithTypeInfo,
8	separateOperations,
9	GraphQLError
10	} = require('graphql')	2✔
11	const QueryValidationVisitor = require('./lib/query-validation-visitor.js')	2✔
12	const { getDirective, mapSchema, MapperKind } = require('@graphql-tools/utils')	2✔
13	const { getConstraintTypeObject, getScalarType } = require('./lib/type-utils')	2✔
14	const { constraintDirectiveTypeDefs } = require('./lib/type-defs')	2✔
15
16	function constraintDirective () {
17	const constraintTypes = {}	386✔
18
19	function getConstraintType (fieldName, type, notNull, directiveArgumentMap, list, listNotNull) {
20	// Names must match /^[_a-zA-Z][_a-zA-Z0-9]*$/ as per graphql-js
21	let uniqueTypeName
22	if (directiveArgumentMap.uniqueTypeName) {	410✔
23	uniqueTypeName = directiveArgumentMap.uniqueTypeName.replace(/\W/g, '')	32✔
24	} else {
25	uniqueTypeName =	378✔
26	`${fieldName}_${list ? 'List_' : ''}${listNotNull ? 'ListNotNull_' : ''}${	756✔
27	type.name
28	}_${notNull ? 'NotNull_' : ''}` +	378✔
29	Object.entries(directiveArgumentMap)
30	.map(([key, value]) => {
31	if (	380✔
32	key === 'min' \|\|	1,464✔
33	key === 'max' \|\|
34	key === 'exclusiveMin' \|\|
35	key === 'exclusiveMax' \|\|
36	key === 'multipleOf'
37	) {
38	return `${key}_${value.toString().replace(/\W/g, 'dot')}`	186✔
39	}
40	return `${key}_${value.toString().replace(/\W/g, '')}`	194✔
41	})
42	.join('_')
43	}
44	const key = Symbol.for(uniqueTypeName)	410✔
45	let constraintType = constraintTypes[key]	410✔
46	if (constraintType) return constraintType	410!
47	constraintType = getConstraintTypeObject(fieldName, type, uniqueTypeName, directiveArgumentMap)	410✔
48	if (notNull) {	410✔
49	constraintType = new GraphQLNonNull(constraintType)	166✔
50	}
51	if (list) {	410✔
52	constraintType = new GraphQLList(constraintType)	22✔
53	if (listNotNull) {	22✔
54	constraintType = new GraphQLNonNull(constraintType)	14✔
55	}
56	}
57	constraintTypes[key] = constraintType	410✔
58
59	return constraintType	410✔
60	}
61
62	function wrapType (fieldConfig, directiveArgumentMap) {
63	const result = getScalarType(fieldConfig.type)	410✔
64	const fieldName = fieldConfig.astNode.name.value	410✔
65	fieldConfig.type = getConstraintType(	410✔
66	fieldName,
67	result.scalarType,
68	result.scalarNotNull,
69	directiveArgumentMap,
70	result.list,
71	result.listNotNull
72	)
73	}
74
75	return (schema) =>	386✔
76	mapSchema(schema, {	386✔
77	[MapperKind.FIELD]: (fieldConfig) => {
78	const directiveArgumentMap = getDirective(schema, fieldConfig, 'constraint')?.[0]	1,154✔
79
80	if (directiveArgumentMap) {	1,154✔
81	wrapType(fieldConfig, directiveArgumentMap)	382✔
82
83	return fieldConfig	382✔
84	}
85	},
86	[MapperKind.ARGUMENT]: (fieldConfig) => {
87	const directiveArgumentMap = getDirective(schema, fieldConfig, 'constraint')?.[0]	194✔
88
89	if (directiveArgumentMap) {	194✔
90	wrapType(fieldConfig, directiveArgumentMap)	28✔
91
92	return fieldConfig	28✔
93	}
94	}
95	})
96	}
97
98	function validateQuery (schema, query, variables, operationName) {
99	const typeInfo = new TypeInfo(schema)	818✔
100
101	const errors = []	818✔
102	const context = new ValidationContext(	818✔
103	schema,
104	query,
105	typeInfo,
106	(error) => errors.push(error)	474✔
107	)
108	const visitor = new QueryValidationVisitor(context, {	818✔
109	variables,
110	operationName
111	})
112
113	visit(query, visitWithTypeInfo(typeInfo, visitor))	818✔
114
115	return errors	818✔
116	}
117
118	function createApolloQueryValidationPlugin ({ schema }) {
119	return {	120✔
120	async requestDidStart () {
121	return ({	278✔
122	async didResolveOperation ({ request, document }) {
123	const query = request.operationName	278!
124	? separateOperations(document)[request.operationName]
125	: document
126
127	const errors = validateQuery(	278✔
128	schema,
129	query,
130	request.variables,
131	request.operationName
132	)
133	if (errors.length > 0) {	278✔
134	throw errors.map(err => {	130✔
135	const { UserInputError } = require('apollo-server-errors')	158✔
136	return new UserInputError(err.message, { field: err.fieldName, context: err.context })	158✔
137	})
138	}
139	}
140	})
141	}
142	}
143	}
144
145	function createEnvelopQueryValidationPlugin () {
146	return {	112✔
147	onExecute ({ args, setResultAndStopExecution }) {
148	const errors = validateQuery(args.schema, args.document, args.variableValues, args.operationName)	262✔
149	if (errors.length > 0) {	262✔
150	setResultAndStopExecution({ errors: errors.map(err => { return new GraphQLError(err.message, err, { code: err.code, field: err.fieldName, context: err.context, exception: err.originalError }) }) })	158✔
151	}
152	}
153	}
154	}
155
156	function createQueryValidationRule (options) {
UNCOV 157	return (context) => {	×
UNCOV 158	return new QueryValidationVisitor(context, options)	×
159	}
160	}
161
162	module.exports = { constraintDirective, constraintDirectiveTypeDefs, validateQuery, createApolloQueryValidationPlugin, createEnvelopQueryValidationPlugin, createQueryValidationRule }	2✔

confuser / graphql-constraint-directive / 3949001373

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous