minor
#29412
Unzuverlässiger Test „TestDynamicComponentService.testIncrementalUpdates“: Überprüft das asynchrone WatchService-Ereignis nach einer festen Wartezeit von 10 ms
Problem
test.com.top_logic.layout.editor.TestDynamicComponentService#testIncrementalUpdates (Ausführung mit H2_KB) schlägt zeitweise fehl (Build wird UNSTABLE). In Jenkins Build_Git #15016 wurde der Test bestanden, in #15017 bei identischem Commit 1c79cfb jedoch fehlgeschlagen; es handelt sich also um einen echten, nicht deterministischen Fehler und nicht um eine Regression. Die einzige Log-Zeile in der Nähe des Fehlers ist das normale Herunterfahren von DynamicComponentService; es gibt keine Ausnahme oder Stack-Trace, was mit einem einfachen Fehlschlag von ` assertNotNull` /`assertNull` übereinstimmt.
(Trat während der Untersuchung von PR #1485 / #29195 zutage, steht jedoch in keinem Zusammenhang mit dieser Änderung.)
Grundursache
Der Test erstellt zunächst eine Layout-Definitionsdatei, löscht diese anschließend, wartet jedes Mal genau 10 ms und führt dann eine einzelne nicht blockierende Abfrage des Dateiüberwachungsdienstes des Betriebssystems durch, bevor die Überprüfung erfolgt. java.nio.file.WatchService liefert Ereignisse asynchron mit unbegrenzter Latenz, sodass 10 ms auf einem ausgelasteten CI-Host nicht immer ausreichen.
- com.top_logic/src/test/java/test/com/top_logic/layout/editor/TestDynamicComponentService.java:55 – Thread.sleep(10), anschließend assertHasTemplate(...) bei :57.
- ...TestDynamicComponentService.java:62 – Thread.sleep(10), anschließend assertMissingTemplate(...) bei Zeile 64.
- Der Lesepfad ist vollständig nicht blockierend: DynamicComponentService.java:167 ruft FileSystemCache.getCache().fetchUpdates() auf.
- com.top_logic.basic/src/main/java/com/top_logic/basic/io/IDEFileSystemCache.java:88–100 (fetchUpdates) → poll() bei Zeile 168–176 verwendet die arg-freie Methode _watcher.poll() (Zeile 169) mit null Argumenten, das sofort null zurückgibt, wenn das Betriebssystem das Ereignis noch nicht in die Warteschlange gestellt hat.
Wenn das Ereignis nicht innerhalb von 10 ms eingetroffen ist, erzeugt `fetchUpdates()` kein `PathUpdate`, `_allDefinitions` wird nicht aktualisiert und die Assertion erkennt einen veralteten Zustand → unvorhersehbarer Fehler.
Der Test ist über ServiceTestSetup, das FileSystemCache.Module mit devel-file-cache-ide.config.xml startet, an den echten IDEFileSystemCache (nicht an den No-Op-Standard) gebunden, sodass der WatchService tatsächlich im Einsatz ist.
Vorgeschlagene Korrektur (nur für den Test)
Ersetze jeden „fixed-sleep-then-single-check“-Zyklus durch eine begrenzte „poll-until“-Schleife: Wiederhole getComponentDefinition(...) so lange, bis der erwartete Zustand (vorhanden/nicht vorhanden) festgestellt wird oder ein großzügiges Timeout (~10 s) abgelaufen ist. Da „getComponentDefinition“ bei jedem Aufruf „fetchUpdates()“ erneut aufruft, wird der Watcher bei jedem erneuten Versuch erneut abgefragt, sodass das verspätete Ereignis erfasst wird, sobald das Betriebssystem es liefert; der „Happy Path“ kehrt weiterhin innerhalb weniger Millisekunden zurück. Eine echte Regression schlägt dann deterministisch beim Ablauf des Timeouts mit einer eindeutigen Meldung fehl, anstatt wie bisher mit einem stillen Assert.
Am besten lässt sich dies als wiederverwendbarer „awaitUntil(timeout, BooleanSupplier)“ -Helper in „BasicTestCase“ umsetzen (derzeit gibt es dort kein solches „poll-until“-Dienstprogramm). Das produktive „IDEFileSystemCache.poll()“ sollte nicht blockierend gestaltet werden – dies würde das Risiko bergen, den Anfragethread zum Stillstand zu bringen; die Korrektur gehört in den Test.
Verwandte Themen
- #28090 (geschlossen, TL_7.8.1) behob ein anderes Symptom in derselben Komponente – der Cache protokollierte einen Fehler bei schnellem „Erstellen und Löschen“. Dieses Ticket betrifft die testinterne Synchronisation, die weiterhin zeitabhängig ist.
Anmerkungen
- Lässt sich nur sporadisch reproduzieren; eine einfache Wiederholung der CI-Ausführung ist in der Regel erfolgreich.