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
Guest Memberships via Sites API (#5205)
hq18d9461d1525e
diff --git a/extra/lib/plausible_web/controllers/api/external_sites_controller.ex b/extra/lib/plausible_web/controllers/api/external_sites_controller.exindex 0a311f49e3..1ea08a3e08 100644--- a/extra/lib/plausible_web/controllers/api/external_sites_controller.ex+++ b/extra/lib/plausible_web/controllers/api/external_sites_controller.ex@@ -28,6 +28,30 @@ defmodule PlausibleWeb.Api.ExternalSitesController do})end+ def guests_index(conn, params) do+ user = conn.assigns.current_user++ with {:ok, site_id} <- expect_param_key(params, "site_id"),+ {:ok, site} <- get_site(user, site_id, [:owner, :admin, :editor, :viewer]) do+ opts = [cursor_fields: [inserted_at: :desc, id: :desc], limit: 100, maximum_limit: 1000]+ page = site |> Sites.list_guests_query() |> paginate(params, opts)++ json(conn, %{+ guests:+ Enum.map(page.entries, fn entry ->+ Map.take(entry, [:email, :role, :status])+ end),+ meta: pagination_meta(page.metadata)+ })+ else+ {:missing, "site_id"} ->+ H.bad_request(conn, "Parameter `site_id` is required to list goals")++ {:error, :site_not_found} ->+ H.not_found(conn, "Site could not be found")+ end+ end+def goals_index(conn, params) douser = conn.assigns.current_user@@ -138,6 +162,81 @@ defmodule PlausibleWeb.Api.ExternalSitesController doendend+ def find_or_create_guest(conn, params) do+ with {:ok, site_id} <- expect_param_key(params, "site_id"),+ {:ok, email} <- expect_param_key(params, "email"),+ {:ok, role} <- expect_param_key(params, "role", ["viewer", "editor"]),+ {:ok, site} <- get_site(conn.assigns.current_user, site_id, [:owner, :admin]) do+ existing = Repo.one(Sites.list_guests_query(site, email: email))++ if existing do+ json(conn, %{+ role: existing.role,+ email: existing.email,+ status: existing.status+ })+ else+ case Plausible.Site.Memberships.CreateInvitation.create_invitation(+ site,+ conn.assigns.current_user,+ email,+ role+ ) do+ {:ok, invitation} ->+ json(conn, %{+ role: invitation.role,+ email: invitation.team_invitation.email,+ status: "invited"+ })+ end+ end+ else+ {:error, :site_not_found} ->+ H.not_found(conn, "Site could not be found")++ {:missing, "role"} ->+ H.bad_request(+ conn,+ "Parameter `role` is required to create guest. Possible values: `viewer` or `editor`"+ )++ {:missing, param} ->+ H.bad_request(conn, "Parameter `#{param}` is required to create guest")+ end+ end++ def delete_guest(conn, params) do+ with {:ok, site_id} <- expect_param_key(params, "site_id"),+ {:ok, email} <- expect_param_key(params, "email"),+ {:ok, site} <- get_site(conn.assigns.current_user, site_id, [:owner, :admin]) do+ existing = Repo.one(Sites.list_guests_query(site, email: email))++ case existing do+ %{status: "invited", id: id} ->+ with guest_invitation when not is_nil(guest_invitation) <-+ Repo.get(Teams.GuestInvitation, id) do+ Teams.Invitations.remove_guest_invitation(guest_invitation)+ end++ %{status: "accepted", email: email} ->+ with %{} = user <- Repo.get_by(Plausible.Auth.User, email: email) do+ Teams.Memberships.remove(site, user)+ end++ _ ->+ :ignore+ end++ json(conn, %{"deleted" => true})+ else+ {:error, :site_not_found} ->+ H.not_found(conn, "Site could not be found")++ {:missing, param} ->+ H.bad_request(conn, "Parameter `#{param}` is required to delete a guest")+ end+ end+def find_or_create_shared_link(conn, params) dowith {:ok, site_id} <- expect_param_key(params, "site_id"),{:ok, link_name} <- expect_param_key(params, "name"),@@ -235,10 +334,22 @@ defmodule PlausibleWeb.Api.ExternalSitesController do%{"error" => error_msg}end- defp expect_param_key(params, key) do+ defp expect_param_key(params, key, inclusion \\ [])++ defp expect_param_key(params, key, []) docase Map.fetch(params, key) do:error -> {:missing, key}res -> resendend++ defp expect_param_key(params, key, inclusion) do+ case expect_param_key(params, key, []) do+ {:ok, value} = ok ->+ if value in inclusion, do: ok, else: {:missing, key}++ _ ->+ {:missing, key}+ end+ endenddiff --git a/lib/plausible/sites.ex b/lib/plausible/sites.exindex d2080d8aef..a3c801bab5 100644--- a/lib/plausible/sites.ex+++ b/lib/plausible/sites.ex@@ -151,6 +151,67 @@ defmodule Plausible.Sites do%{memberships: memberships, invitations: site_transfers ++ invitations}end+ @spec list_guests_query(Site.t(), Keyword.t()) :: Ecto.Query.t()+ def list_guests_query(site, opts \\ []) do+ guest_memberships =+ from(+ gm in Teams.GuestMembership,+ inner_join: tm in assoc(gm, :team_membership),+ inner_join: u in assoc(tm, :user),+ as: :user,+ where: gm.site_id == ^site.id,+ select: %{+ id: gm.id,+ inserted_at: gm.inserted_at,+ email: u.email,+ role: gm.role,+ status: "accepted"+ }+ )++ guest_memberships =+ if email = opts[:email] do+ guest_memberships |> where([user: u], u.email == ^email)+ else+ guest_memberships+ end++ guest_invitations =+ from(+ gi in Teams.GuestInvitation,+ inner_join: ti in assoc(gi, :team_invitation),+ as: :team_invitation,+ where: gi.site_id == ^site.id,+ select: %{+ id: gi.id,+ inserted_at: gi.inserted_at,+ email: ti.email,+ role: gi.role,+ status: "invited"+ }+ )++ guest_invitations =+ if email = opts[:email] do+ guest_invitations |> where([team_invitation: ti], ti.email == ^email)+ else+ guest_invitations+ end++ guests = union_all(guest_memberships, ^guest_invitations)++ from(g in subquery(guests),+ select: %{+ id: g.id,+ inserted_at: g.inserted_at,+ email: g.email,+ role: g.role,+ status: g.status+ },+ order_by: [desc: g.inserted_at, desc: g.id]+ )+ end+@spec for_user_query(Auth.User.t(), Teams.Team.t() | nil) :: Ecto.Query.t()def for_user_query(user, team \\ nil) doquery =diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.exindex a8e753134a..10c5048cc0 100644--- a/lib/plausible_web/router.ex+++ b/lib/plausible_web/router.ex@@ -267,6 +267,7 @@ defmodule PlausibleWeb.Router doget "/", ExternalSitesController, :indexget "/goals", ExternalSitesController, :goals_index+ get "/guests", ExternalSitesController, :guests_indexget "/:site_id", ExternalSitesController, :get_siteend@@ -275,8 +276,13 @@ defmodule PlausibleWeb.Router dopost "/", ExternalSitesController, :create_siteput "/shared-links", ExternalSitesController, :find_or_create_shared_link+put "/goals", ExternalSitesController, :find_or_create_goaldelete "/goals/:goal_id", ExternalSitesController, :delete_goal++ put "/guests", ExternalSitesController, :find_or_create_guest+ delete "/guests/:email", ExternalSitesController, :delete_guest+put "/:site_id", ExternalSitesController, :update_sitedelete "/:site_id", ExternalSitesController, :delete_siteenddiff --git a/test/plausible_web/controllers/api/external_sites_controller_test.exs b/test/plausible_web/controllers/api/external_sites_controller_test.exsindex c0588f31c7..4253930557 100644--- a/test/plausible_web/controllers/api/external_sites_controller_test.exs+++ b/test/plausible_web/controllers/api/external_sites_controller_test.exs@@ -3,6 +3,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest douse PlausibleWeb.ConnCase, async: falseuse Plausible.Repouse Plausible.Teams.Test+ use Bamboo.Teston_ee dosetup :create_user@@ -261,6 +262,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do})res = json_response(conn, 200)+assert res["goal_type"] == "event"assert res["display_name"] == "Signup"assert res["event_name"] == "Signup"@@ -634,6 +636,249 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest doendend+ describe "GET /api/v1/sites/guests" do+ test "returns empty when there are no guests for site", %{conn: conn, user: user} do+ site = new_site(owner: user)+ conn = get(conn, "/api/v1/sites/guests?site_id=#{site.domain}")++ assert json_response(conn, 200) == %{+ "guests" => [],+ "meta" => %{+ "before" => nil,+ "after" => nil,+ "limit" => 100+ }+ }+ end++ test "returns guests when present", %{conn: conn, user: user} do+ site = new_site(owner: user)++ guest1 = add_guest(site, site: site, role: :editor)+ guest2 = add_guest(site, site: site, role: :viewer)+ guest3 = invite_guest(site, "[email protected]", inviter: user, role: :viewer)++ conn = get(conn, "/api/v1/sites/guests?site_id=#{site.domain}")++ assert json_response(conn, 200) == %{+ "guests" => [+ %{"email" => guest2.email, "status" => "accepted", "role" => "viewer"},+ %{"email" => guest1.email, "status" => "accepted", "role" => "editor"},+ %{+ "email" => guest3.team_invitation.email,+ "status" => "invited",+ "role" => "viewer"+ }+ ],+ "meta" => %{+ "before" => nil,+ "after" => nil,+ "limit" => 100+ }+ }+ end++ test "returns guests paginated", %{conn: conn, user: user} do+ site = new_site(owner: user)++ %{email: guest1_email} = add_guest(site, site: site, role: :editor)+ %{email: guest2_email} = add_guest(site, site: site, role: :viewer)+ invite_guest(site, "[email protected]", inviter: user, role: :viewer)++ conn1 = get(conn, "/api/v1/sites/guests?site_id=#{site.domain}&limit=2")++ assert %{+ "guests" => [+ %{"email" => ^guest2_email, "status" => "accepted", "role" => "viewer"},+ %{"email" => ^guest1_email, "status" => "accepted", "role" => "editor"}+ ],+ "meta" => %{+ "before" => nil,+ "after" => after_cursor,+ "limit" => 2+ }+ } = json_response(conn1, 200)++ conn2 =+ get(+ conn,+ "/api/v1/sites/guests?site_id=#{site.domain}&limit=2&after=#{after_cursor}"+ )++ assert %{+ "guests" => [+ %{+ "email" => "[email protected]",+ "status" => "invited",+ "role" => "viewer"+ }+ ],+ "meta" => %{+ "before" => before_cursor,+ "after" => nil,+ "limit" => 2+ }+ } =+ json_response(conn2, 200)++ assert is_binary(before_cursor)+ end+ end++ describe "PUT /api/v1/sites/guests" do+ test "creates new invitation", %{conn: conn, user: user} do+ site = new_site(owner: user)++ conn =+ put(conn, "/api/v1/sites/guests?site_id=#{site.domain}", %{+ "role" => "viewer",+ "email" => "[email protected]"+ })++ assert json_response(conn, 200) == %{+ "status" => "invited",+ "email" => "[email protected]",+ "role" => "viewer"+ }++ assert_email_delivered_with(+ to: [nil: "[email protected]"],+ subject: ~r/You've been invited to #{site.domain}/+ )+ end++ test "is idempotent", %{conn: conn, user: user} do+ site = new_site(owner: user)++ conn1 =+ put(conn, "/api/v1/sites/guests?site_id=#{site.domain}", %{+ "role" => "viewer",+ "email" => "[email protected]"+ })++ assert_email_delivered_with(to: [nil: "[email protected]"])+ assert json_response(conn1, 200)++ conn2 =+ put(conn, "/api/v1/sites/guests?site_id=#{site.domain}", %{+ "role" => "editor",+ "email" => "[email protected]"+ })++ assert %{"role" => "viewer", "status" => "invited"} = json_response(conn2, 200)++ assert %{memberships: [_], invitations: [%{role: "viewer"}]} =+ Plausible.Sites.list_people(site)++ assert_no_emails_delivered()+ end++ test "is idempotent when membership already present", %{conn: conn, user: user} do+ site = new_site(owner: user)+ guest = new_user(email: "[email protected]")++ add_guest(site, role: :viewer, user: guest)++ conn =+ put(conn, "/api/v1/sites/guests?site_id=#{site.domain}", %{+ "role" => "editor",+ "email" => "[email protected]"+ })++ assert %{"role" => "viewer", "status" => "accepted"} = json_response(conn, 200)++ assert %{+ memberships: [%{user: _}, %{user: %{email: "[email protected]"}}],+ invitations: []+ } =+ Plausible.Sites.list_people(site)++ assert_no_emails_delivered()+ end++ test "fails for unknown role", %{conn: conn, user: user} do+ site = new_site(owner: user)++ conn =+ put(conn, "/api/v1/sites/guests?site_id=#{site.domain}", %{+ "role" => "owner",+ "email" => "[email protected]"+ })++ assert %{"error" => error} = json_response(conn, 400)++ assert error =~+ "Parameter `role` is required to create guest. Possible values: `viewer` or `editor`"++ assert_no_emails_delivered()+ end+ end++ describe "DELETE /api/v1/sites/guests" do+ test "no-op when nothing to delete", %{conn: conn, user: user} do+ site = new_site(owner: user)++ conn = delete(conn, "/api/v1/sites/guests/[email protected]?site_id=#{site.domain}")++ assert json_response(conn, 200) == %{"deleted" => true}+ end++ test "deletes invitation", %{conn: conn, user: user} do+ site = new_site(owner: user)++ invite_guest(site, "[email protected]", inviter: user, role: :viewer)++ assert %{invitations: [_]} = Plausible.Sites.list_people(site)++ conn = delete(conn, "/api/v1/sites/guests/[email protected]?site_id=#{site.domain}")++ assert json_response(conn, 200) == %{"deleted" => true}++ assert %{invitations: []} = Plausible.Sites.list_people(site)+ end++ test "deletes guest membership", %{conn: conn, user: user} do+ site = new_site(owner: user)++ guest = new_user(email: "[email protected]")+ add_guest(site, role: :viewer, user: guest)++ assert %{memberships: [_, _]} = Plausible.Sites.list_people(site)++ conn = delete(conn, "/api/v1/sites/guests/#{guest.email}?site_id=#{site.domain}")++ assert json_response(conn, 200) == %{"deleted" => true}++ assert %{memberships: [_]} = Plausible.Sites.list_people(site)+ end++ test "is idempotent", %{conn: conn, user: user} do+ site = new_site(owner: user)++ invite_guest(site, "[email protected]", inviter: user, role: :viewer)++ assert %{invitations: [_]} = Plausible.Sites.list_people(site)++ conn1 = delete(conn, "/api/v1/sites/guests/[email protected]?site_id=#{site.domain}")+ assert json_response(conn1, 200) == %{"deleted" => true}++ conn2 = delete(conn, "/api/v1/sites/guests/[email protected]?site_id=#{site.domain}")+ assert json_response(conn2, 200) == %{"deleted" => true}+ end++ test "won't delete non-guest membership", %{conn: conn, user: user} do+ site = new_site(owner: user)++ assert %{memberships: [_]} = Plausible.Sites.list_people(site)++ conn = delete(conn, "/api/v1/sites/guests/#{user.email}?site_id=#{site.domain}")++ assert json_response(conn, 200) == %{"deleted" => true}++ assert %{memberships: [_]} = Plausible.Sites.list_people(site)+ end+ end+describe "GET /api/v1/sites/:site_id" dosetup :create_site