[Bug]: Unable to distinguish enum symbol from union-type symbol in Semantic API

[MohamedSabthar]

Description

Consider following code

public enum Baz {
    # This is open
    OPEN,
    # This is close
    CLOSE
}

public type State Baz;

TypeReferenceTypeSymbol typeReferenceTypeSymbol = <State>; // I have set the State as typereferenceTypeSymbol
calling typeReferenceTypeSymbol.typeDescriptor() returns UnionTypeSymbol but it should return EnumSymbol

Steps to Reproduce

No response

Affected Version(s)

No response

OS, DB, other environment details and versions

No response

Related area

-> Compilation

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response

[dulajdilshan]

We can get the enum-type by typeReferenceTypeSymbol.definition()

[lnash94]

enum Result {
    NOTAVAILABLE,
    AVAILABLE
}

type RAction Result;

When we are going to take typeDescriptor() from RAction it returns BallerinaUnionTypeSymbol instead of TypeReference. Is this the expected type?

Reference issue: ballerina-platform/ballerina-library#5123

[dulajdilshan]

This is a kind of expected behavior (according to the design decisions). Therefore, we are fixing @lnash94's original issue (which is "unable to distinguish enum and union-type) by introducing new APIs within UnionTypeSymbol

enum Result {
    NOTAVAILABLE,
    AVAILABLE
}

type RAction Result;

When we are going to take typeDescriptor() from RAction it returns BallerinaUnionTypeSymbol instead of TypeReference. Is this the expected type?

Reference issue: ballerina-platform/ballerina-standard-library#5123

[dulajdilshan]

Changing the issue title to "[Bug]: Unable to distinguish enum symbol from union-type symbol in Semantic API" due to this

This is a kind of expected behavior (according to the design decisions). Therefore, we are fixing @lnash94's original issue (which is "unable to distinguish enum and union-type) by introducing new APIs within UnionTypeSymbol

[dulajdilshan]

We had a discussion sometime back with @MaryamZi and @lnash94, and decided not to send any updates for this since we shouldn't expose any attributes through UnionTypeSymbol to check whether it is an enum or not (complying with the spec), The correct behaviour would be - the Semantic API user should get the visible-symbols and retrieve the enum symbol

[dulajdilshan]

Closing this due to the last comment

[github-actions]

This issue is NOT closed with a proper Reason/ label. Make sure to add proper reason label before closing. Please add or leave a comment with the proper reason label now.

      - Reason/EngineeringMistake - The issue occurred due to a mistake made in the past.
      - Reason/Regression - The issue has introduced a regression.
      - Reason/MultipleComponentInteraction - Issue occured due to interactions in multiple components.
      - Reason/Complex - Issue occurred due to complex scenario.
      - Reason/Invalid - Issue is invalid.
      - Reason/Other - None of the above cases.