ngscheurich

ngscheurich

Polymorphic field in Absinthe

Hi all! My GraphQL education is still in a fairly nascent stage and I’ve run into an issue that seems like it should be easy to solve, yet I can’t figure out a solution. This makes me think I have a flawed mental model and/or a suboptimal implementation.

Here’s a brief rundown of the relevant pieces of my application, with some of my possibly incorrect understandings made explicit:

  • A PostgreSQL table, datapoints, that contains a payload column (among others) which is set to the map type in my Ecto migration. As far as I understand, this configuration means that Ecto will create that column as jsonb and encode/decode as appropriate.
  • The payload map should contain a :value key which is one of data shapes: a boolean value, a string, or a list of strings. I am enforcing this rule via various strategies which I can’t imagine have any bearing on my GraphQL conundrum.
  • An Elixir module that defines an Ecto schema for the datapoints table with field(:payload, :map).
  • An Elixir module that defines an Absinthe schema. It defines an object, :datapoint, as part of the root query object.

My issue comes into play when I try to define the :payload field on the :datapoint object in my schema, i.e.:

object :datapoint do
  field(:id, :id)
  field(:name, :string)
  field(:type, :string)
  field(:payload, # ??? #)
end

How should I tell Absinthe that this field should be one of type :boolean, :string, or list_of(:string)? I’ve gone down quite the rabbit hole of unions, interfaces, and custom scalars, but nothing seems quite right… I can share more code upon request, but I don’t want to start this off with a giant wall of text, and I’m hoping I’m missing something simple. :grimacing:

Any help is very greatly appreciated!

Marked As Solved

benwilson512

benwilson512

Author of Craft GraphQL APIs in Elixir with Absinthe

Once again you’re actually 100% on the right path. The GraphQL type system has your back here actually, because you’ve got 3 completely different return types, so it forces you to articulate the branches you want to handle:

query ($elderId: String!, $datapointName: String!, $count: Int) {
  datapointsForElder(elderId: $elderId, datapointName: $datapointName, count: $count) {
    name,
  	type,
    payload {
      ... on BooleanPayload { __typename value }
      ... on StringPayload { __typename value }
      ... on ListPayload { __typename value }
    }
  }
}

The addition of __typename is handy since it will annotate in the result JSON which outcome it was.

And yeah! I’m looking forward to the conference as well, please stop by and say hi!

10
Post #4

Also Liked

benwilson512

benwilson512

Author of Craft GraphQL APIs in Elixir with Absinthe

Hey @ngscheurich!

The GraphQL type system only permits unions between objects. This leads to the following slightly cumbersome solution:

object :boolean_value do
  field :value, non_null(:boolean)
end

object :string_value do
  field :value, non_null(:string)
end

object :string_list do
  field :value, list_of(:string)
end

union :payload do
  types [:string_value, :string_list, :boolean_value]

  resolve_type fn payload ->
    #exercise for the reader
  end
end
ngscheurich

ngscheurich

Thanks for the quick response, @benwilson512!

So, it seems like I was sort of on the right path, which is a nice sanity check. Here’s the code I was working on:

 object :boolean_payload do
    field(:value, :boolean)
  end

  object :string_payload do
    field(:value, :string)
  end

  object :list_payload do
    field(:value, list_of(:string))
  end

  union :payload do
    types([:boolean_payload, :string_payload, :list_payload])
    resolve_type(&resolve_payload_value/2)
  end

  defp resolve_payload_value(value, _) when is_boolean(value),
    do: :boolean_payload

  defp resolve_payload_value(value, _) when is_binary(value),
    do: :string_payload

  defp resolve_payload_value(value, _) when is_list(value),
    do: :list_payload

My confusion is around how to write the query, e.g., what I should sub-select on payload here:

query ($elderId: String!, $datapointName: String!, $count: Int) {
  datapointsForElder(elderId: $elderId, datapointName: $datapointName, count: $count) {
    name,
  	type,
    payload {
      ???
    }
  }
}

I’m looking at inline fragments at the moment, like ... on BooleanPayload { value } but something about that doesn’t seem quite right…

It seems like I have more of GraphQL problem, so I’ll study up on that part of the equation—any advice is, of course, appreciated though.

P. S. Looking forward to seeing you at The Big Elixir this week!

benwilson512

benwilson512

Author of Craft GraphQL APIs in Elixir with Absinthe

This is really more of an ecto qustion than an Absinthe question. I’d use a custom ecto type that always returned dates instead of sometimes an atom. Your GraphQL clients shouldn’t know or care that you’re using mysql.

Where Next?

Popular in Questions Top

pgiesin
This should be a simple problem but I just can’t seem to figure it out. I have a standalone Elixir app that won’t find the database. Dep...
New
ycv005
I have followed this StackOverflow post to install the specific version of Erlang. And When I am running mix ecto.setup then getting fol...
New
Werner
Hi, I’m using Ubuntu 18.04 and after updating to OTP-24.0 yesterday i have this warning when I run “mix local.hex”: 14:57:30.512 [warn] ...
New
SoCreat
i’m a new one to elixir which editor can i use vs code? or atom? Thanks! :smiley:
New
mgjohns61585
Could someone help me? I'm making my first elixir program, number guessing game. I can't figure out how to convert the user's guess from ...
New
electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
chrisalley
ExUnit now has describe blocks which is a welcome addition coming from RSpec. In the docs, it states that nested hierarchies of describe ...
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers' Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New
siddhant3030
Hi, I have to write a raw query for one of my project. But till now I have used ecto queries and don’t have much experience writing raw ...
New

Other popular topics Top

JorisKok
I have a server on AWS, and was running a load test using artillery. When looking at the Phoenix dashboard I see the Ports going to 100% ...
New
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
vertexbuffer
Hello, can anybody help here..? I have a list of players and I what to delete an element, but every for loop the list is reverting to ori...
New
lastday4you
I wanted to check elixir version in phoenix because i found that my elixir is 1.5 but when i use Enum.chunk_by it said the function is un...
New
myronmarston
The Elixir Typespec docs show the following syntax for keyword lists in typespecs: # ... | [key: type] # keyword lis...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
josevalim
Hi everyone, One of the features added to Elixir early on to help integration with Erlang code was the idea of overridable function defi...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New
Nvim
Elixir appears to be a superior language to Python. I don’t see any advantage of Python over Elixir. Are there any?
New

We're in Beta

About us Mission Statement