Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Add "SSO" billing plan feature and hide SSO setup behind it (#5524)
Adrian Gruntkowskicf34850a13ee
diff --git a/extra/lib/plausible_web/controllers/sso_controller.ex b/extra/lib/plausible_web/controllers/sso_controller.exindex eb08cd9f52..ad5e19ae23 100644--- a/extra/lib/plausible_web/controllers/sso_controller.ex+++ b/extra/lib/plausible_web/controllers/sso_controller.ex@@ -78,7 +78,8 @@ defmodule PlausibleWeb.SSOController doenddef sso_settings(conn, _params) do- if Plausible.Teams.setup?(conn.assigns.current_team) and Plausible.sso_enabled?() do+ if Plausible.Teams.setup?(conn.assigns.current_team) and Plausible.sso_enabled?() and+ Plausible.Billing.Feature.SSO.check_availability(conn.assigns.current_team) == :ok dorender(conn, :sso_settings,layout: {PlausibleWeb.LayoutView, :settings},connect_live_socket: truediff --git a/extra/lib/plausible_web/live/customer_support/live/team.ex b/extra/lib/plausible_web/live/customer_support/live/team.exindex 983246293c..6ed15a2f04 100644--- a/extra/lib/plausible_web/live/customer_support/live/team.ex+++ b/extra/lib/plausible_web/live/customer_support/live/team.ex@@ -75,7 +75,7 @@ defmodule PlausibleWeb.CustomerSupport.Live.Team dohourly_api_request_limit: 600,site_limit: 50,team_member_limit: 10,- features: Plausible.Billing.Feature.list()+ features: Plausible.Billing.Feature.list() -- [Plausible.Billing.Feature.SSO]}enddiff --git a/lib/plausible/billing/feature.ex b/lib/plausible/billing/feature.exindex c9bd5bb0eb..86af601758 100644--- a/lib/plausible/billing/feature.ex+++ b/lib/plausible/billing/feature.ex@@ -78,7 +78,8 @@ defmodule Plausible.Billing.Feature doPlausible.Billing.Feature.RevenueGoals,Plausible.Billing.Feature.SiteSegments,Plausible.Billing.Feature.SitesAPI,- Plausible.Billing.Feature.StatsAPI+ Plausible.Billing.Feature.StatsAPI,+ Plausible.Billing.Feature.SSO]# Generate a union type for features@@ -231,6 +232,15 @@ defmodule Plausible.Billing.Feature.SitesAPI dodisplay_name: "Sites API"end+defmodule Plausible.Billing.Feature.SSO do+ use Plausible++ @moduledoc false+ use Plausible.Billing.Feature,+ name: :sso,+ display_name: "Single Sign-On"+end+defmodule Plausible.Billing.Feature.Teams do@moduledoc """Unlike other feature modules, this one only exists to make feature gatingdiff --git a/lib/plausible/teams/billing.ex b/lib/plausible/teams/billing.exindex 63f24e9dd1..a84e65b92e 100644--- a/lib/plausible/teams/billing.ex+++ b/lib/plausible/teams/billing.ex@@ -12,7 +12,7 @@ defmodule Plausible.Teams.Billing doalias Plausible.Teamsalias Plausible.Billing.{EnterprisePlan, Feature, Plan, Plans, Quota}- alias Plausible.Billing.Feature.{Goals, Props, SitesAPI, StatsAPI, SharedLinks}+ alias Plausible.Billing.Feature.{Goals, Props, SitesAPI, StatsAPI, SharedLinks, SSO}require Plausible.Billing.Subscription.Status@@ -556,8 +556,21 @@ defmodule Plausible.Teams.Billing do))- if sites_api_used? do- site_scoped_feature_usage ++ [SitesAPI]+ site_scoped_feature_usage =+ if sites_api_used? do+ site_scoped_feature_usage ++ [SitesAPI]+ else+ site_scoped_feature_usage+ end++ sso_used? =+ case Plausible.Auth.SSO.get_integration_for(team) do+ {:ok, _} -> true+ _ -> false+ end++ if sso_used? do+ site_scoped_feature_usage ++ [SSO]elsesite_scoped_feature_usageend@@ -662,7 +675,7 @@ defmodule Plausible.Teams.Billing donil ->if Teams.on_trial?(team) do- Feature.list() -- [SitesAPI]+ Feature.list() -- [SitesAPI, SSO]else[Goals]enddiff --git a/lib/plausible_web/plugins/api/schemas/capabilities.ex b/lib/plausible_web/plugins/api/schemas/capabilities.exindex 527b817c7b..1fe152a926 100644--- a/lib/plausible_web/plugins/api/schemas/capabilities.ex+++ b/lib/plausible_web/plugins/api/schemas/capabilities.ex@@ -36,7 +36,8 @@ defmodule PlausibleWeb.Plugins.API.Schemas.Capabilities doSitesAPI: false,SiteSegments: false,Teams: false,- SharedLinks: false+ SharedLinks: false,+ SSO: false}}})diff --git a/lib/plausible_web/views/layout_view.ex b/lib/plausible_web/views/layout_view.exindex f464bb904d..649ebd5483 100644--- a/lib/plausible_web/views/layout_view.ex+++ b/lib/plausible_web/views/layout_view.ex@@ -135,7 +135,9 @@ defmodule PlausibleWeb.LayoutView doif(current_team_role in [:owner, :billing, :admin, :editor],do: %{key: "API Keys", value: "api-keys", icon: :key}),- if(Plausible.sso_enabled?() and current_team_role == :owner,+ if(+ Plausible.sso_enabled?() and current_team_role == :owner and+ Plausible.Billing.Feature.SSO.check_availability(current_team) == :ok,do: %{key: "Single Sign-On", value: "sso/general", icon: :cloud}),if(current_team_role == :owner,diff --git a/test/plausible/billing/quota_test.exs b/test/plausible/billing/quota_test.exsindex b41810522a..f32708a007 100644--- a/test/plausible/billing/quota_test.exs+++ b/test/plausible/billing/quota_test.exs@@ -622,7 +622,8 @@ defmodule Plausible.Billing.QuotaTest dotest "returns all features when user in on trial" doteam = new_user(trial_expiry_date: Date.shift(Date.utc_today(), day: 7)) |> team_of()- assert Plausible.Billing.Feature.list() -- [Plausible.Billing.Feature.SitesAPI] ==+ assert Plausible.Billing.Feature.list() --+ [Plausible.Billing.Feature.SitesAPI, Plausible.Billing.Feature.SSO] ==Plausible.Teams.Billing.allowed_features_for(team)end@@ -641,7 +642,8 @@ defmodule Plausible.Billing.QuotaTest dotest "returns all features for enterprise users who have not upgraded yet and are on trial" doteam = new_user() |> subscribe_to_enterprise_plan(subscription?: false) |> team_of()- assert Plausible.Billing.Feature.list() -- [Plausible.Billing.Feature.SitesAPI] ==+ assert Plausible.Billing.Feature.list() --+ [Plausible.Billing.Feature.SitesAPI, Plausible.Billing.Feature.SSO] ==Plausible.Teams.Billing.allowed_features_for(team)enddiff --git a/test/plausible_web/controllers/sso_controller_sync_test.exs b/test/plausible_web/controllers/sso_controller_sync_test.exsindex 930a84975d..e9a5d50c47 100644--- a/test/plausible_web/controllers/sso_controller_sync_test.exs+++ b/test/plausible_web/controllers/sso_controller_sync_test.exs@@ -37,7 +37,9 @@ defmodule PlausibleWeb.SSOControllerSyncTest doendtest "sso team settings item is guarded by the env var", %{conn: conn} do- user = new_user()+ user =+ new_user() |> subscribe_to_enterprise_plan(features: [Plausible.Billing.Feature.SSO])+team = new_site(owner: user).team |> Plausible.Teams.complete_setup(){:ok, ctx} = log_in(%{conn: conn, user: user})conn = ctx[:conn]diff --git a/test/plausible_web/controllers/sso_controller_test.exs b/test/plausible_web/controllers/sso_controller_test.exsindex 568db7a0af..b03eb4c229 100644--- a/test/plausible_web/controllers/sso_controller_test.exs+++ b/test/plausible_web/controllers/sso_controller_test.exs@@ -22,6 +22,36 @@ defmodule PlausibleWeb.SSOControllerTest do{:ok, team: team, integration: integration, domain: domain, sso_domain: sso_domain}end+ describe "settings item visibility" do+ test "sso team settings item renders when SSO feature plan is added", %{conn: conn} do+ user =+ new_user() |> subscribe_to_enterprise_plan(features: [Plausible.Billing.Feature.SSO])++ team = new_site(owner: user).team |> Plausible.Teams.complete_setup()+ {:ok, conn: conn} = log_in(%{conn: conn, user: user})+ conn = set_current_team(conn, team)++ conn = get(conn, Routes.settings_path(conn, :team_general))++ assert html = html_response(conn, 200)++ assert html =~ "Single Sign-On"+ end++ test "sso team settings item is hidden when there's no SSO plan feature", %{conn: conn} do+ user = new_user()+ team = new_site(owner: user).team |> Plausible.Teams.complete_setup()+ {:ok, conn: conn} = log_in(%{conn: conn, user: user})+ conn = set_current_team(conn, team)++ conn = get(conn, Routes.settings_path(conn, :team_general))++ assert html = html_response(conn, 200)++ refute html =~ "Single Sign-On"+ end+ end+describe "login_form/2" dotest "renders login view", %{conn: conn} doconn = get(conn, Routes.sso_path(conn, :login_form, prefer: "sso"))@@ -208,7 +238,16 @@ defmodule PlausibleWeb.SSOControllerTest doassert redirected_to(conn, 302) == "/sites"end- test "renders when team is setup", %{conn: conn, team: team} do+ test "redirects when team lacks SSO plan feature", %{conn: conn, team: team} do+ team = Plausible.Teams.complete_setup(team)+ conn = set_current_team(conn, team)+ conn = get(conn, Routes.sso_path(conn, :sso_settings))++ assert redirected_to(conn, 302) == "/sites"+ end++ test "renders when team has SSO plan feature", %{conn: conn, team: team, user: user} do+ user |> subscribe_to_enterprise_plan(features: [Plausible.Billing.Feature.SSO])team = Plausible.Teams.complete_setup(team)conn = set_current_team(conn, team)conn = get(conn, Routes.sso_path(conn, :sso_settings))diff --git a/test/plausible_web/live/customer_support/teams_test.exs b/test/plausible_web/live/customer_support/teams_test.exsindex 5197eadb4c..f32f9466e0 100644--- a/test/plausible_web/live/customer_support/teams_test.exs+++ b/test/plausible_web/live/customer_support/teams_test.exs@@ -176,7 +176,8 @@ defmodule PlausibleWeb.Live.CustomerSupport.TeamsTest do"revenue_goals" => "false","site_segments" => "false","shared_links" => "true",- "sites_api" => "true"+ "sites_api" => "true",+ "sso" => "false"}}})diff --git a/test/plausible_web/live/sso_management_test.exs b/test/plausible_web/live/sso_management_test.exsindex 16375b982a..72b3d58166 100644--- a/test/plausible_web/live/sso_management_test.exs+++ b/test/plausible_web/live/sso_management_test.exs@@ -50,7 +50,7 @@ defmodule PlausibleWeb.Live.SSOMangementTest do"""describe "/settings/sso/general" do- setup [:create_user, :log_in, :create_team, :setup_team]+ setup [:create_user, :log_in, :create_team, :add_plan, :setup_team]test "renders", %{conn: conn} doresp =@@ -64,7 +64,7 @@ defmodule PlausibleWeb.Live.SSOMangementTest doenddescribe "live" do- setup [:create_user, :log_in, :create_team, :setup_team]+ setup [:create_user, :log_in, :create_team, :add_plan, :setup_team]test "init setup - basic walk through", %{conn: conn} do{lv, _html} = get_lv(conn)@@ -306,6 +306,12 @@ defmodule PlausibleWeb.Live.SSOMangementTest do{:ok, lv, html} = live(conn, Routes.sso_path(conn, :sso_settings)){lv, html}end++ defp add_plan(%{user: user}) do+ subscribe_to_enterprise_plan(user, features: [Plausible.Billing.Feature.SSO])++ :ok+ endendendenddiff --git a/test/plausible_web/plugins/api/controllers/capabilities_test.exs b/test/plausible_web/plugins/api/controllers/capabilities_test.exsindex ae1f5afe83..ee1efb1992 100644--- a/test/plausible_web/plugins/api/controllers/capabilities_test.exs+++ b/test/plausible_web/plugins/api/controllers/capabilities_test.exs@@ -32,7 +32,8 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do"StatsAPI" => false,"SitesAPI" => false,"SiteSegments" => false,- "SharedLinks" => false+ "SharedLinks" => false,+ "SSO" => false}}@@ -59,7 +60,8 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do"StatsAPI" => false,"SitesAPI" => false,"SiteSegments" => false,- "SharedLinks" => false+ "SharedLinks" => false,+ "SSO" => false}}@@ -88,7 +90,8 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do"StatsAPI" => true,"SitesAPI" => false,"SiteSegments" => true,- "SharedLinks" => true+ "SharedLinks" => true,+ "SSO" => false}}@@ -119,7 +122,8 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do"StatsAPI" => false,"SitesAPI" => false,"SiteSegments" => false,- "SharedLinks" => true+ "SharedLinks" => true,+ "SSO" => false}}@@ -153,7 +157,8 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do"StatsAPI" => true,"SitesAPI" => true,"SiteSegments" => false,- "SharedLinks" => false+ "SharedLinks" => false,+ "SSO" => false}}