const string array not being added to json payload

[tharindu-nw]

Description

I have a string array that I need to send inside a json payload of an http request. I have declared this array a const. When I add it to the json payload and send the request, the value is not being sent in the request.

Steps to Reproduce

Declare a const string array:

const string[] CONST_ROLES = ["Admin"];

Add this value in an http request payload:

http:Request newRequest = new;
newRequest.setJsonPayload({
      roles: CONST_ROLES,
      name: "John"
});
http:Response|error newResponse = httpClient->post("/req/path", newRequest);

Trace logs show the following as the req payload:

{"roles":, "name":"John"}

Version

2201.10.0

Environment Details (with versions)

OS: MacOS Sonoma

[TharmiganK]

Constant arrays are represented as tuple type in Ballerina. We are using JsonUtils.Serialize lang API to convert the json to a output stream which writes on the wire. Seems like the issue is with this lang API which does not consider the tuple case:

ballerina-lang/bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/internal/json/JsonGenerator.java

Line 290 in 35de750

switch (TypeUtils.getImpliedType(TypeChecker.getType(json)).getTag()) {

@warunalakshitha / @HindujaB FYI

As a workaround, you could use the toJson on the actual json value to make it work:

http:Request newRequest = new;
newRequest.setJsonPayload({
      roles: CONST_ROLES,
      name: "John"
}.toJson());
http:Response|error newResponse = httpClient->post("/req/path", newRequest);

[HindujaB]

The JSONGenerator class has an older implementation where it assumes the object to be of explicit json type where all the elements are either from JSON primitives, json[], or map<json> types. Therefore it misses the alternative representations such as records and tuples.
Another workaround from the native side would be to use JsonUtils.convertToJson(value) before serializing the value.
We will provide a fix.

[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.