[!!!][TASK] Introduce RecordInsertedEvent, drop remove isNewRecord from RecordUpdatedEvent

The deprecated $isNewRecord property, constructor parameter and
isNewRecord() method are removed from RecordUpdatedEvent. A new
RecordInsertedEvent is introduced for record creations; RecordMonitor
now dispatches it upon record creation.

All three event listeners and Services.yaml are updated
accordingly.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: 2 people

Classes/Domain/Index/Queue/UpdateHandler/EventListener/ImmediateProcessingEventListener.php

@@ -24,6 +24,7 @@
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\PageMovedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordDeletedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordGarbageCheckEvent;
+use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordMovedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordUpdatedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\VersionSwappedEvent;
@@ -110,6 +111,26 @@ protected function handleRecordMovedEvent(RecordMovedEvent $event): void
         }
     }
 
+    /**
+     * Handles record insertions
+     *
+     * @throws DBALException
+     * @throws UnexpectedTYPO3SiteInitializationException
+     * @throws RootPageRecordNotFoundException
+     *
+     * @noinspection PhpUnused
+     */
+    protected function handleRecordInsertedEvent(RecordInsertedEvent $event): void
+    {
+        if ($event->isContentElementUpdate()) {
+            $this->getDataUpdateHandler()->handleContentElementUpdate($event->getUid(), $event->getFields());
+        } elseif ($event->isPageUpdate()) {
+            $this->getDataUpdateHandler()->handlePageUpdate($event->getUid(), $event->getFields());
+        } else {
+            $this->getDataUpdateHandler()->handleRecordUpdate($event->getUid(), $event->getTable());
+        }
+    }
+
     /**
      * Handles record updates
      *

Classes/Domain/Index/Queue/UpdateHandler/Events/RecordInsertedEvent.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events;
+
+/**
+ * Event fired if a record is created
+ */
+class RecordInsertedEvent extends AbstractDataUpdateEvent {}

Classes/Domain/Index/Queue/UpdateHandler/Events/RecordUpdatedEvent.php

@@ -18,33 +18,6 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events;
 
 /**
- * Event fired if a record is created or updated
+ * Event fired if a record is updated
  */
-class RecordUpdatedEvent extends AbstractDataUpdateEvent
-{
-    /**
-     * @deprecated For compatibility reasons flag "$isNewRecord" is added to RecordUpdatedEvent,
-     *             in v14 a separate RecordInsertedEvent will be used
-     */
-    protected bool $isNewRecord;
-
-    public function __construct(
-        int $uid,
-        string $table,
-        array $fields = [],
-        bool $frontendGroupsRemoved = false,
-        bool $isNewRecord = false,
-    ) {
-        parent::__construct($uid, $table, $fields, $frontendGroupsRemoved);
-        $this->isNewRecord = $isNewRecord;
-    }
-
-    /**
-     * @deprecated For compatibility reasons flag "$isNewRecord" is added to RecordUpdatedEvent,
-     *             in v14 a separate RecordInsertedEvent will be used
-     */
-    final public function isNewRecord(): bool
-    {
-        return $this->isNewRecord;
-    }
-}
+class RecordUpdatedEvent extends AbstractDataUpdateEvent {}

Classes/IndexQueue/RecordMonitor.php

@@ -18,6 +18,7 @@
 namespace ApacheSolrForTypo3\Solr\IndexQueue;
 
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\ContentElementDeletedEvent;
+use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordMovedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordUpdatedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\VersionSwappedEvent;
@@ -164,12 +165,12 @@ public function processDatamap_afterDatabaseOperations(
             return;
         }
 
+        $eventClass = $status === 'new' ? RecordInsertedEvent::class : RecordUpdatedEvent::class;
         $this->eventDispatcher->dispatch(
-            new RecordUpdatedEvent(
+            new $eventClass(
                 (int)$recordUid,
                 $table,
                 $fields,
-                isNewRecord: ($status === 'new' ? true : false),
             ),
         );
     }

Configuration/Services.yaml

@@ -146,6 +146,10 @@ services:
         identifier: 'solr.index.updatehandler.noprocessingeventlistener'
         before: 'solr.index.updatehandler.immediateprocessingeventlistener,solr.index.updatehandler.delayedprocessingeventlistener'
         event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordMovedEvent
+      - name: event.listener
+        identifier: 'solr.index.updatehandler.noprocessingeventlistener'
+        before: 'solr.index.updatehandler.immediateprocessingeventlistener,solr.index.updatehandler.delayedprocessingeventlistener'
+        event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent
       - name: event.listener
         identifier: 'solr.index.updatehandler.noprocessingeventlistener'
         before: 'solr.index.updatehandler.immediateprocessingeventlistener,solr.index.updatehandler.delayedprocessingeventlistener'
@@ -180,6 +184,10 @@ services:
         identifier: 'solr.index.updatehandler.immediateprocessingeventlistener'
         before: 'solr.index.updatehandler.delayedprocessingeventlistener'
         event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordMovedEvent
+      - name: event.listener
+        identifier: 'solr.index.updatehandler.immediateprocessingeventlistener'
+        before: 'solr.index.updatehandler.delayedprocessingeventlistener'
+        event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent
       - name: event.listener
         identifier: 'solr.index.updatehandler.immediateprocessingeventlistener'
         before: 'solr.index.updatehandler.delayedprocessingeventlistener'
@@ -212,6 +220,9 @@ services:
       - name: event.listener
         identifier: 'solr.index.updatehandler.delayedprocessingeventlistener'
         event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordMovedEvent
