Class/Record not getting mapped to schema properly

[droidben]

I'm trying to implement a small bank for an assignment which I've chosen to implement with Quarkus and Smallrye GraphQL. However my DTO classes or records don't get converted serialized / mapped to a schema properly. I'm always getting the following error:

graphql.schema.validation.InvalidSchemaException: invalid schema:
"TransferDTOInput" must define one or more fields.

When I leave out the constructors the conversion works, but this is not really an option since the constructors are used for serialization. This is also picked up on the JSON-B docs: https://javaee.github.io/jsonb-spec/docs/user-guide.html#custom-instantiation

The record AccountDTO get's serialized / converted to the correct schema with the constructors when being used as an output type in functions like:

    @Query
    @Description("Returns a collection of accounts")
    public @NonNull Collection<AccountDTO> getAccounts() throws IOException {
        var accNrs = bank.getBank().getAccountNumbers();
        var accounts = new ArrayList<AccountDTO>();
        for (var accNr : accNrs) {
            bank.Account acc = bank.getBank().getAccount(accNr);
            accounts.add(new AccountDTO(acc.getOwner(), acc.getNumber(), acc.getBalance(), true));
        }
        return accounts;
    }

    @Query
    @Description("Returns an account")
    public Optional<AccountDTO> getAccount(String number) throws IOException {
        var acc = bank.getBank().getAccount(number);
        return Optional.of(new AccountDTO(acc.getOwner(), acc.getNumber(), acc.getBalance(), true));
    }

    @Mutation
    @Description("Creates an account")
    public AccountDTO createAccount(String owner) throws IOException {
        var nr = bank.getBank().createAccount(owner);
        var account = bank.getBank().getAccount(nr);
        return new AccountDTO(account.getOwner(), account.getNumber(), account.getBalance(), account.isActive());
    }

But as soon as they are used as input types the schema generation failes:

    @Mutation
    @Description("Transfer balance between accounts")
    public Optional<String> transfer(@Source TransferDTO transferDTO) {
        try {
            var s = bank.addTransfer(transferDTO);
            bank.executeTransfer(s);
            return Optional.empty();
        } catch (Exception e) {
            return Optional.ofNullable(exceptionMapper(e));
        }
    }

The records are as follows:

import com.fasterxml.jackson.annotation.JsonProperty;
import io.quarkus.runtime.annotations.RegisterForReflection;
import jakarta.json.bind.annotation.JsonbCreator;
import jakarta.json.bind.annotation.JsonbNillable;
import jakarta.json.bind.annotation.JsonbProperty;

@RegisterForReflection
@JsonbNillable
public record AccountDTO(
    @JsonProperty("owner") @JsonbProperty("owner") String owner,
    @JsonProperty("number") @JsonbProperty("number") String number,
    @JsonProperty("balance") @JsonbProperty("balance") double balance,
    @JsonProperty("active") @JsonbProperty("active") boolean active
) {
    @JsonbCreator
    public AccountDTO() {
        this("", "", 0.0, true);
    }

    @JsonbCreator
    public AccountDTO(@JsonbProperty("owner") String owner) {
        this(owner, "", 0.0, true);
    }

    @JsonbCreator
    public AccountDTO(@JsonbProperty("owner") String owner, @JsonbProperty("number") String number) {
        this(owner, number, 0.0, true);
    }

    @JsonbCreator
    public AccountDTO(@JsonbProperty("owner") String owner, @JsonbProperty("number") String number, @JsonbProperty("balance") double balance) {
        this(owner, number, balance, true);
    }
}

import com.fasterxml.jackson.annotation.JsonProperty;
import io.quarkus.runtime.annotations.RegisterForReflection;
import jakarta.json.bind.annotation.JsonbCreator;
import jakarta.json.bind.annotation.JsonbNillable;
import jakarta.json.bind.annotation.JsonbProperty;

