Merge pull request #35 from epochtalk/dialyxir-update

Dialyxir update, fixes static code analysis

Author: akinsey

.github/workflows/main.yml

@@ -77,7 +77,36 @@ jobs:
           key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('mix.lock') }}
       - run: mix format --check-formatted
       - run: mix credo || ret=$?; if [ $ret != 2 ]; then exit $ret; fi
-      - run: mix dialyzer --no-check --ignore-exit-status
+      # PLT cache for dialyzer
+      # Don't cache PLTs based on mix.lock hash, as Dialyzer can incrementally update even old ones
+      # Cache key based on Elixir & Erlang version (also useful when running in matrix)
+      - name: Restore PLT cache
+        uses: actions/cache/restore@v3
+        id: plt_cache
+        with:
+          key: |
+            ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt
+          path: |
+            priv/plts
+      # Create PLTs if no cache was found
+      - name: Create PLTs
+        if: steps.plt_cache.outputs.cache-hit != 'true'
+        run: mix dialyzer --plt
+      # By default, the GitHub Cache action will only save the cache if all steps in the job succeed,
+      # so we separate the cache restore and save steps in case running dialyzer fails.
+      - name: Save PLT cache
+        uses: actions/cache/save@v3
+        if: steps.plt_cache.outputs.cache-hit != 'true'
+        id: plt_cache_save
+        with:
+          key: |
+            ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt
+          path: |
+            priv/plts
+      - name: Run dialyzer
+        run: mix dialyzer --format github
   test_job:
     needs: dependencies
     name: Run tests

lib/epochtalk_server/models/role.ex

@@ -168,7 +168,7 @@ defmodule EpochtalkServer.Models.Role do
   @doc """
   Updates the priority_restrictions of an existing `Role` in the database
   """
-  @spec set_priority_restrictions(id :: integer, priority_restrictions :: list()) ::
+  @spec set_priority_restrictions(id :: integer, priority_restrictions :: list() | nil) ::
           {:ok, role :: t()} | {:error, Ecto.Changeset.t()}
   def set_priority_restrictions(id, []), do: set_priority_restrictions(id, nil)
 

lib/epochtalk_server/session.ex

@@ -46,7 +46,7 @@ defmodule EpochtalkServer.Session do
   Get the resource for a specified user_id and session_id if available
   Otherwise, return an error
   """
-  @spec get_resource(user_id :: String.t(), session_id :: String.t()) ::
+  @spec get_resource(user_id :: non_neg_integer, session_id :: String.t()) ::
           {:ok, resource :: map()}
           | {:error, reason :: String.t() | Redix.Error.t() | Redix.ConnectionError.t()}
   def get_resource(user_id, session_id) do

lib/epochtalk_server_web/helpers/validate.ex

@@ -10,7 +10,7 @@ defmodule EpochtalkServerWeb.Helpers.Validate do
   Helper used to default a list request parameter.  If the list is valid, returns the list
   otherwise, defaults to empty list
   """
-  @spec sanitize_list(attrs :: map, key :: String.t()) :: List.t()
+  @spec sanitize_list(attrs :: map, key :: String.t()) :: [any()] | []
   def sanitize_list(attrs, key)
       when is_map(attrs) and is_binary(key),
       do: if(is_list(attrs[key]), do: attrs[key], else: [])

mix.exs

@@ -36,7 +36,7 @@ defmodule EpochtalkServer.MixProject do
       {:argon2_elixir, "~> 3.0.0"},
       {:corsica, "~> 1.2.0"},
       {:credo, "~> 1.6", only: [:dev, :test], runtime: false},
-      {:dialyxir, "~> 1.0", only: [:dev], runtime: false},
+      {:dialyxir, "~> 1.2", only: [:dev], runtime: false},
       {:ecto_sql, "~> 3.6"},
       {:ex_doc, "~> 0.28.5"},
       {:gen_smtp, "~> 1.2"},