Fixed occurances of altered titles in search results

[bookstack] / tests / Entity / EntitySearchTest.php

diff --git a/tests/Entity/EntitySearchTest.php b/tests/Entity/EntitySearchTest.php
index 3f60f9c36126b559b027a0d84f39cda03a5080b6..6929adc74bb60feb92293104094afa2f1f4dfa73 100644 (file)
--- a/tests/Entity/EntitySearchTest.php
+++ b/tests/Entity/EntitySearchTest.php
@@ -1,142 +1,414 @@
 <?php
 
 <?php
 

-use Illuminate\Support\Facades\DB;
+namespace Tests\Entity;
+
+use BookStack\Actions\Tag;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\Bookshelf;
+use BookStack\Entities\Models\Chapter;
+use BookStack\Entities\Models\Page;
+use Tests\TestCase;

 
 class EntitySearchTest extends TestCase
 {
 
 class EntitySearchTest extends TestCase
 {

-

     public function test_page_search()
     {
     public function test_page_search()
     {

-        $book = \BookStack\Book::all()->first();
+        $book = Book::all()->first();

         $page = $book->pages->first();
 
         $page = $book->pages->first();
 

-        $this->asAdmin()
-            ->visit('/')
-            ->type($page->name, 'term')
-            ->press('header-search-box-button')
-            ->see('Search Results')
-            ->seeInElement('.entity-list', $page->name)
-            ->clickInElement('.entity-list', $page->name)
-            ->seePageIs($page->getUrl());
+        $search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
+        $search->assertSee('Search Results');
+        $search->assertSeeText($page->name, true);
+    }
+
+    public function test_bookshelf_search()
+    {
+        /** @var Bookshelf $shelf */
+        $shelf = Bookshelf::query()->first();
+
+        $search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . '  {type:bookshelf}');
+        $search->assertSee('Search Results');
+        $search->assertSeeText($shelf->name, true);

     }
 
     public function test_invalid_page_search()
     {
     }
 
     public function test_invalid_page_search()
     {

-        $this->asAdmin()
-            ->visit('/')
-            ->type('<p>test</p>', 'term')
-            ->press('header-search-box-button')
-            ->see('Search Results')
-            ->seeStatusCode(200);
+        $resp = $this->asEditor()->get('/search?term=' . urlencode('<p>test</p>'));
+        $resp->assertSee('Search Results');
+        $resp->assertStatus(200);
+        $this->get('/search?term=cat+-')->assertStatus(200);

     }
 
     }
 

-    public function test_empty_search_redirects_back()
+    public function test_empty_search_shows_search_page()

     {
     {

-        $this->asAdmin()
-            ->visit('/')
-            ->visit('/search/all')
-            ->seePageIs('/');
+        $res = $this->asEditor()->get('/search');
+        $res->assertStatus(200);
+    }
+
+    public function test_searching_accents_and_small_terms()
+    {
+        $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
+        $this->asEditor();
+
+        $accentSearch = $this->get('/search?term=' . urlencode('áéíí'));
+        $accentSearch->assertStatus(200)->assertSee($page->name);
+
+        $smallSearch = $this->get('/search?term=' . urlencode('a2'));
+        $smallSearch->assertStatus(200)->assertSee($page->name);

     }
 
     public function test_book_search()
     {
     }
 
     public function test_book_search()
     {

-        $book = \BookStack\Book::all()->first();
+        $book = Book::first();

         $page = $book->pages->last();
         $chapter = $book->chapters->last();
 
         $page = $book->pages->last();
         $chapter = $book->chapters->last();
 

-        $this->asAdmin()
-            ->visit('/search/book/' . $book->id . '?term=' . urlencode($page->name))
-            ->see($page->name)
+        $pageTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($page->name));
+        $pageTestResp->assertSee($page->name);

 
 

-            ->visit('/search/book/' . $book->id  . '?term=' . urlencode($chapter->name))
-            ->see($chapter->name);
+        $chapterTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($chapter->name));
+        $chapterTestResp->assertSee($chapter->name);

     }
 
     }
 

-    public function test_empty_book_search_redirects_back()
+    public function test_chapter_search()

     {
     {

-        $book = \BookStack\Book::all()->first();
-        $this->asAdmin()
-            ->visit('/books')
-            ->visit('/search/book/' . $book->id . '?term=')
-            ->seePageIs('/books');
+        $chapter = Chapter::has('pages')->first();
+        $page = $chapter->pages[0];
+
+        $pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
+        $pageTestResp->assertSee($page->name);

     }
 
     }
 

