Comments API: Addressed failing tests and static testing

Author: ssddanbrown

app/Activity/CommentRepo.php

@@ -31,6 +31,7 @@ public function getVisibleById(int $id): Comment
 
     /**
      * Start a query for comments visible to the user.
+     * @return Builder<Comment>
      */
     public function getQueryForVisible(): Builder
     {

app/Entities/Models/Entity.php

@@ -237,6 +237,7 @@ public function tags(): MorphMany
 
     /**
      * Get the comments for an entity.
+     * @return MorphMany<Comment, $this>
      */
     public function comments(bool $orderByCreated = true): MorphMany
     {

app/Http/ApiController.php

@@ -12,7 +12,7 @@ abstract class ApiController extends Controller
      * The validation rules for this controller.
      * Can alternative be defined in a rules() method is they need to be dynamic.
      *
-     * @var array<string, string[]>
+     * @var array<string, array<string, string[]>>
      */
     protected array $rules = [];
 

app/Search/SearchRunner.php

@@ -461,9 +461,9 @@ protected function sortByLastCommented(EloquentBuilder $query, Entity $model, bo
     {
         $commentsTable = DB::getTablePrefix() . 'comments';
         $morphClass = str_replace('\\', '\\\\', $model->getMorphClass());
-        $commentQuery = DB::raw('(SELECT c1.entity_id, c1.entity_type, c1.created_at as last_commented FROM ' . $commentsTable . ' c1 LEFT JOIN ' . $commentsTable . ' c2 ON (c1.entity_id = c2.entity_id AND c1.entity_type = c2.entity_type AND c1.created_at < c2.created_at) WHERE c1.entity_type = \'' . $morphClass . '\' AND c2.created_at IS NULL) as comments');
+        $commentQuery = DB::raw('(SELECT c1.commentable_id, c1.commentable_type, c1.created_at as last_commented FROM ' . $commentsTable . ' c1 LEFT JOIN ' . $commentsTable . ' c2 ON (c1.commentable_id = c2.commentable_id AND c1.commentable_type = c2.commentable_type AND c1.created_at < c2.created_at) WHERE c1.commentable_type = \'' . $morphClass . '\' AND c2.created_at IS NULL) as comments');
 
-        $query->join($commentQuery, $model->getTable() . '.id', '=', DB::raw('comments.entity_id'))
+        $query->join($commentQuery, $model->getTable() . '.id', '=', DB::raw('comments.commentable_id'))
             ->orderBy('last_commented', $negated ? 'asc' : 'desc');
     }
 }

database/factories/Activity/Models/CommentFactory.php

@@ -2,6 +2,7 @@
 
 namespace Database\Factories\Activity\Models;
 
+use BookStack\Users\Models\User;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
 class CommentFactory extends Factory
@@ -29,12 +30,16 @@ public function definition()
         $html = '<p>' . $text . '</p>';
         $nextLocalId = static::$nextLocalId++;
 
+        $user = User::query()->first();
+
         return [
             'html'      => $html,
             'parent_id' => null,
             'local_id'  => $nextLocalId,
             'content_ref' => '',
             'archived' => false,
+            'created_by' => $user ?? User::factory(),
+            'updated_by' => $user ?? User::factory(),
         ];
     }
 }

tests/Activity/WatchTest.php

@@ -340,8 +340,8 @@ public function test_notifications_sent_in_right_language()
             ActivityType::PAGE_CREATE => $entities['page'],
             ActivityType::PAGE_UPDATE => $entities['page'],
             ActivityType::COMMENT_CREATE => Comment::factory()->make([
-                'entity_id' => $entities['page']->id,
-                'entity_type' => $entities['page']->getMorphClass(),
+                'commentable_id' => $entities['page']->id,
+                'commentable_type' => $entities['page']->getMorphClass(),
             ]),
         ];
 

tests/Entity/CommentDisplayTest.php

