Merge branch 'release/3.3.2'

studioespresso · Nov 15, 2023 · 2140158 · 2140158
2 parents dc66bd7 + c3b3520
commit 2140158
Show file tree

Hide file tree

Showing 11 changed files with 35 additions and 31 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -21,6 +21,7 @@ jobs:
           DB_PASSWORD: root
           DB_PORT: 3306
           DB_DRIVER: mysql
+          DB_SERVER: 127.0.0.1
           APP_ENV: testing
 
         steps:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## 3.3.2 - 2023-11-15
+### Fixed
+- Fixed an error on the Control Panel Utility page ([#284](https://github.com/studioespresso/craft-scout/issues/284))
+- Fixed an error when saving elements without a site property ([#285](https://github.com/studioespresso/craft-scout/issues/285****))
+
 ## 3.3.1 - 2023-11-08
 
 ### Added

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "studioespresso/craft-scout",
     "description": "Craft Scout provides a simple solution for adding full-text search to your entries. Scout will automatically keep your search indexes in sync with your entries.",
     "type": "craft-plugin",
-    "version": "3.3.1",
+    "version": "3.3.2",
     "keywords": [
         "craft",
         "cms",

diff --git a/src/Scout.php b/src/Scout.php
@@ -168,7 +168,7 @@ function (ElementEvent $event) {
                             ->push(
                                 new IndexElement([
                                     'id' => $element->id,
-                                    'siteId' => $element->site->id
+                                    'siteId' => $element->site ? $element->site->id : null
                                 ])
                             );
                     } else {
@@ -203,7 +203,7 @@ function (ElementEvent $event) {
                         ->push(
                             new DeindexElement([
                                 'id' => $element->id,
-                                'siteId' => $element->site->id
+                                'siteId' => $element->site ? $element->site->id : null
                             ])
                         );
                 }

diff --git a/src/jobs/DeindexElement.php b/src/jobs/DeindexElement.php
@@ -11,8 +11,8 @@ class DeindexElement extends BaseJob
     /** @var int */
     public $id;
 
-    /** @var int */
-    public int $siteId;
+    /** @var int|null */
+    public int|null $siteId;
 
     public function execute($queue): void
     {

diff --git a/src/jobs/IndexElement.php b/src/jobs/IndexElement.php
@@ -13,8 +13,8 @@ class IndexElement extends BaseJob
     /** @var int */
     public int $id;
 
-    /** @var int */
-    public int $siteId;
+    /** @var int|null */
+    public int|null $siteId;
 
     public function execute($queue): void
     {

diff --git a/src/utilities/ScoutUtility.php b/src/utilities/ScoutUtility.php
@@ -41,8 +41,12 @@ public static function contentHtml(): string
                 $sites = 'all';
                 if ($engine->scoutIndex->criteria->siteId != '*') {
                     $sites = [];
-                    foreach ($engine->scoutIndex->criteria->siteId as $id) {
-                        $sites[] = Craft::$app->getSites()->getSiteById($id);
+                    if (is_array($engine->scoutIndex->criteria->siteId)) {
+                        foreach ($engine->scoutIndex->criteria->siteId as $id) {
+                            $sites[] = Craft::$app->getSites()->getSiteById($id);
+                        }
+                    } else {
+                        $sites = $engine->scoutIndex->criteria->siteId;
                     }
                 }
                 $stats = array_merge($stats, [

diff --git a/tests/_bootstrap.php b/tests/_bootstrap.php
@@ -20,7 +20,11 @@
 
 // Load dotenv?
 if (file_exists(CRAFT_BASE_PATH . '/.env')) {
-    (new Dotenv\Dotenv(CRAFT_BASE_PATH))->load();
+    if (class_exists(Dotenv\Dotenv::class)) {
+        // By default, this will allow .env file values to override environment variables
+        // with matching names. Use `createUnsafeImmutable` to disable this.
+        Dotenv\Dotenv::createUnsafeMutable(CRAFT_BASE_PATH)->safeLoad();
+    }
 }
 
 // Load and run Craft

diff --git a/tests/_craft/config/db.php b/tests/_craft/config/db.php
@@ -1,12 +1,12 @@
 <?php
 
 return [
-    'password' => 'root',
-    'user' => 'root',
-    'database' => 'scout_testing',
+    'server' => getenv('DB_SERVER') ?? '127.0.0.1',
+    'user' => getenv('DB_USER') ?? 'root',
+    'password' => getenv('DB_PASSWORD') ?? 'root',
+    'database' => getenv('DB_DATABASE') ?? 'scout_testing',
+    'schema' => getenv('DB_SCHEMA'),
     'tablePrefix' => '',
     'driver' => 'mysql',
-    'port' => 3306,
-    'schema' => getenv('DB_SCHEMA'),
-    'server' => '127.0.0.1',
+    'port' => getenv('DB_PORT') ?? 3306,
 ];
diff --git a/tests/docker-compose.yml b/tests/docker-compose.yml
diff --git a/tests/unit/ScoutUtilityTest.php b/tests/unit/ScoutUtilityTest.php
@@ -27,9 +27,13 @@ protected function _before()
             'engine' => FakeEngine::class,
             'indices' => [
                 ScoutIndex::create('Blog')
-                    ->criteria(function($query) {
+                    ->criteria(function ($query) {
                         return $query;
                     }),
+                ScoutIndex::create('Blog_with_one_site')
+                ->criteria(function ($query) {
+                    return $query->siteId(1);
+                }),
             ],
         ]);
         $scout->init();