[FEAT] (compile-time error): prevent stub entities from having fields beyond their key fields #2445
Conversation
…yond their key fields
Waqibsk
requested review from
DimuthuMadushan,
MohamedSabthar,
ThisaruGuruge and
shafreenAnfar
as code owners
|
|
|
There was a problem hiding this comment.
Please format the code and remove unnecessary empty lines.
You need to add tests for the fix in the compiler-plugin-tests submodule in order to validate the fix. Tests should be comprehensive, covering the following scenarios:
- Valid scenario where an entity is defined with just a key field
- Valid scenario where an entity is defined with key field and other additional fields with a resolve reference function
- Invalid scenario where an entity is defined with key field and other additional fields where resolve reference is not present.
@MohamedSabthar Please add if I missed anything.
| INVALID_EMPTY_RECORD_INPUT_TYPE(DiagnosticMessage.ERROR_147, DiagnosticCode.GRAPHQL_147, DiagnosticSeverity.ERROR), | ||
| INVALID_MODIFICATION_OF_SERVICE_CONFIG_FIELD(DiagnosticMessage.ERROR_148, DiagnosticCode.GRAPHQL_148, | ||
| DiagnosticSeverity.ERROR), | ||
| INVALID_ENTITY_FIELD(DiagnosticMessage.ERROR_149, DiagnosticCode.GRAPHQL_149,DiagnosticSeverity.ERROR), |
There was a problem hiding this comment.
Check the formatting.
| INVALID_ENTITY_FIELD(DiagnosticMessage.ERROR_149, DiagnosticCode.GRAPHQL_149,DiagnosticSeverity.ERROR), | |
| INVALID_ENTITY_FIELD(DiagnosticMessage.ERROR_149, DiagnosticCode.GRAPHQL_149, DiagnosticSeverity.ERROR), |
| if (KEY.equals(fieldName)) { | ||
| validateKeyField(specificFieldNode); | ||
| keyFields = extractKeyFields(specificFieldNode); | ||
|
|
There was a problem hiding this comment.
Remove extra empty lines.
|
|
||
| validateFieldsAgainstKeys(keyFields, entityAnnotation.location()); | ||
|
|
There was a problem hiding this comment.
Ditto
| validateFieldsAgainstKeys(keyFields, entityAnnotation.location()); | |
| validateFieldsAgainstKeys(keyFields, entityAnnotation.location()); |
|
|
||
| if (keyFields == null || keyFields.isEmpty()) { | ||
| return; | ||
|
|
| } | ||
|
|
||
| private void validateFieldsAgainstKeys(List<String> keyFields, Location location) { | ||
|
|
3 participants
Introduce compile-time validation to ensure stub entities only contain fields
defined in their key fields list.
ServiceValidator.javato check record fields against key fieldsPurpose
Fixes: #4816
Examples
Checklist
commonspackage changes (if there are any, please update the GraphQL version in GraphQL tools and Ballerina dev tools)compilerpackage changes (if there are any, please update the GraphQL version in Ballerina dev tools)