From c7a86623b1589a3bd68a84a8d54a1eadc1aacefb Mon Sep 17 00:00:00 2001
From: Kristóf Marussy <kristof@marussy.com>
Date: Sun, 10 Sep 2023 23:07:11 +0200
Subject: fix: VIATRA projection indexer error

When a projection indexer is constructed for a production node, the projection
memory is only populated if changes are being propagated. The cache doesn't get
populated even if changes are flushed afterwards. This not only returns invalid
query results, but also a duplicate deletion exception will be thrown when the
production node tries to delete a tuple from the index memory.

To counteract this issue, we enable update propagation while a matcher (and its
associated indexers) are being created.
---
 .../viatra/runtime/api/ViatraQueryEngine.java      |  3 ++
 .../internal/apiimpl/ViatraQueryEngineImpl.java    | 51 +++++++++++++++-------
 2 files changed, 39 insertions(+), 15 deletions(-)

(limited to 'subprojects/viatra-runtime/src/main')

diff --git a/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/api/ViatraQueryEngine.java b/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/api/ViatraQueryEngine.java
index 4c603a47..0f402b49 100644
--- a/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/api/ViatraQueryEngine.java
+++ b/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/api/ViatraQueryEngine.java
@@ -15,6 +15,7 @@ import tools.refinery.viatra.runtime.api.scope.QueryScope;
 import tools.refinery.viatra.runtime.matchers.ViatraQueryRuntimeException;
 
 import java.util.Set;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 /**
@@ -147,4 +148,6 @@ public abstract class ViatraQueryEngine {
     public abstract QueryScope getScope();
 
 	public abstract void flushChanges();
+
+	public abstract <T> T withFlushingChanges(Supplier<T> supplier);
 }
diff --git a/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/internal/apiimpl/ViatraQueryEngineImpl.java b/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/internal/apiimpl/ViatraQueryEngineImpl.java
index 47a51629..5317a79e 100644
--- a/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/internal/apiimpl/ViatraQueryEngineImpl.java
+++ b/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/internal/apiimpl/ViatraQueryEngineImpl.java
@@ -41,6 +41,7 @@ import java.lang.ref.WeakReference;
 import java.lang.reflect.InvocationTargetException;
 import java.util.*;
 import java.util.concurrent.Callable;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 import static tools.refinery.viatra.runtime.matchers.util.Preconditions.checkArgument;
@@ -164,9 +165,27 @@ public final class ViatraQueryEngineImpl extends AdvancedViatraQueryEngine
 		}
 		delayMessageDelivery = false;
 		try {
-			for (IQueryBackend backend : this.queryBackends.values()) {
-				backend.flushUpdates();
-			}
+			flushAllBackends();
+		} finally {
+			delayMessageDelivery = true;
+		}
+	}
+
+	private void flushAllBackends() {
+		for (IQueryBackend backend : this.queryBackends.values()) {
+			backend.flushUpdates();
+		}
+	}
+
+	@Override
+	public <T> T withFlushingChanges(Supplier<T> callback) {
+		if (!delayMessageDelivery) {
+			return callback.get();
+		}
+		delayMessageDelivery = false;
+		try {
+			flushAllBackends();
+			return callback.get();
 		} finally {
 			delayMessageDelivery = true;
 		}
@@ -186,18 +205,20 @@ public final class ViatraQueryEngineImpl extends AdvancedViatraQueryEngine
     @Override
     public <Matcher extends ViatraQueryMatcher<? extends IPatternMatch>> Matcher getMatcher(
             IQuerySpecification<Matcher> querySpecification, QueryEvaluationHint optionalEvaluationHints) {
-        IMatcherCapability capability = getRequestedCapability(querySpecification, optionalEvaluationHints);
-        Matcher matcher = doGetExistingMatcher(querySpecification, capability);
-        if (matcher != null) {
-            return matcher;
-        }
-        matcher = querySpecification.instantiate();
-
-        BaseMatcher<?> baseMatcher = (BaseMatcher<?>) matcher;
-        ((QueryResultWrapper) baseMatcher).setBackend(this,
-                getResultProvider(querySpecification, optionalEvaluationHints), capability);
-        internalRegisterMatcher(querySpecification, baseMatcher);
-        return matcher;
+		return withFlushingChanges(() -> {
+			IMatcherCapability capability = getRequestedCapability(querySpecification, optionalEvaluationHints);
+			Matcher matcher = doGetExistingMatcher(querySpecification, capability);
+			if (matcher != null) {
+				return matcher;
+			}
+			matcher = querySpecification.instantiate();
+
+			BaseMatcher<?> baseMatcher = (BaseMatcher<?>) matcher;
+			((QueryResultWrapper) baseMatcher).setBackend(this,
+					getResultProvider(querySpecification, optionalEvaluationHints), capability);
+			internalRegisterMatcher(querySpecification, baseMatcher);
+			return matcher;
+		});
     }
 
     @Override
-- 
cgit v1.2.3-70-g09d2