feat: track uncommitted Model changes

8 files changed, 82 insertions, 33 deletions

diff --git a/subprojects/store-query-viatra/src/test/java/tools/refinery/store/query/viatra/QueryTest.java b/subprojects/store-query-viatra/src/test/java/tools/refinery/store/query/viatra/QueryTest.java
index ba0abca0..6a37b54a 100644
--- a/subprojects/store-query-viatra/src/test/java/tools/refinery/store/query/viatra/QueryTest.java
+++ b/subprojects/store-query-viatra/src/test/java/tools/refinery/store/query/viatra/QueryTest.java
@@ -38,7 +38,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var assetInterpretation = model.getInterpretation(asset);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -79,7 +79,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -127,7 +127,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -181,7 +181,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -233,7 +233,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var animalInterpretation = model.getInterpretation(animal);
                 var friendInterpretation = model.getInterpretation(friend);
@@ -278,7 +278,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
                 var predicateResultSet = queryEngine.getResultSet(predicate);
@@ -319,7 +319,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -372,7 +372,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -414,7 +414,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -467,7 +467,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -509,7 +509,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -559,7 +559,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -600,7 +600,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
@@ -652,7 +652,7 @@ class QueryTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
diff --git a/subprojects/store-query-viatra/src/test/java/tools/refinery/store/query/viatra/QueryTransactionTest.java b/subprojects/store-query-viatra/src/test/java/tools/refinery/store/query/viatra/QueryTransactionTest.java
index ec2e7647..98995339 100644
--- a/subprojects/store-query-viatra/src/test/java/tools/refinery/store/query/viatra/QueryTransactionTest.java
+++ b/subprojects/store-query-viatra/src/test/java/tools/refinery/store/query/viatra/QueryTransactionTest.java
@@ -31,7 +31,7 @@ class QueryTransactionTest {
                                 .queries(predicate)
                                 .build();
 
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var assetInterpretation = model.getInterpretation(asset);
                 var queryEngine = model.getAdapter(ModelQuery.ADAPTER);
diff --git a/subprojects/store/src/main/java/tools/refinery/store/model/Model.java b/subprojects/store/src/main/java/tools/refinery/store/model/Model.java
index 8d2a4614..6ca1ac7b 100644
--- a/subprojects/store/src/main/java/tools/refinery/store/model/Model.java
+++ b/subprojects/store/src/main/java/tools/refinery/store/model/Model.java
@@ -9,10 +9,14 @@ import tools.refinery.store.representation.Symbol;
 import java.util.Optional;
 
 public interface Model extends Versioned {
+        long NO_STATE_ID = -1;
+
         ModelStore getStore();
 
         long getState();
 
+        boolean hasUncommittedChanges();
+
         default AnyInterpretation getInterpretation(AnySymbol symbol) {
                 return getInterpretation((Symbol<?>) symbol);
         }
diff --git a/subprojects/store/src/main/java/tools/refinery/store/model/ModelStore.java b/subprojects/store/src/main/java/tools/refinery/store/model/ModelStore.java
index bc863d4b..2e7e62c3 100644
--- a/subprojects/store/src/main/java/tools/refinery/store/model/ModelStore.java
+++ b/subprojects/store/src/main/java/tools/refinery/store/model/ModelStore.java
@@ -12,9 +12,9 @@ import java.util.Set;
 public interface ModelStore {
         Collection<AnySymbol> getSymbols();
 
-        Model createModel();
+        Model createEmptyModel();
 
-        Model createModel(long state);
+        Model createModelForState(long state);
 
         Set<Long> getStates();
 
diff --git a/subprojects/store/src/main/java/tools/refinery/store/model/internal/ModelImpl.java b/subprojects/store/src/main/java/tools/refinery/store/model/internal/ModelImpl.java
index 10331e28..9eb438c4 100644
--- a/subprojects/store/src/main/java/tools/refinery/store/model/internal/ModelImpl.java
+++ b/subprojects/store/src/main/java/tools/refinery/store/model/internal/ModelImpl.java
@@ -18,8 +18,9 @@ public class ModelImpl implements Model {
         private Map<? extends AnySymbol, ? extends VersionedInterpretation<?>> interpretations;
         private final AdapterList<ModelAdapter> adapters;
         private final List<ModelListener> listeners = new ArrayList<>();
+        private boolean uncommittedChanges;
         private ModelAction pendingAction = ModelAction.NONE;
-        private long restoringToState = -1;
+        private long restoringToState = NO_STATE_ID;
 
         ModelImpl(ModelStore store, long state, int adapterCount) {
                 this.store = store;
@@ -61,9 +62,29 @@ public class ModelImpl implements Model {
                 return new ModelDiffCursor(diffCursors);
         }
 
+        private void setState(long state) {
+                this.state = state;
+                uncommittedChanges = false;
+        }
+
+        void markAsChanged() {
+                if (!uncommittedChanges) {
+                        uncommittedChanges = true;
+                }
+        }
+
+        @Override
+        public boolean hasUncommittedChanges() {
+                return uncommittedChanges;
+        }
+
+        private boolean hasPendingAction() {
+                return pendingAction != ModelAction.NONE || restoringToState != NO_STATE_ID;
+        }
+
         @Override
         public long commit() {
-                if (pendingAction != ModelAction.NONE) {
+                if (hasPendingAction()) {
                         throw pendingActionError("commit");
                 }
                 pendingAction = ModelAction.COMMIT;
@@ -88,7 +109,7 @@ public class ModelImpl implements Model {
                                         versionSet = true;
                                 }
                         }
-                        state = version;
+                        setState(version);
                         while (i < listenerCount) {
                                 listeners.get(i).afterCommit();
                                 i++;
@@ -101,7 +122,7 @@ public class ModelImpl implements Model {
 
         @Override
         public void restore(long version) {
-                if (pendingAction != ModelAction.NONE) {
+                if (hasPendingAction()) {
                         throw pendingActionError("restore to %d".formatted(version));
                 }
                 if (!store.getStates().contains(version)) {
@@ -119,14 +140,14 @@ public class ModelImpl implements Model {
                         for (var interpretation : interpretations.values()) {
                                 interpretation.restore(version);
                         }
-                        state = version;
+                        setState(version);
                         while (i < listenerCount) {
                                 listeners.get(i).afterRestore();
                                 i++;
                         }
                 } finally {
                         pendingAction = ModelAction.NONE;
-                        restoringToState = -1;
+                        restoringToState = NO_STATE_ID;
                 }
         }
 
diff --git a/subprojects/store/src/main/java/tools/refinery/store/model/internal/ModelStoreImpl.java b/subprojects/store/src/main/java/tools/refinery/store/model/internal/ModelStoreImpl.java
index 8aab57af..e8c205e4 100644
--- a/subprojects/store/src/main/java/tools/refinery/store/model/internal/ModelStoreImpl.java
+++ b/subprojects/store/src/main/java/tools/refinery/store/model/internal/ModelStoreImpl.java
@@ -6,6 +6,7 @@ import tools.refinery.store.adapter.ModelAdapterType;
 import tools.refinery.store.adapter.ModelStoreAdapter;
 import tools.refinery.store.map.DiffCursor;
 import tools.refinery.store.map.VersionedMapStore;
+import tools.refinery.store.model.Model;
 import tools.refinery.store.model.ModelDiffCursor;
 import tools.refinery.store.model.ModelStore;
 import tools.refinery.store.representation.AnySymbol;
@@ -27,13 +28,13 @@ public class ModelStoreImpl implements ModelStore {
                 return Collections.unmodifiableCollection(stores.keySet());
         }
 
-        private ModelImpl createEmptyModel(long state) {
+        private ModelImpl createModelWithoutInterpretations(long state) {
                 return new ModelImpl(this, state, adapters.size());
         }
 
         @Override
-        public ModelImpl createModel() {
-                var model = createEmptyModel(-1);
+        public ModelImpl createEmptyModel() {
+                var model = createModelWithoutInterpretations(Model.NO_STATE_ID);
                 var interpretations = new HashMap<AnySymbol, VersionedInterpretation<?>>(stores.size());
                 for (var entry : this.stores.entrySet()) {
                         var symbol = entry.getKey();
@@ -45,8 +46,8 @@ public class ModelStoreImpl implements ModelStore {
         }
 
         @Override
-        public synchronized ModelImpl createModel(long state) {
-                var model = createEmptyModel(state);
+        public synchronized ModelImpl createModelForState(long state) {
+                var model = createModelWithoutInterpretations(state);
                 var interpretations = new HashMap<AnySymbol, VersionedInterpretation<?>>(stores.size());
                 for (var entry : this.stores.entrySet()) {
                         var symbol = entry.getKey();
diff --git a/subprojects/store/src/main/java/tools/refinery/store/model/internal/VersionedInterpretation.java b/subprojects/store/src/main/java/tools/refinery/store/model/internal/VersionedInterpretation.java
index 1bdb1cdf..6d82f5d7 100644
--- a/subprojects/store/src/main/java/tools/refinery/store/model/internal/VersionedInterpretation.java
+++ b/subprojects/store/src/main/java/tools/refinery/store/model/internal/VersionedInterpretation.java
@@ -77,6 +77,7 @@ public class VersionedInterpretation<T> implements Interpretation<T> {
         @Override
         public T put(Tuple key, T value) {
                 checkKey(key);
+                model.markAsChanged();
                 var oldValue = map.put(key, value);
                 notifyListeners(key, oldValue, value, false);
                 return oldValue;
@@ -88,6 +89,7 @@ public class VersionedInterpretation<T> implements Interpretation<T> {
                         map.putAll(cursor);
                         return;
                 }
+                model.markAsChanged();
                 if (cursor.getDependingMaps().contains(map)) {
                         List<Tuple> keys = new ArrayList<>();
                         List<T> values = new ArrayList<>();
diff --git a/subprojects/store/src/test/java/tools/refinery/store/model/tests/ModelTest.java b/subprojects/store/src/test/java/tools/refinery/store/model/tests/ModelTest.java
index e7bff1f9..371b5e47 100644
--- a/subprojects/store/src/test/java/tools/refinery/store/model/tests/ModelTest.java
+++ b/subprojects/store/src/test/java/tools/refinery/store/model/tests/ModelTest.java
@@ -1,6 +1,7 @@
 package tools.refinery.store.model.tests;
 
 import org.junit.jupiter.api.Test;
+import tools.refinery.store.model.Model;
 import tools.refinery.store.model.ModelStore;
 import tools.refinery.store.representation.Symbol;
 import tools.refinery.store.tuple.Tuple;
@@ -30,7 +31,7 @@ class ModelTest {
                 var friend = new Symbol<>("friend", 2, Boolean.class, false);
 
                 var store = ModelStore.builder().symbols(person, age, friend).build();
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var ageInterpretation = model.getInterpretation(age);
                 var friendInterpretation = model.getInterpretation(friend);
@@ -59,7 +60,7 @@ class ModelTest {
                 var person = new Symbol<>("Person", 1, Boolean.class, false);
 
                 var store = ModelStore.builder().symbols(person).build();
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
 
                 final Tuple tuple3 = Tuple.of(1, 1, 1);
@@ -72,7 +73,7 @@ class ModelTest {
                 var age = new Symbol<>("age", 1, Integer.class, null);
 
                 var store = ModelStore.builder().symbols(age).build();
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var ageInterpretation = model.getInterpretation(age);
 
                 ageInterpretation.put(Tuple.of(1), null); // valid
@@ -88,7 +89,7 @@ class ModelTest {
                 var friend = new Symbol<>("friend", 2, Boolean.class, false);
 
                 var store = ModelStore.builder().symbols(person, age, friend).build();
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var ageInterpretation = model.getInterpretation(age);
                 var friendInterpretation = model.getInterpretation(friend);
@@ -116,7 +117,7 @@ class ModelTest {
                 var friend = new Symbol<>("friend", 2, Boolean.class, false);
 
                 var store = ModelStore.builder().symbols(person, friend).build();
-                var model = store.createModel();
+                var model = store.createEmptyModel();
                 var personInterpretation = model.getInterpretation(person);
                 var friendInterpretation = model.getInterpretation(friend);
 
@@ -124,25 +125,45 @@ class ModelTest {
                 personInterpretation.put(Tuple.of(1), true);
                 friendInterpretation.put(Tuple.of(0, 1), true);
                 friendInterpretation.put(Tuple.of(1, 0), true);
+
+                assertTrue(model.hasUncommittedChanges());
+                assertEquals(Model.NO_STATE_ID, model.getState());
+
                 long state1 = model.commit();
 
+                assertFalse(model.hasUncommittedChanges());
+                assertEquals(state1, model.getState());
+
                 assertFalse(personInterpretation.get(Tuple.of(2)));
                 assertFalse(friendInterpretation.get(Tuple.of(0, 2)));
 
                 personInterpretation.put(Tuple.of(2), true);
                 friendInterpretation.put(Tuple.of(0, 2), true);
+
+                assertTrue(model.hasUncommittedChanges());
+                assertEquals(state1, model.getState());
+
                 long state2 = model.commit();
 
+                assertFalse(model.hasUncommittedChanges());
+                assertEquals(state2, model.getState());
+
                 assertTrue(personInterpretation.get(Tuple.of(2)));
                 assertTrue(friendInterpretation.get(Tuple.of(0, 2)));
 
                 model.restore(state1);
 
+                assertFalse(model.hasUncommittedChanges());
+                assertEquals(state1, model.getState());
+
                 assertFalse(personInterpretation.get(Tuple.of(2)));
                 assertFalse(friendInterpretation.get(Tuple.of(0, 2)));
 
                 model.restore(state2);
 
+                assertFalse(model.hasUncommittedChanges());
+                assertEquals(state2, model.getState());
+
                 assertTrue(personInterpretation.get(Tuple.of(2)));
                 assertTrue(friendInterpretation.get(Tuple.of(0, 2)));
         }