senconscious

senconscious

Embeds in schemaless changesets

Hello everyone. I want to use schemaless changesets to validate external data. And I wonder how to properly use embeds with them.

Let’s assume I want to validate the nested map under the user key in my params payload. And I want my data to be a map in the end. So to get this work I managed to write this “hack”:

defmodule Params do
  import Ecto.Changeset

  @user_types %{id: :integer}

  @user_fields Map.keys(@user_types)

  @types %{
    name: :string,
    page: :integer,
    page_size: :integer,
    ages: {:array, :integer},
    user:
      {:embed,
       elem(
         Ecto.ParameterizedType.init(Ecto.Embedded,
           cardinality: :one,
           related: __MODULE__,
           field: :user
         ),
         2
       )}
  }

  @default %{
    page: 1,
    page_size: 10
  }

  @fields Map.keys(@types) -- [:user]

  def build(entity \\ @default, attrs \\ %{}) do
    entity
    |> changeset(attrs)
    |> apply_action(:insert)
  end

  def changeset(entity, attrs) do
    {entity, @types}
    |> cast(attrs, @fields)
    |> cast_embed(:user, with: &user_changeset/2)
  end

  def user_changeset(entity, attrs) do
    {entity, @user_types}
    |> cast(attrs, @user_fields)
  end

  def __schema__(:primary_key), do: []
  def __struct__, do: %{}
end

Although it’s kinda working doesn’t seems good. As I need to define __schema__/1 and __struct__/0 functons with custom behavior while setting related key to not being relation module, but parent module.

I want to know better approaches to how to validate nested data using schemaless changesets. Or maybe that’s not proper usage of schemaless changeset. And I need to use schema/embedded_schema to avoid “hacking” ?

Most Liked

jswanner

jswanner

When wanting to validate external data with Ecto like this and it’s a nested data structure, I prefer using embedded_schema over schemaless changesets (which I use when validating flat data structures). I’ve also used Goal, which is a wrapper around Ecto.

I’ve also been wanting to try the aforementioned Drops library, but have not yet done so.

sodapopcan

sodapopcan

You should check out Drops which seems like it would be more suited to what you’re looking for. Sorry I don’t have a direct answer. I do use Ecto for non-database-backed validation but always with a(n embedded) schema. I’m actually not sure how it would work without one as the casting functions are looking at the schema definition for the types. But again, no experience with schemaless, so I’m not saying there is not a way for sure, just recommending Drops :slight_smile:

senconscious

senconscious

The reasons why I’m looking for a solution using schemaless changesets (instead of an easy solution with embedded schemas) are:

  1. I want my success payload to be a map. So I don’t need to invoke Map.from_struct/1 function recursively or define implementation of protocols (like Enumarable);
  2. I want my success payload to contain only those keys that were sent by a user. In some scenarios it’s important whether the key was explicitly set to nil or it wasn’t included in the payload;

There’re plenty of libraries that solves this problems with building schemas under the hood. But I look for more simpler solution that doesn’t require any external deps.

One more idea that I’ve got is define key with :map type. And writing in changeset custom function to put value after applying changes. The code for this solution:

defmodule NewParams do
    import Ecto.Changeset

    @user_types %{id: :integer}

    @user_fields Map.keys(@user_types)

    @types %{
      name: :string,
      page: :integer,
      page_size: :integer,
      ages: {:array, :integer},
      user: :map
    }

    @default %{
      page: 1,
      page_size: 10
    }

    @fields Map.keys(@types)

    def build(entity \\ @default, attrs \\ %{}) do
      @default
      |> Map.merge(entity)
      |> changeset(attrs)
      |> apply_action(:insert)
    end

    def changeset(entity, attrs) do
      {entity, @types}
      |> cast(attrs, @fields)
      |> cast_user()
    end

    def cast_user(%{changes: %{user: changes_user}} = changeset) do
      data_user = changeset.data[:user] || %{}

      case build_user(data_user, changes_user) do
        {:ok, user} ->
          put_change(changeset, :user, user)

        {:error, user_changeset} ->
          changeset
          |> put_change(:user, user_changeset)
          |> Map.put(:valid?, false)
      end
    end

    def cast_user(changeset), do: changeset

    def build_user(entity, attrs) do
      entity
      |> user_changeset(attrs)
      |> apply_action(:validate)
    end

    def user_changeset(entity, attrs) do
      {entity, @user_types}
      |> cast(attrs, @user_fields)
    end
  end

But not sure whether it’s better than using schemaless embed type. Still looking for solution

Where Next?

Popular in Questions Top

chokchit
** (DBConnection.ConnectionError) connection not available and request was dropped from queue after 2733ms. You can configure how long re...
New
Tee
can someone please explain to me how Enum.reduce works with maps
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
lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
New
nobody
How to bind a phoenix app to a specific ip address? could not find anything about that, nowhere, unfortunately, but for me this is quite...
New
jaysoifer
Is there a way to rollback a specific migration and only that one (“skipping” all the other ones)? Would mix ecto.rollback -v 200809061...
New
itssasanka
Hi all, Trying to get some more clarity over utc_datetime and naive_datetime for Ecto: The documentation above suggests that while ...
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
jason.o
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
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

Other popular topics Top

danschultzer
None of the current solutions worked well for me, so I went ahead and built a user management system from scratch. This project took far...
548 29377 241
New
malloryerik
Hi, this is for people who, like me, have had some friction using .html.heex templates in VSCode. The solution seems to be, in a hyphena...
New
AngeloChecked
What learn first? Rust or Elixir Hi Elixir community! I’m here because i want learn a new language. I’m a junior developer and mainly i ...
New
dokuzbir
I want to highlight html closing tags when i click a html tag. That works in .html files but doesnt work for html.eex templates. How can...
New
Emily
I have VueJS GUIs with the project generated using Webpack. I have Elixir modules that will need to be used by the VueJS GUIs. I forese...
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
RisingFromAshes
I’ve read in another post that it may be possible with a router helper - but I couldn’t find an appropriate one, and tbh, I’m still just ...
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New
AstonJ
Seen any cool LiveView demos, sample apps or examples? Please post them here! :003:
New
sergio
Kind of like when jquery came out, it was super necessary. Existing drag and drop libraries have a bunch of baggage to support old browse...
New

We're in Beta

About us Mission Statement