Update ServiceValidator.java #2105
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added compile-time validation in the GraphQL compiler plugin to ensure stub entities annotated with @subgraph:Entity`only contain key fields. Non-key fields are now identified and trigger a diagnostic error during validation. The implementation includes extracting key fields from the annotation and validating record fields against these keys.
Codewithsumeet
requested review from
shafreenAnfar,
ThisaruGuruge,
DimuthuMadushan and
MohamedSabthar
as code owners
|
|
|
Comment on lines
+189
to
+199
| if (entityAnnotation.annotValue().isEmpty()) { | ||
| return; | ||
| } | ||
|
|
||
|
|
||
| List<String> keyFields = new ArrayList<>(); | ||
| for (MappingFieldNode fieldNode : entityAnnotation.annotValue().get().fields()) { | ||
| if (fieldNode.kind() != SPECIFIC_FIELD) { | ||
|
|
||
| addDiagnostic(CompilationDiagnostic.PROVIDE_KEY_VALUE_PAIR_FOR_ENTITY_ANNOTATION, fieldNode.location()); | ||
| continue; |
There was a problem hiding this comment.
Incorrect indentation. Check other places as well.
| } | ||
| SpecificFieldNode specificFieldNode = (SpecificFieldNode) fieldNode; | ||
| Node fieldNameNode = specificFieldNode.fieldName(); | ||
|
|
| IdentifierToken fieldNameToken = (IdentifierToken) fieldNameNode; | ||
| String fieldName = fieldNameToken.text().trim(); | ||
| if (KEY.equals(fieldName)) { | ||
| validateKeyField(specificFieldNode); | ||
|
|
Comment on lines
+214
to
+215
|
|
||
|
|
| private void validateFieldsAgainstKeys(List<String> keyFields, Location entityLocation) { | ||
| for (RecordFieldSymbol recordField : getRecordFields()) { | ||
| String fieldName = recordField.getName().orElse(""); | ||
|
|
There was a problem hiding this comment.
Suggested change
Remove extra new lines. Check other places as well.
| String fieldName = recordField.getName().orElse(""); | ||
|
|
||
| if (!keyFields.contains(fieldName)) { | ||
| addDiagnostic(CompilationDiagnostic.INVALID_ENTITY_FIELD, entityLocation, fieldName); |
There was a problem hiding this comment.
Diagnostic CompilationDiagnostic.INVALID_ENTITY_FIELD should be defined in CompilationDiagnostic.
| } | ||
|
|
||
| private void validateFieldsAgainstKeys(List<String> keyFields, Location entityLocation) { | ||
| for (RecordFieldSymbol recordField : getRecordFields()) { |
There was a problem hiding this comment.
Undefined function getRecordFields() ?
Comment on lines
+230
to
+246
| List<String> keyFields = new ArrayList<>(); | ||
| if (specificFieldNode.valueExpr().isPresent()) { | ||
| ExpressionNode valueNode = specificFieldNode.valueExpr().get(); | ||
|
|
||
| if (valueNode.kind() == SyntaxKind.LIST_CONSTRUCTOR) { | ||
| for (Node keyField : ((ListConstructorExpressionNode) valueNode).expressions()) { | ||
| if (keyField.kind() == SyntaxKind.STRING_LITERAL) { | ||
| keyFields.add(keyField.toString().replace("\"", "").trim()); | ||
| } | ||
| } | ||
| } else if (valueNode.kind() == SyntaxKind.STRING_LITERAL) { | ||
|
|
||
| keyFields.add(valueNode.toString().replace("\"", "").trim()); | ||
| } | ||
| } | ||
| return keyFields; | ||
| } |
There was a problem hiding this comment.
Suggested change
| List<String> keyFields = new ArrayList<>(); | |
| if (specificFieldNode.valueExpr().isPresent()) { | |
| ExpressionNode valueNode = specificFieldNode.valueExpr().get(); | |
| if (valueNode.kind() == SyntaxKind.LIST_CONSTRUCTOR) { | |
| for (Node keyField : ((ListConstructorExpressionNode) valueNode).expressions()) { | |
| if (keyField.kind() == SyntaxKind.STRING_LITERAL) { | |
| keyFields.add(keyField.toString().replace("\"", "").trim()); | |
| } | |
| } | |
| } else if (valueNode.kind() == SyntaxKind.STRING_LITERAL) { | |
| keyFields.add(valueNode.toString().replace("\"", "").trim()); | |
| } | |
| } | |
| return keyFields; | |
| } | |
| List<String> keyFields = new ArrayList<>(); | |
| if (specificFieldNode.valueExpr().isPresent()) { | |
| ExpressionNode valueNode = specificFieldNode.valueExpr().get(); | |
| if (valueNode.kind() == SyntaxKind.LIST_CONSTRUCTOR) { | |
| for (Node keyField : ((ListConstructorExpressionNode) valueNode).expressions()) { | |
| if (keyField.kind() == SyntaxKind.STRING_LITERAL) { | |
| keyFields.add(keyField.toString().replace("\"", "").trim()); | |
| } | |
| } | |
| } else if (valueNode.kind() == SyntaxKind.STRING_LITERAL) { | |
| keyFields.add(valueNode.toString().replace("\"", "").trim()); | |
| } | |
| } | |
| return keyFields; | |
| } |
|
hi @Codewithsumeet ! are you still working on this? |
|
Sorry, im not working on this |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added compile-time validation in the GraphQL compiler plugin to ensure stub entities annotated with @subgraph:Entity`only contain key fields. Non-key fields are now identified and trigger a diagnostic error during validation. The implementation includes extracting key fields from the annotation and validating record fields against these keys.
Purpose
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)