joshua.aug

joshua.aug

"The pattern can never match the type." error from dialyzer

Im getting this error from dialyzer “The pattern can never match the type.”

Here’s some sample code

  @spec check_rating_to_play(any(), any()) :: :ok | {:error, String.t()}
  def check_rating_to_play(user_id, consul_state) do
  @spec check_rank_to_play(any(), any()) :: :ok | {:error, String.t()}
  def check_rank_to_play(user, consul_state) do

This function is called like this

    rating_check_result = LobbyRestrictions.check_rating_to_play(userid, state)

    rank_check_result = LobbyRestrictions.check_rank_to_play(user, state)

    cond do
      rating_check_result != :ok ->
        # Send message
        {_, msg} = rating_check_result
        CacheUser.send_direct_message(get_coordinator_userid(), userid, msg)
        false

      rank_check_result != :ok ->
        # Send message
        {_, msg} = rank_check_result
        CacheUser.send_direct_message(get_coordinator_userid(), userid, msg)
        false

Is dialyzer saying that the first condition is always true? I’m confused.

Marked As Solved

al2o3cr

al2o3cr

Dialyzer has inferred that check_rating_to_play and check_rank_to_play can ONLY return :ok, so it deduces that those branches of the cond are dead.

The issue is sneaky, but ultimately comes from get_failed_rating_check_text and get_failed_rank_check_text returning the wrong type.

A walkthrough of what’s happening. Start in this code, from check_rating_to_play:

    cond do
      state.minimum_rating_to_play != nil and player_rating < state.minimum_rating_to_play ->
        msg = get_failed_rating_check_text(player_rating, state, rating_type)
        {:error, msg}
# maximum clause omitted
      true ->
        # All good
        :ok
    end

What’s the type of msg? It’s the return type of get_failed_rating_check_text.

What’s that type? It’s [String.t()]!

  def get_failed_rating_check_text(player_rating, consul_state, rating_type) do
    bounds = get_rating_bounds_for_title(consul_state)
    player_rating_text = player_rating |> Decimal.from_float() |> Decimal.round(2)

    [
      @splitter,
      "You don't meet the rating requirements for this lobby (#{bounds}). Your #{rating_type} match rating is #{player_rating_text}. Learn more about rating here:",
      "https://www.beyondallreason.info/guide/rating-and-lobby-balance#openskill"
    ]
  end

Dialyzer sees this and infers that the minimum_rating_to_play branch of the cond would make the function return {:error, [String.t()]}.

The function is not specced to return that type, so Dialyzer infers that that branch does not execute, so check_rating_to_play “always” returns :ok.

When I run Dialyzer locally, it also complains about get_coordinator_userid not being called - further evidence it has deduced that those branches are dead.

Replacing the lists in get_failed_rating_check_text and get_failed_rank_check_text with a literal string makes all three messages go away, verifying the diagnosis.

Possible fixes:

  • join the strings together in get_failed_rating_check_text etc

  • widen the type of check_rating_to_play etc to :ok, {:error, iodata()}

Also Liked

LostKobrakai

LostKobrakai

To dialyzer doesn‘t matter what it can theoretically return. The only thing that matters is what dialyzer inferred for it to return. And if inference says it only ever returns ˋ:okˋ then the error message makes sense. Now the question becomes why dialyzer would infer that ˋ:okˋ is the only possible return value for those functions.

kokolegorille

kokolegorille

It looks the state is never nil, so :ok can never be reached…

    cond do
      state.minimum_rating_to_play != nil and player_rating < state.minimum_rating_to_play ->
        msg = get_failed_rating_check_text(player_rating, state, rating_type)
        {:error, msg}

      state.maximum_rating_to_play != nil and player_rating > state.maximum_rating_to_play ->
        msg = get_failed_rating_check_text(player_rating, state, rating_type)
        {:error, msg}

      true ->
        # All good
        :ok 

In this file…

https://github.com/beyond-all-reason/teiserver/blob/08351a1af2be5021041f447c881e330f45216d77/lib/teiserver/lobby/libs/lobby_restrictions.ex

Last Post!

al2o3cr

al2o3cr

Followup: if you use the :overspecs flag in your Dialyxir config, you get a much more intelligible error message (among a BUNCH of messages):

________________________________________________________________________________
lib/teiserver/lobby/libs/lobby_restrictions.ex:130:missing_range
The type specification is missing types returned by function.

Function:
Teiserver.Lobby.LobbyRestrictions.check_rank_to_play/2

Type specification return types:
:ok | {:error, binary()}

Missing from spec:
{:error, [<<_::64, _::size(8)>>, ...]}

________________________________________________________________________________
lib/teiserver/lobby/libs/lobby_restrictions.ex:163:missing_range
The type specification is missing types returned by function.

Function:
Teiserver.Lobby.LobbyRestrictions.check_rating_to_play/2

Type specification return types:
:ok | {:error, binary()}

Missing from spec:
{:error, [<<_::64, _::size(8)>>, ...]}

Unfortunately, you also get a TON of these:

________________________________________________________________________________
lib/teiserver_web/controllers/api/hailstorm_controller.ex:205:contract_subtype
Type specification is a subtype of the success typing.

Function:
Teiserver.API.HailstormAuth.authorize/3

Type specification:
@spec authorize(Atom.t(), Plug.Conn.t(), Map.t()) :: Boolean.t()

Success typing:
@spec authorize(_, _, _) :: any()

Somewhat annoying that those two checks are only available together, as the former seems like a much stronger “there may be a bug” signal than the latter. :thinking:

Where Next?

Popular in Questions Top

vonH
When I run the Plug and I recompile I wind up having to use Ctrl C to quit iex and start again. Witht the help of rlwrap I can use the cu...
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
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
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
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? Ecto.Repo — Ecto v3.14.0 has exampl...
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

grych
Hi folks, Few months ago I have announced the proof-of-concept of the library to manipulate the browsers DOM objects directly from Elixi...
639 54260 488
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
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
sergio_101
I am VERY much an elixir newbie. I have taken one elixir course and one phoenix course on Udemy. During that course, I saw the instructor...
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
TunkShif
This post is an instruction guide to help you setup your Neovim for Elixir development from scratch. It includes general information on h...
274 42716 114
New

We're in Beta

About us Mission Statement