EventStore: persistence for events (#524)

* add migration and ecto schema for event_data
* add protocol for events
* save user_id in events
* add missing commands

lib/radiator/event_store.ex

@@ -3,8 +3,66 @@ defmodule Radiator.EventStore do
   EventStore persists events
   """
 
+  alias Radiator.EventStore.EventData
+  alias Radiator.Outline.Event.AbstractEvent
+  alias Radiator.Repo
+
   def persist_event(event) do
-    # persist event
+    {:ok, _stored_event} =
+      create_event_data(%{
+        data: AbstractEvent.payload(event),
+        event_type: AbstractEvent.event_type(event),
+        uuid: event.event_id,
+        user_id: event.user_id
+      })
+
     event
   end
+
+  @doc """
+  Returns the list of foo_events.
+
+  ## Examples
+
+      iex> list_events()
+      [%Event{}, ...]
+
+  """
+  def list_event_data do
+    Repo.all(EventData)
+  end
+
+  @doc """
+  Gets a single event data.
+
+  Raises `Ecto.NoResultsError` if the EventData does not exist.
+
+  ## Examples
+
+      iex> get_event_data!(123)
+      %Event{}
+
+      iex> get_event_data!(456)
+      ** (Ecto.NoResultsError)
+
+  """
+  def get_event_data!(id), do: Repo.get!(EventData, id)
+
+  @doc """
+  Creates a event.
+
+  ## Examples
+
+      iex> create_event_data(%{field: value})
+      {:ok, %EventData{}}
+
+      iex> create_event_data(%{field: bad_value})
+      {:error, %Ecto.Changeset{}}
+
+  """
+  def create_event_data(attrs \\ %{}) do
+    %EventData{}
+    |> EventData.changeset(attrs)
+    |> Repo.insert()
+  end
 end

lib/radiator/event_store/event_data.ex

@@ -0,0 +1,25 @@
+defmodule Radiator.EventStore.EventData do
+  @moduledoc """
+  EventData schema represents a persistend event.
+  """
+  use Ecto.Schema
+  import Ecto.Changeset
+
+  alias Radiator.Accounts.User
+
+  @primary_key {:uuid, :binary_id, autogenerate: false}
+  schema "event_data" do
+    field :data, :map, default: %{}
+    field :event_type, :string
+
+    belongs_to :user, User
+    timestamps(type: :utc_datetime)
+  end
+
+  @doc false
+  def changeset(event, attrs) do
+    event
+    |> cast(attrs, [:uuid, :event_type, :data, :user_id])
+    |> validate_required([:uuid, :event_type, :user_id])
+  end
+end

lib/radiator/outline.ex

@@ -91,7 +91,7 @@ defmodule Radiator.Outline do
       {:error, %Ecto.Changeset{}}
 
   """
-  def remove_node(%Node{} = node, _socket_id \\ nil) do
+  def remove_node(%Node{} = node) do
     next_node =
       Node
       |> where([n], n.prev_id == ^node.uuid)

lib/radiator/outline/command.ex

@@ -1,7 +1,12 @@
 defmodule Radiator.Outline.Command do
   @moduledoc false
 
-  alias Radiator.Outline.Command.{ChangeNodeContentCommand, InsertNodeCommand}
+  alias Radiator.Outline.Command.{
+    ChangeNodeContentCommand,
+    DeleteNodeCommand,
+    InsertNodeCommand,
+    MoveNodeCommand
+  }
 
   def build("insert_node", payload, user_id, event_id) do
     %InsertNodeCommand{
@@ -11,6 +16,14 @@ defmodule Radiator.Outline.Command do
     }
   end
 
+  def build("delete_node", node_id, user_id, event_id) do
+    %DeleteNodeCommand{
+      event_id: event_id,
+      user_id: user_id,
+      node_id: node_id
+    }
+  end
+
   def build("change_node_content", node_id, content, user_id, event_id) do
     %ChangeNodeContentCommand{
       event_id: event_id,
@@ -19,4 +32,14 @@ defmodule Radiator.Outline.Command do
       content: content
     }
   end
+
+  def build("move_node", node_id, parent_node_id, prev_node_id, user_id, event_id) do
+    %MoveNodeCommand{
+      event_id: event_id,
+      user_id: user_id,
+      node_id: node_id,
+      parent_node_id: parent_node_id,
+      prev_node_id: prev_node_id
+    }
+  end
 end

lib/radiator/outline/dispatch.ex

@@ -11,23 +11,22 @@ defmodule Radiator.Outline.Dispatch do
   end
 
   def change_node_content(node_id, content, user_id, event_id) do
-    # IO.inspect(node_id, label: "Dispatcher change_node_content")
     "change_node_content"
     |> Command.build(node_id, content, user_id, event_id)
     |> EventProducer.enqueue()
   end
 
-  # def move_node(attributes, user_id, event_id) do
-  #   "move_node"
-  #   |> Command.build(attributes, user_id, event_id)
-  #   |> EventProducer.enqueue()
-  # end
-
-  # def delete_node(node_id, user_id, event_id) do
-  #   "delete_node"
-  #   |> Command.build(node_id, user_id, event_id)
-  #   |> EventProducer.enqueue()
-  # end
+  def move_node(node_id, parent_node_id, prev_node_id, user_id, event_id) do
+    "move_node"
+    |> Command.build(node_id, parent_node_id, prev_node_id, user_id, event_id)
+    |> EventProducer.enqueue()
+  end
+
+  def delete_node(node_id, user_id, event_id) do
+    "delete_node"
+    |> Command.build(node_id, user_id, event_id)
+    |> EventProducer.enqueue()
+  end
 
   def subscribe(_episode_id) do
     Phoenix.PubSub.subscribe(Radiator.PubSub, "events")

lib/radiator/outline/event/abstract_event.ex

@@ -0,0 +1,38 @@
+defprotocol Radiator.Outline.Event.AbstractEvent do
+  def payload(event)
+  def event_type(event)
+end
+
+alias Radiator.Outline.Event.{NodeContentChangedEvent, NodeInsertedEvent}
+
+defimpl Radiator.Outline.Event.AbstractEvent, for: NodeInsertedEvent do
+  def payload(event) do
+    event.node
+  end
+
+  def event_type(_event), do: "NodeInsertedEvent"
+end
+
+defimpl Radiator.Outline.Event.AbstractEvent, for: NodeContentChangedEvent do
+  def payload(event) do
+    %{node_id: event.node_id, content: event.content}
+  end
+
+  def event_type(_event), do: "NodeInsertedEvent"
+end
+
+defimpl Radiator.Outline.Event.AbstractEvent, for: NodeDeletedEvent do
+  def payload(event) do
+    event.node_id
+  end
+
+  def event_type(_event), do: "NodeDeletedEvent"
+end
+
+defimpl Radiator.Outline.Event.AbstractEvent, for: NodeMovedEvent do
+  def payload(event) do
+    %{node_id: event.node_id, parent_id: event.parent_id, prev_id: event.prev_id}
+  end
+
+  def event_type(_event), do: "NodeInsertedEvent"
+end

lib/radiator/outline/event/node_content_changed_event.ex

@@ -1,5 +1,5 @@
 defmodule Radiator.Outline.Event.NodeContentChangedEvent do
   @moduledoc false
 
-  defstruct [:event_id, :node]
+  defstruct [:event_id, :node_id, :content, :user_id]
 end

lib/radiator/outline/event/node_deleted_event.ex

@@ -1,3 +1,4 @@
 defmodule Radiator.Outline.Event.NodeDeletedEvent do
   @moduledoc false
+  defstruct [:event_id, :node_id, :user_id]
 end

lib/radiator/outline/event/node_inserted_event.ex

@@ -1,5 +1,5 @@
 defmodule Radiator.Outline.Event.NodeInsertedEvent do
   @moduledoc false
 
-  defstruct [:event_id, :node]
+  defstruct [:event_id, :node, :user_id]
 end

lib/radiator/outline/event/node_moved_event.ex

@@ -1,3 +1,4 @@
 defmodule Radiator.Outline.Event.NodeMovedEvent do
   @moduledoc false
+  defstruct [:event_id, :node_id, :parent_id, :prev_id, :user_id]
 end

lib/radiator/outline/event_consumer.ex

@@ -24,8 +24,9 @@ defmodule Radiator.Outline.EventConsumer do
     {:noreply, [], state}
   end
 
-  defp process_command(%InsertNodeCommand{payload: payload} = command) do
+  defp process_command(%InsertNodeCommand{payload: payload, user_id: user_id} = command) do
     payload
+    |> Map.merge(%{"user_id" => user_id})
     |> Outline.insert_node()
     |> handle_insert_node_result(command)
   end
@@ -37,7 +38,7 @@ defmodule Radiator.Outline.EventConsumer do
   end
 
   defp handle_insert_node_result({:ok, node}, command) do
-    %NodeInsertedEvent{node: node, event_id: command.event_id}
+    %NodeInsertedEvent{node: node, event_id: command.event_id, user_id: command.user_id}
     |> EventStore.persist_event()
     |> Dispatch.broadcast()
 
@@ -49,8 +50,13 @@ defmodule Radiator.Outline.EventConsumer do
     :error
   end
 
-  def handle_change_node_content_result({:ok, node}, command) do
-    %NodeContentChangedEvent{node: node, event_id: command.event_id}
+  def handle_change_node_content_result({:ok, node}, %ChangeNodeContentCommand{} = command) do
+    %NodeContentChangedEvent{
+      node_id: node.id,
+      content: node.content,
+      user_id: command.user_id,
+      event_id: command.event_id
+    }
     |> EventStore.persist_event()
     |> Dispatch.broadcast()
 

lib/radiator/outline/node.ex

@@ -1,7 +1,6 @@
 defmodule Radiator.Outline.Node do
   @moduledoc """
-  The node model which represents a single node in the outline.
-  Currenty there is no concept of a tree
+  The node model represents a single node in the outline.
   """
   use Ecto.Schema
   import Ecto.Changeset

lib/radiator_web/live/episode_live/index.ex

@@ -1,7 +1,6 @@
 defmodule RadiatorWeb.EpisodeLive.Index do
   use RadiatorWeb, :live_view
 
-  alias Radiator.Outline
   alias Radiator.Outline.{Dispatch, NodeRepository}
   alias Radiator.Outline.Event.{NodeContentChangedEvent, NodeInsertedEvent}
   alias Radiator.Podcast
@@ -67,13 +66,13 @@ defmodule RadiatorWeb.EpisodeLive.Index do
     |> reply(:noreply)
   end
 
-  def handle_event("delete_node", %{"uuid" => uuid}, socket) do
+  def handle_event("delete_node", %{"uuid" => _uuid}, socket) do
     _event_id = generate_event_id(socket.id)
 
-    case NodeRepository.get_node(uuid) do
-      nil -> nil
-      node -> Outline.remove_node(node, socket.id)
-    end
+    # case NodeRepository.get_node(uuid) do
+    #   nil -> nil
+    #   node -> Outline.remove_node(node, socket.id)
+    # end
 
     socket
     |> reply(:noreply)
@@ -95,9 +94,12 @@ defmodule RadiatorWeb.EpisodeLive.Index do
     |> reply(:noreply)
   end
 
-  def handle_info(%NodeContentChangedEvent{node: node}, socket) do
+  def handle_info(
+        %NodeContentChangedEvent{node_id: id, content: content},
+        socket
+      ) do
     socket
-    |> push_event("update", %{node: node})
+    |> push_event("update", %{node: %{id: id, content: content}})
     |> reply(:noreply)
   end
 

priv/repo/migrations/20240501153929_create_event_data.exs

@@ -0,0 +1,16 @@
+defmodule Radiator.Repo.Migrations.CreateEventData do
+  use Ecto.Migration
+
+  def change do
+    create table(:event_data, primary_key: false) do
+      add :uuid, :uuid, primary_key: true
+      add :event_type, :string
+      add :user_id, references(:users, on_delete: :nothing)
+      add :data, :map, default: %{}
+
+      timestamps(type: :utc_datetime)
+    end
+
+    create index(:event_data, [:user_id])
+  end
+end

test/radiator/event_store_test.exs

@@ -0,0 +1,45 @@
+defmodule Radiator.EventStoreTest do
+  use Radiator.DataCase
+
+  alias Radiator.EventStore
+
+  describe "event_data" do
+    alias Radiator.EventStore.EventData
+
+    alias Radiator.AccountsFixtures
+    import Radiator.EventStoreFixtures
+
+    @invalid_attrs %{data: nil, uuid: nil, event_type: nil}
+
+    test "list_event_data/0 returns all event_data" do
+      event = event_data_fixture()
+      assert EventStore.list_event_data() == [event]
+    end
+
+    test "get_event!/1 returns the event_data with given id" do
+      event = event_data_fixture()
+      assert EventStore.get_event_data!(event.uuid) == event
+    end
+
+    test "create_event/1 with valid data creates a event" do
+      user = AccountsFixtures.user_fixture()
+
+      valid_attrs = %{
+        data: %{},
+        uuid: Ecto.UUID.generate(),
+        event_type: "some event_type",
+        user_id: user.id
+      }
+
+      assert {:ok, %EventData{} = event} = EventStore.create_event_data(valid_attrs)
+      assert event.data == %{}
+      assert event.uuid == valid_attrs.uuid
+      assert event.event_type == valid_attrs.event_type
+      assert event.user_id == valid_attrs.user_id
+    end
+
+    test "create_event/1 with invalid data returns error changeset" do
+      assert {:error, %Ecto.Changeset{}} = EventStore.create_event_data(@invalid_attrs)
+    end
+  end
+end