]> BookStack Code Mirror - bookstack/blob - tests/User/UserPreferencesTest.php
fix typo
[bookstack] / tests / User / UserPreferencesTest.php
1 <?php
2
3 namespace Tests\User;
4
5 use BookStack\Activity\Tools\UserEntityWatchOptions;
6 use BookStack\Activity\WatchLevels;
7 use Tests\TestCase;
8
9 class UserPreferencesTest extends TestCase
10 {
11     public function test_index_view()
12     {
13         $resp = $this->asEditor()->get('/preferences');
14         $resp->assertOk();
15         $resp->assertSee('Interface Keyboard Shortcuts');
16         $resp->assertSee('Edit Profile');
17     }
18
19     public function test_index_view_accessible_but_without_profile_and_notifications_for_guest_user()
20     {
21         $this->setSettings(['app-public' => 'true']);
22         $this->permissions->grantUserRolePermissions($this->users->guest(), ['receive-notifications']);
23         $resp = $this->get('/preferences');
24         $resp->assertOk();
25         $resp->assertSee('Interface Keyboard Shortcuts');
26         $resp->assertDontSee('Edit Profile');
27         $resp->assertDontSee('Notification');
28     }
29     public function test_interface_shortcuts_updating()
30     {
31         $this->asEditor();
32
33         // View preferences with defaults
34         $resp = $this->get('/preferences/shortcuts');
35         $resp->assertSee('Interface Keyboard Shortcuts');
36
37         $html = $this->withHtml($resp);
38         $html->assertFieldHasValue('enabled', 'false');
39         $html->assertFieldHasValue('shortcut[home_view]', '1');
40
41         // Update preferences
42         $resp = $this->put('/preferences/shortcuts', [
43             'enabled' => 'true',
44             'shortcut' => ['home_view' => 'Ctrl + 1'],
45         ]);
46
47         $resp->assertRedirect('/preferences/shortcuts');
48         $resp->assertSessionHas('success', 'Shortcut preferences have been updated!');
49
50         // View updates to preferences page
51         $resp = $this->get('/preferences/shortcuts');
52         $html = $this->withHtml($resp);
53         $html->assertFieldHasValue('enabled', 'true');
54         $html->assertFieldHasValue('shortcut[home_view]', 'Ctrl + 1');
55     }
56
57     public function test_body_has_shortcuts_component_when_active()
58     {
59         $editor = $this->users->editor();
60         $this->actingAs($editor);
61
62         $this->withHtml($this->get('/'))->assertElementNotExists('body[component="shortcuts"]');
63
64         setting()->putUser($editor, 'ui-shortcuts-enabled', 'true');
65         $this->withHtml($this->get('/'))->assertElementExists('body[component="shortcuts"]');
66     }
67
68     public function test_notification_routes_requires_notification_permission()
69     {
70         $viewer = $this->users->viewer();
71         $resp = $this->actingAs($viewer)->get('/preferences/notifications');
72         $this->assertPermissionError($resp);
73
74         $resp = $this->put('/preferences/notifications');
75         $this->assertPermissionError($resp);
76
77         $this->permissions->grantUserRolePermissions($viewer, ['receive-notifications']);
78         $resp = $this->get('/preferences/notifications');
79         $resp->assertOk();
80         $resp->assertSee('Notification Preferences');
81     }
82
83     public function test_notification_preferences_updating()
84     {
85         $editor = $this->users->editor();
86
87         // View preferences with defaults
88         $resp = $this->actingAs($editor)->get('/preferences/notifications');
89         $resp->assertSee('Notification Preferences');
90
91         $html = $this->withHtml($resp);
92         $html->assertFieldHasValue('preferences[comment-replies]', 'false');
93
94         // Update preferences
95         $resp = $this->put('/preferences/notifications', [
96             'preferences' => ['comment-replies' => 'true'],
97         ]);
98
99         $resp->assertRedirect('/preferences/notifications');
100         $resp->assertSessionHas('success', 'Notification preferences have been updated!');
101
102         // View updates to preferences page
103         $resp = $this->get('/preferences/notifications');
104         $html = $this->withHtml($resp);
105         $html->assertFieldHasValue('preferences[comment-replies]', 'true');
106     }
107
108     public function test_notification_preferences_show_watches()
109     {
110         $editor = $this->users->editor();
111         $book = $this->entities->book();
112
113         $options = new UserEntityWatchOptions($editor, $book);
114         $options->updateLevelByValue(WatchLevels::COMMENTS);
115
116         $resp = $this->actingAs($editor)->get('/preferences/notifications');
117         $resp->assertSee($book->name);
118         $resp->assertSee('All Page Updates & Comments');
119
120         $options->updateLevelByValue(WatchLevels::DEFAULT);
121
122         $resp = $this->actingAs($editor)->get('/preferences/notifications');
123         $resp->assertDontSee($book->name);
124         $resp->assertDontSee('All Page Updates & Comments');
125     }
126
127     public function test_notification_preferences_not_accessible_to_guest()
128     {
129         $this->setSettings(['app-public' => 'true']);
130         $guest = $this->users->guest();
131         $this->permissions->grantUserRolePermissions($guest, ['receive-notifications']);
132
133         $resp = $this->get('/preferences/notifications');
134         $this->assertPermissionError($resp);
135
136         $resp = $this->put('/preferences/notifications', [
137             'preferences' => ['comment-replies' => 'true'],
138         ]);
139         $this->assertPermissionError($resp);
140     }
141
142     public function test_update_sort_preference()
143     {
144         $editor = $this->users->editor();
145         $this->actingAs($editor);
146
147         $updateRequest = $this->patch('/preferences/change-sort/books', [
148             'sort'  => 'created_at',
149             'order' => 'desc',
150         ]);
151         $updateRequest->assertStatus(302);
152
153         $this->assertDatabaseHas('settings', [
154             'setting_key' => 'user:' . $editor->id . ':books_sort',
155             'value'       => 'created_at',
156         ]);
157         $this->assertDatabaseHas('settings', [
158             'setting_key' => 'user:' . $editor->id . ':books_sort_order',
159             'value'       => 'desc',
160         ]);
161         $this->assertEquals('created_at', setting()->getForCurrentUser('books_sort'));
162         $this->assertEquals('desc', setting()->getForCurrentUser('books_sort_order'));
163     }
164
165     public function test_update_sort_bad_entity_type_handled()
166     {
167         $editor = $this->users->editor();
168         $this->actingAs($editor);
169
170         $updateRequest = $this->patch('/preferences/change-sort/dogs', [
171             'sort'  => 'name',
172             'order' => 'asc',
173         ]);
174         $updateRequest->assertStatus(500);
175
176         $this->assertNotEmpty('name', setting()->getForCurrentUser('bookshelves_sort'));
177         $this->assertNotEmpty('asc', setting()->getForCurrentUser('bookshelves_sort_order'));
178     }
179
180     public function test_update_expansion_preference()
181     {
182         $editor = $this->users->editor();
183         $this->actingAs($editor);
184
185         $updateRequest = $this->patch('/preferences/change-expansion/home-details', ['expand' => 'true']);
186         $updateRequest->assertStatus(204);
187
188         $this->assertDatabaseHas('settings', [
189             'setting_key' => 'user:' . $editor->id . ':section_expansion#home-details',
190             'value'       => 'true',
191         ]);
192         $this->assertEquals(true, setting()->getForCurrentUser('section_expansion#home-details'));
193
194         $invalidKeyRequest = $this->patch('/preferences/change-expansion/my-home-details', ['expand' => 'true']);
195         $invalidKeyRequest->assertStatus(500);
196     }
197
198     public function test_toggle_dark_mode()
199     {
200         $home = $this->actingAs($this->users->editor())->get('/');
201         $home->assertSee('Dark Mode');
202         $this->withHtml($home)->assertElementNotExists('.dark-mode');
203
204         $this->assertEquals(false, setting()->getForCurrentUser('dark-mode-enabled', false));
205         $prefChange = $this->patch('/preferences/toggle-dark-mode');
206         $prefChange->assertRedirect();
207         $this->assertEquals(true, setting()->getForCurrentUser('dark-mode-enabled'));
208
209         $home = $this->actingAs($this->users->editor())->get('/');
210         $this->withHtml($home)->assertElementExists('.dark-mode');
211         $home->assertDontSee('Dark Mode');
212         $home->assertSee('Light Mode');
213     }
214
215     public function test_dark_mode_defaults_to_config_option()
216     {
217         config()->set('setting-defaults.user.dark-mode-enabled', false);
218         $this->assertEquals(false, setting()->getForCurrentUser('dark-mode-enabled'));
219         $home = $this->get('/login');
220         $this->withHtml($home)->assertElementNotExists('.dark-mode');
221
222         config()->set('setting-defaults.user.dark-mode-enabled', true);
223         $this->assertEquals(true, setting()->getForCurrentUser('dark-mode-enabled'));
224         $home = $this->get('/login');
225         $this->withHtml($home)->assertElementExists('.dark-mode');
226     }
227
228     public function test_books_view_type_preferences_when_list()
229     {
230         $editor = $this->users->editor();
231         setting()->putUser($editor, 'books_view_type', 'list');
232
233         $resp = $this->actingAs($editor)->get('/books');
234         $this->withHtml($resp)
235             ->assertElementNotExists('.featured-image-container')
236             ->assertElementExists('.content-wrap .entity-list-item');
237     }
238
239     public function test_books_view_type_preferences_when_grid()
240     {
241         $editor = $this->users->editor();
242         setting()->putUser($editor, 'books_view_type', 'grid');
243
244         $resp = $this->actingAs($editor)->get('/books');
245         $this->withHtml($resp)->assertElementExists('.featured-image-container');
246     }
247
248     public function test_shelf_view_type_change()
249     {
250         $editor = $this->users->editor();
251         $shelf = $this->entities->shelf();
252         setting()->putUser($editor, 'bookshelf_view_type', 'list');
253
254         $resp = $this->actingAs($editor)->get($shelf->getUrl())->assertSee('Grid View');
255         $this->withHtml($resp)
256             ->assertElementNotExists('.featured-image-container')
257             ->assertElementExists('.content-wrap .entity-list-item');
258
259         $req = $this->patch("/preferences/change-view/bookshelf", ['view' => 'grid']);
260         $req->assertRedirect($shelf->getUrl());
261
262         $resp = $this->actingAs($editor)->get($shelf->getUrl())
263             ->assertSee('List View');
264
265         $this->withHtml($resp)
266             ->assertElementExists('.featured-image-container')
267             ->assertElementNotExists('.content-wrap .entity-list-item');
268     }
269
270     public function test_update_code_language_favourite()
271     {
272         $editor = $this->users->editor();
273         $page = $this->entities->page();
274         $this->actingAs($editor);
275
276         $this->patch('/preferences/update-code-language-favourite', ['language' => 'php', 'active' => true]);
277         $this->patch('/preferences/update-code-language-favourite', ['language' => 'javascript', 'active' => true]);
278
279         $resp = $this->get($page->getUrl('/edit'));
280         $resp->assertSee('option:code-editor:favourites="php,javascript"', false);
281
282         $this->patch('/preferences/update-code-language-favourite', ['language' => 'ruby', 'active' => true]);
283         $this->patch('/preferences/update-code-language-favourite', ['language' => 'php', 'active' => false]);
284
285         $resp = $this->get($page->getUrl('/edit'));
286         $resp->assertSee('option:code-editor:favourites="javascript,ruby"', false);
287     }
288 }