Optional query arguments

[franden]

Ia m using the microprofile-graphql-client 1.1.0 in my quarkus project and I am struggling with an issue with optional parameter for some quieries.
The used GraphQL API allows to filter catalogue entries with a filter argument. If some filter attributes are applied, then the result is filtered, otherwise no filtering is done.

@Query("catalogues")
List<CatalogueDTO> getCatalogues(
    @Header(name = HttpHeaders.AUTHORIZATION) String authorization,
    @Header(name = "customer-id") String customerId,
    @Name("filter")CatalogueRequestParams catalogueRequestParams
);

@Input("CatalogueRequestParams")
public class CatalogueRequestParams {

    FrameType frameType;
    Boolean remoteEdgingEnabled;

    public Boolean getRemoteEdgingEnabled() {
        return remoteEdgingEnabled;
    }

    public CatalogueRequestParams setRemoteEdgingEnabled(Boolean remoteEdgingEnabled) {
        this.remoteEdgingEnabled = remoteEdgingEnabled;
        return this;
    }

    public FrameType getFrameType() {
        return frameType;
    }

    public CatalogueRequestParams setFrameType(FrameType frameType) {
        this.frameType = frameType;
        return this;
    }
}

A) If the filter parameter are set, this query will be generated:

{
	"query": "query catalogues($filter: CatalogueRequestParams) { catalogues(filter: $filter) {type owner uid} }",
	"variables": {
		"filter": {
                        "frameType": "METALL",
			"remoteEdgingEnabled": true
		}
	},
	"operationName": "catalogues"
}

B) if the parameter are not set, the filter will be set to null.

{
	"query": "query catalogues($filter: CatalogueRequestParams) { catalogues(filter: $filter) {type owner uid} }",
	"variables": {
		"filter": {
			"frameType": null,
			"remoteEdgingEnabled": null
		}
	},
	"operationName": "catalogues"
}

issue in case A) "remoteEdgingEnabled": true leads to an validation exception on the GraphQL server. if I change it to "remoteEdgingEnabled": "true" the query works.

issue in case B) leads to an validation exception on the GraphQL server. It works only if I remove the filter values completely.

My Questions:

• Do I am facing an issue with the microprofile-graphql-client or is it a issue with the server implementation of the GraphQL API?
• Can I somehow instrument microprofile-graphql-client to "ignore" variables which are set to null? Because in my case, absence of an filter has different meaning as set to null or false.
• Why are the queries generated by microprofile-graphql-client are using "variables". Is it possible to instrument it to generate queries like this:

{
  catalogues(filter: {frameType: METAL  remoteEdgingEnabled:true} ) {
    type,
    owner,
    uid,
  }
}

[t1]

Do I am facing an issue with the microprofile-graphql-client or is it a issue with the server implementation of the GraphQL API?

Without your server side code nor the exact validation error you get, I'll have to guess. A) looks like you don't have a Boolean but a String on the server side. B) is even more difficult to guess; maybe it's NonNull on the server?

Can I somehow instrument microprofile-graphql-client to "ignore" variables which are set to null?

No, but you could have a second client query without or with fewer parameters (I'm skipping the headers here for brevity):

List<CatalogueDTO> catalogues();
List<CatalogueDTO> catalogues(CatalogueRequestParamsWithoutRemoteEdging filter);
List<CatalogueDTO> catalogues(CatalogueRequestParams filter);

@Input("CatalogueRequestParams")
public class CatalogueRequestParamsWithoutRemoteEdging {
    FrameType frameType;
    ...
}

Why are the queries generated by microprofile-graphql-client are using "variables".

This helps the service to cache the query, i.e. it doesn't have to parse the same request again and again only because a variable changes.

[franden]

Case A: According to the schema, remoteEdgingEnabled parameter is a "Booolean".
Case B: According to the schema, remoteEdgingEnabled parameter is optional. The issue happens with all other parameters too. In case of "simplified" request, null will be accepted. SO such request works:

{  
  catalogues(filter: {frameType: null}) {
    type,
    owner,
    uid,
  }
}

I guess, the root cause of the issue is the usage of graphql-java 13.0 on the server side.
The exception which I get in both cases comes from the used library on the sever: graphql.execution.ValuesResolver Line 195: Variable 'remoteEdgingEnabled' has an invalid value. Expected type 'Boolean' but was 'JsonValueImpl

No, but you could have a second client query without or with fewer parameters (I'm skipping the headers here for brevity)

Ok, I will do it in this way. Thanks.

[t1]

Are you fine with that solution? Can we close this issue, now?