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

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
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
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
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
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New
marius95
Hello everyone, I try to use an Javascript Event Handler in my root.html.leex file. Therefore I created a function in the app.js file: ...
New
dblack
I’ve got an issue with an app and I’ve no idea of how to troubleshoot it. I’m hoping someone here might have seen something similar. I p...
New

Other popular topics Top

nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 54921 245
New
sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
New
axelson
This post is a wiki (feel free to hit the edit button near the bottom right of this post to add your own changes!) This post collects co...
239 49084 226
New
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
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

We're in Beta

About us Mission Statement