Merge branch '7.11' of github.com:gchq/stroom

stroomdev66 · stroomdev66 · commit f6e2c6d53f05 · 2026-02-12T12:27:45.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,15 @@ DO NOT ADD CHANGES HERE - ADD THEM USING log_change.sh
 ~~~
 
 
+## [v7.11-beta.24] - 2026-02-12
+
+* Bug **#5391** : Fix folder DocRef NPE.
+
+* Bug **#5392** : Fix PlanB segfault.
+
+* Bug **#5300** : Fix path `millis` parameter.
+
+
 ## [v7.11-beta.23] - 2026-02-09
 
 * Feature **#5313** : Allow users to prevent empty reports from being sent on a per report basis.
@@ -2000,7 +2009,8 @@ DO NOT ADD CHANGES HERE - ADD THEM USING log_change.sh
 * Issue **#3830** : Add S3 data storage option.
 
 
-[Unreleased]: https://github.com/gchq/stroom/compare/v7.11-beta.23...HEAD
+[Unreleased]: https://github.com/gchq/stroom/compare/v7.11-beta.24...HEAD
+[v7.11-beta.24]: https://github.com/gchq/stroom/compare/v7.11-beta.23...v7.11-beta.24
 [v7.11-beta.23]: https://github.com/gchq/stroom/compare/v7.11-beta.22...v7.11-beta.23
 [v7.11-beta.22]: https://github.com/gchq/stroom/compare/v7.11-beta.21...v7.11-beta.22
 [v7.11-beta.21]: https://github.com/gchq/stroom/compare/v7.11-beta.20...v7.11-beta.21
diff --git a/stroom-core-shared/src/main/java/stroom/planb/shared/HasCondenseSettings.java b/stroom-core-shared/src/main/java/stroom/planb/shared/HasCondenseSettings.java
@@ -0,0 +1,6 @@
+package stroom.planb.shared;
+
+public interface HasCondenseSettings {
+
+    DurationSetting getCondense();
+}
diff --git a/stroom-core-shared/src/main/java/stroom/planb/shared/HistogramSettings.java b/stroom-core-shared/src/main/java/stroom/planb/shared/HistogramSettings.java
@@ -36,7 +36,8 @@
         "valueSchema"
 })
 @JsonInclude(Include.NON_NULL)
-public final class HistogramSettings extends AbstractPlanBSettings {
+public final class HistogramSettings
+        extends AbstractPlanBSettings {
 
     @JsonProperty
     private final HistogramKeySchema keySchema;
diff --git a/stroom-core-shared/src/main/java/stroom/planb/shared/MetricSettings.java b/stroom-core-shared/src/main/java/stroom/planb/shared/MetricSettings.java
@@ -36,7 +36,8 @@
         "valueSchema"
 })
 @JsonInclude(Include.NON_NULL)
-public final class MetricSettings extends AbstractPlanBSettings {
+public final class MetricSettings
+        extends AbstractPlanBSettings {
 
     @JsonProperty
     private final MetricKeySchema keySchema;
diff --git a/stroom-core-shared/src/main/java/stroom/planb/shared/RangeStateSettings.java b/stroom-core-shared/src/main/java/stroom/planb/shared/RangeStateSettings.java
@@ -36,7 +36,8 @@
         "valueSchema"
 })
 @JsonInclude(Include.NON_NULL)
-public final class RangeStateSettings extends AbstractPlanBSettings {
+public final class RangeStateSettings
+        extends AbstractPlanBSettings {
 
     @JsonProperty
     private final RangeKeySchema keySchema;
diff --git a/stroom-core-shared/src/main/java/stroom/planb/shared/SessionSettings.java b/stroom-core-shared/src/main/java/stroom/planb/shared/SessionSettings.java
@@ -36,7 +36,9 @@
         "keySchema"
 })
 @JsonInclude(Include.NON_NULL)
-public final class SessionSettings extends AbstractPlanBSettings {
+public final class SessionSettings
+        extends AbstractPlanBSettings
+        implements HasCondenseSettings {
 
     @JsonProperty
     private final DurationSetting condense;
@@ -56,6 +58,7 @@ public SessionSettings(@JsonProperty("maxStoreSize") final Long maxStoreSize,
         this.keySchema = NullSafe.requireNonNullElse(keySchema, new SessionKeySchema.Builder().build());
     }
 
+    @Override
     public DurationSetting getCondense() {
         return condense;
     }
diff --git a/stroom-core-shared/src/main/java/stroom/planb/shared/StateSettings.java b/stroom-core-shared/src/main/java/stroom/planb/shared/StateSettings.java
@@ -36,7 +36,8 @@
         "valueSchema"
 })
 @JsonInclude(Include.NON_NULL)