@@ -72,8 +72,8 @@ public function test_comment_editor_js_loaded_with_create_or_edit_permissions()
 
         Comment::factory()->create([
             'created_by'  => $editor->id,
-            'entity_type' => 'page',
-            'entity_id'   => $page->id,
+            'commentable_type' => 'page',
+            'commentable_id'   => $page->id,
         ]);
 
         $resp = $this->actingAs($editor)->get($page->getUrl());
@@ -84,7 +84,7 @@ public function test_comment_editor_js_loaded_with_create_or_edit_permissions()
     public function test_comment_displays_relative_times()
     {
         $page = $this->entities->page();
-        $comment = Comment::factory()->create(['entity_id' => $page->id, 'entity_type' => $page->getMorphClass()]);
+        $comment = Comment::factory()->create(['commentable_id' => $page->id, 'commentable_type' => $page->getMorphClass()]);
         $comment->created_at = now()->subWeek();
         $comment->updated_at = now()->subDay();
         $comment->save();

tests/Entity/CommentStoreTest.php

@@ -14,6 +14,7 @@ public function test_add_comment()
         $this->asAdmin();
         $page = $this->entities->page();
 
+        Comment::factory()->create(['commentable_id' => $page->id, 'commentable_type' => 'page', 'local_id' => 2]);
         $comment = Comment::factory()->make(['parent_id' => 2]);
         $resp = $this->postJson("/comment/$page->id", $comment->getAttributes());
 
@@ -24,9 +25,9 @@ public function test_add_comment()
         $pageResp->assertSee($comment->html, false);
 
         $this->assertDatabaseHas('comments', [
-            'local_id'    => 1,
-            'entity_id'   => $page->id,
-            'entity_type' => Page::newModelInstance()->getMorphClass(),
+            'local_id'    => 3,
+            'commentable_id'   => $page->id,
+            'commentable_type' => 'page',
             'parent_id'   => 2,
         ]);
 
@@ -52,9 +53,9 @@ public function test_add_comment_stores_content_reference_only_if_format_valid()
             ]);
 
             if ($valid) {
-                $this->assertDatabaseHas('comments', ['entity_id' => $page->id, 'content_ref' => $ref]);
+                $this->assertDatabaseHas('comments', ['commentable_id' => $page->id, 'content_ref' => $ref]);
             } else {
-                $this->assertDatabaseMissing('comments', ['entity_id' => $page->id, 'content_ref' => $ref]);
+                $this->assertDatabaseMissing('comments', ['commentable_id' => $page->id, 'content_ref' => $ref]);
             }
         }
     }
@@ -79,7 +80,7 @@ public function test_comment_edit()
 
         $this->assertDatabaseHas('comments', [
             'html'      => $newHtml,
-            'entity_id' => $page->id,
+            'commentable_id' => $page->id,
         ]);
 
         $this->assertActivityExists(ActivityType::COMMENT_UPDATE);
@@ -218,7 +219,7 @@ public function test_scripts_are_removed_even_if_already_in_db()
         $page = $this->entities->page();
         Comment::factory()->create([
             'html' => '<script>superbadscript</script><script>superbadscript</script><p onclick="superbadonclick">scriptincommentest</p>',
-            'entity_type' => 'page', 'entity_id' => $page
+            'commentable_type' => 'page', 'commentable_id' => $page
         ]);
 
         $resp = $this->asAdmin()->get($page->getUrl());
@@ -236,8 +237,8 @@ public function test_comment_html_is_limited()
         $resp = $this->asAdmin()->post("/comment/{$page->id}", ['html' => $input]);
         $resp->assertOk();
         $this->assertDatabaseHas('comments', [
-           'entity_type' => 'page',
-           'entity_id' => $page->id,
+           'commentable_type' => 'page',
+           'commentable_id' => $page->id,
            'html' => $expected,
         ]);
 
@@ -259,8 +260,8 @@ public function test_comment_html_spans_are_cleaned()
         $resp = $this->asAdmin()->post("/comment/{$page->id}", ['html' => $input]);
         $resp->assertOk();
         $this->assertDatabaseHas('comments', [
-            'entity_type' => 'page',
-            'entity_id' => $page->id,
+            'commentable_type' => 'page',
+            'commentable_id' => $page->id,
             'html' => $expected,
         ]);