Skip to content

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

Switch `Sites.list[_with_invitations]` to use teams schemas (#4747)

Adrian Gruntkowskifc92ed501834
diff --git a/lib/plausible/sites.ex b/lib/plausible/sites.ex
index 9252f50be8..aaf4ee5c69 100644
--- a/lib/plausible/sites.ex
+++ b/lib/plausible/sites.ex
@@ -71,8 +71,24 @@ defmodule Plausible.Sites do
)
end
- @spec list(Auth.User.t(), map(), [list_opt()]) :: Scrivener.Page.t()
def list(user, pagination_params, opts \\ []) do
+ if Plausible.Teams.read_team_schemas?(user) do
+ Plausible.Teams.Sites.list(user, pagination_params, opts)
+ else
+ old_list(user, pagination_params, opts)
+ end
+ end
+
+ def list_with_invitations(user, pagination_params, opts \\ []) do
+ if Plausible.Teams.read_team_schemas?(user) do
+ Plausible.Teams.Sites.list_with_invitations(user, pagination_params, opts)
+ else
+ old_list_with_invitations(user, pagination_params, opts)
+ end
+ end
+
+ @spec old_list(Auth.User.t(), map(), [list_opt()]) :: Scrivener.Page.t()
+ def old_list(user, pagination_params, opts \\ []) do
domain_filter = Keyword.get(opts, :filter_by_domain)
from(s in Site,
@@ -104,8 +120,8 @@ defmodule Plausible.Sites do
|> Repo.paginate(pagination_params)
end
- @spec list_with_invitations(Auth.User.t(), map(), [list_opt()]) :: Scrivener.Page.t()
- def list_with_invitations(user, pagination_params, opts \\ []) do
+ @spec old_list_with_invitations(Auth.User.t(), map(), [list_opt()]) :: Scrivener.Page.t()
+ def old_list_with_invitations(user, pagination_params, opts \\ []) do
domain_filter = Keyword.get(opts, :filter_by_domain)
result =
diff --git a/lib/plausible/teams.ex b/lib/plausible/teams.ex
index 253fc6e721..1b227d1670 100644
--- a/lib/plausible/teams.ex
+++ b/lib/plausible/teams.ex
@@ -8,6 +8,10 @@ defmodule Plausible.Teams do
alias __MODULE__
alias Plausible.Repo
+ def read_team_schemas?(user) do
+ FunWithFlags.enabled?(:read_team_schemas, for: user)
+ end
+
def with_subscription(team) do
Repo.preload(team, subscription: last_subscription_query())
end
diff --git a/lib/plausible/teams/sites.ex b/lib/plausible/teams/sites.ex
index 173066ce01..d832c3c87a 100644
--- a/lib/plausible/teams/sites.ex
+++ b/lib/plausible/teams/sites.ex
@@ -89,8 +89,9 @@ defmodule Plausible.Teams.Sites do
from(u in subquery(union_query),
inner_join: s in Plausible.Site,
on: u.site_id == s.id,
+ as: :site,
left_join: up in Site.UserPreference,
- on: up.site_id == s.id,
+ on: up.site_id == s.id and up.user_id == ^user.id,
select: %{
s
| entry_type:
@@ -119,6 +120,8 @@ defmodule Plausible.Teams.Sites do
|> Repo.paginate(pagination_params)
end
+ @role_type Plausible.Auth.Invitation.__schema__(:type, :role)
+
@spec list_with_invitations(Auth.User.t(), map(), [list_opt()]) :: Scrivener.Page.t()
def list_with_invitations(user, pagination_params, opts \\ []) do
domain_filter = Keyword.get(opts, :filter_by_domain)
@@ -128,40 +131,102 @@ defmodule Plausible.Teams.Sites do
inner_join: t in assoc(tm, :team),
inner_join: s in assoc(t, :sites),
where: tm.user_id == ^user.id and tm.role != :guest,
- select: %{site_id: s.id, entry_type: "site", invitation_id: 0, invitation_role: ""}
+ select: %{
+ site_id: s.id,
+ entry_type: "site",
+ invitation_id: 0,
+ invitation_role: nil,
+ transfer_id: 0
+ }
guest_membership_query =
from(tm in Teams.Membership,
inner_join: gm in assoc(tm, :guest_memberships),
inner_join: s in assoc(gm, :site),
where: tm.user_id == ^user.id and tm.role == :guest,
- select: %{site_id: s.id, entry_type: "site", invitation_id: 0, invitation_role: ""}
+ select: %{
+ site_id: s.id,
+ entry_type: "site",
+ invitation_id: 0,
+ invitation_role: nil,
+ transfer_id: 0
+ }
)
guest_invitation_query =
from ti in Teams.Invitation,
+ as: :team_invitation,
inner_join: gi in assoc(ti, :guest_invitations),
inner_join: s in assoc(gi, :site),
+ as: :site,
+ where:
+ not exists(
+ from tm in Teams.Membership,
+ inner_join: u in assoc(tm, :user),
+ left_join: gm in assoc(tm, :guest_memberships),
+ on: gm.site_id == parent_as(:site).id,
+ where: tm.team_id == parent_as(:team_invitation).team_id,
+ where: u.email == parent_as(:team_invitation).email,
+ where: not is_nil(gm.id) or tm.role != :guest,
+ select: 1
+ ),
where: ti.email == ^user.email and ti.role == :guest,
select: %{
site_id: s.id,
entry_type: "invitation",
invitation_id: ti.id,
- invitation_role: gi.role
+ invitation_role:
+ fragment(
+ """
+ CASE
+ WHEN ? = 'editor' THEN 'admin'
+ ELSE ?
+ END
+ """,
+ gi.role,
+ gi.role
+ ),
+ transfer_id: 0
+ }
+
+ site_transfer_query =
+ from st in Teams.SiteTransfer,
+ as: :site_transfer,
+ inner_join: s in assoc(st, :site),
+ as: :site,
+ where: st.email == ^user.email,
+ where:
+ not exists(
+ from tm in Teams.Membership,
+ inner_join: u in assoc(tm, :user),
+ where: tm.team_id == parent_as(:site).team_id,
+ where: u.email == parent_as(:site_transfer).email,
+ select: 1
+ ),
+ select: %{
+ site_id: s.id,
+ entry_type: "invitation",
+ invitation_id: 0,
+ invitation_role: "owner",
+ transfer_id: st.id
}
union_query =
from s in team_membership_query,
union_all: ^guest_membership_query,
- union_all: ^guest_invitation_query
+ union_all: ^guest_invitation_query,
+ union_all: ^site_transfer_query
from(u in subquery(union_query),
inner_join: s in Plausible.Site,
on: u.site_id == s.id,
+ as: :site,
left_join: up in Site.UserPreference,
- on: up.site_id == s.id,
+ on: up.site_id == s.id and up.user_id == ^user.id,
left_join: ti in Teams.Invitation,
on: ti.id == u.invitation_id,
+ left_join: st in Teams.SiteTransfer,
+ on: st.id == u.transfer_id,
select: %{
s
| entry_type:
@@ -181,9 +246,11 @@ defmodule Plausible.Teams.Sites do
pinned_at: selected_as(up.pinned_at, :pinned_at),
invitations: [
%Plausible.Auth.Invitation{
- invitation_id: ti.invitation_id,
- email: ti.email,
- role: u.invitation_role
+ invitation_id: coalesce(ti.invitation_id, st.transfer_id),
+ email: coalesce(ti.email, st.email),
+ role: type(coalesce(u.invitation_role, "owner"), ^@role_type),
+ site_id: s.id,
+ site: s
}
]
},
@@ -195,11 +262,17 @@ defmodule Plausible.Teams.Sites do
)
|> maybe_filter_by_domain(domain_filter)
|> Repo.paginate(pagination_params)
+ |> Map.update!(:entries, fn entries ->
+ # temporary prosthetic, when switching to the new model eventually,
+ # we'll have to preload memberships from new schemas
+ membership_query = from sm in Site.Membership, where: sm.user_id == ^user.id
+ Repo.preload(entries, memberships: membership_query)
+ end)
end
defp maybe_filter_by_domain(query, domain)
when byte_size(domain) >= 1 and byte_size(domain) <= 64 do
- where(query, [s], ilike(s.domain, ^"%#{domain}%"))
+ where(query, [site: s], ilike(s.domain, ^"%#{domain}%"))
end
defp maybe_filter_by_domain(query, _), do: query
diff --git a/lib/plausible_web/live/sites.ex b/lib/plausible_web/live/sites.ex
index 16036c4e07..cdf61a06a4 100644
--- a/lib/plausible_web/live/sites.ex
+++ b/lib/plausible_web/live/sites.ex
@@ -35,7 +35,7 @@ defmodule PlausibleWeb.Live.Sites do
|> assign_new(:needs_to_upgrade, fn %{current_user: current_user, sites: sites} ->
user_owns_sites =
Enum.any?(sites.entries, fn site ->
- List.first(site.memberships ++ site.invitations).role == :owner
+ List.first(site.invitations).role == :owner
end) ||
Auth.user_owns_sites?(current_user)
diff --git a/test/plausible/site/sites_test.exs b/test/plausible/site/sites_test.exs
index 07fea67c19..cb5b4e2e7f 100644
--- a/test/plausible/site/sites_test.exs
+++ b/test/plausible/site/sites_test.exs
@@ -172,8 +172,8 @@ defmodule Plausible.SitesTest do
describe "list/3 and list_with_invitations/3" do
test "returns empty when there are no sites" do
- user = insert(:user)
- _rogue_site = insert(:site)
+ user = new_user()
+ _rogue_site = new_site()
assert %{
entries: [],
@@ -209,32 +209,17 @@ defmodule Plausible.SitesTest do
end
test "pinned site doesn't matter with membership revoked (no active invitations)" do
- user1 = insert(:user, email: "[email protected]")
- user2 = insert(:user, email: "[email protected]")
-
- team1 = insert(:team)
- insert(:site, team: team1, members: [user1], domain: "one.example.com")
- insert(:team_membership, team: team1, user: user1, role: :owner)
-
- team2 = insert(:team)
-
- site2 =
- insert(:site,
- team: team2,
- members: [user2],
- domain: "two.example.com"
- )
+ user1 = new_user(email: "[email protected]")
+ _user2 = new_user(email: "[email protected]")
- insert(:team_membership, team: team2, user: user2, role: :owner)
+ new_site(owner: user1, domain: "one.example.com")
+ site2 = new_site(domain: "two.example.com")
- membership = insert(:site_membership, user: user1, role: :viewer, site: site2)
- team_membership = insert(:team_membership, team: team2, user: user1, role: :guest)
- insert(:guest_membership, team_membership: team_membership, site: site2, role: :viewer)
+ user1 = site2 |> add_guest(user: user1, role: :viewer)
{:ok, _} = Sites.toggle_pin(user1, site2)
- Repo.delete!(membership)
- Repo.delete!(team_membership)
+ revoke_membership(site2, user1)
assert %{entries: [%{domain: "one.example.com"}]} = Sites.list(user1, %{})
assert %{entries: [%{domain: "one.example.com"}]} = Sites.list_with_invitations(user1, %{})
@@ -245,40 +230,16 @@ defmodule Plausible.SitesTest do
Plausible.Teams.Sites.list_with_invitations(user1, %{})
end
- test "pinned site doesn't matter with membership revoked (with active invitation)" do
- user1 = insert(:user, email: "[email protected]")
- user2 = insert(:user, email: "[email protected]")
-
- team1 = insert(:team)
- insert(:site, team: team1, members: [user1], domain: "one.example.com")
- insert(:team_membership, team: team1, user: user1, role: :owner)
-
- team2 = insert(:team)
-
- site2 =
- insert(:site,
- team: team2,
- members: [user2],
- domain: "two.example.com"
- )
+ test "pinned site with active invitation" do
+ user1 = new_user(email: "[email protected]")
+ user2 = new_user(email: "[email protected]")
- insert(:team_membership, team: team2, user: user2, role: :owner)
+ site1 = new_site(domain: "one.example.com", owner: user1)
+ site2 = new_site(domain: "two.example.com")
- membership = insert(:site_membership, user: user1, role: :viewer, site: site2)
- team_membership = insert(:team_membership, team: team2, user: user1, role: :guest)
- insert(:guest_membership, team_membership: team_membership, site: site2, role: :viewer)
+ invite_guest(site2, user1, role: :editor, inviter: user2)
- insert(:invitation, email: user1.email, inviter: user2, role: :owner, site: site2)
-
- team_invitation =
- insert(:team_invitation, team: team2, email: user1.email, inviter: user2, role: :guest)
-
- insert(:guest_invitation, team_invitation: team_invitation, site: site2, role: :editor)
-
- {:ok, _} = Sites.toggle_pin(user1, site2)
-
- Repo.delete!(membership)
- Repo.delete!(team_membership)
+ {:ok, _} = Sites.toggle_pin(user1, site1)
assert %{entries: [%{domain: "one.example.com"}]} = Sites.list(user1, %{})
@@ -292,374 +253,203 @@ defmodule Plausible.SitesTest do
end
test "puts invitations first, pinned sites second, sites last" do
- user = insert(:user, email: "[email protected]")
-
- team1 = insert(:team)
-
- site1 =
- %{id: site_id1} = insert(:site, team: team1, members: [user], domain: "one.example.com")
-
- insert(:team_membership, team: team1, user: user, role: :owner)
- team2 = insert(:team)
-
- site2 =
- %{id: site_id2} = insert(:site, team: team2, members: [user], domain: "two.example.com")
-
- insert(:team_membership, team: team2, user: build(:user), role: :owner)
- team_membership2 = insert(:team_membership, team: team2, user: user, role: :guest)
- insert(:guest_membership, team_membership: team_membership2, site: site2, role: :editor)
-
- team4 = insert(:team)
-
- site4 =
- %{id: site_id4} = insert(:site, team: team4, members: [user], domain: "four.example.com")
-
- insert(:team_membership, team: team4, user: build(:user), role: :owner)
- team_membership4 = insert(:team_membership, team: team4, user: user, role: :guest)
- insert(:guest_membership, team_membership: team_membership4, site: site4, role: :viewer)
-
- _rogue_site = insert(:site, team: build(:team), domain: "rogue.example.com")
-
- ## Having owner invite on owned site does not make much sense?
- ## Maybe that was a repro of real-life example?
- # insert(:invitation, email: user.email, inviter: build(:user), role: :owner, site: site1)
-
- # team_invitation1 =
- # insert(:team_invitation,
- # team: team1,
- # email: user.email,
- # inviter: build(:user),
- # role: :guest
- # )
-
- # insert(:guest_invitation, team_invitation: team_invitation1, site: site1, role: :editor)
-
- team3 = insert(:team)
+ user1 = new_user()
+ user2 = new_user()
+ user3 = new_user()
- site3 = %{id: site_id3} = insert(:site, team: team3, domain: "three.example.com")
+ site1 = new_site(owner: user1, domain: "one.example.com")
+ site2 = new_site(owner: user2, domain: "two.example.com")
+ site3 = new_site(domain: "three.example.com")
+ site4 = new_site(domain: "four.example.com")
+ site5 = new_site(owner: user3, domain: "five.example.com")
- insert(:invitation, email: user.email, inviter: build(:user), role: :viewer, site: site3)
+ invite_guest(site2, user1, role: :editor, inviter: user2)
+ add_guest(site3, user: user1, role: :viewer)
+ add_guest(site4, user: user1, role: :editor)
- team_invitation2 =
- insert(:team_invitation,
- team: team3,
- email: user.email,
- inviter: build(:user),
- role: :guest
- )
+ invite_transfer(site5, user1, inviter: user3)
- insert(:guest_invitation, team_invitation: team_invitation2, site: site3, role: :viewer)
+ {:ok, _} = Sites.toggle_pin(user1, site3)
+ {:ok, _pin_to_ignore} = Sites.toggle_pin(user2, site2)
- insert(:invitation, email: "[email protected]", inviter: user, role: :viewer, site: site1)
-
- team_invitation3 =
- insert(:team_invitation,
- team: team1,
- email: "[email protected]",
- inviter: user,
- role: :guest
- )
-
- insert(:guest_invitation, team_invitation: team_invitation3, site: site1, role: :viewer)
-
- insert(:invitation,
- site: site1,
- inviter: user,
- )
-
- team_invitation4 =
- insert(:team_invitation,
- team: team1,
- email: "[email protected]",
- inviter: user,
- role: :guest
- )
-
- insert(:guest_invitation, team_invitation: team_invitation4, site: site1, role: :editor)
-
- {:ok, _} = Sites.toggle_pin(user, site2)
+ site1_id = site1.id
+ site2_id = site2.id
+ site3_id = site3.id
+ site4_id = site4.id
+ site5_id = site5.id
assert %{
entries: [
- %{id: ^site_id2, entry_type: "pinned_site"},
- %{id: ^site_id4, entry_type: "site"},
- %{id: ^site_id1, entry_type: "site"}
+ %{id: ^site3_id, entry_type: "pinned_site"},
+ %{id: ^site4_id, entry_type: "site"},
+ %{id: ^site1_id, entry_type: "site"}
]
- } = Sites.list(user, %{})
+ } = Sites.list(user1, %{})
assert %{
entries: [
- %{id: ^site_id3, entry_type: "invitation"},
- %{id: ^site_id2, entry_type: "pinned_site"},
- %{id: ^site_id4, entry_type: "site"},
- %{id: ^site_id1, entry_type: "site"}
+ %{id: ^site5_id, entry_type: "invitation"},
+ %{id: ^site2_id, entry_type: "invitation"},
+ %{id: ^site3_id, entry_type: "pinned_site"},
+ %{id: ^site4_id, entry_type: "site"},
+ %{id: ^site1_id, entry_type: "site"}
]
- } = Sites.list_with_invitations(user, %{})
-
- assert %{
- entries: [
- %{id: ^site_id2, entry_type: "pinned_site"},
- %{id: ^site_id4, entry_type: "site"},
- %{id: ^site_id1, entry_type: "site"}
- ]
- } = Plausible.Teams.Sites.list(user, %{})
-
- assert %{
- entries: [
- %{id: ^site_id3, entry_type: "invitation"},
- %{id: ^site_id2, entry_type: "pinned_site"},
- %{id: ^site_id4, entry_type: "site"},
- %{id: ^site_id1, entry_type: "site"}
- ]
- } = Plausible.Teams.Sites.list_with_invitations(user, %{})
+ } = Sites.list_with_invitations(user1, %{})
end
test "pinned sites are ordered according to the time they were pinned at" do
- user = insert(:user, email: "[email protected]")
-
- site1 = %{id: site_id1} = insert(:site, members: [user], domain: "one.example.com")
- site2 = %{id: site_id2} = insert(:site, members: [user], domain: "two.example.com")
- site4 = %{id: site_id4} = insert(:site, members: [user], domain: "four.example.com")
+ user1 = new_user()
+ user2 = new_user()
+ user3 = new_user()
- _rogue_site = insert(:site, domain: "rogue.example.com")
+ site1 = new_site(owner: user1, domain: "one.example.com")
+ site2 = new_site(owner: user2, domain: "two.example.com")
+ site3 = new_site(domain: "three.example.com")
+ site4 = new_site(domain: "four.example.com")
+ site5 = new_site(owner: user3, domain: "five.example.com")
- insert(:invitation, email: user.email, inviter: build(:user), role: :owner, site: site1)
+ invite_guest(site2, user1, role: :editor, inviter: user2)
+ add_guest(site3, user: user1, role: :viewer)
+ add_guest(site4, user: user1, role: :editor)
- %{id: site_id3} =
- insert(:site,
- domain: "three.example.com",
- invitations: [
- build(:invitation, email: user.email, inviter: build(:user), role: :viewer)
- ]
- )
+ invite_transfer(site5, user1, inviter: user3)
- insert(:invitation, email: "[email protected]", inviter: user, role: :viewer, site: site1)
+ {:ok, _} = Sites.toggle_pin(user1, site3)
- insert(:invitation,
- site: site1,
- inviter: user,
- )
+ site1_id = site1.id
+ site2_id = site2.id
+ site3_id = site3.id
+ site4_id = site4.id
+ site5_id = site5.id
- Sites.set_option(user, site2, :pinned_at, ~N[2023-10-22 12:00:00])
- {:ok, _} = Sites.toggle_pin(user, site4)
+ Sites.set_option(user1, site1, :pinned_at, ~N[2023-10-22 12:00:00])
+ {:ok, _} = Sites.toggle_pin(user1, site3)
assert %{
entries: [
- %{id: ^site_id4, entry_type: "pinned_site"},
- %{id: ^site_id2, entry_type: "pinned_site"},
- %{id: ^site_id1, entry_type: "site"}
+ %{id: ^site3_id, entry_type: "pinned_site"},
+ %{id: ^site1_id, entry_type: "pinned_site"},
+ %{id: ^site4_id, entry_type: "site"}
]
- } = Sites.list(user, %{})
+ } = Sites.list(user1, %{})
assert %{
entries: [
- %{id: ^site_id1, entry_type: "invitation"},
- %{id: ^site_id3, entry_type: "invitation"},
- %{id: ^site_id4, entry_type: "pinned_site"},
- %{id: ^site_id2, entry_type: "pinned_site"}
+ %{id: ^site5_id, entry_type: "invitation"},
+ %{id: ^site2_id, entry_type: "invitation"},
+ %{id: ^site3_id, entry_type: "pinned_site"},
+ %{id: ^site1_id, entry_type: "pinned_site"},
+ %{id: ^site4_id, entry_type: "site"}
]
- } = Sites.list_with_invitations(user, %{})
+ } = Sites.list_with_invitations(user1, %{})
end
test "filters by domain" do
- user = insert(:user)
- %{id: site_id1} = insert(:site, domain: "first.example.com", members: [user])
- %{id: _site_id2} = insert(:site, domain: "second.example.com", members: [user])
- _rogue_site = insert(:site)
-
- %{id: site_id3} =
- insert(:site,
- domain: "first-another.example.com",
- invitations: [
- build(:invitation, email: user.email, inviter: build(:user), role: :viewer)
- ]
- )
+ user1 = new_user()
+ user2 = new_user()
+ user3 = new_user()
- assert %{
- entries: [
- %{id: ^site_id1}
- ]
- } = Sites.list(user, %{}, filter_by_domain: "first")
+ site1 = new_site(owner: user1, domain: "first.example.com")
+ site2 = new_site(owner: user2, domain: "first-transfer.example.com")
+ site3 = new_site(owner: user3, domain: "first-invitation.example.com")
+ _site4 = new_site(owner: user1, domain: "another.example.com")
+
+ invite_guest(site3, user1, role: :viewer, inviter: user3)
+ invite_transfer(site2, user1, inviter: user2)
+
+ site1_id = site1.id
+ site2_id = site2.id
+ site3_id = site3.id
assert %{
entries: [
- %{id: ^site_id3},
- %{id: ^site_id1}
+ %{id: ^site1_id}
]
- } = Sites.list_with_invitations(user, %{}, filter_by_domain: "first")
- end
- end
-
- describe "list/3" do
- test "returns sites only, no invitations" do
- user = insert(:user, email: "[email protected]")
-
- site1 = %{id: site_id1} = insert(:site, members: [user], domain: "one.example.com")
- %{id: site_id2} = insert(:site, members: [user], domain: "two.example.com")
- %{id: site_id4} = insert(:site, members: [user], domain: "four.example.com")
-
- _rogue_site = insert(:site, domain: "rogue.example.com")
-
- insert(:invitation, email: user.email, inviter: build(:user), role: :owner, site: site1)
-
- insert(:site,
- domain: "three.example.com",
- invitations: [
- build(:invitation, email: user.email, inviter: build(:user), role: :viewer)
- ]
- )
-
- insert(:invitation, email: "[email protected]", inviter: user, role: :viewer, site: site1)
-
- insert(:invitation,
- site: site1,
- inviter: user,
- )
+ } = Sites.list(user1, %{}, filter_by_domain: "first")
assert %{
entries: [
- %{id: ^site_id4, entry_type: "site"},
- %{id: ^site_id1, entry_type: "site"},
- %{id: ^site_id2, entry_type: "site"}
+ %{id: ^site3_id},
+ %{id: ^site2_id},
+ %{id: ^site1_id}
]
- } = Sites.list(user, %{})
+ } = Sites.list_with_invitations(user1, %{}, filter_by_domain: "first")
end
test "handles pagination correctly" do
- user = insert(:user)
- %{id: site_id1} = insert(:site, members: [user])
- %{id: site_id2} = insert(:site, members: [user])
- _rogue_site = insert(:site)
+ user1 = new_user()
+ user2 = new_user()
+ user3 = new_user()
- insert(:site,
- invitations: [
- build(:invitation, email: user.email, inviter: build(:user), role: :viewer)
- ]
- )
+ site1 = new_site(owner: user1, domain: "one.example.com")
+ site2 = new_site(owner: user2, domain: "two.example.com")
+ site3 = new_site(domain: "three.example.com")
+ site4 = new_site(domain: "four.example.com")
+ site5 = new_site(owner: user3, domain: "five.example.com")
- site4 = %{id: site_id4} = insert(:site, members: [user])
+ invite_guest(site2, user1, role: :editor, inviter: user2)
+ add_guest(site3, user: user1, role: :viewer)
+ add_guest(site4, user: user1, role: :editor)
- {:ok, _} = Sites.toggle_pin(user, site4)
+ invite_transfer(site5, user1, inviter: user3)
+
+ {:ok, _} = Sites.toggle_pin(user1, site3)
+
+ site1_id = site1.id
+ site2_id = site2.id
+ site3_id = site3.id
+ site4_id = site4.id
+ site5_id = site5.id
assert %{
- entries: [
- %{id: ^site_id4},
- %{id: ^site_id1}
- ],
+ entries: [%{id: ^site3_id}, %{id: ^site4_id}],
page_number: 1,
page_size: 2,
total_entries: 3,
total_pages: 2
- } = Sites.list(user, %{"page_size" => 2})
+ } = Sites.list(user1, %{"page_size" => 2})
assert %{
- entries: [
- %{id: ^site_id2}
- ],
+ entries: [%{id: ^site1_id}],
page_number: 2,
page_size: 2,
total_entries: 3,
total_pages: 2
- } = Sites.list(user, %{"page" => 2, "page_size" => 2})
+ } = Sites.list(user1, %{"page_size" => 2, "page" => 2})
assert %{
- entries: [
- %{id: ^site_id4},
- %{id: ^site_id1}
- ],
+ entries: [%{id: ^site3_id}, %{id: ^site4_id}, %{id: ^site1_id}],
page_number: 1,
- page_size: 2,
+ page_size: 3,
total_entries: 3,
- total_pages: 2
- } = Sites.list(user, %{"page" => 1, "page_size" => 2})
- end
- end
-
- describe "list_with_invitations/3" do
- test "returns invitations and sites" do
- user = insert(:user, email: "[email protected]")
-
- site1 = %{id: site_id1} = insert(:site, members: [user], domain: "one.example.com")
- %{id: site_id2} = insert(:site, members: [user], domain: "two.example.com")
- %{id: site_id4} = insert(:site, members: [user], domain: "four.example.com")
-
- _rogue_site = insert(:site, domain: "rogue.example.com")
-
- insert(:invitation, email: user.email, inviter: build(:user), role: :owner, site: site1)
-
- %{id: site_id3} =
- insert(:site,
- domain: "three.example.com",
- invitations: [
- build(:invitation, email: user.email, inviter: build(:user), role: :viewer)
- ]
- )
-
- insert(:invitation, email: "[email protected]", inviter: user, role: :viewer, site: site1)
-
- insert(:invitation,
- site: site1,
- inviter: user,
- )
-
- assert %{
- entries: [
- %{id: ^site_id1, entry_type: "invitation"},
- %{id: ^site_id3, entry_type: "invitation"},
- %{id: ^site_id4, entry_type: "site"},
- %{id: ^site_id2, entry_type: "site"}
- ]
- } = Sites.list_with_invitations(user, %{})
- end
-
- test "handles pagination correctly" do
- user = insert(:user)
- %{id: site_id1} = insert(:site, members: [user])
- %{id: site_id2} = insert(:site, members: [user])
- _rogue_site = insert(:site)
-
- %{id: site_id3} =
- insert(:site,
- invitations: [
- build(:invitation, email: user.email, inviter: build(:user), role: :viewer)
- ]
- )
+ total_pages: 1
+ } = Sites.list(user1, %{"page_size" => 3})
+ # list_with_invitations
+ #
assert %{
- entries: [
- %{id: ^site_id3},
- %{id: ^site_id1}
- ],
+ entries: [%{id: ^site5_id}, %{id: ^site2_id}],
page_number: 1,
page_size: 2,
- total_entries: 3,
- total_pages: 2
- } = Sites.list_with_invitations(user, %{"page_size" => 2})
+ total_entries: 5,
+ total_pages: 3
+ } = Sites.list_with_invitations(user1, %{"page_size" => 2})
assert %{
- entries: [
- %{id: ^site_id2}
- ],
+ entries: [%{id: ^site3_id}, %{id: ^site4_id}],
page_number: 2,
page_size: 2,
- total_entries: 3,
- total_pages: 2
- } = Sites.list_with_invitations(user, %{"page" => 2, "page_size" => 2})
+ total_entries: 5,
+ total_pages: 3
+ } = Sites.list_with_invitations(user1, %{"page_size" => 2, "page" => 2})
assert %{
- entries: [
- %{id: ^site_id3},
- %{id: ^site_id1}
- ],
- page_number: 1,
+ entries: [%{id: ^site1_id}],
+ page_number: 3,
page_size: 2,
- total_entries: 3,
- total_pages: 2
- } = Sites.list_with_invitations(user, %{"page" => 1, "page_size" => 2})
+ total_entries: 5,
+ total_pages: 3
+ } = Sites.list_with_invitations(user1, %{"page_size" => 2, "page" => 3})
end
end
diff --git a/test/plausible_web/controllers/api/internal_controller_test.exs b/test/plausible_web/controllers/api/internal_controller_test.exs
index c156f22f3c..579c926877 100644
--- a/test/plausible_web/controllers/api/internal_controller_test.exs
+++ b/test/plausible_web/controllers/api/internal_controller_test.exs
@@ -1,13 +1,14 @@
defmodule PlausibleWeb.Api.InternalControllerTest do
use PlausibleWeb.ConnCase, async: true
use Plausible.Repo
+ use Plausible.Teams.Test
describe "GET /api/sites" do
setup [:create_user, :log_in]
test "returns a list of site domains for the current user", %{conn: conn, user: user} do
- site = insert(:site, members: [user])
- site2 = insert(:site, members: [user])
+ site = new_site(owner: user)
+ site2 = new_site(owner: user)
conn = get(conn, "/api/sites")
%{"data" => sites} = json_response(conn, 200)
@@ -23,28 +24,15 @@ defmodule PlausibleWeb.Api.InternalControllerTest do
inserted =
for i <- 1..10 do
i = to_string(i)
-
- insert(:site,
- members: [user],
- domain: "site#{String.pad_leading(i, 2, "0")}.example.com"
- )
+ new_site(owner: user, domain: "site#{String.pad_leading(i, 2, "0")}.example.com")
end
- _rogue = insert(:site, domain: "site00.example.com")
-
- insert(:site,
- domain: "friend.example.com",
- invitations: [
- build(:invitation, email: user.email, inviter: build(:user), role: :viewer)
- ]
- )
-
- insert(:invitation,
- email: "[email protected]",
- inviter: user,
- role: :viewer,
- site: hd(inserted)
- )
+ _rogue = new_site(domain: "site00.example.com")
+
+ inviter = new_user()
+ site = new_site(owner: inviter, domain: "friend.example.com")
+ invite_guest(site, user, inviter: inviter, role: :viewer)
+ invite_guest(List.first(inserted), user, inviter: inviter, role: :viewer)
{:ok, _} =
Plausible.Sites.toggle_pin(user, Plausible.Sites.get_by_domain!("site07.example.com"))
diff --git a/test/plausible_web/controllers/site_controller_test.exs b/test/plausible_web/controllers/site_controller_test.exs
index e01e73a952..299688042e 100644
--- a/test/plausible_web/controllers/site_controller_test.exs
+++ b/test/plausible_web/controllers/site_controller_test.exs
@@ -3,6 +3,7 @@ defmodule PlausibleWeb.SiteControllerTest do
use Plausible.Repo
use Bamboo.Test
use Oban.Testing, repo: Plausible.Repo
+ use Plausible.Teams.Test
import ExUnit.CaptureLog
import Mox
@@ -65,7 +66,7 @@ defmodule PlausibleWeb.SiteControllerTest do
conn: conn,
user: user
} do
- site = insert(:site, members: [user])
+ site = new_site(owner: user)
# will be skipped
populate_stats(site, [build(:pageview)])
@@ -80,21 +81,18 @@ defmodule PlausibleWeb.SiteControllerTest do
end
test "shows invitations for user by email address", %{conn: conn, user: user} do
- site = insert(:site)
- insert(:invitation, email: user.email, site_id: site.id, inviter: build(:user))
+ inviter = new_user()
+ site = new_site(owner: inviter)
+ invite_guest(site, user, inviter: inviter, role: :editor)
conn = get(conn, "/sites")
assert html_response(conn, 200) =~ site.domain
end
test "invitations are case insensitive", %{conn: conn, user: user} do
- site = insert(:site)
-
- insert(:invitation,
- email: String.upcase(user.email),
- site_id: site.id,
- inviter: build(:user)
- )
+ inviter = new_user()
+ site = new_site(owner: inviter)
+ invite_guest(site, String.upcase(user.email), inviter: inviter, role: :editor)
conn = get(conn, "/sites")
@@ -103,8 +101,8 @@ defmodule PlausibleWeb.SiteControllerTest do
test "paginates sites", %{conn: initial_conn, user: user} do
for i <- 1..25 do
- insert(:site,
- members: [user],
+ new_site(
+ owner: user,
domain: "paginated-site#{String.pad_leading("#{i}", 2, "0")}.example.com"
)
end
@@ -147,7 +145,7 @@ defmodule PlausibleWeb.SiteControllerTest do
conn: initial_conn,
user: user
} do
- insert(:site, members: [user])
+ new_site(owner: user)
conn = get(initial_conn, "/sites")
resp = html_response(conn, 200)
@@ -168,17 +166,14 @@ defmodule PlausibleWeb.SiteControllerTest do
end
test "filters by domain", %{conn: conn, user: user} do
- _site1 = insert(:site, domain: "first.example.com", members: [user])
- _site2 = insert(:site, domain: "second.example.com", members: [user])
- _rogue_site = insert(:site)
-
- _site3 =
- insert(:site,
- domain: "first-another.example.com",
- invitations: [
- build(:invitation, email: user.email, inviter: build(:user), role: :viewer)
- ]
- )
+ _site1 = new_site(domain: "first.example.com", owner: user)
+ _site2 = new_site(domain: "second.example.com", owner: user)
+ _rogue_site = new_site()
+
+ inviter = new_user()
+
+ new_site(owner: inviter, domain: "first-another.example.com")
+ |> invite_guest(user, inviter: inviter, role: :viewer)
conn = get(conn, "/sites", filter_text: "first")
resp = html_response(conn, 200)
@@ -192,7 +187,7 @@ defmodule PlausibleWeb.SiteControllerTest do
conn: conn,
user: user
} do
- _site1 = insert(:site, domain: "example.com", members: [user])
+ _site1 = new_site(domain: "example.com", owner: user)
conn = get(conn, "/sites", filter_text: "none")
resp = html_response(conn, 200)
@@ -206,7 +201,7 @@ defmodule PlausibleWeb.SiteControllerTest do
conn: conn,
user: user
} do
- site = insert(:site, domain: "example.com", members: [user])
+ site = new_site(domain: "example.com", owner: user)
conn = get(conn, "/sites")
resp = html_response(conn, 200)
@@ -217,11 +212,8 @@ defmodule PlausibleWeb.SiteControllerTest do
conn: conn,
user: user
} do
- site =
- insert(:site,
- domain: "example.com",
- memberships: [build(:site_membership, user: user, role: :viewer)]
- )
+ site = new_site(domain: "example.com")
+ add_guest(site, user: user, role: :viewer)
conn = get(conn, "/sites")
resp = html_response(conn, 200)
diff --git a/test/plausible_web/live/sites_test.exs b/test/plausible_web/live/sites_test.exs
index 47bae8e44c..6e29cb7839 100644
--- a/test/plausible_web/live/sites_test.exs
+++ b/test/plausible_web/live/sites_test.exs
@@ -1,5 +1,6 @@
defmodule PlausibleWeb.Live.SitesTest do
use PlausibleWeb.ConnCase, async: true
+ use Plausible.Teams.Test
import Phoenix.LiveViewTest
import Plausible.Test.Support.HTML
@@ -20,15 +21,10 @@ defmodule PlausibleWeb.Live.SitesTest do
conn: conn,
user: user
} do
- site = insert(:site)
+ inviter = new_user()
+ site = new_site(owner: inviter)
- invitation =
- insert(:invitation,
- site_id: site.id,
- inviter: build(:user),
- email: user.email,
- role: :owner
- )
+ invitation = invite_transfer(site, user, inviter: inviter)
{:ok, _lv, html} = live(conn, "/sites")
@@ -42,20 +38,14 @@ defmodule PlausibleWeb.Live.SitesTest do
conn: conn,
user: user
} do
- site = insert(:site)
+ inviter = new_user()
+ site = new_site(owner: inviter)
- insert(:growth_subscription, user: user)
+ invitation = invite_transfer(site, user, inviter: inviter)
# fill site quota
- insert_list(10, :site, members: [user])
-
- invitation =
- insert(:invitation,
- site_id: site.id,
- inviter: build(:user),
- email: user.email,
- role: :owner
- )
+ insert(:growth_subscription, user: user)
+ for _ <- 1..10, do: new_site(owner: user)
{:ok, _lv, html} = live(conn, "/sites")
@@ -70,18 +60,12 @@ defmodule PlausibleWeb.Live.SitesTest do
conn: conn,
user: user
} do
- site = insert(:site, allowed_event_props: ["dummy"])
+ inviter = new_user()
+ site = new_site(owner: inviter, allowed_event_props: ["dummy"])
+ invitation = invite_transfer(site, user, inviter: inviter)
insert(:growth_subscription, user: user)
- invitation =
- insert(:invitation,
- site_id: site.id,
- inviter: build(:user),
- email: user.email,
- role: :owner
- )
-
{:ok, _lv, html} = live(conn, "/sites")
invitation_data = get_invitation_data(html)
@@ -91,7 +75,7 @@ defmodule PlausibleWeb.Live.SitesTest do
end
test "renders 24h visitors correctly", %{conn: conn, user: user} do
- site = insert(:site, members: [user])
+ site = new_site(owner: user)
populate_stats(site, [build(:pageview), build(:pageview), build(:pageview)])
@@ -103,9 +87,9 @@ defmodule PlausibleWeb.Live.SitesTest do
end
test "filters by domain", %{conn: conn, user: user} do
- _site1 = insert(:site, domain: "first.example.com", members: [user])
- _site2 = insert(:site, domain: "second.example.com", members: [user])
- _site3 = insert(:site, domain: "first-another.example.com", members: [user])
+ _site1 = new_site(domain: "first.example.com", owner: user)
+ _site2 = new_site(domain: "second.example.com", owner: user)
+ _site3 = new_site(domain: "first-another.example.com", owner: user)
{:ok, lv, _html} = live(conn, "/sites")
@@ -118,9 +102,9 @@ defmodule PlausibleWeb.Live.SitesTest do
end
test "filtering plays well with pagination", %{conn: conn, user: user} do
- _site1 = insert(:site, domain: "first.another.example.com", members: [user])
- _site2 = insert(:site, domain: "second.example.com", members: [user])
- _site3 = insert(:site, domain: "third.another.example.com", members: [user])
+ _site1 = new_site(domain: "first.another.example.com", owner: user)
+ _site2 = new_site(domain: "second.example.com", owner: user)
+ _site3 = new_site(domain: "third.another.example.com", owner: user)
{:ok, lv, html} = live(conn, "/sites?page_size=2")
@@ -143,7 +127,7 @@ defmodule PlausibleWeb.Live.SitesTest do
describe "pinning" do
test "renders pin site option when site not pinned", %{conn: conn, user: user} do
- site = insert(:site, members: [user])
+ site = new_site(owner: user)
{:ok, _lv, html} = live(conn, "/sites")
@@ -154,7 +138,7 @@ defmodule PlausibleWeb.Live.SitesTest do
end
test "site state changes when pin toggled", %{conn: conn, user: user} do
- site = insert(:site, members: [user])
+ site = new_site(owner: user)
{:ok, lv, _html} = live(conn, "/sites")
@@ -181,11 +165,11 @@ defmodule PlausibleWeb.Live.SitesTest do
test "shows error when pins limit hit", %{conn: conn, user: user} do
for _ <- 1..9 do
- site = insert(:site, members: [user])
+ site = new_site(owner: user)
assert {:ok, _} = Plausible.Sites.toggle_pin(user, site)
end
- site = insert(:site, members: [user])
+ site = new_site(owner: user)
{:ok, lv, _html} = live(conn, "/sites")
@@ -200,7 +184,7 @@ defmodule PlausibleWeb.Live.SitesTest do
end
test "does not allow pinning site user doesn't have access to", %{conn: conn, user: user} do
- site = insert(:site)
+ site = new_site()
{:ok, lv, _html} = live(conn, "/sites")
diff --git a/test/support/teams/test.ex b/test/support/teams/test.ex
index 983ea40dfd..93fd3b8994 100644
--- a/test/support/teams/test.ex
+++ b/test/support/teams/test.ex
@@ -3,9 +3,118 @@ defmodule Plausible.Teams.Test do
Convenience assertions for teams schema transition
"""
alias Plausible.Repo
+ alias Plausible.Teams
+
+ import Ecto.Query
use ExUnit.CaseTemplate
+ import Plausible.Factory
+
+ def new_site(args \\ []) do
+ args =
+ if user = args[:owner] do
+ {:ok, team} = Teams.get_or_create(user)
+
+ args
+ |> Keyword.put(:team, team)
+ |> Keyword.put(:members, [user])
+ else
+ user = new_user()
+ {:ok, team} = Teams.get_or_create(user)
+
+ args
+ |> Keyword.put(:team, team)
+ |> Keyword.put(:members, [user])
+ end
+
+ :site
+ |> insert(args)
+ |> Repo.preload(:memberships)
+ end
+
+ def new_team() do
+ new_user()
+ |> Map.fetch!(:team_memberships)
+ |> List.first()
+ end
+
+ def new_user(args \\ []) do
+ user = insert(:user, args)
+ {:ok, _team} = Teams.get_or_create(user)
+ Repo.preload(user, :team_memberships)
+ end
+
+ def add_guest(site, args \\ []) do
+ user = Keyword.get(args, :user, new_user())
+ role = Keyword.fetch!(args, :role)
+ team = Repo.preload(site, :team).team
+
+ insert(:site_membership, user: user, role: translate_role_to_old_model(role), site: site)
+
+ team_membership = insert(:team_membership, team: team, user: user, role: :guest)
+ insert(:guest_membership, team_membership: team_membership, site: site, role: role)
+
+ user |> Repo.preload([:site_memberships, :team_memberships])
+ end
+
+ def invite_guest(site, invitee_or_email, args \\ []) when not is_nil(invitee_or_email) do
+ role = Keyword.fetch!(args, :role)
+ inviter = Keyword.fetch!(args, :inviter)
+ team = Repo.preload(site, :team).team
+
+ email =
+ case invitee_or_email do
+ %{email: email} -> email
+ email when is_binary(email) -> email
+ end
+
+ old_model_invitation =
+ insert(:invitation,
+ email: email,
+ inviter: inviter,
+ role: translate_role_to_old_model(role),
+ site: site
+ )
+
+ team_invitation =
+ insert(:team_invitation, team: team, email: email, inviter: inviter, role: :guest)
+
+ insert(:guest_invitation, team_invitation: team_invitation, site: site, role: role)
+
+ old_model_invitation
+ end
+
+ def invite_transfer(site, invitee, args \\ []) do
+ inviter = Keyword.fetch!(args, :inviter)
+
+ old_model_invitation =
+ insert(:invitation, email: invitee.email, inviter: inviter, role: :owner, site: site)
+
+ insert(:site_transfer,
+ transfer_id: old_model_invitation.invitation_id,
+ email: invitee.email,
+ site: site,
+ initiator: inviter
+ )
+
+ old_model_invitation
+ end
+
+ def revoke_membership(site, user) do
+ Repo.delete_all(
+ from sm in Plausible.Site.Membership,
+ where: sm.user_id == ^user.id and sm.site_id == ^site.id
+ )
+
+ Repo.delete_all(
+ from tm in Plausible.Teams.Membership,
+ where: tm.user_id == ^user.id and tm.team_id == ^site.team.id
+ )
+
+ user |> Repo.preload([:site_memberships, :team_memberships])
+ end
+
defmacro __using__(_) do
quote do
import Plausible.Teams.Test
@@ -85,4 +194,7 @@ defmodule Plausible.Teams.Test do
role: role
)
end
+
+ defp translate_role_to_old_model(:editor), do: :admin
+ defp translate_role_to_old_model(role), do: role
end
diff --git a/test/test_helper.exs b/test/test_helper.exs
index 3906208d93..53956b8a9a 100644
--- a/test/test_helper.exs
+++ b/test/test_helper.exs
@@ -13,6 +13,8 @@ else
FunWithFlags.disable(:experimental_reduced_joins)
end
+FunWithFlags.enable(:read_team_schemas)
+
Ecto.Adapters.SQL.Sandbox.mode(Plausible.Repo, :manual)
# warn about minio if it's included in tests but not running