-public final class StateSettings extends AbstractPlanBSettings {
+public final class StateSettings
+        extends AbstractPlanBSettings {
 
     @JsonProperty
     private final StateKeySchema keySchema;
diff --git a/stroom-core-shared/src/main/java/stroom/planb/shared/TemporalRangeStateSettings.java b/stroom-core-shared/src/main/java/stroom/planb/shared/TemporalRangeStateSettings.java
@@ -37,7 +37,9 @@
         "valueSchema"
 })
 @JsonInclude(Include.NON_NULL)
-public final class TemporalRangeStateSettings extends AbstractPlanBSettings {
+public final class TemporalRangeStateSettings
+        extends AbstractPlanBSettings
+        implements HasCondenseSettings {
 
     @JsonProperty
     private final DurationSetting condense;
@@ -61,6 +63,7 @@ public TemporalRangeStateSettings(@JsonProperty("maxStoreSize") final Long maxSt
         this.valueSchema = NullSafe.requireNonNullElse(valueSchema, new StateValueSchema.Builder().build());
     }
 
+    @Override
     public DurationSetting getCondense() {
         return condense;
     }
diff --git a/stroom-core-shared/src/main/java/stroom/planb/shared/TemporalStateSettings.java b/stroom-core-shared/src/main/java/stroom/planb/shared/TemporalStateSettings.java
@@ -37,7 +37,9 @@
         "valueSchema"
 })
 @JsonInclude(Include.NON_NULL)
