[FEAT] (compile-time error): prevent stub entities from having fields beyond their key fields

[Waqibsk]

Introduce compile-time validation to ensure stub entities only contain fields
defined in their key fields list.

• Add validation in ServiceValidator.java to check record fields against key fields
• Add new diagnostic message for invalid additional fields

Purpose

Fixes: #4816

Examples

Checklist

• Linked to an issue
• Updated the changelog
• Added tests
• Updated the spec
• Checked native-image compatibility
• No commons package changes (if there are any, please update the GraphQL version in GraphQL tools and Ballerina dev tools)
• No compiler package changes (if there are any, please update the GraphQL version in Ballerina dev tools)

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[ThisaruGuruge]

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:

1. Valid scenario where an entity is defined with just a key field
2. Valid scenario where an entity is defined with key field and other additional fields with a resolve reference function
3. 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.

[ThisaruGuruge]

Check the formatting.

Suggested change

	INVALID_ENTITY_FIELD(DiagnosticMessage.ERROR_149, DiagnosticCode.GRAPHQL_149,DiagnosticSeverity.ERROR),
	INVALID_ENTITY_FIELD(DiagnosticMessage.ERROR_149, DiagnosticCode.GRAPHQL_149, DiagnosticSeverity.ERROR),

[ThisaruGuruge]

Remove extra empty lines.

Suggested change

[ThisaruGuruge]

Ditto

Suggested change

	validateFieldsAgainstKeys(keyFields, entityAnnotation.location());
	validateFieldsAgainstKeys(keyFields, entityAnnotation.location());

[ThisaruGuruge]

Suggested change

[ThisaruGuruge]

Suggested change

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Waqibsk]

Hi @ThisaruGuruge , i have added the tests
but my current implementation ,
is failing for test

3. Invalid scenario where an entity is defined with key field and other additional fields where resolve reference is not present.

It would be great if you could share some insights on how to handle this.
Also, are there any code formatting guidelines for the project that I can refer to?

Thanks!

[ThisaruGuruge]

Hi @Waqibsk

You can define an entity like this:

@subgraph:Entity {
    key: "id"
}
public type Product record {
    readonly string id;
    int number;
    // ...
};

In this case, there are additional fields in the entity record (int number), but the reference resolver is not present in the @subgraph:Entity annotation. You can read the GraphQL documentation to better understand this.