Skip to content

Commit

Permalink
add actor field name to error message
Browse files Browse the repository at this point in the history
  • Loading branch information
@sbarker2
sbarker2 committed Oct 13, 2023
1 parent 9854491 commit c31aa9e
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 27 deletions.
50 changes: 34 additions & 16 deletions lib/src/main/java/graphql/nadel/validation/NadelHydrationArgumentValidation.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
overallField: GraphQLFieldDefinition,
remoteArg: RemoteArgumentDefinition,
hydration: UnderlyingServiceHydration,
isBatchHydration: Boolean
isBatchHydration: Boolean,
actorFieldName: String
): NadelSchemaValidationError? {
val unwrappedHydrationSourceFieldType = hydrationSourceFieldType.unwrapNonNull()
val unwrappedActorFieldArgType = actorFieldArgType.unwrapNonNull()
Expand All @@ -34,7 +35,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent,
overallField,
remoteArg,
hydration
hydration,
actorFieldName
)
if (error != null) {
return NadelSchemaValidationError.IncompatibleHydrationArgumentType(
Expand All @@ -43,6 +45,7 @@ internal class NadelHydrationArgumentValidation private constructor() {
remoteArg,
hydrationSourceFieldType,
actorFieldArgType,
actorFieldName
)
}
}
Expand All @@ -55,7 +58,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent,
overallField,
remoteArg,
hydration
hydration,
actorFieldName
)
if (error != null) {
return NadelSchemaValidationError.IncompatibleHydrationArgumentType(
Expand All @@ -64,6 +68,7 @@ internal class NadelHydrationArgumentValidation private constructor() {
remoteArg,
hydrationSourceFieldType,
actorFieldArgType,
actorFieldName
)
}

Expand All @@ -76,7 +81,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent,
overallField,
remoteArg,
hydration
hydration,
actorFieldName
)
}
return null
Expand All @@ -88,7 +94,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent: NadelServiceSchemaElement,
overallField: GraphQLFieldDefinition,
remoteArg: RemoteArgumentDefinition,
hydration: UnderlyingServiceHydration
hydration: UnderlyingServiceHydration,
actorFieldName: String
): NadelSchemaValidationError? {

//need to check null compatibility
Expand All @@ -101,22 +108,23 @@ internal class NadelHydrationArgumentValidation private constructor() {
remoteArg,
hydrationSourceFieldType,
actorFieldArgType,
actorFieldName
)
}
val unwrappedHydrationSourceFieldType = hydrationSourceFieldType.unwrapNonNull()
val unwrappedActorFieldArgType = actorFieldArgType.unwrapNonNull()

// scalar feed into scalar
if (unwrappedHydrationSourceFieldType is GraphQLScalarType && unwrappedActorFieldArgType is GraphQLScalarType) {
return validateScalarArg(hydrationSourceFieldType, actorFieldArgType, parent, overallField, remoteArg)
return validateScalarArg(hydrationSourceFieldType, actorFieldArgType, parent, overallField, remoteArg, actorFieldName)
}
// list feed into list
else if (unwrappedHydrationSourceFieldType.isList && unwrappedActorFieldArgType.isList) {
return validateListArg(hydrationSourceFieldType, actorFieldArgType, parent, overallField, remoteArg, hydration)
return validateListArg(hydrationSourceFieldType, actorFieldArgType, parent, overallField, remoteArg, hydration, actorFieldName)
}
// object feed into inputObject (i.e. hydrating with a $source object)
else if (sourceType == ObjectField && unwrappedHydrationSourceFieldType is GraphQLObjectType && unwrappedActorFieldArgType is GraphQLInputObjectType) {
return validateInputObjectArg(unwrappedHydrationSourceFieldType, unwrappedActorFieldArgType, parent, overallField, remoteArg, hydration)
return validateInputObjectArg(unwrappedHydrationSourceFieldType, unwrappedActorFieldArgType, parent, overallField, remoteArg, hydration, actorFieldName)
}
// inputObject feed into inputObject (i.e. hydrating with a $argument object)
else if (sourceType == FieldArgument && unwrappedHydrationSourceFieldType is GraphQLInputObjectType && unwrappedActorFieldArgType is GraphQLInputObjectType) {
Expand All @@ -127,6 +135,7 @@ internal class NadelHydrationArgumentValidation private constructor() {
remoteArg,
hydrationSourceFieldType,
actorFieldArgType,
actorFieldName
)
}
return null
Expand All @@ -138,6 +147,7 @@ internal class NadelHydrationArgumentValidation private constructor() {
remoteArg,
hydrationSourceFieldType,
actorFieldArgType,
actorFieldName
)
}