+    public function test_tag_search()
+    {
+        $newTags = [
+            new Tag([
+                'name'  => 'animal',
+                'value' => 'cat',
+            ]),
+            new Tag([
+                'name'  => 'color',
+                'value' => 'red',
+            ]),
+        ];
+
+        $pageA = Page::first();
+        $pageA->tags()->saveMany($newTags);
+
+        $pageB = Page::all()->last();
+        $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
+
+        $this->asEditor();
+        $tNameSearch = $this->get('/search?term=%5Banimal%5D');
+        $tNameSearch->assertSee($pageA->name)->assertSee($pageB->name);
+
+        $tNameSearch2 = $this->get('/search?term=%5Bcolor%5D');
+        $tNameSearch2->assertSee($pageA->name)->assertDontSee($pageB->name);

 
 

-    public function test_pages_search_listing()
+        $tNameValSearch = $this->get('/search?term=%5Banimal%3Dcat%5D');
+        $tNameValSearch->assertSee($pageA->name)->assertDontSee($pageB->name);
+    }
+
+    public function test_exact_searches()

     {
     {

-        $page = \BookStack\Page::all()->last();
-        $this->asAdmin()->visit('/search/pages?term=' . $page->name)
-            ->see('Page Search Results')->see('.entity-list', $page->name);
+        $page = $this->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
+
+        $exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"'));
+        $exactSearchA->assertStatus(200)->assertSee($page->name);
+
+        $exactSearchB = $this->asEditor()->get('/search?term=' . urlencode('"story not about an orange"'));
+        $exactSearchB->assertStatus(200)->assertDontSee($page->name);

     }
 
     }
 

-    public function test_chapters_search_listing()
+    public function test_search_terms_with_delimiters_are_converted_to_exact_matches()

     {
     {

-        $chapter = \BookStack\Chapter::all()->last();
-        $this->asAdmin()->visit('/search/chapters?term=' . $chapter->name)
-            ->see('Chapter Search Results')->seeInElement('.entity-list', $chapter->name);
+        $this->asEditor();
+        $page = $this->newPage(['name' => 'Delimiter test', 'html' => '<p>1.1 2,2 3?3 4:4 5;5 (8) &lt;9&gt; "10" \'11\' `12`</p>']);
+        $terms = explode(' ', '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`');
+
+        foreach ($terms as $term) {
+            $search = $this->get('/search?term=' . urlencode($term));
+            $search->assertSee($page->name);
+        }

     }
 
     }
 

-    public function test_search_quote_term_preparation()
+    public function test_search_filters()

     {
     {

-        $termString = '"192" cat "dog hat"';
-        $repo = $this->app[\BookStack\Repos\EntityRepo::class];
-        $preparedTerms = $repo->prepareSearchTerms($termString);
-        $this->assertTrue($preparedTerms === ['"192"','"dog hat"', 'cat']);
+        $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']);
+        $this->asEditor();
+        $editorId = $this->getEditor()->id;
+        $editorSlug = $this->getEditor()->slug;
+
+        // Viewed filter searches
+        $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertDontSee($page->name);
+        $this->get($page->getUrl());
+        $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertDontSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertSee($page->name);
+
+        // User filters
+        $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertDontSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editorSlug . '}'))->assertDontSee($page->name);
+        $page->created_by = $editorId;
+        $page->save();
+        $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {created_by: ' . $editorSlug . '}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
+        $page->updated_by = $editorId;
+        $page->save();
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editorSlug . '}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
+        $page->owned_by = $editorId;
+        $page->save();
+        $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:' . $editorSlug . '}'))->assertSee($page->name);
+
+        // Content filters
+        $this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name);
+        $this->get('/search?term=' . urlencode('{in_body:danzorbhsing}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('{in_name:test quaffleachits}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('{in_body:test quaffleachits}'))->assertDontSee($page->name);
+
+        // Restricted filter
+        $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);
+        $page->restricted = true;
+        $page->save();
+        $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);
+
+        // Date filters
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertDontSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertSee($page->name);
+        $page->updated_at = '2037-02-01';
+        $page->save();
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertDontSee($page->name);
+
+        $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertDontSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertSee($page->name);
+        $page->created_at = '2037-02-01';
+        $page->save();
+        $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertSee($page->name);
+        $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);

     }
 
     }
 

-    public function test_books_search_listing()
+    public function test_ajax_entity_search()

     {
     {

-        $book = \BookStack\Book::all()->last();
-        $this->asAdmin()->visit('/search/books?term=' . $book->name)
-            ->see('Book Search Results')->see('.entity-list', $book->name);
+        $page = $this->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
+        $notVisitedPage = Page::first();
+
+        // Visit the page to make popular
+        $this->asEditor()->get($page->getUrl());
+
+        $normalSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
+        $normalSearch->assertSee($page->name);
+
+        $bookSearch = $this->get('/ajax/search/entities?types=book&term=' . urlencode($page->name));
+        $bookSearch->assertDontSee($page->name);
+
+        $defaultListTest = $this->get('/ajax/search/entities');
+        $defaultListTest->assertSee($page->name);
+        $defaultListTest->assertDontSee($notVisitedPage->name);

     }
 
     }
 

