BookStack Code Mirror - bookstack/blob - tests/Entity/CommentTest.php

   1 <?php
   2
   3 namespace Tests\Entity;
   4
   5 use BookStack\Activity\ActivityType;
   6 use BookStack\Activity\Models\Comment;
   7 use BookStack\Entities\Models\Page;
   8 use Tests\TestCase;
   9
  10 class CommentTest extends TestCase
  11 {
  12     public function test_add_comment()
  13     {
  14         $this->asAdmin();
  15         $page = $this->entities->page();
  16
  17         $comment = Comment::factory()->make(['parent_id' => 2]);
  18         $resp = $this->postJson("/comment/$page->id", $comment->getAttributes());
  19
  20         $resp->assertStatus(200);
  21         $resp->assertSee($comment->html, false);
  22
  23         $pageResp = $this->get($page->getUrl());
  24         $pageResp->assertSee($comment->html, false);
  25
  26         $this->assertDatabaseHas('comments', [
  27             'local_id'    => 1,
  28             'entity_id'   => $page->id,
  29             'entity_type' => Page::newModelInstance()->getMorphClass(),
  30             'text'        => null,
  31             'parent_id'   => 2,
  32         ]);
  33
  34         $this->assertActivityExists(ActivityType::COMMENT_CREATE);
  35     }
  36
  37     public function test_comment_edit()
  38     {
  39         $this->asAdmin();
  40         $page = $this->entities->page();
  41
  42         $comment = Comment::factory()->make();
  43         $this->postJson("/comment/$page->id", $comment->getAttributes());
  44
  45         $comment = $page->comments()->first();
  46         $newHtml = '<p>updated text content</p>';
  47         $resp = $this->putJson("/comment/$comment->id", [
  48             'html' => $newHtml,
  49         ]);
  50
  51         $resp->assertStatus(200);
  52         $resp->assertSee($newHtml, false);
  53         $resp->assertDontSee($comment->html, false);
  54
  55         $this->assertDatabaseHas('comments', [
  56             'html'      => $newHtml,
  57             'entity_id' => $page->id,
  58         ]);
  59
  60         $this->assertActivityExists(ActivityType::COMMENT_UPDATE);
  61     }
  62
  63     public function test_comment_delete()
  64     {
  65         $this->asAdmin();
  66         $page = $this->entities->page();
  67
  68         $comment = Comment::factory()->make();
  69         $this->postJson("/comment/$page->id", $comment->getAttributes());
  70
  71         $comment = $page->comments()->first();
  72
  73         $resp = $this->delete("/comment/$comment->id");
  74         $resp->assertStatus(200);
  75
  76         $this->assertDatabaseMissing('comments', [
  77             'id' => $comment->id,
  78         ]);
  79
  80         $this->assertActivityExists(ActivityType::COMMENT_DELETE);
  81     }
  82
  83     public function test_scripts_cannot_be_injected_via_comment_html()
  84     {
  85         $page = $this->entities->page();
  86
  87         $script = '<script>const a = "script";</script><p onclick="1">My lovely comment</p>';
  88         $this->asAdmin()->postJson("/comment/$page->id", [
  89             'html' => $script,
  90         ]);
  91
  92         $pageView = $this->get($page->getUrl());
  93         $pageView->assertDontSee($script, false);
  94         $pageView->assertSee('<p>My lovely comment</p>', false);
  95
  96         $comment = $page->comments()->first();
  97         $this->putJson("/comment/$comment->id", [
  98             'html' => $script . '<p>updated</p>',
  99         ]);
 100
 101         $pageView = $this->get($page->getUrl());
 102         $pageView->assertDontSee($script, false);
 103         $pageView->assertSee('<p>My lovely comment</p><p>updated</p>');
 104     }
 105
 106     public function test_scripts_are_removed_even_if_already_in_db()
 107     {
 108         $page = $this->entities->page();
 109         Comment::factory()->create([
 110             'html' => '<script>superbadscript</script><p onclick="superbadonclick">scriptincommentest</p>',
 111             'entity_type' => 'page', 'entity_id' => $page
 112         ]);
 113
 114         $resp = $this->asAdmin()->get($page->getUrl());
 115         $resp->assertSee('scriptincommentest', false);
 116         $resp->assertDontSee('superbadscript', false);
 117         $resp->assertDontSee('superbadonclick', false);
 118     }
 119
 120     public function test_comment_html_is_limited()
 121     {
 122         $page = $this->entities->page();
 123         $input = '<h1>Test</h1><p id="abc" href="beans">Content<a href="#cat" data-a="b">a</a><section>Hello</section></p>';
 124         $expected = '<p>Content<a href="#cat">a</a></p>';
 125
 126         $resp = $this->asAdmin()->post("/comment/{$page->id}", ['html' => $input]);
 127         $resp->assertOk();
 128         $this->assertDatabaseHas('comments', [
 129            'entity_type' => 'page',
 130            'entity_id' => $page->id,
 131            'html' => $expected,
 132         ]);
 133
 134         $comment = $page->comments()->first();
 135         $resp = $this->put("/comment/{$comment->id}", ['html' => $input]);
 136         $resp->assertOk();
 137         $this->assertDatabaseHas('comments', [
 138             'id'   => $comment->id,
 139             'html' => $expected,
 140         ]);
 141     }
 142
 143     public function test_reply_comments_are_nested()
 144     {
 145         $this->asAdmin();
 146         $page = $this->entities->page();
 147
 148         $this->postJson("/comment/$page->id", ['html' => '<p>My new comment</p>']);
 149         $this->postJson("/comment/$page->id", ['html' => '<p>My new comment</p>']);
 150
 151         $respHtml = $this->withHtml($this->get($page->getUrl()));
 152         $respHtml->assertElementCount('.comment-branch', 3);
 153         $respHtml->assertElementNotExists('.comment-branch .comment-branch');
 154
 155         $comment = $page->comments()->first();
 156         $resp = $this->postJson("/comment/$page->id", [
 157             'html' => '<p>My nested comment</p>', 'parent_id' => $comment->local_id
 158         ]);
 159         $resp->assertStatus(200);
 160
 161         $respHtml = $this->withHtml($this->get($page->getUrl()));
 162         $respHtml->assertElementCount('.comment-branch', 4);
 163         $respHtml->assertElementContains('.comment-branch .comment-branch', 'My nested comment');
 164     }
 165
 166     public function test_comments_are_visible_in_the_page_editor()
 167     {
 168         $page = $this->entities->page();
 169
 170         $this->asAdmin()->postJson("/comment/$page->id", ['html' => '<p>My great comment to see in the editor</p>']);
 171
 172         $respHtml = $this->withHtml($this->get($page->getUrl('/edit')));
 173         $respHtml->assertElementContains('.comment-box .content', 'My great comment to see in the editor');
 174     }
 175
 176     public function test_comment_creator_name_truncated()
 177     {
 178         [$longNamedUser] = $this->users->newUserWithRole(['name' => 'Wolfeschlegelsteinhausenbergerdorff'], ['comment-create-all', 'page-view-all']);
 179         $page = $this->entities->page();
 180
 181         $comment = Comment::factory()->make();
 182         $this->actingAs($longNamedUser)->postJson("/comment/$page->id", $comment->getAttributes());
 183
 184         $pageResp = $this->asAdmin()->get($page->getUrl());
 185         $pageResp->assertSee('Wolfeschlegels…');
 186     }
 187
 188     public function test_comment_editor_js_loaded_with_create_or_edit_permissions()
 189     {
 190         $editor = $this->users->editor();
 191         $page = $this->entities->page();
 192
 193         $resp = $this->actingAs($editor)->get($page->getUrl());
 194         $resp->assertSee('tinymce.min.js?', false);
 195         $resp->assertSee('window.editor_translations', false);
 196         $resp->assertSee('component="entity-selector"', false);
 197
 198         $this->permissions->removeUserRolePermissions($editor, ['comment-create-all']);
 199         $this->permissions->grantUserRolePermissions($editor, ['comment-update-own']);
 200
 201         $resp = $this->actingAs($editor)->get($page->getUrl());
 202         $resp->assertDontSee('tinymce.min.js?', false);
 203         $resp->assertDontSee('window.editor_translations', false);
 204         $resp->assertDontSee('component="entity-selector"', false);
 205
 206         Comment::factory()->create([
 207             'created_by'  => $editor->id,
 208             'entity_type' => 'page',
 209             'entity_id'   => $page->id,
 210         ]);
 211
 212         $resp = $this->actingAs($editor)->get($page->getUrl());
 213         $resp->assertSee('tinymce.min.js?', false);
 214         $resp->assertSee('window.editor_translations', false);
 215         $resp->assertSee('component="entity-selector"', false);
 216     }
 217
 218     public function test_comment_displays_relative_times()
 219     {
 220         $page = $this->entities->page();
 221         $comment = Comment::factory()->create(['entity_id' => $page->id, 'entity_type' => $page->getMorphClass()]);
 222         $comment->created_at = now()->subWeek();
 223         $comment->updated_at = now()->subDay();
 224         $comment->save();
 225
 226         $pageResp = $this->asAdmin()->get($page->getUrl());
 227         $html = $this->withHtml($pageResp);
 228
 229         // Create date shows relative time as text to user
 230         $html->assertElementContains('.comment-box', 'commented 1 week ago');
 231         // Updated indicator has full time as title
 232         $html->assertElementContains('.comment-box span[title^="Updated ' . $comment->updated_at->format('Y-m-d') .  '"]', 'Updated');
 233     }
 234 }