Add typespecs, property tests, and dialyzer CI

.github/workflows/ci.yml

@@ -1,34 +1,57 @@
-on: push
-
-env:
-  ELIXIR_ERL_OPTIONS: -kernel prevent_overlapping_partitions false
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        elixir-version: [1.15, 1.14, 1.13]
-        otp-version: [26, 25, 24]
-        exclude:
-          - elixir-version: 1.13
-            otp-version: 26
-
-    name: Tests
-    steps:
-      - uses: actions/checkout@v3
-      - uses: erlef/setup-beam@v1
-        with:
-          elixir-version: ${{ matrix.elixir-version }}
-          otp-version: ${{ matrix.otp-version }}
-
-      - run: mix deps.get
-
-      - run: mix compile --warnings-as-errors
-        if: matrix.elixir-version == 1.15 && matrix.otp-version == 26
-
-      - run: mix format --check-formatted
-        if: matrix.elixir-version == 1.15 && matrix.otp-version == 26
-
-      - run: mix test
+on: push
+
+env:
+  ELIXIR_ERL_OPTIONS: -kernel prevent_overlapping_partitions false
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        elixir-version: [1.15, 1.14, 1.13]
+        otp-version: [26, 25, 24]
+        exclude:
+          - elixir-version: 1.13
+            otp-version: 26
+
+    name: Tests
+    steps:
+      - uses: actions/checkout@v3
+      - uses: erlef/setup-beam@v1
+        with:
+          elixir-version: ${{ matrix.elixir-version }}
+          otp-version: ${{ matrix.otp-version }}
+
+      - run: mix deps.get
+
+      - run: mix compile --warnings-as-errors
+        if: matrix.elixir-version == 1.15 && matrix.otp-version == 26
+
+      - run: mix format --check-formatted
+        if: matrix.elixir-version == 1.15 && matrix.otp-version == 26
+
+      - run: mix test
+
+  dialyzer:
+    runs-on: ubuntu-latest
+    name: Dialyzer
+    steps:
+      - uses: actions/checkout@v3
+      - uses: erlef/setup-beam@v1
+        with:
+          elixir-version: 1.15
+          otp-version: 26
+
+      - name: Restore PLT cache
+        uses: actions/cache@v3
+        with:
+          path: priv/plts
+          key: plt-${{ runner.os }}-1.15-26-${{ hashFiles('mix.lock') }}
+          restore-keys: |
+            plt-${{ runner.os }}-1.15-26-
+
+      - run: mkdir -p priv/plts
+      - run: mix deps.get
+      - run: mix dialyzer --plt
+      - run: mix dialyzer

.gitignore

@@ -1,31 +1,34 @@
-# The directory Mix will write compiled artifacts to.
-/_build/
-
-# If you run "mix test --cover", coverage assets end up here.
-/cover/
-
-# The directory Mix downloads your dependencies sources to.
-/deps/
-
-# Where 3rd-party dependencies like ExDoc output generated docs.
-/doc/
-
-# Ignore .fetch files in case you like to edit your project deps locally.
-/.fetch
-
-# If the VM crashes, it generates a dump, let's ignore it too.
-erl_crash.dump
-
-# Also ignore archive artifacts (built via "mix archive.build").
-*.ez
-
-# Ignore package tarball (built via "mix hex.build").
-horde-*.tar
-
-.elixir_ls
-
-*.beam
-
-.tool-versions
-
-*.app
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where 3rd-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+horde-*.tar
+
+.elixir_ls
+
+*.beam
+
+.tool-versions
+
+*.app
+
+# Dialyzer PLT files
+/priv/plts/

lib/horde/distribution_strategy.ex

@@ -3,9 +3,9 @@ defmodule Horde.DistributionStrategy do
 
   @moduledoc """
   Define your own distribution strategy by implementing this behaviour and configuring Horde to use it.
-
+  
   A few distribution strategies are included in Horde, namely:
-
+  
   - `Horde.UniformDistribution`
   - `Horde.UniformQuorumDistribution`
   - `Horde.UniformRandomDistribution`
@@ -15,6 +15,6 @@ defmodule Horde.DistributionStrategy do
               spec :: Supervisor.child_spec(),
               members :: [member()]
             ) ::
-              {:ok, member()} | {:error, reason :: String.t()}
-  @callback has_quorum?(members :: [member()]) :: boolean()
+              {:ok, member()} | {:error, reason :: atom()}
+  @callback has_quorum?(members :: [member()]) :: boolean() | nil
 end

lib/horde/dynamic_supervisor_impl.ex

@@ -231,7 +231,7 @@ defmodule Horde.DynamicSupervisorImpl do
     {:noreply, state}
   end
 
-  def handle_cast({:untrack_child_process, child_id}, state) do
+  def handle_cast({:release_child_process, child_id}, state) do
     {value, new_processes_by_id} = pop_item(state.processes_by_id, child_id)
 
     new_state =