@RegisterForReflection
@JsonbNillable
public record TransferDTO(
    @JsonProperty("transferId") @JsonbProperty("transferId") String transferId,
    @JsonProperty("from") @JsonbProperty("from") AccountDTO from,
    @JsonProperty("to") @JsonbProperty("to") AccountDTO to,
    @JsonProperty("amount") @JsonbProperty("amount") double amount,
    @JsonProperty("executed") @JsonbProperty("executed") boolean executed
) {
    @JsonbCreator
    public TransferDTO() {
        this("", null, null, 0, false);
    }

    @JsonbCreator
    public TransferDTO(@JsonbProperty("from") AccountDTO from, @JsonbProperty("to") AccountDTO to, @JsonbProperty("amount") double amount) {
        this("", from, to, amount, false);
    }

    @JsonbCreator
    public TransferDTO(@JsonbProperty("transferId") String transferId, @JsonbProperty("from") AccountDTO from, @JsonbProperty("to") AccountDTO to, @JsonbProperty("amount") double amount) {
        this(transferId, from, to, amount, false);
    }
}

I've also tried to write TransferDTO as a class since that is what mostly mentioned in the docs:
https://download.eclipse.org/microprofile/microprofile-graphql-1.0/microprofile-graphql.html#types
https://javaee.github.io/jsonb-spec/docs/user-guide.html#custom-instantiation

import com.fasterxml.jackson.annotation.JsonProperty;
import io.quarkus.runtime.annotations.RegisterForReflection;
import jakarta.json.bind.annotation.JsonbCreator;
import jakarta.json.bind.annotation.JsonbNillable;
import jakarta.json.bind.annotation.JsonbProperty;
import org.eclipse.microprofile.graphql.Ignore;

@RegisterForReflection
@JsonbNillable
public class TransferDTO {

    @JsonProperty("transferId") @JsonbProperty("transferId") String transferId;
    @JsonProperty("from") @JsonbProperty("from") AccountDTO from;
    @JsonProperty("to") @JsonbProperty("to") AccountDTO to;
    @JsonProperty("amount") @JsonbProperty("amount") double amount;
    @JsonProperty("executed") @JsonbProperty("executed") boolean executed;

    @JsonbCreator
    public TransferDTO() {
        this.transferId = "";
        this.from = null;
        this.to = null;
        this.amount = 0;
        this.executed = false;
    }

    @JsonbCreator
    public TransferDTO(@JsonbProperty("from") AccountDTO from, @JsonbProperty("to") AccountDTO to, @JsonbProperty("amount") double amount) {
        this.transferId = "";
        this.from = from;
        this.to = to;
        this.amount = amount;
        this.executed = false;
    }

    @JsonbCreator
    public TransferDTO(@JsonbProperty("transferId") String transferId, @JsonbProperty("from") AccountDTO from, @JsonbProperty("to") AccountDTO to, @JsonbProperty("amount") double amount) {
        this.transferId = transferId;
        this.from = from;
        this.to = to;
        this.amount = amount;
        this.executed = false;
    }

    @JsonbCreator
    public TransferDTO(@JsonbProperty("transferId") String transferId, @JsonbProperty("from") AccountDTO from, @JsonbProperty("to") AccountDTO to, @JsonbProperty("amount") double amount, @JsonbProperty("executed") boolean executed) {
        this.transferId = transferId;
        this.from = from;
        this.to = to;
        this.amount = amount;
        this.executed = executed;
    }

    @Ignore
    public String transferId() {
        return transferId;
    }

    @Ignore
    public AccountDTO from() {
        return from;
    }

    @Ignore
    public AccountDTO to() {
        return to;
    }

    @Ignore
    public double amount() {
        return amount;
    }

    @Ignore
    public boolean executed() {
        return executed;
    }
}

How can I tell Quarkus / Smallrye to ignore the constructors or what annotations to I need for the record or class to convert to a schema correctly?

[droidben]

@phillip-kruger @t1 Could this be a bug?

[droidben]