-    public function test_searching_hypen_doesnt_break()
+    public function test_ajax_entity_serach_shows_breadcrumbs()

     {
     {

-        $this->visit('/search/all?term=cat+-')
-            ->seeStatusCode(200);
+        $chapter = Chapter::first();
+        $page = $chapter->pages->first();
+        $this->asEditor();
+
+        $pageSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
+        $pageSearch->assertSee($page->name);
+        $pageSearch->assertSee($chapter->getShortName(42));
+        $pageSearch->assertSee($page->book->getShortName(42));
+
+        $chapterSearch = $this->get('/ajax/search/entities?term=' . urlencode($chapter->name));
+        $chapterSearch->assertSee($chapter->name);
+        $chapterSearch->assertSee($chapter->book->getShortName(42));

     }
 
     }
 

-    public function test_tag_search()
+    public function test_sibling_search_for_pages()

     {
     {

-        $newTags = [
-            new \BookStack\Tag([
-                'name' => 'animal',
-                'value' => 'cat'
-            ]),
-            new \BookStack\Tag([
-                'name' => 'color',
-                'value' => 'red'
-            ])
-        ];
+        $chapter = Chapter::query()->with('pages')->first();
+        $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
+        $page = $chapter->pages->first();

 
 

-        $pageA = \BookStack\Page::first();
-        $pageA->tags()->saveMany($newTags);
+        $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
+        $search->assertSuccessful();
+        foreach ($chapter->pages as $page) {
+            $search->assertSee($page->name);
+        }

 
 

-        $pageB = \BookStack\Page::all()->last();
-        $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
+        $search->assertDontSee($chapter->name);
+    }
+
+    public function test_sibling_search_for_pages_without_chapter()
+    {
+        $page = Page::query()->where('chapter_id', '=', 0)->firstOrFail();
+        $bookChildren = $page->book->getDirectChildren();
+        $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
+
+        $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
+        $search->assertSuccessful();
+        foreach ($bookChildren as $child) {
+            $search->assertSee($child->name);
+        }
+
+        $search->assertDontSee($page->book->name);
+    }
+
+    public function test_sibling_search_for_chapters()
+    {
+        $chapter = Chapter::query()->firstOrFail();
+        $bookChildren = $chapter->book->getDirectChildren();
+        $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');

 
 

-        $this->asAdmin()->visit('/search/all?term=%5Banimal%5D')
-            ->seeLink($pageA->name)
-            ->seeLink($pageB->name);
+        $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
+        $search->assertSuccessful();
+        foreach ($bookChildren as $child) {
+            $search->assertSee($child->name);
+        }

 
 

-        $this->visit('/search/all?term=%5Bcolor%5D')
-            ->seeLink($pageA->name)
-            ->dontSeeLink($pageB->name);
+        $search->assertDontSee($chapter->book->name);
+    }

 
 

-        $this->visit('/search/all?term=%5Banimal%3Dcat%5D')
-            ->seeLink($pageA->name)
-            ->dontSeeLink($pageB->name);
+    public function test_sibling_search_for_books()
+    {
+        $books = Book::query()->take(10)->get();
+        $book = $books->first();
+        $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');

 
 

+        $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
+        $search->assertSuccessful();
+        foreach ($books as $expectedBook) {
+            $search->assertSee($expectedBook->name);
+        }

     }
 
     }
 

