Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

CRM: First pass SSO support (#5517)

Adam Rutkowski4387d4240945
diff --git a/extra/lib/plausible/customer_support/resource/team.ex b/extra/lib/plausible/customer_support/resource/team.ex
index c40c1c3c75..bc910cec09 100644
--- a/extra/lib/plausible/customer_support/resource/team.ex
+++ b/extra/lib/plausible/customer_support/resource/team.ex
@@ -55,6 +55,18 @@ defmodule Plausible.CustomerSupport.Resource.Team do
preload: [subscription: s]
end
+ q =
+ if opts[:with_sso_only?] do
+ from t in q,
+ inner_join: sso_integration in assoc(t, :sso_integration),
+ as: :sso_integration,
+ left_join: sso_domains in assoc(sso_integration, :sso_domains),
+ as: :sso_domains,
+ or_where: ilike(sso_domains.domain, ^"%#{input}%")
+ else
+ q
+ end
+
Plausible.Repo.all(q)
end
diff --git a/extra/lib/plausible_web/live/customer_support.ex b/extra/lib/plausible_web/live/customer_support.ex
index c417160e90..79a528083a 100644
--- a/extra/lib/plausible_web/live/customer_support.ex
+++ b/extra/lib/plausible_web/live/customer_support.ex
@@ -57,6 +57,12 @@ defmodule PlausibleWeb.Live.CustomerSupport do
<p class="font-sans pl-2 mb-1">
Like above, but only finds team(s) with subscription (in any status).
</p>
+
+ <strong>team:</strong>input <strong>+sso</strong>
+ <br />
+ <p class="font-sans pl-2 mb-1">
+ Like above, but only finds team(s) with SSO integrations (in any status).
+ </p>
</div>
</div>
</div>
@@ -209,6 +215,13 @@ defmodule PlausibleWeb.Live.CustomerSupport do
[limit: 90]
end
+ opts =
+ if "sso" in mods do
+ Keyword.merge(opts, with_sso_only?: true)
+ else
+ opts
+ end
+
{[Resource.Team], input, opts}
end
diff --git a/extra/lib/plausible_web/live/customer_support/live/team.ex b/extra/lib/plausible_web/live/customer_support/live/team.ex
index aac4a237d4..983246293c 100644
--- a/extra/lib/plausible_web/live/customer_support/live/team.ex
+++ b/extra/lib/plausible_web/live/customer_support/live/team.ex
@@ -2,16 +2,16 @@ defmodule PlausibleWeb.CustomerSupport.Live.Team do
@moduledoc false
use Plausible.CustomerSupport.Resource, :component
+ alias Plausible.Auth.SSO
+ alias Plausible.Billing.EnterprisePlan
alias Plausible.Billing.{Plans, Subscription}
+ alias Plausible.Repo
alias Plausible.Teams
alias Plausible.Teams.Management.Layout
- alias Plausible.Billing.EnterprisePlan
-
alias PlausibleWeb.Router.Helpers, as: Routes
require Plausible.Billing.Subscription.Status
- alias Plausible.Repo
import Ecto.Query
def update(%{resource_id: resource_id}, socket) do
@@ -21,13 +21,26 @@ defmodule PlausibleWeb.CustomerSupport.Live.Team do
usage = Teams.Billing.quota_usage(team, with_features: true)
+ sso_integration = get_sso_integration(team)
+
limits = %{
monthly_pageviews: Teams.Billing.monthly_pageview_limit(team),
sites: Teams.Billing.site_limit(team),
team_members: Teams.Billing.team_member_limit(team)
}
- {:ok, assign(socket, team: team, form: form, usage: usage, limits: limits)}
+ {:ok,
+ assign(socket,
+ team: team,
+ form: form,
+ usage: usage,
+ limits: limits,
+ sso_integration: sso_integration
+ )}
+ end
+
+ def update(%{tab: "sso"}, %{assigns: %{team: _team}} = socket) do
+ {:ok, assign(socket, tab: "sso")}
end
def update(%{tab: "sites"}, %{assigns: %{team: team}} = socket) do
@@ -161,6 +174,9 @@ defmodule PlausibleWeb.CustomerSupport.Live.Team do
<.tab to="sites" tab={@tab}>
Sites ({number_format(@usage.sites)}/{number_format(@limits.sites)})
</.tab>
+ <.tab :if={@sso_integration} to="sso" tab={@tab}>
+ SSO
+ </.tab>
<.tab to="billing" tab={@tab}>
Billing
</.tab>
@@ -222,6 +238,52 @@ defmodule PlausibleWeb.CustomerSupport.Live.Team do
</div>
</div>
+ <div :if={@tab == "sso"} class="mt-4 mb-4 text-gray-900 dark:text-gray-400">
+ <p :if={@sso_integration} class="mb-4">
+ Configured?: <code>{SSO.Integration.configured?(@sso_integration)}</code>
+ <br /> IDP Signin URL:
+ <code>
+ {@sso_integration.config.idp_signin_url}
+ </code>
+ <br />IDP Entity ID: <code>{@sso_integration.config.idp_entity_id}</code>
+ </p>
+ <.table
+ :if={not Enum.empty?(@sso_integration.sso_domains)}
+ rows={@sso_integration.sso_domains}
+ >
+ <:thead>
+ <.th>Domain</.th>
+ <.th>Status</.th>
+ <.th></.th>
+ </:thead>
+ <:tbody :let={sso_domain}>
+ <.td>
+ {sso_domain.domain}
+ </.td>
+ <.td>
+ {sso_domain.status}
+ <span :if={sso_domain.verified_via}>
+ (via {sso_domain.verified_via} at {Calendar.strftime(
+ sso_domain.last_verified_at,
+ "%b %-d, %Y"
+ )})
+ </span>
+ </.td>
+ <.td actions>
+ <.delete_button
+ :if={can_delete?(sso_domain)}
+ id={"remove-domain-#{sso_domain.identifier}"}
+ phx-click="remove-domain"
+ phx-value-identifier={sso_domain.identifier}
+ phx-target={@myself}
+ class="text-sm text-red-600"
+ data-confirm={"Are you sure you want to remove domain '#{sso_domain.domain}'?"}
+ />
+ </.td>
+ </:tbody>
+ </.table>
+ </div>
+
<div :if={@tab == "billing"} class="mt-4 mb-4 text-gray-900 dark:text-gray-400">
<h1 class="text-xs font-semibold">Usage</h1>
<.table rows={monthly_pageviews_usage(@usage.monthly_pageviews, @limits.monthly_pageviews)}>
@@ -573,6 +635,12 @@ defmodule PlausibleWeb.CustomerSupport.Live.Team do
{:noreply, assign(socket, show_plan_form?: true)}
end
+ def handle_event("remove-domain", %{"identifier" => i}, socket) do
+ domain = Enum.find(socket.assigns.sso_integration.sso_domains, &(&1.identifier == i))
+ SSO.Domains.remove(domain)
+ {:noreply, assign(socket, sso_integration: get_sso_integration(socket.assigns.team))}
+ end
+
def handle_event("hide-plan-form", _, socket) do
{:noreply, assign(socket, show_plan_form?: false)}
end
@@ -910,4 +978,15 @@ defmodule PlausibleWeb.CustomerSupport.Live.Team do
/>
"""
end
+
+ defp can_delete?(sso_domain) do
+ Plausible.Auth.SSO.Domains.check_can_remove(sso_domain) == :ok
+ end
+
+ defp get_sso_integration(team) do
+ case SSO.get_integration_for(team) do
+ {:error, :not_found} -> nil
+ {:ok, integration} -> integration
+ end
+ end
end
diff --git a/lib/plausible/teams/team.ex b/lib/plausible/teams/team.ex
index 8ba1fa23e0..87d1b85e55 100644
--- a/lib/plausible/teams/team.ex
+++ b/lib/plausible/teams/team.ex
@@ -51,6 +51,10 @@ defmodule Plausible.Teams.Team do
has_one :subscription, Plausible.Billing.Subscription
has_one :enterprise_plan, Plausible.Billing.EnterprisePlan
+ on_ee do
+ has_one :sso_integration, Plausible.Auth.SSO.Integration
+ end
+
has_many :ownerships, Plausible.Teams.Membership,
where: [role: :owner],
preload_order: [asc: :id]
diff --git a/test/plausible_web/live/customer_support/teams_test.exs b/test/plausible_web/live/customer_support/teams_test.exs
index 381b101961..5197eadb4c 100644
--- a/test/plausible_web/live/customer_support/teams_test.exs
+++ b/test/plausible_web/live/customer_support/teams_test.exs
@@ -8,6 +8,8 @@ defmodule PlausibleWeb.Live.CustomerSupport.TeamsTest do
import Phoenix.LiveViewTest
import Plausible.Test.Support.HTML
+ alias Plausible.Auth.SSO
+
require Plausible.Billing.Subscription.Status
defp open_team(id, qs \\ []) do
@@ -236,5 +238,56 @@ defmodule PlausibleWeb.Live.CustomerSupport.TeamsTest do
lv
end
end
+
+ describe "sso" do
+ setup [:create_user, :log_in, :create_site]
+
+ setup %{user: user} do
+ patch_env(:super_admin_user_ids, [user.id])
+ end
+
+ test "sso tab normally won't render", %{conn: conn, user: user} do
+ team = team_of(user)
+ {:ok, _lv, html} = live(conn, open_team(team.id))
+
+ refute element_exists?(html, ~s|a[href="?tab=sso"]|)
+ end
+
+ test "tab renders when there's sso integration", %{conn: conn, user: user} do
+ team = team_of(user)
+
+ SSO.initiate_saml_integration(team)
+
+ {:ok, _lv, html} = live(conn, open_team(team.id))
+
+ assert element_exists?(html, ~s|a[href="?tab=sso"]|)
+ end
+
+ test "sso tab displays domains", %{conn: conn, user: user} do
+ team = team_of(user)
+
+ integration = SSO.initiate_saml_integration(team)
+
+ SSO.Domains.add(integration, "sso1.example.com")
+ SSO.Domains.add(integration, "sso2.example.com")
+
+ {:ok, lv, _html} = live(conn, open_team(team.id, tab: :sso))
+
+ html = render(lv)
+
+ assert html =~ "sso1.example.com"
+ assert html =~ "sso2.example.com"
+ end
+
+ test "delete domain", %{conn: conn, user: user} do
+ team = team_of(user)
+ integration = SSO.initiate_saml_integration(team)
+ {:ok, domain} = SSO.Domains.add(integration, "sso1.example.com")
+ {:ok, lv, _html} = live(conn, open_team(team.id, tab: :sso))
+
+ lv |> element("button#remove-domain-#{domain.identifier}") |> render_click()
+ refute render(lv) =~ "sso1.example.com"
+ end
+ end
end
end
diff --git a/test/plausible_web/live/customer_support_test.exs b/test/plausible_web/live/customer_support_test.exs
index 342b8f3bc7..9793402541 100644
--- a/test/plausible_web/live/customer_support_test.exs
+++ b/test/plausible_web/live/customer_support_test.exs
@@ -2,6 +2,7 @@ defmodule PlausibleWeb.Live.CustomerSupportTest do
use PlausibleWeb.ConnCase, async: false
use Plausible.Teams.Test
use Plausible
+
@moduletag :ee_only
on_ee do
@@ -10,6 +11,8 @@ defmodule PlausibleWeb.Live.CustomerSupportTest do
import Phoenix.LiveViewTest
import Plausible.Test.Support.HTML
+ alias Plausible.Auth.SSO
+
describe "unauthenticated" do
test "not allowed if not logged in", %{conn: conn} do
conn = get(conn, @cs_index)
@@ -93,6 +96,31 @@ defmodule PlausibleWeb.Live.CustomerSupportTest do
refute_search_result(html, "team", team1.id)
assert_search_result(html, "team", team2.id)
refute_search_result(html, "team", team3.id)
+
+ type_into_input(lv, "filter-text", "team:Team T +sso")
+ html = render(lv)
+ refute_search_result(html, "team", team1.id)
+ refute_search_result(html, "team", team2.id)
+ refute_search_result(html, "team", team3.id)
+
+ integration = SSO.initiate_saml_integration(team2)
+
+ SSO.Domains.add(integration, "some-sso.example.com")
+
+ SSO.initiate_saml_integration(team3)
+
+ type_into_input(lv, "filter-text", "team:Team T +sso")
+ html = render(lv)
+ refute_search_result(html, "team", team1.id)
+ assert_search_result(html, "team", team2.id)
+ assert_search_result(html, "team", team3.id)
+
+ type_into_input(lv, "filter-text", "team:some-sso +sso")
+ html = render(lv)
+
+ refute_search_result(html, "team", team1.id)
+ assert_search_result(html, "team", team2.id)
+ refute_search_result(html, "team", team3.id)
end
end