Expose open option in funnel settings UI

Author: zoldar

extra/lib/plausible/funnel.ex

@@ -56,7 +56,7 @@ defmodule Plausible.Funnel do
 
   def changeset(funnel \\ %__MODULE__{}, attrs \\ %{}) do
     funnel
-    |> cast(attrs, [:name])
+    |> cast(attrs, [:name, :open])
     |> validate_required([:name])
     |> put_steps(attrs[:steps] || attrs["steps"])
     |> validate_length(:steps, min: @min_steps, max: @max_steps)

extra/lib/plausible/funnels.ex

@@ -13,10 +13,12 @@ defmodule Plausible.Funnels do
 
   import Ecto.Query
 
-  @spec create(Plausible.Site.t(), String.t(), [map()]) ::
+  @spec create(Plausible.Site.t(), String.t(), [map()], Keyword.t()) ::
           {:ok, Funnel.t()}
           | {:error, Ecto.Changeset.t() | :invalid_funnel_size | :upgrade_required}
-  def create(site, name, steps)
+  def create(site, name, steps, opts \\ [])
+
+  def create(site, name, steps, opts)
       when is_list(steps) and length(steps) in Funnel.min_steps()..Funnel.max_steps() do
     site = Plausible.Repo.preload(site, :team)
 
@@ -26,19 +28,19 @@ defmodule Plausible.Funnels do
 
       :ok ->
         site
-        |> create_changeset(name, steps)
+        |> create_changeset(name, steps, opts)
         |> Repo.insert()
     end
   end
 
-  def create(_site, _name, _goals) do
+  def create(_site, _name, _goals, _opts) do
     {:error, :invalid_funnel_size}
   end
 
-  @spec update(Funnel.t(), String.t(), [map()]) ::
+  @spec update(Funnel.t(), String.t(), [map()], Keyword.t()) ::
           {:ok, Funnel.t()}
           | {:error, Ecto.Changeset.t() | :invalid_funnel_size | :upgrade_required}
-  def update(funnel, name, steps) do
+  def update(funnel, name, steps, opts \\ []) do
     site = Plausible.Repo.preload(funnel, site: :team).site
 
     case Plausible.Billing.Feature.Funnels.check_availability(site.team) do
@@ -47,27 +49,29 @@ defmodule Plausible.Funnels do
 
       :ok ->
         funnel
-        |> Funnel.changeset(%{name: name, steps: steps})
+        |> edit_changeset(name, steps, opts)
         |> Repo.update()
     end
   end
 
-  @spec create_changeset(Plausible.Site.t(), String.t(), [map()]) ::
+  @spec create_changeset(Plausible.Site.t(), String.t(), [map()], Keyword.t()) ::
           Ecto.Changeset.t()
-  def create_changeset(site, name, steps) do
-    Funnel.changeset(%Funnel{site_id: site.id}, %{name: name, steps: steps})
+  def create_changeset(site, name, steps, opts \\ []) do
+    open? = Keyword.get(opts, :open?, false)
+    Funnel.changeset(%Funnel{site_id: site.id}, %{name: name, steps: steps, open: open?})
   end
 
-  @spec edit_changeset(Plausible.Funnel.t(), String.t(), [map()]) ::
+  @spec edit_changeset(Plausible.Funnel.t(), String.t(), [map()], Keyword.t()) ::
           Ecto.Changeset.t()
-  def edit_changeset(funnel, name, steps) do
-    Funnel.changeset(funnel, %{name: name, steps: steps})
+  def edit_changeset(funnel, name, steps, opts \\ []) do
+    open? = Keyword.get(opts, :open?, false)
+    Funnel.changeset(funnel, %{name: name, steps: steps, open: open?})
   end
 
-  @spec ephemeral_definition(Plausible.Site.t(), String.t(), [map()]) :: Funnel.t()
-  def ephemeral_definition(site, name, steps) do
+  @spec ephemeral_definition(Plausible.Site.t(), String.t(), [map()], Keyword.t()) :: Funnel.t()
+  def ephemeral_definition(site, name, steps, opts \\ []) do
     site
-    |> create_changeset(name, steps)
+    |> create_changeset(name, steps, opts)
     |> Ecto.Changeset.apply_changes()
   end
 

extra/lib/plausible_web/live/funnel_settings/form.ex

@@ -79,6 +79,12 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form do
               label="Funnel Name"
             />
 
+            <.input
+              type="checkbox"
+              field={f[:open]}
+              label="Open funnel"
+            />
+
             <div id="steps-builder" class="mt-6">
               <.label>
                 Funnel Steps
@@ -245,7 +251,8 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form do
       socket.assigns.site
       |> Funnels.create_changeset(
         params["name"],
-        steps_from_assigns
+        steps_from_assigns,
+        open?: params["open"] == "true"
       )
       |> Map.put(:action, :validate)
 
@@ -262,10 +269,10 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form do
     save_fn =
       case funnel do
         %Plausible.Funnel{} ->
-          fn -> Funnels.update(funnel, params["name"], steps) end
+          fn -> Funnels.update(funnel, params["name"], steps, open?: params["open"] == "true") end
 
         nil ->
-          fn -> Funnels.create(site, params["name"], steps) end
+          fn -> Funnels.create(site, params["name"], steps, open?: params["open"] == "true") end
       end
 
     case save_fn.() do
@@ -423,7 +430,8 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form do
       funnel
       |> Funnels.edit_changeset(
         funnel.name,
-        Enum.map(funnel.steps, &%{goal_id: &1.goal.id})
+        Enum.map(funnel.steps, &%{goal_id: &1.goal.id}),
+        open?: funnel.open
       )
       |> to_form()
 

test/plausible_web/controllers/api/stats_controller/funnels_test.exs

@@ -613,9 +613,12 @@ defmodule PlausibleWeb.Api.StatsController.FunnelsTest do
       {:ok, goals}
     end
 
-    defp setup_funnel(site, goal_names) do
+    defp setup_funnel(site, goal_names, open? \\ false) do
       {:ok, goals} = setup_goals(site, goal_names)
-      Plausible.Funnels.create(site, "Test funnel", Enum.map(goals, &%{"goal_id" => &1.id}))
+
+      Plausible.Funnels.create(site, "Test funnel", Enum.map(goals, &%{"goal_id" => &1.id}),
+        open?: open?
+      )
     end
   end
 end