test: enable async on RepoCase tests using start_enactment (audit #18) (#80)

Author: fahchen

lib/coloured_flow/runner/enactment/enactment.ex

@@ -96,6 +96,10 @@ defmodule ColouredFlow.Runner.Enactment do
   @spec start_link(options()) :: GenServer.on_start()
   def start_link(options) do
     enactment_id = Keyword.fetch!(options, :enactment_id)
+    # Forward `$callers` from the calling process so collaborating processes
+    # (e.g., Ecto.Adapters.SQL.Sandbox-aware tests) can be tracked. See
+    # `ExUnit.Callbacks.start_supervised/2` for the recommended pattern.
+    options = Keyword.put_new(options, :"$callers", Process.get(:"$callers", []))
 
     GenServer.start_link(
       __MODULE__,
@@ -107,10 +111,13 @@ defmodule ColouredFlow.Runner.Enactment do
 
   @impl GenServer
   def init(options) do
-    state =
-      __MODULE__
-      |> struct(options)
-      |> Map.put(:hibernate_after, Lifespan.hibernate_after_from_options(options))
+    {callers, options} = Keyword.pop(options, :"$callers", [])
+    Process.put(:"$callers", callers)
+
+    options =
+      Keyword.put(options, :hibernate_after, Lifespan.hibernate_after_from_options(options))
+
+    state = struct(__MODULE__, options)
 
     {:ok, state, {:continue, :populate_state}}
   end

test/coloured_flow/runner/enactment/enactment_termination_and_exception_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.Enactment.EnactmentTerminationAndExceptionTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   import ColouredFlow.MultiSet, only: :sigils

test/coloured_flow/runner/enactment/enactment_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.EnactmentTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   alias ColouredFlow.Enactment.BindingElement
@@ -304,6 +304,7 @@ defmodule ColouredFlow.Runner.EnactmentTest do
 
     test "coalesces a burst of :take_snapshot messages into fewer storage writes",
          %{enactment: enactment} do
+      enactment_id = enactment.id
       [enactment_server: enactment_server] = start_enactment(%{enactment: enactment})
 
       # Wait until the boot-time snapshot from `handle_continue` has been emitted
@@ -317,8 +318,12 @@ defmodule ColouredFlow.Runner.EnactmentTest do
         :telemetry.attach(
           handler_id,
           [:coloured_flow, :runner, :enactment, :take_snapshot],
-          fn _event, _measurements, _metadata, _config ->
-            send(self_pid, :snapshot_taken)
+          fn _event, _measurements, metadata, _config ->
+            # Filter by enactment_id so concurrent async tests don't pollute
+            # this test's measurement.
+            if metadata.enactment_id == enactment_id do
+              send(self_pid, :snapshot_taken)
+            end
           end,
           nil
         )

test/coloured_flow/runner/enactment/integration_tests/constants_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.Enactment.IntegrationTests.ConstantsTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   alias ColouredFlow.Enactment.BindingElement

test/coloured_flow/runner/enactment/integration_tests/pattern_match_on_complex_tokens_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.Enactment.IntegrationTests.PatternMatchOnComplexTokensTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   alias ColouredFlow.Enactment.BindingElement

test/coloured_flow/runner/enactment/integration_tests/reuse_workitems_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.Enactment.IntegrationTests.ReuseWorkitemsTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   alias ColouredFlow.Enactment.BindingElement

test/coloured_flow/runner/enactment/integration_tests/transition_without_input_places_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.Enactment.IntegrationTests.TransitionWithoutInputPlacesTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   alias ColouredFlow.Enactment.BindingElement

test/coloured_flow/runner/enactment/integration_tests/transition_without_output_places_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.Enactment.IntegrationTests.TransitionWithoutOutputPlacesTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   alias ColouredFlow.Enactment.BindingElement

test/coloured_flow/runner/enactment/integration_tests/transition_without_token_consumed_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.Enactment.IntegrationTests.TransitionWithoutTokenConsumedTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   alias ColouredFlow.Enactment.BindingElement

test/coloured_flow/runner/enactment/integration_tests/transition_without_token_produced_test.exs

@@ -1,5 +1,5 @@
 defmodule ColouredFlow.Runner.Enactment.IntegrationTests.TransitionWithoutTokenProducedTest do
-  use ColouredFlow.RepoCase
+  use ColouredFlow.RepoCase, async: true
   use ColouredFlow.RunnerHelpers
 
   alias ColouredFlow.Enactment.BindingElement