Fl4m3Ph03n1x

Fl4m3Ph03n1x

Incorrect dialyzer warning with defguard

Background

I am playing around with defguard in macro I am defining. The macro has an opaque type and I think dialyzer is having issues with this:

macro:

defmodule NewType do

  defmacro deftype(name, type) do
    quote do
      defmodule unquote(name) do
        @opaque t :: {unquote(name), unquote(type)}

        @spec new(value :: unquote(type)) :: t
        def new(value) when is_binary(value), do: {unquote(name), value}

        @spec extract(new_type :: t) :: unquote(type)
        def extract({unquote(name), value}), do: value
      end
    end
  end

  defguard is_type?(value, mod)
           when is_tuple(value) and
                  elem(value, 0) == mod and is_binary(elem(value, 1))
end

In theory, an invocation of deftype Name, String.t() would generate:

defmodule Name do
   @opaque t :: {Name, String.t}

  @spec new(value :: String.t()) :: t
  def new(value) when is_binary(value), do: {Name, value}

  @spec extract(new_type :: t) :: String.t()
  def extract({Name, value}), do: value
end

And in fact, this code works as intended:

type.ex (module where I define several types)

defmodule Type do
  import NewType
  
  deftype Name, String.t()
end

test.ex

defmodule Test do
  alias Type.Name

  @spec print(Name.t()) :: binary
  def print(name), do: Name.extract(name)
end

Problem

The problem arises when I try to use the guard:

test.ex

defmodule Test do
  import NewType
  alias Type.Name

  @spec print(Name.t()) :: binary
  def print(name) when is_type?(name, Name), do: Name.extract(name)
end

Everything runs as expected, but dialyzer does not see it the same way:

lib/test.ex:6:no_return
Function print/1 has no local return.
________________________________________________________________________________
lib/test.ex:6:call_without_opaque
Function call without opaqueness type mismatch.

Call does not have expected opaque term of type Type.Name.t() in the 1st position.

Type.Name.extract(_name :: tuple())

________________________________________________________________________________
done (warnings were emitted)
Halting VM with exit status 2

Even though Name.extract does receive a Name.t as a parameter, dialyzer states otherwise.
At this point, I think this might be because I am “exposing” the internal data structure in the guard with is_tuple, but at the same time, I don’t see how else I can have defguard and still use opaque types.

Question

Am I missing something?

Marked As Solved

NobbZ

NobbZ

Dialyzer ignores the spec of Test.print/1, when it has other ways to infer the type of the argument. Due to the use of the is_type?/1 guard, dialyzer infers that the type has to be tuple(). tuple() is not Name.t().

If you deal with opaque types, you can not manually create them, you can not destructure them, you can not use them in guards. You have to pass them around as they are. Only functions in Name are allowed to access its internals.

Where Next?

Popular in Questions Top

sergio
In Ruby, I can go: User.find_by(email: "foobar@email.com").update(email: "hello@email.com") How can I do something similar in Elixir? ...
New
jerry
Good day to you all. I have been struggling to get a query involving like and ilike to work. Can anyone assist me on this, please? pro...
New
New
Kagamiiiii
Student & New to elixir. Nice language. I want to convert a english character, e.g. “a”, which is stored in a variable, to it’s asci...
New
sacepums
Hey guys. I'm new to elixir and im really stocked about it. But I ran into a bit of problem - I need to convert a date sting, for examp...
New
mcarvalho
What is the difference between System.get_env and Application.get_env? For example, what are best practices to use one versus another.
New
aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
minhajuddin
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
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
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New

Other popular topics Top

yurko
Here are few pieces of (common) Linux knowledge that we use for reasonably small one server apps. We use Ubuntu but this should work for ...
New
Tee
can someone please explain to me how Enum.reduce works with maps
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
itssasanka
Hi all, Trying to get some more clarity over utc_datetime and naive_datetime for Ecto: https://hexdocs.pm/ecto/Ecto.Schema.html#module-...
New
chrismccord
This release brings a number of exciting features, including integration with the new Phoenix LiveDashboard and Phoenix LiveView. There h...
New
chensan
I have a User schema with a :from_id field set to type :string: defmodule TweetBot.Repo.Migrations.CreateUsers do use Ecto.Migration ...
New
stefanluptak
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
New
johnnyicon
Hi all, I've just started learning Elixir and Phoenix Framework, so please pardon my n00bness at this stage. I'm trying to use Postg...
New
skosch
To my knowledge, put_in, Map.update etc. all have the one limitation of not automatically creating intermediate keys when needed (for exa...
New
vrod
I am using the Starship cross-shell prompt – it seems pretty nice, but I get some errors: [WARN] - (starship::utils): Executing command ...
New

We're in Beta

About us Mission Statement