Add support for Plug (#6)

* Add support for Plug

* Update Storex application supervisor children spec

* Add separated test config

* Update GitHub Actions workflow

* Reorganize tests files, directories structure

* Reorganize tests files, directories structure

* Fix Plug handler stop result

* Handlers tests

.github/workflows/main.yml

@@ -24,7 +24,7 @@ jobs:
       with:
         otp-version: ${{matrix.otp}}
         elixir-version: ${{matrix.elixir}}
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       with:
         path: deps
         key: ${{ runner.os }}-${{matrix.otp}}-${{matrix.elixir}}-mix-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}

CHANGELOG.md

@@ -0,0 +1,42 @@
+# storex
+
+## 0.3.0
+
+- **[BREAKING]** Rename Cowbow handler module from `Storex.Socket.Handler` to `Storex.Handler.Cowboy`
+- Add support for Plug based apps `plug Storex.Plug`
+- Update Storex application supervisor children spec
+
+## 0.2.5
+
+- Fix diff of Date struct
+- Rewrite tests from Hound to Wallaby
+
+## 0.2.4
+
+- Fix root state update
+- Remove optional from jason dependency
+
+## 0.2.3
+
+- Fix reconnect of WebSocket on connection close
+
+## 0.2.2
+
+- Fix reconnect of WebSocket on connection close
+
+## 0.2.1
+
+- Typescript/Javascript improvements
+
+## 0.2.0
+
+- Dynamic registry declaration
+- - Default registry on ETS
+- Fix issue with a restart of Store when stopped on disconnect
+- Update dependencies
+
+## 0.1.0
+
+- The only diff of the store state is being sent on each mutation.
+- Subscriber of connection status
+- Fixes in library

README.md

@@ -16,7 +16,7 @@ Add **storex** to deps in `mix.exs`:
 
 ```elixir
 defp deps do
-  [{:storex, "~> 0.2.5"}]
+  [{:storex, "~> 0.3.0"}]
 end
 ```
 
@@ -30,33 +30,28 @@ Also you need to add **storex** to `package.json` dependencies:
 
 ### Add storex websocket handler
 
-You need to add handler `Storex.Socket.Handler` to cowboy dispatch.
+You need to add handler `Storex.Handler.Plug` or `Storex.Handler.Cowboy`.
 
 **Phoenix:**
-Example based on [Phoenix guides](https://hexdocs.pm/phoenix/Phoenix.Endpoint.Cowboy2Adapter.html)
-
 ```elixir
-config :exampleapp, ExampleApp.Endpoint,
-  http: [
-    dispatch: [
-      {:_,
-       [
-         {"/storex", Storex.Socket.Handler, []},
-         {:_, Phoenix.Endpoint.Cowboy2Handler, {ExampleApp.Endpoint, []}}
-       ]}
-    ]
-  ]
+defmodule YourAppWeb.Endpoint do
+  use Phoenix.Endpoint, otp_app: :your_app
+
+  plug Storex.Plug, path: "/storex"
+
+  # ...
+end
 ```
 
 **Cowboy:**
 ```elixir
 :cowboy_router.compile([
-    {:_, [
-      # ...
-      {"/storex", Storex.Socket.Handler, []},
-      # ...
-    ]}
-  ])
+  {:_, [
+    # ...
+    {"/storex", Storex.Socket.Handler, []},
+    # ...
+  ]}
+])
 ```
 
 ### Create store

config/config.exs

@@ -3,9 +3,3 @@ import Config
 config :storex,
   session_id_library: Nanoid,
   registry: Storex.Registry.ETS
-
-config :wallaby,
-  otp_app: :storex,
-  chromedriver: [
-    # headless: false
-  ]

config/test.exs

@@ -0,0 +1,7 @@
+import Config
+
+config :wallaby,
+  otp_app: :storex,
+  chromedriver: [
+    # headless: false
+  ]

lib/storex.ex

@@ -6,8 +6,8 @@ defmodule Storex do
     import Supervisor.Spec, warn: false
 
     children = [
-      worker(Storex.Registry.ETS, []),
-      supervisor(Storex.Supervisor, [])
+      {Storex.Registry.ETS, []},
+      {Storex.Supervisor, []}
     ]
 
     Supervisor.start_link(children, strategy: :one_for_one, name: __MODULE__)
@@ -16,9 +16,8 @@ defmodule Storex do
   @doc """
   Mutate store from elixir.
 
+  Call mutation callback in store synchronously:
   ```elixir
-  Call mutation callback in store synchronously.
-
   Storex.mutate("d9ez7fgkp96", "ExampleApp.Store", "reload", ["user_id"])
   ```
   """

lib/storex/socket/handler.ex → lib/storex/handler/cowboy.ex

@@ -1,8 +1,6 @@
-defmodule Storex.Socket.Handler do
+defmodule Storex.Handler.Cowboy do
   @moduledoc false
 
-  @behaviour :cowboy_websocket
-
   alias Storex.Socket
 
   def init(request, _state) do
@@ -36,6 +34,7 @@ defmodule Storex.Socket.Handler do
     try do
       :erlang.binary_to_term(frame)
       |> Socket.message_handle(state)
+      |> map_response()
     rescue
       ArgumentError -> {:reply, {:close, 1007, "Payload is malformed."}, state}
     end
@@ -46,6 +45,7 @@ defmodule Storex.Socket.Handler do
     |> case do
       {:ok, message} ->
         Socket.message_handle(message, state)
+        |> map_response()
 
       {:error, _} ->
         {:reply, {:close, 1007, "Payload is malformed."}, state}
@@ -63,9 +63,18 @@ defmodule Storex.Socket.Handler do
       }
     }
     |> Socket.message_handle(state)