Expand All @@ -146,7 +156,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
actorFieldArgType: GraphQLType,
parent: NadelServiceSchemaElement,
overallField: GraphQLFieldDefinition,
remoteArg: RemoteArgumentDefinition
remoteArg: RemoteArgumentDefinition,
actorFieldName: String
): NadelSchemaValidationError? {
if (hydrationSourceFieldType.unwrapNonNull() is GraphQLScalarType && actorFieldArgType.unwrapNonNull() is GraphQLScalarType) {
if (isScalarAssignable(hydrationSourceFieldType.unwrapNonNull() as GraphQLScalarType, actorFieldArgType.unwrapNonNull() as GraphQLScalarType)) {
Expand All @@ -158,6 +169,7 @@ internal class NadelHydrationArgumentValidation private constructor() {
remoteArg,
hydrationSourceFieldType,
actorFieldArgType,
actorFieldName
)
}
}
Expand All @@ -181,7 +193,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent: NadelServiceSchemaElement,
overallField: GraphQLFieldDefinition,
remoteArg: RemoteArgumentDefinition,
hydration: UnderlyingServiceHydration
hydration: UnderlyingServiceHydration,
actorFieldName: String
): NadelSchemaValidationError? {
var hydrationSourceFieldInnerType: GraphQLType = hydrationSourceFieldType.unwrapNonNull().unwrapOne()
var actorFieldArgInnerType: GraphQLType = actorFieldArgType.unwrapNonNull().unwrapOne()
Expand All @@ -191,7 +204,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent,
overallField,
remoteArg,
hydration
hydration,
actorFieldName
) != null
if (errorExists) {
return NadelSchemaValidationError.IncompatibleHydrationArgumentType(
Expand All @@ -200,6 +214,7 @@ internal class NadelHydrationArgumentValidation private constructor() {
remoteArg,
hydrationSourceFieldType,
actorFieldArgType,
actorFieldName
)
}
return null
Expand All @@ -211,7 +226,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent: NadelServiceSchemaElement,
overallField: GraphQLFieldDefinition,
remoteArg: RemoteArgumentDefinition,
hydration: UnderlyingServiceHydration
hydration: UnderlyingServiceHydration,
actorFieldName: String
): NadelSchemaValidationError? {
for (actorInnerField in actorFieldArgType.fields) {
val actorInnerFieldName = actorInnerField.name
Expand All @@ -223,7 +239,8 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent,
overallField,
remoteArg,
actorInnerFieldName
actorInnerFieldName,
actorFieldName
)
}
} else {
Expand All @@ -233,16 +250,17 @@ internal class NadelHydrationArgumentValidation private constructor() {
parent,
overallField,
remoteArg,
hydration
hydration,
actorFieldName
) != null
if (thisFieldHasError) { // want to return top level type to user
if (thisFieldHasError) {
return NadelSchemaValidationError.IncompatibleFieldInHydratedInputObject(
parent,
overallField,
remoteArg,
hydrationSourceFieldType,
actorFieldArgType,
actorInnerFieldName
actorInnerFieldName,
)
}
}
Expand Down
7 changes: 5 additions & 2 deletions lib/src/main/java/graphql/nadel/validation/NadelHydrationValidation.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,8 @@ internal class NadelHydrationValidation(
overallField,
remoteArgDef,
hydration,
isBatchHydration
isBatchHydration,
actorField.name
)
}
}
Expand All @@ -248,7 +249,8 @@ internal class NadelHydrationValidation(
overallField,
remoteArgDef,
hydration,
isBatchHydration
isBatchHydration,
actorField.name
)
}
}
Expand All @@ -267,6 +269,7 @@ internal class NadelHydrationValidation(
overallField,
remoteArgDef,
actorFieldArg.type,
actorField.name
)
}
return null
Expand Down
25 changes: 16 additions & 9 deletions lib/src/main/java/graphql/nadel/validation/NadelSchemaValidationError.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,7 @@ sealed interface NadelSchemaValidationError {
val remoteArg: RemoteArgumentDefinition,
val hydrationType: GraphQLType,
val actorArgInputType: GraphQLType,
val actorFieldName: String
) : NadelSchemaValidationError {
val service: Service get() = parentType.service

Expand All @@ -374,10 +375,11 @@ sealed interface NadelSchemaValidationError {

val argumentSuppliedFromSubString = if (remoteArg.remoteArgumentSource.sourceType == ObjectField)
"the value from field \"$remoteArgSource\" from service \"$s\""
else "the supplied argument called \"${remoteArg.remoteArgumentSource.argumentName}\""
else "a supplied argument called \"${remoteArg.remoteArgumentSource.argumentName}\""

"Field \"$of\" tried to hydrate with argument \"$hydrationArgName\" using $argumentSuppliedFromSubString" +
" of type $ht but it was not assignable to the expected type $at"
"Field \"$of\" tried to hydrate using the actor field \"$actorFieldName\" and argument \"$hydrationArgName\"." +
"However, you are supplying actor field argument with $argumentSuppliedFromSubString " +
"of type $ht which is not assignable to the expected type $at"
}

override val subject = overallField
Expand All @@ -388,6 +390,7 @@ sealed interface NadelSchemaValidationError {
val overallField: GraphQLFieldDefinition,
val remoteArg: RemoteArgumentDefinition,
val actorArgInputType: GraphQLType,
val actorFieldName: String
) : NadelSchemaValidationError {
val service: Service get() = parentType.service

Expand All @@ -396,8 +399,9 @@ sealed interface NadelSchemaValidationError {
val of = makeFieldCoordinates(parentType.overall.name, overallField.name)
val at = GraphQLTypeUtil.simplePrint(actorArgInputType)

"Field $of tried to hydrate with argument $hydrationArgName of type $at using a statically supplied argument, " +
"but the type of the supplied static argument is incompatible"
"Field $of tried to hydrate using actor field \"$actorFieldName\". " +
"However, the type of the static argument you are supplying actor field arg \"$hydrationArgName\" with " +
"is not assignable to the expected type $at"
}

override val subject = overallField
Expand All @@ -419,8 +423,10 @@ sealed interface NadelSchemaValidationError {
val of = makeFieldCoordinates(parentType.overall.name, overallField.name)
val remoteArgSource =
"${parentType.underlying.name}.${remoteArg.remoteArgumentSource.pathToField?.joinToString(separator = ".")}"
"Field $of tried to hydrate with argument \"$hydrationArgName\" using value from $remoteArgSource " +
"but the types are not compatible"

"Field \"$of\" tried to hydrate using the actor field \"$actorFieldName\" and argument \"$hydrationArgName\"." +
"However, you are supplying actor field argument with the value from $remoteArgSource " +
"and the types are incompatible"
}

override val subject = overallField
Expand All @@ -431,6 +437,7 @@ sealed interface NadelSchemaValidationError {
val overallField: GraphQLFieldDefinition,
val remoteArg: RemoteArgumentDefinition,
val missingFieldName: String,
val actorFieldName: String,
) : NadelSchemaValidationError {
val service: Service get() = parentType.service

Expand All @@ -440,8 +447,8 @@ sealed interface NadelSchemaValidationError {
val remoteArgSource =
"${parentType.underlying.name}.${remoteArg.remoteArgumentSource.pathToField?.joinToString(separator = ".")}"
val s = service.name
"Field $of tried to hydrate with argument \"$hydrationArgName\" using value from $remoteArgSource in service $s" +
" but it was missing the field $missingFieldName"
"Field $of tried to hydrate using field \"$actorFieldName\" with argument \"$hydrationArgName\" using value from $remoteArgSource in service $s" +
" but it was missing the required field $missingFieldName"
}

override val subject = overallField
Expand Down

0 comments on commit c31aa9e

Please sign in to comment.