-public final class TemporalStateSettings extends AbstractPlanBSettings {
+public final class TemporalStateSettings
+        extends AbstractPlanBSettings
+        implements HasCondenseSettings {
 
     @JsonProperty
     private final DurationSetting condense;
@@ -61,6 +63,7 @@ public TemporalStateSettings(@JsonProperty("maxStoreSize") final Long maxStoreSi
         this.valueSchema = NullSafe.requireNonNullElse(valueSchema, new StateValueSchema.Builder().build());
     }
 
+    @Override
     public DurationSetting getCondense() {
         return condense;
     }
diff --git a/stroom-explorer/stroom-explorer-impl/src/main/java/stroom/explorer/impl/FolderExplorerActionHandler.java b/stroom-explorer/stroom-explorer-impl/src/main/java/stroom/explorer/impl/FolderExplorerActionHandler.java
@@ -130,9 +130,7 @@ public void deleteDocument(final DocRef docRef) {
     public DocRefInfo info(final DocRef docRef) {
         final ExplorerTreeNode explorerTreeNode = explorerTreeDao.findByUUID(docRef.getUuid());
         if (explorerTreeNode == null) {
-            throw new DocumentNotFoundException(DocRef.builder()
-                    .uuid(docRef.getUuid())
-                    .build());
+            throw new DocumentNotFoundException(docRef);
         }
 
         if (!securityContext.hasDocumentPermission(docRef, DocumentPermission.VIEW)) {
@@ -142,11 +140,7 @@ public DocRefInfo info(final DocRef docRef) {
 
         return DocRefInfo
                 .builder()
-                .docRef(DocRef.builder()
-                        .type(explorerTreeNode.getType())
-                        .uuid(explorerTreeNode.getUuid())
-                        .name(explorerTreeNode.getName())
-                        .build())
+                .docRef(explorerTreeNode.getDocRef())
                 .otherInfo("DB ID: " + explorerTreeNode.getId())
                 .build();
     }
diff --git a/stroom-state/stroom-planb-impl/src/main/java/stroom/planb/impl/data/StoreShard.java b/stroom-state/stroom-planb-impl/src/main/java/stroom/planb/impl/data/StoreShard.java
@@ -25,14 +25,10 @@
 import stroom.planb.impl.db.StatePaths;
 import stroom.planb.shared.AbstractPlanBSettings;
 import stroom.planb.shared.DurationSetting;
+import stroom.planb.shared.HasCondenseSettings;
 import stroom.planb.shared.PlanBDoc;
-import stroom.planb.shared.RangeStateSettings;
 import stroom.planb.shared.RetentionSettings;
-import stroom.planb.shared.SessionSettings;
 import stroom.planb.shared.SnapshotSettings;
-import stroom.planb.shared.StateSettings;
-import stroom.planb.shared.TemporalRangeStateSettings;
-import stroom.planb.shared.TemporalStateSettings;
 import stroom.util.concurrent.UncheckedInterruptedException;
 import stroom.util.io.FileUtil;
 import stroom.util.logging.LambdaLogger;
@@ -46,7 +42,6 @@
 import jakarta.inject.Provider;
 import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
 import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
-import org.lmdbjava.LmdbException;
 
 import java.io.BufferedOutputStream;
 import java.io.IOException;
@@ -84,7 +79,6 @@ class StoreShard implements Shard {
 
     private final PlanBDoc doc;
     private volatile Db<?, ?> db;
-    private volatile boolean open;
     private volatile Instant lastWriteTime;
     private volatile Instant lastSnapshotTime;
 
@@ -190,19 +184,7 @@ public long deleteOldData(final PlanBDoc doc) {
     }
 
     private RetentionSettings getRetentionSettings(final PlanBDoc doc) {
-        RetentionSettings retention = null;
-        if (doc.getSettings() instanceof final StateSettings stateSettings) {
-            retention = stateSettings.getRetention();
-        } else if (doc.getSettings() instanceof final TemporalStateSettings temporalStateSettings) {
-            retention = temporalStateSettings.getRetention();
-        } else if (doc.getSettings() instanceof final RangeStateSettings rangeStateSettings) {
-            retention = rangeStateSettings.getRetention();
-        } else if (doc.getSettings() instanceof final TemporalRangeStateSettings temporalRangeStateSettings) {
-            retention = temporalRangeStateSettings.getRetention();
-        } else if (doc.getSettings() instanceof final SessionSettings sessionSettings) {
-            retention = sessionSettings.getRetention();
-        }
-        return retention;
+        return NullSafe.get(doc, PlanBDoc::getSettings, AbstractPlanBSettings::getRetention);
     }
 
     @Override
@@ -242,15 +224,10 @@ public long condense(final PlanBDoc doc) {
     }
 
     private static DurationSetting getCondenseDuration(final PlanBDoc doc) {
-        DurationSetting condense = null;
-        if (doc.getSettings() instanceof final TemporalStateSettings temporalStateSettings) {
-            condense = temporalStateSettings.getCondense();
-        } else if (doc.getSettings() instanceof final TemporalRangeStateSettings temporalRangeStateSettings) {
-            condense = temporalRangeStateSettings.getCondense();
-        } else if (doc.getSettings() instanceof final SessionSettings sessionSettings) {
-            condense = sessionSettings.getCondense();
+        if (doc.getSettings() instanceof final HasCondenseSettings hasCondenseSettings) {
+            return hasCondenseSettings.getCondense();
         }
-        return condense;
+        return null;
     }
 
     @Override
@@ -292,13 +269,16 @@ public void compact() {
                                 StandardCopyOption.REPLACE_EXISTING,
                                 StandardCopyOption.ATOMIC_MOVE);
                     } catch (final IOException e) {
+                        // Log any error that happens on move, we will end up reopening the old database.
                         LOGGER.error(e::getMessage, e);
                     }
 
                     // Cleanup.
                     FileUtil.deleteDir(compactedDir);
 
                     // Open the new DB.
+                    // Note that if the move above fails we will end up reopening the old database.
+                    // This is expected recovery behaviour.
                     open();
 
                     lastWriteTime = Instant.now();
@@ -343,21 +323,25 @@ public void checkSnapshotStatus(final SnapshotRequest request) {
 
     @Override
     public void createSnapshot() {
+        // Check if a new snapshot is required and create one if it is.
         if (isNewSnapshotRequired()) {
             try {
                 writeLock.lockInterruptibly();
                 try {
-                    // TODO : Possibly create windowed snapshots.
-                    final Instant lastWriteTime = this.lastWriteTime;
-                    try {
-                        // Get the snapshot file.
-                        Files.createDirectories(snapshotDir);
-                        final Path tmpFile = getSnapshotTmp();
-                        final Path zipFile = getSnapshotZip();
-                        createZip(tmpFile, lastWriteTime);
-                        Files.move(tmpFile, zipFile, StandardCopyOption.ATOMIC_MOVE);
-                    } finally {
-                        this.lastSnapshotTime = lastWriteTime;
+                    // Check again that a new snapshot is required new we are under lock.
+                    if (isNewSnapshotRequired()) {
+                        // TODO : Possibly create windowed snapshots.
+                        final Instant lastWriteTime = this.lastWriteTime;
+                        try {
+                            // Get the snapshot file.
+                            Files.createDirectories(snapshotDir);
+                            final Path tmpFile = getSnapshotTmp();
+                            final Path zipFile = getSnapshotZip();
+                            createZip(tmpFile, lastWriteTime);
+                            Files.move(tmpFile, zipFile, StandardCopyOption.ATOMIC_MOVE);
+                        } finally {
+                            this.lastSnapshotTime = lastWriteTime;
+                        }
                     }
                 } catch (final Exception e) {
                     LOGGER.error(e::getMessage, e);
@@ -426,20 +410,10 @@ private void createZip(final Path zipFile,
 
     @Override
     public <R> R get(final Function<Db<?, ?>, R> function) {
-        try {
-            final Db<?, ?> db = this.db;
-            if (db != null) {
-                return function.apply(db);
-            }
-        } catch (final LmdbException e) {
-            LOGGER.debug(e::getMessage, e);
-        }
-
-        // Try again under lock.
         try {
             readLock.lockInterruptibly();
             try {
-                if (!open) {
+                if (db == null) {
                     throw new RuntimeException("Database is closed");
                 }
                 return function.apply(db);
@@ -456,12 +430,15 @@ public void cleanup() {
 
     }
 
+    /**
+     * Must only be called during construction (before the object is published) or while holding
+     * {@code exclusiveReadLock}.
+     */
     private void open() {
-        if (!open) {
+        if (db == null) {
             if (Files.exists(shardDir)) {
                 LOGGER.info(() -> "Found local shard for '" + doc.asDocRef() + "'");
                 db = PlanBDb.open(doc, shardDir, byteBuffers, byteBufferFactory, false);
-                open = true;
 
             } else {
                 // If this node is supposed to be a node that stores shards, but it doesn't have it, then error.
@@ -472,11 +449,16 @@ private void open() {
         }
     }
 
+    /**
+     * Must only be called while holding {@code exclusiveReadLock}.
+     */
     private void close() {
-        if (open) {
-            db.close();
-            db = null;
-            open = false;
+        if (db != null) {
+            try {
+                db.close();
+            } finally {
+                db = null;
+            }
         }
     }
 
@@ -487,20 +469,10 @@ public PlanBDoc getDoc() {
 
     @Override
     public String getInfo() {
-        try {
-            final Db<?, ?> db = this.db;
-            if (db != null) {
-                return db.getInfoString();
-            }
-        } catch (final LmdbException e) {
-            LOGGER.debug(e::getMessage, e);
-        }
-
-        // Try again under lock.
         try {
             readLock.lockInterruptibly();
             try {
-                if (!open) {
+                if (db == null) {
                     throw new RuntimeException("Database is closed");
                 }
                 return db.getInfoString();
diff --git a/stroom-util/src/main/java/stroom/util/io/SimplePathCreator.java b/stroom-util/src/main/java/stroom/util/io/SimplePathCreator.java
@@ -25,6 +25,7 @@
 import java.nio.file.Paths;
 import java.time.ZoneOffset;
 import java.time.ZonedDateTime;
+import java.time.temporal.ChronoField;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -90,7 +91,7 @@ public String replaceTimeVars(String path, final ZonedDateTime dateTime) {
         path = replace(path, "hour", dateTime::getHour, 2);
         path = replace(path, "minute", dateTime::getMinute, 2);
         path = replace(path, "second", dateTime::getSecond, 2);
-        path = replace(path, "millis", () -> dateTime.toInstant().toEpochMilli(), 3);
+        path = replace(path, "millis", () -> dateTime.getLong(ChronoField.MILLI_OF_SECOND), 3);
         path = replace(path, "ms", () -> dateTime.toInstant().toEpochMilli(), 0);
 
         return path;