+    |> map_response()
   end
 
   def websocket_info(_info, state) do
     {:ok, state}
   end
+
+  defp map_response({:text, message, state}) do
+    {:reply, {:text, message}, state}
+  end
+
+  defp map_response({:close, code, message, state}) do
+    {:reply, {:close, code, message}, state}
+  end
 end

lib/storex/handler/plug.ex

@@ -0,0 +1,67 @@
+defmodule Storex.Handler.Plug do
+  @moduledoc false
+
+  alias Storex.Socket
+
+  def init(_) do
+    session = Application.get_env(:storex, :session_id_library, Nanoid).generate()
+    pid = self()
+
+    Storex.Registry.register_session(session, pid)
+
+    {:ok, %{session: session, pid: pid}}
+  end
+
+  def terminate(_reason, _req, %{session: session}) do
+    Storex.Registry.session_stores(session)
+    |> Enum.each(fn {session, store, _} ->
+      Storex.Supervisor.remove_store(session, store)
+    end)
+
+    Storex.Registry.unregister_session(session)
+
+    :ok
+  end
+
+  def terminate(_, _) do
+    :ok
+  end
+
+  def handle_in({message, [opcode: :text]}, state) do
+    Jason.decode(message, keys: :atoms)
+    |> case do
+      {:ok, message} ->
+        Socket.message_handle(message, state)
+        |> map_response()
+
+      {:error, _} ->
+        {:stop, "Payload is malformed.", 1007, state}
+    end
+  end
+
+  def handle_info({:mutate, store, mutation, data}, %{session: session} = state) do
+    %{
+      type: "mutation",
+      session: session,
+      store: store,
+      data: %{
+        data: data,
+        name: mutation
+      }
+    }
+    |> Socket.message_handle(state)
+    |> map_response()
+  end
+
+  def handle_info(_info, state) do
+    {:ok, state}
+  end
+
+  defp map_response({:text, message, state}) do
+    {:push, {:text, message}, state}
+  end
+
+  defp map_response({:close, code, message, state}) do
+    {:stop, :normal, {code, message}, state}
+  end
+end

lib/storex/plug.ex

