Skip to content

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

Add SitesAPI plan feature (#5366)

Adrian Gruntkowski6afd12cdab60
diff --git a/lib/plausible/billing/feature.ex b/lib/plausible/billing/feature.ex
index 9606abe6f8..813a77841c 100644
--- a/lib/plausible/billing/feature.ex
+++ b/lib/plausible/billing/feature.ex
@@ -73,6 +73,7 @@ defmodule Plausible.Billing.Feature do
@features [
Plausible.Billing.Feature.Goals,
Plausible.Billing.Feature.StatsAPI,
+ Plausible.Billing.Feature.SitesAPI,
Plausible.Billing.Feature.Props,
Plausible.Billing.Feature.Funnels,
Plausible.Billing.Feature.RevenueGoals,
@@ -212,3 +213,12 @@ defmodule Plausible.Billing.Feature.StatsAPI do
name: :stats_api,
display_name: "Stats API"
end
+
+defmodule Plausible.Billing.Feature.SitesAPI do
+ use Plausible
+
+ @moduledoc false
+ use Plausible.Billing.Feature,
+ name: :sites_api,
+ display_name: "Sites API"
+end
diff --git a/lib/plausible/teams/billing.ex b/lib/plausible/teams/billing.ex
index 6bc8607031..e12b5bf461 100644
--- a/lib/plausible/teams/billing.ex
+++ b/lib/plausible/teams/billing.ex
@@ -13,7 +13,7 @@ defmodule Plausible.Teams.Billing do
alias Plausible.Teams
alias Plausible.Billing.{EnterprisePlan, Feature, Plan, Plans, Quota}
- alias Plausible.Billing.Feature.{Goals, Props, StatsAPI}
+ alias Plausible.Billing.Feature.{Goals, Props, SitesAPI, StatsAPI}
require Plausible.Billing.Subscription.Status
@@ -494,8 +494,28 @@ defmodule Plausible.Teams.Billing do
)
)
- if stats_api_used? do
- site_scoped_feature_usage ++ [Feature.StatsAPI]
+ site_scoped_feature_usage =
+ if stats_api_used? do
+ site_scoped_feature_usage ++ [Feature.StatsAPI]
+ else
+ site_scoped_feature_usage
+ end
+
+ sites_api_used? =
+ Repo.exists?(
+ from tm in Plausible.Teams.Membership,
+ as: :team_membership,
+ where: tm.team_id == ^team.id,
+ where:
+ exists(
+ from ak in Plausible.Auth.ApiKey,
+ where: ak.user_id == parent_as(:team_membership).user_id,
+ where: "sites:provision:*" in ak.scopes
+ )
+ )
+
+ if sites_api_used? do
+ site_scoped_feature_usage ++ [SitesAPI]
else
site_scoped_feature_usage
end
@@ -597,7 +617,7 @@ defmodule Plausible.Teams.Billing do
nil ->
if Teams.on_trial?(team) do
- Feature.list()
+ Feature.list() -- [SitesAPI]
else
[Goals]
end
diff --git a/lib/plausible_web/plugins/api/schemas/capabilities.ex b/lib/plausible_web/plugins/api/schemas/capabilities.ex
index e66ed83366..3b3c19c38a 100644
--- a/lib/plausible_web/plugins/api/schemas/capabilities.ex
+++ b/lib/plausible_web/plugins/api/schemas/capabilities.ex
@@ -33,6 +33,7 @@ defmodule PlausibleWeb.Plugins.API.Schemas.Capabilities do
Props: false,
RevenueGoals: false,
StatsAPI: false,
+ SitesAPI: false,
SiteSegments: false
}
}
diff --git a/test/plausible/billing/quota_test.exs b/test/plausible/billing/quota_test.exs
index e455f521b9..7020f13b1f 100644
--- a/test/plausible/billing/quota_test.exs
+++ b/test/plausible/billing/quota_test.exs
@@ -3,7 +3,7 @@ defmodule Plausible.Billing.QuotaTest do
use Plausible.DataCase, async: true
use Plausible
alias Plausible.Billing.{Quota, Plans}
- alias Plausible.Billing.Feature.{Goals, Props, StatsAPI}
+ alias Plausible.Billing.Feature.{Goals, Props, SitesAPI, StatsAPI}
use Plausible.Teams.Test
@@ -517,6 +517,18 @@ defmodule Plausible.Billing.QuotaTest do
assert [StatsAPI] == Plausible.Teams.Billing.features_usage(team)
end
+ test "returns [SitesAPI] when user has a Sites API enabled api key" do
+ user =
+ new_user()
+ |> subscribe_to_enterprise_plan(features: [StatsAPI, SitesAPI])
+
+ team = team_of(user)
+
+ insert(:api_key, user: user, scopes: ["sites:provision:*"])
+
+ assert [StatsAPI, SitesAPI] == Plausible.Teams.Billing.features_usage(team)
+ end
+
test "returns feature usage based on a user and a custom list of site_ids" do
user = new_user(trial_expiry_date: Date.utc_today())
team = team_of(user)
@@ -601,7 +613,7 @@ defmodule Plausible.Billing.QuotaTest do
test "returns all features when user in on trial" do
team = new_user(trial_expiry_date: Date.shift(Date.utc_today(), day: 7)) |> team_of()
- assert Plausible.Billing.Feature.list() ==
+ assert Plausible.Billing.Feature.list() -- [Plausible.Billing.Feature.SitesAPI] ==
Plausible.Teams.Billing.allowed_features_for(team)
end
@@ -619,7 +631,7 @@ defmodule Plausible.Billing.QuotaTest do
test "returns all features for enterprise users who have not upgraded yet and are on trial" do
team = new_user() |> subscribe_to_enterprise_plan(subscription?: false) |> team_of()
- assert Plausible.Billing.Feature.list() ==
+ assert Plausible.Billing.Feature.list() -- [Plausible.Billing.Feature.SitesAPI] ==
Plausible.Teams.Billing.allowed_features_for(team)
end
@@ -641,6 +653,19 @@ defmodule Plausible.Billing.QuotaTest do
assert [Plausible.Billing.Feature.StatsAPI] ==
Plausible.Teams.Billing.allowed_features_for(team)
end
+
+ test "returns SitesAPI feature for enterprise customers with appropriate plan" do
+ user = new_user()
+
+ subscribe_to_enterprise_plan(user,
+ features: [Plausible.Billing.Feature.StatsAPI, Plausible.Billing.Feature.SitesAPI]
+ )
+
+ team = team_of(user)
+
+ assert [Plausible.Billing.Feature.StatsAPI, Plausible.Billing.Feature.SitesAPI] ==
+ Plausible.Teams.Billing.allowed_features_for(team)
+ end
end
describe "monthly_pageview_usage/2" do
diff --git a/test/plausible_web/plugins/api/controllers/capabilities_test.exs b/test/plausible_web/plugins/api/controllers/capabilities_test.exs
index bba3247fa7..59a2804100 100644
--- a/test/plausible_web/plugins/api/controllers/capabilities_test.exs
+++ b/test/plausible_web/plugins/api/controllers/capabilities_test.exs
@@ -30,6 +30,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do
"Props" => false,
"RevenueGoals" => false,
"StatsAPI" => false,
+ "SitesAPI" => false,
"SiteSegments" => false
}
}
@@ -55,6 +56,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do
"Props" => false,
"RevenueGoals" => false,
"StatsAPI" => false,
+ "SitesAPI" => false,
"SiteSegments" => false
}
}
@@ -82,6 +84,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do
"Props" => true,
"RevenueGoals" => true,
"StatsAPI" => true,
+ "SitesAPI" => false,
"SiteSegments" => true
}
}
@@ -111,6 +114,40 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CapabilitiesTest do
"Props" => false,
"RevenueGoals" => false,
"StatsAPI" => false,
+ "SitesAPI" => false,
+ "SiteSegments" => false
+ }
+ }
+
+ assert_schema(resp, "Capabilities", spec())
+ end
+
+ @tag :ee_only
+ test "enterprise with SitesAPI", %{conn: conn, site: site, token: token} do
+ [owner | _] = Plausible.Repo.preload(site, :owners).owners
+
+ subscribe_to_enterprise_plan(owner,
+ features: [Plausible.Billing.Feature.StatsAPI, Plausible.Billing.Feature.SitesAPI]
+ )
+
+ resp =
+ conn
+ |> put_req_header("content-type", "application/json")
+ |> authenticate(site.domain, token)
+ |> get(Routes.plugins_api_capabilities_url(PlausibleWeb.Endpoint, :index))
+ |> json_response(200)
+
+ assert resp ==
+ %{
+ "authorized" => true,
+ "data_domain" => site.domain,
+ "features" => %{
+ "Funnels" => false,
+ "Goals" => true,
+ "Props" => false,
+ "RevenueGoals" => false,
+ "StatsAPI" => true,
+ "SitesAPI" => true,
"SiteSegments" => false
}
}