Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add ApolloCompatibilitySkipEnumValueValidation #1031

Closed
wants to merge 1 commit into from
+146 −1
Closed

feat: add ApolloCompatibilitySkipEnumValueValidation #1031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 144 additions & 0 deletions execution/engine/execution_engine_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,14 @@ func withValueCompletion() executionTestOptions {
}
}

func withSkipEnumValueValidation() executionTestOptions {
return func(options *_executionTestOptions) {
options.resolvableOptions = resolve.ResolvableOptions{
ApolloCompatibilitySkipEnumValueValidation: true,
}
}
}

func TestExecutionEngine_Execute(t *testing.T) {
run := func(testCase ExecutionEngineTestCase, withError bool, expectedErrorMessage string, options ...executionTestOptions) func(t *testing.T) {
t.Helper()
Expand Down Expand Up @@ -2200,6 +2208,70 @@ func TestExecutionEngine_Execute(t *testing.T) {
},
))

t.Run("invalid nullable enum value is valid with skip enum value validation", runWithoutError(
ExecutionEngineTestCase{
schema: schema,
operation: func(t *testing.T) graphql.Request {
return graphql.Request{
OperationName: "Enum",
Query: `query Enum($enum: Enum!) {
nullableEnum(enum: $enum)
}`,
Variables: []byte(`{"enum":"A"}`),
}
},
dataSources: []plan.DataSource{
mustGraphqlDataSourceConfiguration(t,
"id",
mustFactory(t,
testNetHttpClient(t, roundTripperTestCase{
expectedHost: "example.com",
expectedPath: "/",
expectedBody: "",
sendResponseBody: `{"data":{"nullableEnum":"INVALID"}}`,
sendStatusCode: 200,
}),
),
&plan.DataSourceMetadata{
RootNodes: []plan.TypeField{
{
TypeName: "Query",
FieldNames: []string{"nullableEnum"},
},
},
},
mustConfiguration(t, graphql_datasource.ConfigurationInput{
Fetch: &graphql_datasource.FetchConfiguration{
URL: "https://example.com/",
Method: "GET",
},
SchemaConfiguration: mustSchemaConfig(
t,
nil,
enumSDL,
),
}),
),
},
fields: []plan.FieldConfiguration{
{
TypeName: "Query",
FieldName: "nullableEnum",
Path: []string{"nullableEnum"},
Arguments: []plan.ArgumentConfiguration{
{
Name: "enum",
SourceType: plan.FieldArgumentSource,
RenderConfig: plan.RenderArgumentAsGraphQLValue,
},
},
},
},
expectedResponse: `{"data":{"nullableEnum":"INVALID"}}`,
},
withSkipEnumValueValidation(),
))

t.Run("nested invalid nullable enum value", runWithoutError(
ExecutionEngineTestCase{
schema: schema,
Expand Down Expand Up @@ -2271,6 +2343,78 @@ func TestExecutionEngine_Execute(t *testing.T) {
},
))

t.Run("nested invalid nullable enum value is valid with skip enum value validation", runWithoutError(
ExecutionEngineTestCase{
schema: schema,
operation: func(t *testing.T) graphql.Request {
return graphql.Request{
OperationName: "Enum",
Query: `query Enum($enum: Enum) {
nestedEnums {
nullableEnum(enum: $enum)
}
}`,
Variables: []byte(`{"enum":"A"}`),
}
},
dataSources: []plan.DataSource{
mustGraphqlDataSourceConfiguration(t,
"id",
mustFactory(t,
testNetHttpClient(t, roundTripperTestCase{
expectedHost: "example.com",
expectedPath: "/",
expectedBody: "",
sendResponseBody: `{"data":{"nestedEnums":{"nullableEnum":"INVALID"}}}`,
sendStatusCode: 200,
}),
),
&plan.DataSourceMetadata{
RootNodes: []plan.TypeField{
{
TypeName: "Query",
FieldNames: []string{"nestedEnums"},
},
},
ChildNodes: []plan.TypeField{
{
TypeName: "Object",
FieldNames: []string{"nullableEnum"},
},
},
},
mustConfiguration(t, graphql_datasource.ConfigurationInput{
Fetch: &graphql_datasource.FetchConfiguration{
URL: "https://example.com/",
Method: "GET",
},
SchemaConfiguration: mustSchemaConfig(
t,
nil,
enumSDL,
),
}),
),
},
fields: []plan.FieldConfiguration{
{
TypeName: "Object",
FieldName: "nullableEnum",
Path: []string{"nullableEnum"},
Arguments: []plan.ArgumentConfiguration{
{
Name: "enum",
SourceType: plan.FieldArgumentSource,
RenderConfig: plan.RenderArgumentAsGraphQLValue,
},
},
},
},
expectedResponse: `{"data":{"nestedEnums":{"nullableEnum":"INVALID"}}}`,
},
withSkipEnumValueValidation(),
))

t.Run("invalid non-nullable enum value returned by list", runWithoutError(
ExecutionEngineTestCase{
schema: schema,
Expand Down
3 changes: 2 additions & 1 deletion v2/pkg/engine/resolve/resolvable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ type ResolvableOptions struct {
ApolloCompatibilitySuppressFetchErrors bool
ApolloCompatibilityReplaceUndefinedOpFieldError bool
ApolloCompatibilityReplaceInvalidVarError bool
ApolloCompatibilitySkipEnumValueValidation bool
}

func NewResolvable(options ResolvableOptions) *Resolvable {
Expand Down Expand Up @@ -1066,7 +1067,7 @@ func (r *Resolvable) walkEnum(e *Enum, value *astjson.Value) bool {
return r.err()
}
valueString := string(value.GetStringBytes())
if !e.isValidValue(valueString) {
if !r.options.ApolloCompatibilitySkipEnumValueValidation && !e.isValidValue(valueString) {
/* When an invalid value is returned, the data is set to null.
* If the value is nullable, the null data should not propagate up, so r.walkNull() is returned.
* To avoid appending an error twice, the appending only happens on the first walk
Expand Down