]> BookStack Code Mirror - bookstack/commitdiff
Merge branch 'development' into release
authorDan Brown <redacted>
Tue, 11 Nov 2025 12:15:16 +0000 (12:15 +0000)
committerDan Brown <redacted>
Tue, 11 Nov 2025 12:15:16 +0000 (12:15 +0000)
app/Entities/Models/Book.php
app/Entities/Models/EntityScope.php
dev/docker/db-testing/Dockerfile [new file with mode: 0644]
dev/docker/db-testing/run.sh [new file with mode: 0755]
tests/Entity/EntityQueryTest.php [new file with mode: 0644]
tests/Uploads/ImageTest.php

index afd50797b15e070501bd0b28b79cb16f6816a32a..1909dbd56316023b957ddf877387e996350a0e5a 100644 (file)
@@ -67,8 +67,7 @@ class Book extends Entity implements HasDescriptionInterface, HasCoverInterface,
      */
     public function chapters(): HasMany
     {
-        return $this->hasMany(Chapter::class)
-            ->where('type', '=', 'chapter');
+        return $this->hasMany(Chapter::class);
     }
 
     /**
index deb10c5ecbc63834e882da1296eff5cbf039134a..c77b75a1624cbb077008a0882e2e57e3d9529300 100644 (file)
@@ -15,11 +15,12 @@ class EntityScope implements Scope
     public function apply(Builder $builder, Model $model): void
     {
         $builder = $builder->where('type', '=', $model->getMorphClass());
+        $table = $model->getTable();
         if ($model instanceof Page) {
-            $builder->leftJoin('entity_page_data', 'entity_page_data.page_id', '=', 'entities.id');
+            $builder->leftJoin('entity_page_data', 'entity_page_data.page_id', '=', "{$table}.id");
         } else {
-            $builder->leftJoin('entity_container_data', function (JoinClause $join) use ($model) {
-                $join->on('entity_container_data.entity_id', '=', 'entities.id')
+            $builder->leftJoin('entity_container_data', function (JoinClause $join) use ($model, $table) {
+                $join->on('entity_container_data.entity_id', '=', "{$table}.id")
                     ->where('entity_container_data.entity_type', '=', $model->getMorphClass());
             });
         }
diff --git a/dev/docker/db-testing/Dockerfile b/dev/docker/db-testing/Dockerfile
new file mode 100644 (file)
index 0000000..69b07a2
--- /dev/null
@@ -0,0 +1,30 @@
+FROM ubuntu:24.04
+
+# Install additional dependencies
+RUN apt-get update && \
+    apt-get install -y \
+        git \
+               wget \
+        zip \
+        unzip \
+               php \
+               php-bcmath php-curl php-mbstring php-gd php-xml php-zip php-mysql php-ldap \
+       && \
+    rm -rf /var/lib/apt/lists/*
+
+# Take branch as an argument so we can choose which BookStack
+# branch to test against
+ARG BRANCH=development
+
+# Download BookStack & install PHP deps
+RUN mkdir -p /var/www && \
+    git clone https://github.com/bookstackapp/bookstack.git --branch "$BRANCH" --single-branch /var/www/bookstack && \
+    cd /var/www/bookstack && \ 
+   wget https://raw.githubusercontent.com/composer/getcomposer.org/f3108f64b4e1c1ce6eb462b159956461592b3e3e/web/installer -O - -q | php -- --quiet --filename=composer && \
+    php composer install
+
+# Set the BookStack dir as the default working dir
+WORKDIR /var/www/bookstack
+
+# Set the default action as running php
+ENTRYPOINT ["/bin/php"]
diff --git a/dev/docker/db-testing/run.sh b/dev/docker/db-testing/run.sh
new file mode 100755 (executable)
index 0000000..9898e52
--- /dev/null
@@ -0,0 +1,57 @@
+#!/bin/bash
+
+BRANCH=${1:-development}
+
+# Build the container with a known name
+docker build --build-arg BRANCH="$BRANCH" -t bookstack:db-testing .
+if [ $? -eq 1 ]; then
+  echo "Failed to build app container for testing"
+  exit 1
+fi
+
+# List of database containers to test against
+containers=(
+  "mysql:5.7"
+  "mysql:8.0"
+  "mysql:8.4"
+  "mysql:9.5"
+  "mariadb:10.2"
+  "mariadb:10.6"
+  "mariadb:10.11"
+  "mariadb:11.4"
+  "mariadb:11.8"
+  "mariadb:12.0"
+)
+
+# Pre-clean-up from prior runs
+docker stop bs-dbtest-db
+docker network rm bs-dbtest-net
+
+# Cycle over each database image
+for img in "${containers[@]}"; do
+  echo "Starting tests with $img..."
+  docker network create bs-dbtest-net
+  docker run -d --rm --name "bs-dbtest-db" \
+    -e MYSQL_DATABASE=bookstack-test \
+    -e MYSQL_USER=bookstack \
+    -e MYSQL_PASSWORD=bookstack \
+    -e MYSQL_ROOT_PASSWORD=password \
+         --network=bs-dbtest-net \
+    "$img"
+  sleep 20
+  APP_RUN='docker run -it --rm --network=bs-dbtest-net -e TEST_DATABASE_URL="mysql://bookstack:bookstack@bs-dbtest-db:3306" bookstack:db-testing'
+  $APP_RUN artisan migrate --force --database=mysql_testing
+  $APP_RUN artisan db:seed --force --class=DummyContentSeeder --database=mysql_testing
+  $APP_RUN vendor/bin/phpunit
+  if [ $? -eq 0 ]; then
+    echo "$img - Success"
+  else
+    echo "$img - Error"
+    read -p "Stop script? [y/N] " ans
+    [[ $ans == [yY] ]] && exit 0
+  fi
+
+  docker stop "bs-dbtest-db"
+  docker network rm bs-dbtest-net
+done
+
diff --git a/tests/Entity/EntityQueryTest.php b/tests/Entity/EntityQueryTest.php
new file mode 100644 (file)
index 0000000..7d3fd38
--- /dev/null
@@ -0,0 +1,44 @@
+<?php
+
+namespace Entity;
+
+use BookStack\Entities\Models\Book;
+use Illuminate\Database\Eloquent\Builder;
+use Tests\TestCase;
+
+class EntityQueryTest extends TestCase
+{
+    public function test_basic_entity_query_has_join_and_type_applied()
+    {
+        $query = Book::query();
+        $expected = 'select * from `entities` left join `entity_container_data` on `entity_container_data`.`entity_id` = `entities`.`id` and `entity_container_data`.`entity_type` = ? where `type` = ? and `entities`.`deleted_at` is null';
+        $this->assertEquals($expected, $query->toSql());
+        $this->assertEquals(['book', 'book'], $query->getBindings());
+    }
+
+    public function test_joins_in_sub_queries_use_alias_names()
+    {
+        $query = Book::query()->whereHas('chapters', function (Builder $query) {
+            $query->where('name', '=', 'a');
+        });
+
+        // Probably from type limits on relation where not needed?
+        $expected = 'select * from `entities` left join `entity_container_data` on `entity_container_data`.`entity_id` = `entities`.`id` and `entity_container_data`.`entity_type` = ? where exists (select * from `entities` as `laravel_reserved_%d` left join `entity_container_data` on `entity_container_data`.`entity_id` = `laravel_reserved_%d`.`id` and `entity_container_data`.`entity_type` = ? where `entities`.`id` = `laravel_reserved_%d`.`book_id` and `name` = ? and `type` = ? and `laravel_reserved_%d`.`deleted_at` is null) and `type` = ? and `entities`.`deleted_at` is null';
+        $this->assertStringMatchesFormat($expected, $query->toSql());
+        $this->assertEquals(['book', 'chapter', 'a', 'chapter', 'book'], $query->getBindings());
+    }
+
+    public function test_book_chapter_relation_applies_type_condition()
+    {
+        $book = $this->entities->book();
+        $query = $book->chapters();
+        $expected = 'select * from `entities` left join `entity_container_data` on `entity_container_data`.`entity_id` = `entities`.`id` and `entity_container_data`.`entity_type` = ? where `entities`.`book_id` = ? and `entities`.`book_id` is not null and `type` = ? and `entities`.`deleted_at` is null';
+        $this->assertEquals($expected, $query->toSql());
+        $this->assertEquals(['chapter', $book->id, 'chapter'], $query->getBindings());
+
+        $query = Book::query()->whereHas('chapters');
+        $expected = 'select * from `entities` left join `entity_container_data` on `entity_container_data`.`entity_id` = `entities`.`id` and `entity_container_data`.`entity_type` = ? where exists (select * from `entities` as `laravel_reserved_%d` left join `entity_container_data` on `entity_container_data`.`entity_id` = `laravel_reserved_%d`.`id` and `entity_container_data`.`entity_type` = ? where `entities`.`id` = `laravel_reserved_%d`.`book_id` and `type` = ? and `laravel_reserved_%d`.`deleted_at` is null) and `type` = ? and `entities`.`deleted_at` is null';
+        $this->assertStringMatchesFormat($expected, $query->toSql());
+        $this->assertEquals(['book', 'chapter', 'chapter', 'book'], $query->getBindings());
+    }
+}
index a2f03df34d4f62d12d163ea23378811418f6e58d..c5a5eb2ba0fc59900180f462b4c6133e6bee2f15 100644 (file)
@@ -73,6 +73,10 @@ class ImageTest extends TestCase
 
     public function test_image_display_thumbnail_generation_for_animated_avif_images_uses_original_file()
     {
+        if (! function_exists('imageavif')) {
+            $this->markTestSkipped('imageavif() is not available');
+        }
+
         $page = $this->entities->page();
         $admin = $this->users->admin();
         $this->actingAs($admin);