gmile

gmile

Hi! I’m continuing my battle (1, 2) against transitive compile-time dependencies on a large code base :slight_smile:

This time I am facing an issue with getting rid of a comp. time dependency coming from a custom Ecto type. The source code repo depicting the issue is available here.

Basically, I have 3 modules: Ecto schema, custom type and a module with helper functions. Heavily simplified versions of them look like this:

defmodule MySchema do
  use Ecto.Schema

  schema "my_table" do
    field :my_field, MyType
  end
end
defmodule MyType do
  use Ecto.Type

  def type, do: :binary

  def cast(value), do: {:ok, MyHelperModule.heavy_casting_work(value)}
  def load(value), do: {:ok, MyHelperModule.heavy_loading_work(value)}
  def dump(value), do: {:ok, MyHelperModule.heavy_dumping_work(value)}
end
defmodule MyHelperModule do
  def heavy_casting_work(value), do: value
  def heavy_loading_work(value), do: value
  def heavy_dumping_work(value), do: value
end

The problem here is that, in case implementation of MyHelperModule changes, both MyType and MySchema modules need to be re-compiled. It can be seen by calling mix xref graph:

mix xref graph --source lib/my_schema.ex

Output:

lib/my_schema.ex
└── lib/my_type.ex (compile)
    └── lib/my_helper_module.ex

The rationale for MyHelperModule’s existence is that it can be quite complicated, and best for it is to exist & be tested on its own. Additionally, it is sometimes used in other contexts in the application, such that don’t really require an Ecto.Type interface.

What would be a strategy to get rid of a transitive dependency here?

It seems to me that Ecto absolutely needs to compile all custom types ahead of compiling the schema, so the only way to ensure there’s no transitive com.-time dependency is to have MyType be absolutely free of dependencies on any other module in the app :frowning:

Showing Posts 1 to 3

LostKobrakai

LostKobrakai

You can always go and change a compile time dependency to a runtime dependency e.g. by using something like Module.concat to build the module name for your helper module in a function body of a function on the type module.

If the compiler cannot know the module at compile time it cannot react in any way.

Another option would be inverting the dependency. Put the implementations for provided functionality into the type module and let the helper delegate to the implementation on the type.

josevalim

josevalim

Creator of Elixir

:+1: for this particular bit. In this case, it has to be a compile-time dependency, so minimizing the subgraph makes sense.

gmile

gmile OP

Thanks! In a few places in the codebase, I ultimately settled on using Module.concat/1, since refactoring using the “reverse dependency” approach was a little more work in my case, and better done separately.

— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
roeland
Kia ora, We have been using elixir-google-api to connect to Google Drive. However, with the updates to Tesla due to CVEs this is now bro...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
rahultumpala
Hello, I have an Elixir backend that implements a custom protocol over TCP. I want to load test the backend and assess the performance o...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews