Skip to content

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

Implement basic service for searching through site guests (#4949)

hq1ca1fbe3a8054
diff --git a/lib/plausible/teams/invitations/candidates.ex b/lib/plausible/teams/invitations/candidates.ex
new file mode 100644
index 0000000000..57047013cd
--- /dev/null
+++ b/lib/plausible/teams/invitations/candidates.ex
@@ -0,0 +1,33 @@
+defmodule Plausible.Teams.Invitations.Candidates do
+ @moduledoc """
+ Search through team's site guests looking for full membership candidates.
+ """
+ import Ecto.Query
+
+ alias Plausible.Repo
+ alias Plausible.Teams.GuestMembership
+ alias Plausible.Teams
+
+ @spec search_site_guests(Teams.Team.t(), String.t(), Keyword.t()) :: [Plausible.Auth.User.t()]
+ def search_site_guests(%Teams.Team{} = team, name_or_email, opts \\ [])
+ when is_binary(name_or_email) do
+ limit = Keyword.get(opts, :limit, 50)
+ exclude = Keyword.get(opts, :exclude, [])
+
+ all_site_ids = Teams.owned_sites_ids(team)
+ term = "%#{name_or_email}%"
+
+ Repo.all(
+ from gm in GuestMembership,
+ inner_join: tm in assoc(gm, :team_membership),
+ inner_join: u in assoc(tm, :user),
+ where: gm.site_id in ^all_site_ids,
+ where: ilike(u.email, ^term) or ilike(u.name, ^term),
+ where: u.id not in ^for(u <- exclude, do: u.id),
+ order_by: [asc: u.id],
+ select: u,
+ distinct: true,
+ limit: ^limit
+ )
+ end
+end
diff --git a/test/plausible/teams/invitations/candidates_test.exs b/test/plausible/teams/invitations/candidates_test.exs
new file mode 100644
index 0000000000..9578532422
--- /dev/null
+++ b/test/plausible/teams/invitations/candidates_test.exs
@@ -0,0 +1,78 @@
+defmodule Plausible.Teams.Invitations.CandidatesTest do
+ use Plausible.DataCase, async: true
+ use Plausible.Teams.Test
+
+ alias Plausible.Teams.Invitations.Candidates
+
+ test "performs basic searches" do
+ owner = new_user()
+ site = new_site(owner: owner)
+
+ add_guest(site, role: :viewer, user: new_user(email: "[email protected]", name: "Jane Doe"))
+ add_guest(site, role: :viewer, user: new_user(email: "[email protected]", name: "Joe Doe"))
+ add_guest(site, role: :viewer, user: new_user(email: "[email protected]", name: "Wu Tang"))
+
+ assert [
+ %{email: "[email protected]"},
+ %{email: "[email protected]"}
+ ] = Candidates.search_site_guests(team_of(owner), "doe")
+
+ assert [
+ %{email: "[email protected]"},
+ %{email: "[email protected]"}
+ ] = Candidates.search_site_guests(team_of(owner), "FOO")
+
+ assert [
+ %{email: "[email protected]"},
+ %{email: "[email protected]"},
+ %{email: "[email protected]"}
+ ] = Candidates.search_site_guests(team_of(owner), "")
+
+ assert [] = Candidates.search_site_guests(team_of(owner), "WONTMATCH")
+ end
+
+ test "searches across multiple sites" do
+ owner = new_user()
+
+ site1 = new_site(owner: owner)
+ site2 = new_site(owner: owner)
+
+ multi_site_guest = new_user(email: "[email protected]", name: "Jane Doe")
+
+ add_guest(site1, role: :viewer, user: multi_site_guest)
+ add_guest(site2, role: :viewer, user: new_user(email: "[email protected]", name: "Joe Doe"))
+ add_guest(site2, role: :viewer, user: multi_site_guest)
+
+ assert [
+ %{email: "[email protected]"},
+ %{email: "[email protected]"}
+ ] = Candidates.search_site_guests(team_of(owner), "doe")
+ end
+
+ test "capable of limiting results" do
+ owner = new_user()
+ site = new_site(owner: owner)
+
+ add_guest(site, role: :viewer)
+ add_guest(site, role: :viewer)
+ add_guest(site, role: :viewer)
+
+ assert [_, _, _] = Candidates.search_site_guests(team_of(owner), "")
+ assert [_, _] = Candidates.search_site_guests(team_of(owner), "", limit: 2)
+ end
+
+ test "capable of exlucding users" do
+ owner = new_user()
+ site = new_site(owner: owner)
+
+ to_be_excluded = new_user(email: "[email protected]", name: "Jane Doe")
+
+ add_guest(site, role: :viewer, user: to_be_excluded)
+ add_guest(site, role: :viewer, user: new_user(email: "[email protected]", name: "Joe Doe"))
+ add_guest(site, role: :viewer, user: new_user(email: "[email protected]", name: "Wu Tang"))
+
+ assert [
+ %{email: "[email protected]"}
+ ] = Candidates.search_site_guests(team_of(owner), "doe", exclude: [to_be_excluded])
+ end
+end