+      - name: event.listener
+        identifier: 'solr.index.updatehandler.delayedprocessingeventlistener'
+        event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent
       - name: event.listener
         identifier: 'solr.index.updatehandler.delayedprocessingeventlistener'
         event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordUpdatedEvent

Documentation/Releases/solr-release-14-0.rst

@@ -94,6 +94,45 @@ Rename method :php:`isPageIndexable` to :php:`isPageEnabled()` and adjust the si
 (the page record) instead of an :php:`Item` object:
 
 
+!!! RecordUpdatedEvent no longer covers record insertions – use RecordInsertedEvent
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A dedicated :php:`RecordInsertedEvent` has been introduced for record creations.
+The :php:`RecordUpdatedEvent` now only fires for updates; the deprecated
+:php:`$isNewRecord` property, its constructor parameter, and the :php:`isNewRecord()`
+method have been removed from :php:`RecordUpdatedEvent`.
+
+Previously :php:`RecordUpdatedEvent` was dispatched for both new records and updates,
+with :php:`isNewRecord()` acting as a flag to distinguish the two cases.
+In v14 these are two distinct events.
+
+Impact
+""""""
+
+**Listeners checking** :php:`$event->isNewRecord()`
+
+Register your listener for :php:`RecordInsertedEvent` to handle creations, and for
+:php:`RecordUpdatedEvent` to handle updates. Remove any :php:`isNewRecord()` checks:
+
+..  code-block:: yaml
+
+    # Before – one listener covering both cases
+    tags:
+      - name: event.listener
+        event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordUpdatedEvent
+
+    # After – separate registrations
+    tags:
+      - name: event.listener
+        event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent
+      - name: event.listener
+        event: ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordUpdatedEvent
+
+**Code instantiating** :php:`new RecordUpdatedEvent(..., isNewRecord: true)`
+
+Replace with :php:`new RecordInsertedEvent($uid, $table, $fields)`.
+
+
 All Changes
 -----------
 

Tests/Unit/Domain/Index/Queue/UpdateHandler/EventListener/ImmediateProcessingEventListenerTest.php

@@ -23,6 +23,7 @@
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\PageMovedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordDeletedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordGarbageCheckEvent;
+use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordMovedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordUpdatedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\VersionSwappedEvent;
@@ -131,6 +132,7 @@ public static function canHandleEventsDataProvider(): Traversable
         yield [ContentElementDeletedEvent::class, DataUpdateHandler::class, [1], true];
         yield [VersionSwappedEvent::class, DataUpdateHandler::class, [1, 'pages'], true];
         yield [RecordMovedEvent::class, DataUpdateHandler::class, [1, 'pages'], true];
+        yield [RecordInsertedEvent::class, DataUpdateHandler::class, [1, 'pages'], true];
         yield [RecordUpdatedEvent::class, DataUpdateHandler::class, [1, 'pages'], true];
         yield [RecordDeletedEvent::class, GarbageHandler::class, [1, 'pages'], true];
         yield [PageMovedEvent::class, GarbageHandler::class, [1], true];

Tests/Unit/Domain/Index/Queue/UpdateHandler/Events/RecordInsertedEventTest.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace ApacheSolrForTypo3\Solr\Tests\Unit\Domain\Index\Queue\UpdateHandler\Events;
+
+use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent;
+
+/**
+ * Testcase for the RecordInsertedEvent
+ */
+class RecordInsertedEventTest extends SetUpDataUpdateEvent
+{
+    protected const EVENT_CLASS = RecordInsertedEvent::class;
+    protected const EVENT_TEST_TABLE = 'tx_foo_bar';
+}

Tests/Unit/IndexQueue/RecordMonitorTest.php

@@ -16,8 +16,8 @@
 namespace ApacheSolrForTypo3\Solr\Tests\Unit\IndexQueue;
 
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\ContentElementDeletedEvent;
+use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordInsertedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordMovedEvent;
-use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\RecordUpdatedEvent;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\VersionSwappedEvent;
 use ApacheSolrForTypo3\Solr\IndexQueue\RecordMonitor;
 use ApacheSolrForTypo3\Solr\System\Configuration\ExtensionConfiguration;
@@ -191,7 +191,7 @@ public function processDatamap_afterDatabaseOperationsUsesAlreadyResolvedNextAut
             });
         $this->recordMonitor->processDatamap_afterDatabaseOperations('new', 'tt_content', 4711, ['pid' => 1], $dataHandlerMock);
 
-        self::assertTrue($dispatchedEvent instanceof RecordUpdatedEvent);
+        self::assertTrue($dispatchedEvent instanceof RecordInsertedEvent);
         self::assertEquals('tt_content', $dispatchedEvent->getTable());
         self::assertEquals(4711, $dispatchedEvent->getUid());
     }
@@ -213,7 +213,7 @@ public function processDatamap_afterDatabaseOperationsUsesNotYetResolvedNextAuto
 
         $this->recordMonitor->processDatamap_afterDatabaseOperations('new', 'tt_content', $newId, ['pid' => 1], $dataHandlerMock);
 
-        self::assertTrue($dispatchedEvent instanceof RecordUpdatedEvent);
+        self::assertTrue($dispatchedEvent instanceof RecordInsertedEvent);
         self::assertEquals('tt_content', $dispatchedEvent->getTable());
         self::assertEquals(123, $dispatchedEvent->getUid());
     }