Add a rule to enforce resolver type annotations
What does this MR do?
This MR adds a new Rubocop rule: Graphql/ResolverType
.
This rule enforces that every resolver declares its type explicitly using a top level DSL method.
The reasons for this are:
- Executable documentation: developers can see what a resolver returns
- SSOT for field metadata. We currently are being wasteful in this regard, since fields that have resolver classes can inherit the resolver's field options. There is never a reason for a field to override the type, so we should encourage fields with resolvers to delegate to the resolver for all metadata. For this to work, the resolvers will need to have this metadata defined in all cases, so this cop is the first step.
- Enable better testing of resolvers. To test resolvers properly we need to generate fields for them. To do this we need a type definition.
Does this MR meet the acceptance criteria?
Conformity
-
Changelog entry -
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Edited by Luke Duncalfe