@@ -0,0 +1,42 @@
+defmodule Storex.Plug do
+  import Plug.Conn
+
+  @moduledoc """
+  Add Storex to your Plug application, to handle WebSocket connections.
+
+  Example for Phoenix Endpoint:
+
+  ```elixir
+  defmodule YourAppWeb.Endpoint do
+    use Phoenix.Endpoint, otp_app: :your_app
+
+    plug Storex.Plug
+
+    # ...
+  end
+  ```
+
+  ## Options
+
+  - `:path` - The path to mount the Storex handler. Default is `"/storex"`.
+  """
+
+  @doc false
+  def init(options \\ []) do
+    [
+      path: Keyword.get(options, :path, "/storex")
+    ]
+  end
+
+  @doc false
+  def call(%{method: "GET", request_path: path} = conn, path: path) do
+    conn
+    |> WebSockAdapter.upgrade(Storex.Handler.Plug, [], timeout: 60_000)
+    |> halt()
+  end
+
+  @doc false
+  def call(conn, _) do
+    conn
+  end
+end

lib/storex/registries/ets.ex

@@ -11,7 +11,7 @@ defmodule Storex.Registry.ETS do
   @registry :storex_registry
 
   @doc false
-  def start_link do
+  def start_link(_) do
     GenServer.start_link(__MODULE__, nil, name: @registry)
   end
 

lib/storex/socket.ex

@@ -13,11 +13,11 @@ defmodule Storex.Socket do
       Map.put(message, :type, "pong")
       |> Jason.encode!()
 
-    {:reply, {:text, message}, state}
+    {:text, message, state}
   end
 
   def message_handle(%{store: nil}, state) do
-    {:reply, {:close, 4000, "Store is not set."}, state}
+    {:close, 4000, "Store is not set.", state}
   end
 
   def message_handle(%{type: "join"} = message, state) do
@@ -35,11 +35,10 @@ defmodule Storex.Socket do
           |> Map.put(:session, state.session)
           |> Jason.encode!()
 
-        {:reply, {:text, message}, state}
+        {:text, message, state}
 
       _ ->
-        {:reply, {:close, 4001, "Store '#{message.store}' is not defined or can't be compiled."},
-         state}
+        {:close, 4001, "Store '#{message.store}' is not defined or can't be compiled.", state}
     end
   end
 
@@ -80,7 +79,7 @@ defmodule Storex.Socket do
         }
     end
     |> Jason.encode!()
-    |> (&{:reply, {:text, &1}, state}).()
+    |> (&{:text, &1, state}).()
   end
 
   defp safe_concat(store) do

lib/storex/supervisor.ex

@@ -3,7 +3,7 @@ defmodule Storex.Supervisor do
 
   use DynamicSupervisor
 
-  def start_link() do
+  def start_link(_) do
     DynamicSupervisor.start_link(__MODULE__, [], name: __MODULE__)
   end
 

mix.exs

@@ -22,7 +22,7 @@ defmodule Storex.MixProject do
     ]
   end
 
-  defp elixirc_paths(:test), do: ["lib", "test/browser_test", "test/stores"]
+  defp elixirc_paths(:test), do: ["lib", "test/fixtures", "test/storex", "test/support"]
   defp elixirc_paths(_), do: ["lib"]
 
   def application do
@@ -42,7 +42,8 @@ defmodule Storex.MixProject do
 
   defp deps do
     [
-      {:cowboy, "~> 2.9"},
+      {:websock_adapter, "~> 0.5.6"},
+      {:plug, "~> 1.15"},
       {:nanoid, "~> 2.0"},
       {:jason, "~> 1.4"},
 
@@ -51,8 +52,11 @@ defmodule Storex.MixProject do
       {:dialyxir, "~> 1.4", only: [:dev], runtime: false},
 
       # Tests
-      {:ssl_verify_fun, "~> 1.1", manager: :rebar3, override: true},
-      {:wallaby, "~> 0.30.0", runtime: false, only: :test}
+      {:ssl_verify_fun, "~> 1.1", only: :test, manager: :rebar3, override: true},
+      {:wallaby, "~> 0.30.0", runtime: false, only: :test},
+      {:cowboy, "~> 2.9", only: :test},
+      {:bandit, "~> 1.4", only: :test},
+      {:plug_cowboy, "~> 2.0", only: :test}
     ]
   end