1
0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-28 17:02:04 +03:00

Notifications: Review of PR to include path path #4629

- Merged book and chapter name items to a single page path list item
  which has links to parent page/chapter.
- Added permission filtering to page path elements.
- Added page path to also be on comment notifications.
- Updated testing to cover.
- Added new Message Line objects to support.

Done during review of #4629
This commit is contained in:
Dan Brown
2023-11-14 10:31:44 +00:00
parent 65ac197be4
commit d41fd7a8dd
10 changed files with 140 additions and 53 deletions

View File

@ -12,7 +12,6 @@ use BookStack\Activity\Tools\ActivityLogger;
use BookStack\Activity\Tools\UserEntityWatchOptions;
use BookStack\Activity\WatchLevels;
use BookStack\Entities\Models\Entity;
use BookStack\Entities\Tools\TrashCan;
use BookStack\Settings\UserNotificationPreferences;
use Illuminate\Support\Facades\Notification;
use Tests\TestCase;
@ -268,6 +267,7 @@ class WatchTest extends TestCase
return $mail->subject === 'New comment on page: ' . $entities['page']->getShortName()
&& str_contains($mailContent, 'View Comment')
&& str_contains($mailContent, 'Page Name: ' . $entities['page']->name)
&& str_contains($mailContent, 'Page Path: ' . $entities['book']->getShortName(24) . ' > ' . $entities['chapter']->getShortName(24))
&& str_contains($mailContent, 'Commenter: ' . $admin->name)
&& str_contains($mailContent, 'Comment: My new comment response');
});
@ -285,12 +285,13 @@ class WatchTest extends TestCase
$this->actingAs($admin);
$this->entities->updatePage($entities['page'], ['name' => 'Updated page', 'html' => 'new page content']);
$notifications->assertSentTo($editor, function (PageUpdateNotification $notification) use ($editor, $admin) {
$notifications->assertSentTo($editor, function (PageUpdateNotification $notification) use ($editor, $admin, $entities) {
$mail = $notification->toMail($editor);
$mailContent = html_entity_decode(strip_tags($mail->render()), ENT_QUOTES);
return $mail->subject === 'Updated page: Updated page'
&& str_contains($mailContent, 'View Page')
&& str_contains($mailContent, 'Page Name: Updated page')
&& str_contains($mailContent, 'Page Path: ' . $entities['book']->getShortName(24) . ' > ' . $entities['chapter']->getShortName(24))
&& str_contains($mailContent, 'Updated By: ' . $admin->name)
&& str_contains($mailContent, 'you won\'t be sent notifications for further edits to this page by the same editor');
});
@ -314,12 +315,13 @@ class WatchTest extends TestCase
$page = $entities['chapter']->pages()->where('draft', '=', true)->first();
$this->post($page->getUrl(), ['name' => 'My new page', 'html' => 'My new page content']);
$notifications->assertSentTo($editor, function (PageCreationNotification $notification) use ($editor, $admin) {
$notifications->assertSentTo($editor, function (PageCreationNotification $notification) use ($editor, $admin, $entities) {
$mail = $notification->toMail($editor);
$mailContent = html_entity_decode(strip_tags($mail->render()), ENT_QUOTES);
return $mail->subject === 'New page: My new page'
&& str_contains($mailContent, 'View Page')
&& str_contains($mailContent, 'Page Name: My new page')
&& str_contains($mailContent, 'Page Path: ' . $entities['book']->getShortName(24) . ' > ' . $entities['chapter']->getShortName(24))
&& str_contains($mailContent, 'Created By: ' . $admin->name);
});
}
@ -405,4 +407,32 @@ class WatchTest extends TestCase
$this->assertDatabaseMissing('watches', ['watchable_type' => 'page', 'watchable_id' => $page->id]);
}
public function test_page_path_in_notifications_limited_by_permissions()
{
$chapter = $this->entities->chapterHasPages();
$page = $chapter->pages()->first();
$book = $chapter->book;
$notification = new PageCreationNotification($page, $this->users->editor());
$viewer = $this->users->viewer();
$viewerRole = $viewer->roles()->first();
$content = html_entity_decode(strip_tags($notification->toMail($viewer)->render()), ENT_QUOTES);
$this->assertStringContainsString('Page Path: ' . $book->getShortName(24) . ' > ' . $chapter->getShortName(24), $content);
$this->permissions->setEntityPermissions($page, ['view'], [$viewerRole]);
$this->permissions->setEntityPermissions($chapter, [], [$viewerRole]);
$content = html_entity_decode(strip_tags($notification->toMail($viewer)->render()), ENT_QUOTES);
$this->assertStringContainsString('Page Path: ' . $book->getShortName(24), $content);
$this->assertStringNotContainsString(' > ' . $chapter->getShortName(24), $content);
$this->permissions->setEntityPermissions($book, [], [$viewerRole]);
$content = html_entity_decode(strip_tags($notification->toMail($viewer)->render()), ENT_QUOTES);
$this->assertStringNotContainsString('Page Path:', $content);
$this->assertStringNotContainsString($book->getShortName(24), $content);
$this->assertStringNotContainsString($chapter->getShortName(24), $content);
}
}