1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.UserSearchTest do
10 import Pleroma.Factory
13 Tesla.Mock.mock_global(fn env -> apply(HttpRequestMock, :request, [env]) end)
17 describe "User.search" do
18 setup do: clear_config([:instance, :limit_to_local_content])
20 test "returns a resolved user as the first result" do
21 Pleroma.Config.put([:instance, :limit_to_local_content], false)
22 user = insert(:user, %{nickname: "no_relation", ap_id: "https://lain.com/users/lain"})
23 _user = insert(:user, %{nickname: "com_user"})
25 [first_user, _second_user] = User.search("https://lain.com/users/lain", resolve: true)
27 assert first_user.id == user.id
30 test "returns a user with matching ap_id as the first result" do
31 user = insert(:user, %{nickname: "no_relation", ap_id: "https://lain.com/users/lain"})
32 _user = insert(:user, %{nickname: "com_user"})
34 [first_user, _second_user] = User.search("https://lain.com/users/lain")
36 assert first_user.id == user.id
39 test "doesn't die if two users have the same uri" do
40 insert(:user, %{uri: "https://gensokyo.2hu/@raymoo"})
41 insert(:user, %{uri: "https://gensokyo.2hu/@raymoo"})
42 assert [_first_user, _second_user] = User.search("https://gensokyo.2hu/@raymoo")
45 test "returns a user with matching uri as the first result" do
48 nickname: "no_relation",
49 ap_id: "https://lain.com/users/lain",
50 uri: "https://lain.com/@lain"
53 _user = insert(:user, %{nickname: "com_user"})
55 [first_user, _second_user] = User.search("https://lain.com/@lain")
57 assert first_user.id == user.id
60 test "excludes invisible users from results" do
61 user = insert(:user, %{nickname: "john t1000"})
62 insert(:user, %{invisible: true, nickname: "john t800"})
64 [found_user] = User.search("john")
65 assert found_user.id == user.id
68 test "excludes users when discoverable is false" do
69 insert(:user, %{nickname: "john 3000", discoverable: false})
70 insert(:user, %{nickname: "john 3001"})
72 users = User.search("john")
73 assert Enum.count(users) == 1
76 test "excludes service actors from results" do
77 insert(:user, actor_type: "Application", nickname: "user1")
78 service = insert(:user, actor_type: "Service", nickname: "user2")
79 person = insert(:user, actor_type: "Person", nickname: "user3")
81 assert [found_user1, found_user2] = User.search("user")
82 assert [found_user1.id, found_user2.id] -- [service.id, person.id] == []
85 test "accepts limit parameter" do
86 Enum.each(0..4, &insert(:user, %{nickname: "john#{&1}"}))
87 assert length(User.search("john", limit: 3)) == 3
88 assert length(User.search("john")) == 5
91 test "accepts offset parameter" do
92 Enum.each(0..4, &insert(:user, %{nickname: "john#{&1}"}))
93 assert length(User.search("john", limit: 3)) == 3
94 assert length(User.search("john", limit: 3, offset: 3)) == 2
97 defp clear_virtual_fields(user) do
98 Map.merge(user, %{search_rank: nil, search_type: nil})
101 test "finds a user by full nickname or its leading fragment" do
102 user = insert(:user, %{nickname: "john"})
104 Enum.each(["john", "jo", "j"], fn query ->
108 |> clear_virtual_fields()
112 test "finds a user by full name or leading fragment(s) of its words" do
113 user = insert(:user, %{name: "John Doe"})
115 Enum.each(["John Doe", "JOHN", "doe", "j d", "j", "d"], fn query ->
119 |> clear_virtual_fields()
123 test "matches by leading fragment of user domain" do
124 user = insert(:user, %{nickname: "arandom@dude.com"})
125 insert(:user, %{nickname: "iamthedude"})
127 assert [user.id] == User.search("dud") |> Enum.map(& &1.id)
130 test "ranks full nickname match higher than full name match" do
131 nicknamed_user = insert(:user, %{nickname: "hj@shigusegubu.club"})
132 named_user = insert(:user, %{nickname: "xyz@sample.com", name: "HJ"})
134 results = User.search("hj")
136 assert [nicknamed_user.id, named_user.id] == Enum.map(results, & &1.id)
137 assert Enum.at(results, 0).search_rank > Enum.at(results, 1).search_rank
140 test "finds users, considering density of matched tokens" do
141 u1 = insert(:user, %{name: "Bar Bar plus Word Word"})
142 u2 = insert(:user, %{name: "Word Word Bar Bar Bar"})
144 assert [u2.id, u1.id] == Enum.map(User.search("bar word"), & &1.id)
147 test "finds users, boosting ranks of friends and followers" do
149 u2 = insert(:user, %{name: "Doe"})
150 follower = insert(:user, %{name: "Doe"})
151 friend = insert(:user, %{name: "Doe"})
153 {:ok, follower} = User.follow(follower, u1)
154 {:ok, u1} = User.follow(u1, friend)
156 assert [friend.id, follower.id, u2.id] --
157 Enum.map(User.search("doe", resolve: false, for_user: u1), & &1.id) == []
160 test "finds followings of user by partial name" do
161 lizz = insert(:user, %{name: "Lizz"})
162 jimi = insert(:user, %{name: "Jimi"})
163 following_lizz = insert(:user, %{name: "Jimi Hendrix"})
164 following_jimi = insert(:user, %{name: "Lizz Wright"})
165 follower_lizz = insert(:user, %{name: "Jimi"})
167 {:ok, lizz} = User.follow(lizz, following_lizz)
168 {:ok, _jimi} = User.follow(jimi, following_jimi)
169 {:ok, _follower_lizz} = User.follow(follower_lizz, lizz)
171 assert Enum.map(User.search("jimi", following: true, for_user: lizz), & &1.id) == [
175 assert User.search("lizz", following: true, for_user: lizz) == []
178 test "find local and remote users for authenticated users" do
179 u1 = insert(:user, %{name: "lain"})
180 u2 = insert(:user, %{name: "ebn", nickname: "lain@mastodon.social", local: false})
181 u3 = insert(:user, %{nickname: "lain@pleroma.soykaf.com", local: false})
185 |> User.search(for_user: u1)
189 assert [u1.id, u2.id, u3.id] == results
192 test "find only local users for unauthenticated users" do
193 %{id: id} = insert(:user, %{name: "lain"})
194 insert(:user, %{name: "ebn", nickname: "lain@mastodon.social", local: false})
195 insert(:user, %{nickname: "lain@pleroma.soykaf.com", local: false})
197 assert [%{id: ^id}] = User.search("lain")
200 test "find only local users for authenticated users when `limit_to_local_content` is `:all`" do
201 Pleroma.Config.put([:instance, :limit_to_local_content], :all)
203 %{id: id} = insert(:user, %{name: "lain"})
204 insert(:user, %{name: "ebn", nickname: "lain@mastodon.social", local: false})
205 insert(:user, %{nickname: "lain@pleroma.soykaf.com", local: false})
207 assert [%{id: ^id}] = User.search("lain")
210 test "find all users for unauthenticated users when `limit_to_local_content` is `false`" do
211 Pleroma.Config.put([:instance, :limit_to_local_content], false)
213 u1 = insert(:user, %{name: "lain"})
214 u2 = insert(:user, %{name: "ebn", nickname: "lain@mastodon.social", local: false})
215 u3 = insert(:user, %{nickname: "lain@pleroma.soykaf.com", local: false})
223 assert [u1.id, u2.id, u3.id] == results
226 test "does not yield false-positive matches" do
227 insert(:user, %{name: "John Doe"})
229 Enum.each(["mary", "a", ""], fn query ->
230 assert [] == User.search(query)
234 test "works with URIs" do
238 User.search("http://mastodon.example.org/users/admin", resolve: true, for_user: user)
240 result = results |> List.first()
242 user = User.get_cached_by_ap_id("http://mastodon.example.org/users/admin")
244 assert length(results) == 1
248 |> Map.put(:search_rank, nil)
249 |> Map.put(:search_type, nil)
250 |> Map.put(:last_digest_emailed_at, nil)
251 |> Map.put(:multi_factor_authentication_settings, nil)
252 |> Map.put(:notification_settings, nil)
254 assert user == expected
257 test "excludes a blocked users from search result" do
258 user = insert(:user, %{nickname: "Bill"})
260 [blocked_user | users] = Enum.map(0..3, &insert(:user, %{nickname: "john#{&1}"}))
265 %{nickname: "john awful", ap_id: "https://awful-and-rude-instance.com/user/bully"}
268 User.block_domain(user, "awful-and-rude-instance.com")
269 User.block(user, blocked_user)
271 account_ids = User.search("john", for_user: refresh_record(user)) |> collect_ids
273 assert account_ids == collect_ids(users)
274 refute Enum.member?(account_ids, blocked_user.id)
275 refute Enum.member?(account_ids, blocked_user2.id)
276 assert length(account_ids) == 3
279 test "local user has the same search_rank as for users with the same nickname, but another domain" do
281 insert(:user, nickname: "lain@mastodon.social")
282 insert(:user, nickname: "lain")
283 insert(:user, nickname: "lain@pleroma.social")
285 assert User.search("lain@localhost", resolve: true, for_user: user)
286 |> Enum.each(fn u -> u.search_rank == 0.5 end)
289 test "localhost is the part of the domain" do
291 insert(:user, nickname: "another@somedomain")
292 insert(:user, nickname: "lain")
293 insert(:user, nickname: "lain@examplelocalhost")
295 result = User.search("lain@examplelocalhost", resolve: true, for_user: user)
296 assert Enum.each(result, fn u -> u.search_rank == 0.5 end)
297 assert length(result) == 2
300 test "local user search with users" do
302 local_user = insert(:user, nickname: "lain")
303 insert(:user, nickname: "another@localhost.com")
304 insert(:user, nickname: "localhost@localhost.com")
306 [result] = User.search("lain@localhost", resolve: true, for_user: user)
307 assert Map.put(result, :search_rank, nil) |> Map.put(:search_type, nil) == local_user
310 test "works with idna domains" do
311 user = insert(:user, nickname: "lain@" <> to_string(:idna.encode("zetsubou.みんな")))
313 results = User.search("lain@zetsubou.みんな", resolve: false, for_user: user)
315 result = List.first(results)
317 assert user == result |> Map.put(:search_rank, nil) |> Map.put(:search_type, nil)
320 test "works with idna domains converted input" do
321 user = insert(:user, nickname: "lain@" <> to_string(:idna.encode("zetsubou.みんな")))
324 User.search("lain@zetsubou." <> to_string(:idna.encode("zetsubou.みんな")),
329 result = List.first(results)
331 assert user == result |> Map.put(:search_rank, nil) |> Map.put(:search_type, nil)
334 test "works with idna domains and bad chars in domain" do
335 user = insert(:user, nickname: "lain@" <> to_string(:idna.encode("zetsubou.みんな")))
338 User.search("lain@zetsubou!@#$%^&*()+,-/:;<=>?[]'_{}|~`.みんな",
343 result = List.first(results)
345 assert user == result |> Map.put(:search_rank, nil) |> Map.put(:search_type, nil)
348 test "works with idna domains and query as link" do
349 user = insert(:user, nickname: "lain@" <> to_string(:idna.encode("zetsubou.みんな")))
352 User.search("https://zetsubou.みんな/users/lain",
357 result = List.first(results)
359 assert user == result |> Map.put(:search_rank, nil) |> Map.put(:search_type, nil)