-    public function test_ajax_entity_search()
+    public function test_sibling_search_for_shelves()
+    {
+        $shelves = Bookshelf::query()->take(10)->get();
+        $shelf = $shelves->first();
+        $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
+
+        $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
+        $search->assertSuccessful();
+        foreach ($shelves as $expectedShelf) {
+            $search->assertSee($expectedShelf->name);
+        }
+    }
+
+    public function test_search_works_on_updated_page_content()
+    {
+        $page = Page::query()->first();
+        $this->asEditor();
+
+        $update = $this->put($page->getUrl(), [
+            'name' => $page->name,
+            'html' => '<p>dog pandabearmonster spaghetti</p>',
+        ]);
+
+        $search = $this->asEditor()->get('/search?term=pandabearmonster');
+        $search->assertStatus(200);
+        $search->assertSeeText($page->name);
+        $search->assertSee($page->getUrl());
+    }
+
+    public function test_search_ranks_common_words_lower()
+    {
+        $this->newPage(['name' => 'Test page A', 'html' => '<p>dog biscuit dog dog</p>']);
+        $this->newPage(['name' => 'Test page B', 'html' => '<p>cat biscuit</p>']);
+
+        $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
+        $search->assertElementContains('.entity-list > .page', 'Test page A', 1);
+        $search->assertElementContains('.entity-list > .page', 'Test page B', 2);
+
+        for ($i = 0; $i < 2; $i++) {
+            $this->newPage(['name' => 'Test page ' . $i, 'html' => '<p>dog</p>']);
+        }
+
+        $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
+        $search->assertElementContains('.entity-list > .page', 'Test page B', 1);
+        $search->assertElementContains('.entity-list > .page', 'Test page A', 2);
+    }
+
+    public function test_terms_in_headers_have_an_adjusted_index_score()
+    {
+        $page = $this->newPage(['name' => 'Test page A', 'html' => '
+            <p>TermA</p>
+            <h1>TermB <strong>TermNested</strong></h1>
+            <h2>TermC</h2>
+            <h3>TermD</h3>
+            <h4>TermE</h4>
+            <h5>TermF</h5>
+            <h6>TermG</h6>
+        ']);
+
+        $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
+
+        $this->assertEquals(1, $scoreByTerm->get('TermA'));
+        $this->assertEquals(10, $scoreByTerm->get('TermB'));
+        $this->assertEquals(10, $scoreByTerm->get('TermNested'));
+        $this->assertEquals(5, $scoreByTerm->get('TermC'));
+        $this->assertEquals(4, $scoreByTerm->get('TermD'));
+        $this->assertEquals(3, $scoreByTerm->get('TermE'));
+        $this->assertEquals(2, $scoreByTerm->get('TermF'));
+        // Is 1.5 but stored as integer, rounding up
+        $this->assertEquals(2, $scoreByTerm->get('TermG'));
+    }
+
+    public function test_name_and_content_terms_are_merged_to_single_score()

     {
     {

-        $page = \BookStack\Page::all()->last();
-        $notVisitedPage = \BookStack\Page::first();
-        $this->visit($page->getUrl());
-        $this->asAdmin()->visit('/ajax/search/entities?term=' . $page->name)->see('.entity-list', $page->name);
-        $this->asAdmin()->visit('/ajax/search/entities?types=book&term=' . $page->name)->dontSee('.entity-list', $page->name);
-        $this->asAdmin()->visit('/ajax/search/entities')->see('.entity-list', $page->name)->dontSee($notVisitedPage->name);
+        $page = $this->newPage(['name' => 'TermA', 'html' => '
+            <p>TermA</p>
+        ']);
+
+        $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
+
+        // Scores 40 for being in the name then 1 for being in the content
+        $this->assertEquals(41, $scoreByTerm->get('TermA'));
+    }
+
+    public function test_tag_names_and_values_are_indexed_for_search()
+    {
+        $page = $this->newPage(['name' => 'PageA', 'html' => '<p>content</p>', 'tags' => [
+            ['name' => 'Animal', 'value' => 'MeowieCat'],
+            ['name' => 'SuperImportant'],
+        ]]);
+
+        $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
+        $this->assertEquals(5, $scoreByTerm->get('MeowieCat'));
+        $this->assertEquals(3, $scoreByTerm->get('Animal'));
+        $this->assertEquals(3, $scoreByTerm->get('SuperImportant'));
+    }
+
+    public function test_matching_terms_in_search_results_are_highlighted()
+    {
+        $this->newPage(['name' => 'My Meowie Cat', 'html' => '<p>A superimportant page about meowieable animals</p>', 'tags' => [
+            ['name' => 'Animal', 'value' => 'MeowieCat'],
+            ['name' => 'SuperImportant'],
+        ]]);
+
+        $search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');
+        // Title
+        $search->assertSee('My <strong>Meowie</strong> Cat', false);
+        // Content
+        $search->assertSee('A <strong>superimportant</strong> page about <strong>meowie</strong>able animals', false);
+        // Tag name
+        $search->assertElementContains('.tag-name.highlight', 'SuperImportant');
+        // Tag value
+        $search->assertElementContains('.tag-value.highlight', 'MeowieCat');
+    }
+
+    public function test_html_entities_in_item_details_remains_escaped_in_search_results()
+    {
+        $this->newPage(['name' => 'My <cool> TestPageContent', 'html' => '<p>My supercool &lt;great&gt; TestPageContent page</p>']);
+
+        $search = $this->asEditor()->get('/search?term=TestPageContent');
+        $search->assertSee('My &lt;cool&gt; <strong>TestPageContent</strong>', false);
+        $search->assertSee('My supercool &lt;great&gt; <strong>TestPageContent</strong> page', false);

     }
 }
     }
 }