Makes sense, thanks. I've refactored both AccountDTO as well as TransferDTO to be classes with one @JsonbCreator annotated constructor and all getters and setters. This leads to SmallRye GraphQL being able to generate the schema for the input types for AccountDTO and TransferDTO but now fails to to generate the schema for its (output) type:

graphql.schema.validation.InvalidSchemaException: invalid schema:
"AccountDTO" must define one or more fields.graphql.schema.validation.InvalidSchemaException: invalid schema:
"AccountDTO" must define one or more fields.

How must I annotate a class that should be both input and (output) type?

[jmartisk]

What does that class/record look like now?

• If you use a record, then the fields from its canonical constructor are taken into account for the output type. Unless you add some @Ignore on them or something.
• If it's a class, the fields need to have a public getter to be considered (either that, or the fields themselves need to be public)

[droidben]

I wasn't able to get the record to work so I'm using classes now. Here's the class AccountDTO which now can't be converted to a schema type by SmallRye GraphQL:

import com.fasterxml.jackson.annotation.JsonProperty;
import io.quarkus.runtime.annotations.RegisterForReflection;
import jakarta.json.bind.annotation.JsonbCreator;
import jakarta.json.bind.annotation.JsonbProperty;

@RegisterForReflection
public class AccountDTO {

    @JsonProperty("owner") @JsonbProperty("owner") private String owner;
    @JsonProperty("number") @JsonbProperty("number") private String number;
    @JsonProperty("balance") @JsonbProperty("balance") private double balance;
    @JsonProperty("active") @JsonbProperty("active") private boolean active;

    public AccountDTO() {
        this.owner = "";
        this.number = "";
        this.balance = 0;
        this.active = true;
    }

    public AccountDTO(@JsonbProperty("owner") String owner) {
        this.owner = owner;
        this.number = "";
        this.balance = 0;
        this.active = true;
    }

    public AccountDTO(@JsonbProperty("owner") String owner, @JsonbProperty("number") String number) {
        this.owner = owner;
        this.number = number;
        this.balance = 0;
        this.active = true;
    }

    public AccountDTO(@JsonbProperty("owner") String owner, @JsonbProperty("number") String number, @JsonbProperty("balance") double balance) {
        this.owner = owner;
        this.number = number;
        this.balance = balance;
        this.active = true;
    }

    @JsonbCreator
    public AccountDTO(@JsonbProperty("owner") String owner, @JsonbProperty("number") String number, @JsonbProperty("balance") double balance, @JsonbProperty("active") boolean active) {
        this.owner = owner;
        this.number = number;
        this.balance = balance;
        this.active = active;
    }

    public String owner() {
        return owner;
    }

    public String number() {
        return number;
    }

    public double balance() {
        return balance;
    }

    public boolean active() {
        return active;
    }

    public void setOwner(String owner) {
        this.owner = owner;
    }

    public void setNumber(String number) {
        this.number = number;
    }

    public void setBalance(double balance) {
        this.balance = balance;
    }

    public void setActive(boolean active) {
        this.active = active;
    }
}

[jmartisk]

Ok you need getters with names prefixed with get, if they are named exactly the same as the field, they won't be recognized as getters

[droidben]

Works now. Did I overlook this in the docs (that getters and setters are needed and are expected to conform to naming conventions)?
Also this might warrant a feature request to support records since such are quite often used for DTOs.

[jmartisk]

Works now. Did I overlook this in the docs (that getters and setters are needed and are expected to conform to naming conventions)?

It's not mentioned in the docs, this is mandated by the MicroProfile GraphQL spec so we left it out

Also this might warrant a feature request to support records since such are quite often used for DTOs.

As I mentioned in a previous comment, it should work - let me know if you still can't figure it out - fields from the canonical constructor are used for the output type, fields from the @JsonbCreator constructor are used for the input type.. It can just get a little confusing when you use the same record for input as well as output - in which case it may be advisable to split it into two classes/records if you need two different sets of fields on them.