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.

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

Adds Enum Type Default Value Uses Inaccessible Value Rule #47

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
105 changes: 105 additions & 0 deletions spec/Section 4 -- Composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,111 @@ run in sequence to produce the composite execution schema.

### Pre Merge Validation

#### Enum Type Default Value Uses Inaccessible Value

**Error Code**

`ENUM_TYPE_DEFAULT_VALUE_INACCESSIBLE`

**Formal Specification**

- {ValidateArgumentDefaultValues()} must be true.
- {ValidateInputFieldDefaultValues()} must be true.

ValidateArgumentDefaultValues():

- Let {arguments} be all arguments of fields and directives across all subgraphs
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Let {arguments} be all arguments of fields and directives across all subgraphs
- Let {arguments} be all arguments of fields and directives across all source schemas

- For each {argument} in {arguments}
- If {IsExposed(argument)} is true and has a default value:
- Let {defaultValue} be the default value of {argument}
- If not ValidateDefaultValue(defaultValue)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- If not ValidateDefaultValue(defaultValue)
- If not {ValidateDefaultValue(defaultValue)}

- return false
- return true

ValidateInputFieldDefaultValues():

- Let {inputFields} be all input fields of across all subgraphs
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Let {inputFields} be all input fields of across all subgraphs
- Let {inputFields} be all input fields across all source schemas

- For each {inputField} in {inputFields}:
- Let {type} be the type of {inputField}
- If {IsExposed(inputField)} is true and {inputField} has a default value:
- Let {defaultValue} be the default value of {inputField}
- if ValidateDefaultValue(defaultValue) is false
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- if ValidateDefaultValue(defaultValue) is false
- If {ValidateDefaultValue(defaultValue)} is false

- return false
- return true

ValidateDefaultValue(defaultValue):

- If {defaultValue} is a ListValue:
- For each {valueNode} in {defaultValue}:
- If {ValidateDefaultValue(valueNode)} is false
- return false
- If {defaultValue} is an ObjectValue:
- Let {objectFields} be a list of all fields of {defaultValue}
- Let {fields} be a list of all fields {objectFields} are referring to
- For each {field} in {fields}:
- If {IsExposed(field)} is false
- return false
- For each {objectField} in {objectFields}:
- Let {value} be the value of {objectField}
- return {ValidateDefaultValue(value)}
- If {defaultValue} is an EnumValue:
- If {IsExposed(defaultValue)} is false
- return false
- return true

**Explanatory Text**

This rule ensures that inaccessible enum values are not exposed in the composed schema through default values.
Output field arguments, input fields and directive arguments must only use enum values as their default value that is not annotated with the `@inaccessible` directive.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Output field arguments, input fields and directive arguments must only use enum values as their default value that is not annotated with the `@inaccessible` directive.
Output field arguments, input fields, and directive arguments must only use enum values as their default value when not annotated with the `@inaccessible` directive.


In this example the `FOO` value in the `Enum1` enum is not marked with
`@inaccessible`, hence it doesn't violate the rule.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`@inaccessible`, hence it doesn't violate the rule.
`@inaccessible`, hence it does not violate the rule.


```graphql
type Query {
field(type: Enum1 = FOO): [Baz!]!
}

enum Enum1 {
FOO
BAR
}
```

This following example violates this rule because the default value for the field
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This following example violates this rule because the default value for the field
The following example violates this rule because the default value for the field

`field` in type `Input1` references an enum value (`FOO`) that is marked as
`@inaccessible`.

```graphql counter-example
type Query {
field(arg: Enum1 = FOO): [Baz!]!
}

input Input1 {
field: Enum1 = FOO
}

directive @directive1(arg: Enum1 = FOO) on FIELD_DEFINITION
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be removed or described? It's not part of the example description above, and also not in the "good" example.

(same in the next counter-example)


enum Enum1 {
FOO @inaccessible
BAR
}
```

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing description of counter-example.

```graphql counter-example
type Query {
field(arg: Input1 = { field2: "ERROR" }): [Baz!]!
}

directive @directive1(arg: Input1 = { field2: "ERROR" }) on FIELD_DEFINITION

input Input1 {
field1: String
field2: String @inaccessible
}
```

### Merge

### Post Merge Validation
Expand Down
Loading