Merge branch 'develop' into refactor/discoverable_user_field
[akkoma] / test / pleroma / user_search_test.exs
1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
4
5 defmodule Pleroma.UserSearchTest do
6 alias Pleroma.Repo
7 alias Pleroma.User
8 use Pleroma.DataCase
9
10 import Pleroma.Factory
11
12 setup_all do
13 Tesla.Mock.mock_global(fn env -> apply(HttpRequestMock, :request, [env]) end)
14 :ok
15 end
16
17 describe "User.search" do
18 setup do: clear_config([:instance, :limit_to_local_content])
19
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"})
24
25 [first_user, _second_user] = User.search("https://lain.com/users/lain", resolve: true)
26
27 assert first_user.id == user.id
28 end
29
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"})
33
34 [first_user, _second_user] = User.search("https://lain.com/users/lain")
35
36 assert first_user.id == user.id
37 end
38
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")
43 end
44
45 test "returns a user with matching uri as the first result" do
46 user =
47 insert(:user, %{
48 nickname: "no_relation",
49 ap_id: "https://lain.com/users/lain",
50 uri: "https://lain.com/@lain"
51 })
52
53 _user = insert(:user, %{nickname: "com_user"})
54
55 [first_user, _second_user] = User.search("https://lain.com/@lain")
56
57 assert first_user.id == user.id
58 end
59
60 test "excludes invisible users from results" do
61 user = insert(:user, %{nickname: "john t1000"})
62 insert(:user, %{invisible: true, nickname: "john t800"})
63
64 [found_user] = User.search("john")
65 assert found_user.id == user.id
66 end
67
68 test "excludes users when discoverable is false" do
69 insert(:user, %{nickname: "john 3000", is_discoverable: false})
70 insert(:user, %{nickname: "john 3001"})
71
72 users = User.search("john")
73 assert Enum.count(users) == 1
74 end
75
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")
80
81 assert [found_user1, found_user2] = User.search("user")
82 assert [found_user1.id, found_user2.id] -- [service.id, person.id] == []
83 end
84
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
89 end
90
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
95 end
96
97 defp clear_virtual_fields(user) do
98 Map.merge(user, %{search_rank: nil, search_type: nil})
99 end
100
101 test "finds a user by full nickname or its leading fragment" do
102 user = insert(:user, %{nickname: "john"})
103
104 Enum.each(["john", "jo", "j"], fn query ->
105 assert user ==
106 User.search(query)
107 |> List.first()
108 |> clear_virtual_fields()
109 end)
110 end
111
112 test "finds a user by full name or leading fragment(s) of its words" do
113 user = insert(:user, %{name: "John Doe"})
114
115 Enum.each(["John Doe", "JOHN", "doe", "j d", "j", "d"], fn query ->
116 assert user ==
117 User.search(query)
118 |> List.first()
119 |> clear_virtual_fields()
120 end)
121 end
122
123 test "matches by leading fragment of user domain" do
124 user = insert(:user, %{nickname: "arandom@dude.com"})
125 insert(:user, %{nickname: "iamthedude"})
126
127 assert [user.id] == User.search("dud") |> Enum.map(& &1.id)
128 end
129
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"})
133
134 results = User.search("hj")
135
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
138 end
139
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"})
143
144 assert [u2.id, u1.id] == Enum.map(User.search("bar word"), & &1.id)
145 end
146
147 test "finds users, boosting ranks of friends and followers" do
148 u1 = insert(:user)
149 u2 = insert(:user, %{name: "Doe"})
150 follower = insert(:user, %{name: "Doe"})
151 friend = insert(:user, %{name: "Doe"})
152
153 {:ok, follower} = User.follow(follower, u1)
154 {:ok, u1} = User.follow(u1, friend)
155
156 assert [friend.id, follower.id, u2.id] --
157 Enum.map(User.search("doe", resolve: false, for_user: u1), & &1.id) == []
158 end
159
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"})
166
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)
170
171 assert Enum.map(User.search("jimi", following: true, for_user: lizz), & &1.id) == [
172 following_lizz.id
173 ]
174
175 assert User.search("lizz", following: true, for_user: lizz) == []
176 end
177
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})
182
183 results =
184 "lain"
185 |> User.search(for_user: u1)
186 |> Enum.map(& &1.id)
187 |> Enum.sort()
188
189 assert [u1.id, u2.id, u3.id] == results
190 end
191
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})
196
197 assert [%{id: ^id}] = User.search("lain")
198 end
199
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)
202
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})
206
207 assert [%{id: ^id}] = User.search("lain")
208 end
209
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)
212
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})
216
217 results =
218 "lain"
219 |> User.search()
220 |> Enum.map(& &1.id)
221 |> Enum.sort()
222
223 assert [u1.id, u2.id, u3.id] == results
224 end
225
226 test "does not yield false-positive matches" do
227 insert(:user, %{name: "John Doe"})
228
229 Enum.each(["mary", "a", ""], fn query ->
230 assert [] == User.search(query)
231 end)
232 end
233
234 test "works with URIs" do
235 user = insert(:user)
236
237 results =
238 User.search("http://mastodon.example.org/users/admin", resolve: true, for_user: user)
239
240 result = results |> List.first()
241
242 user = User.get_cached_by_ap_id("http://mastodon.example.org/users/admin")
243
244 assert length(results) == 1
245
246 expected =
247 result
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)
253
254 assert user == expected
255 end
256
257 test "excludes a blocked users from search result" do
258 user = insert(:user, %{nickname: "Bill"})
259
260 [blocked_user | users] = Enum.map(0..3, &insert(:user, %{nickname: "john#{&1}"}))
261
262 blocked_user2 =
263 insert(
264 :user,
265 %{nickname: "john awful", ap_id: "https://awful-and-rude-instance.com/user/bully"}
266 )
267
268 User.block_domain(user, "awful-and-rude-instance.com")
269 User.block(user, blocked_user)
270
271 account_ids = User.search("john", for_user: refresh_record(user)) |> collect_ids
272
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
277 end
278
279 test "local user has the same search_rank as for users with the same nickname, but another domain" do
280 user = insert(:user)
281 insert(:user, nickname: "lain@mastodon.social")
282 insert(:user, nickname: "lain")
283 insert(:user, nickname: "lain@pleroma.social")
284
285 assert User.search("lain@localhost", resolve: true, for_user: user)
286 |> Enum.each(fn u -> u.search_rank == 0.5 end)
287 end
288
289 test "localhost is the part of the domain" do
290 user = insert(:user)
291 insert(:user, nickname: "another@somedomain")
292 insert(:user, nickname: "lain")
293 insert(:user, nickname: "lain@examplelocalhost")
294
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
298 end
299
300 test "local user search with users" do
301 user = insert(:user)
302 local_user = insert(:user, nickname: "lain")
303 insert(:user, nickname: "another@localhost.com")
304 insert(:user, nickname: "localhost@localhost.com")
305
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
308 end
309
310 test "works with idna domains" do
311 user = insert(:user, nickname: "lain@" <> to_string(:idna.encode("zetsubou.みんな")))
312
313 results = User.search("lain@zetsubou.みんな", resolve: false, for_user: user)
314
315 result = List.first(results)
316
317 assert user == result |> Map.put(:search_rank, nil) |> Map.put(:search_type, nil)
318 end
319
320 test "works with idna domains converted input" do
321 user = insert(:user, nickname: "lain@" <> to_string(:idna.encode("zetsubou.みんな")))
322
323 results =
324 User.search("lain@zetsubou." <> to_string(:idna.encode("zetsubou.みんな")),
325 resolve: false,
326 for_user: user
327 )
328
329 result = List.first(results)
330
331 assert user == result |> Map.put(:search_rank, nil) |> Map.put(:search_type, nil)
332 end
333
334 test "works with idna domains and bad chars in domain" do
335 user = insert(:user, nickname: "lain@" <> to_string(:idna.encode("zetsubou.みんな")))
336
337 results =
338 User.search("lain@zetsubou!@#$%^&*()+,-/:;<=>?[]'_{}|~`.みんな",
339 resolve: false,
340 for_user: user
341 )
342
343 result = List.first(results)
344
345 assert user == result |> Map.put(:search_rank, nil) |> Map.put(:search_type, nil)
346 end
347
348 test "works with idna domains and query as link" do
349 user = insert(:user, nickname: "lain@" <> to_string(:idna.encode("zetsubou.みんな")))
350
351 results =
352 User.search("https://zetsubou.みんな/users/lain",
353 resolve: false,
354 for_user: user
355 )
356
357 result = List.first(results)
358
359 assert user == result |> Map.put(:search_rank, nil) |> Map.put(:search_type, nil)
360 end
361 end
362 end