Merge pull request #51 from protegeproject/async-events

matthewhorridge · web-flow · commit 62dde7107ed0 · 2025-10-07T17:08:08.000-07:00
Add change request ids to entity creation actions
diff --git a/pom.xml b/pom.xml
@@ -14,7 +14,7 @@
     <description>This library defines an API for the webprotege-backend service</description>
     <groupId>edu.stanford.protege</groupId>
     <artifactId>webprotege-backend-api</artifactId>
-    <version>3.1.5</version>
+    <version>4.0.0-SNAPSHOT</version>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <guava.version>28.0</guava.version>
diff --git a/src/main/java/edu/stanford/protege/webprotege/entity/CreateAnnotationPropertiesResult.java b/src/main/java/edu/stanford/protege/webprotege/entity/CreateAnnotationPropertiesResult.java
@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.google.common.collect.ImmutableSet;
+import edu.stanford.protege.webprotege.common.ChangeRequestId;
 import edu.stanford.protege.webprotege.common.ProjectId;
 import org.semanticweb.owlapi.model.OWLAnnotationProperty;
 
@@ -18,6 +19,7 @@
 
 @JsonTypeName("webprotege.entities.CreateAnnotationProperties")
 public record CreateAnnotationPropertiesResult(@JsonProperty("projectId") @Nonnull ProjectId projectId,
-                                               @JsonProperty("entities") @Nonnull ImmutableSet<EntityNode> entities) implements CreateEntitiesInHierarchyResult<OWLAnnotationProperty> {
+                                               @JsonProperty("entities") @Nonnull ImmutableSet<EntityNode> entities,
+                                               @JsonProperty("changeRequestId") ChangeRequestId changeRequestId) implements CreateEntitiesInHierarchyResult<OWLAnnotationProperty> {
 
 }
diff --git a/src/main/java/edu/stanford/protege/webprotege/entity/CreateClassesAction.java b/src/main/java/edu/stanford/protege/webprotege/entity/CreateClassesAction.java
@@ -37,6 +37,12 @@ public record CreateClassesAction(ChangeRequestId changeRequestId,
 
     public static final String CHANNEL = "webprotege.entities.CreateClasses";
 
+    public CreateClassesAction {
+        if(changeRequestId == null) {
+            changeRequestId = ChangeRequestId.generate();
+        }
+    }
+
     @Override
     public String getChannel() {
         return CHANNEL;
diff --git a/src/main/java/edu/stanford/protege/webprotege/entity/CreateDataPropertiesResult.java b/src/main/java/edu/stanford/protege/webprotege/entity/CreateDataPropertiesResult.java
@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.google.common.collect.ImmutableSet;
+import edu.stanford.protege.webprotege.common.ChangeRequestId;
 import edu.stanford.protege.webprotege.common.ProjectId;
 import edu.stanford.protege.webprotege.dispatch.Result;
 
@@ -13,5 +14,6 @@
  */
 @JsonTypeName("webprotege.entities.CreateDataProperties")
 public record CreateDataPropertiesResult(ProjectId projectId,
-                                         ImmutableSet<EntityNode> entities) implements Result {
+                                         ImmutableSet<EntityNode> entities,
+                                         ChangeRequestId changeRequestId) implements Result {
 }
diff --git a/src/main/java/edu/stanford/protege/webprotege/entity/CreateNamedIndividualsResult.java b/src/main/java/edu/stanford/protege/webprotege/entity/CreateNamedIndividualsResult.java
@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.google.common.collect.ImmutableSet;
+import edu.stanford.protege.webprotege.common.ChangeRequestId;
 import edu.stanford.protege.webprotege.common.ProjectId;
 import edu.stanford.protege.webprotege.dispatch.Result;
 
@@ -15,5 +16,6 @@
  */
 @JsonTypeName("webprotege.entities.CreateNamedIndividuals")
 public record CreateNamedIndividualsResult(@Nonnull ProjectId projectId,
-                                                   ImmutableSet<EntityNode> entities) implements Result {
+                                           ImmutableSet<EntityNode> entities,
+                                           ChangeRequestId changeRequestId) implements Result {
 }
diff --git a/src/main/java/edu/stanford/protege/webprotege/entity/CreateObjectPropertiesResult.java b/src/main/java/edu/stanford/protege/webprotege/entity/CreateObjectPropertiesResult.java
@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.google.common.collect.ImmutableSet;
+import edu.stanford.protege.webprotege.common.ChangeRequestId;
 import edu.stanford.protege.webprotege.common.ProjectId;
 import org.semanticweb.owlapi.model.OWLObjectProperty;
 
@@ -18,6 +19,7 @@
 
 @JsonTypeName("webprotege.entities.CreateObjectProperties")
 public record CreateObjectPropertiesResult(@JsonProperty("projectId") @Nonnull ProjectId projectId,
-                                           @JsonProperty("entities") @Nonnull ImmutableSet<EntityNode> entities) implements CreateEntitiesInHierarchyResult<OWLObjectProperty> {
+                                           @JsonProperty("entities") @Nonnull ImmutableSet<EntityNode> entities,
+                                           @JsonProperty("changeRequestId") ChangeRequestId changeRequestId) implements CreateEntitiesInHierarchyResult<OWLObjectProperty> {
 
 }
diff --git a/src/main/java/edu/stanford/protege/webprotege/hierarchy/EntityHierarchyChangedEvent.java b/src/main/java/edu/stanford/protege/webprotege/hierarchy/EntityHierarchyChangedEvent.java
@@ -4,6 +4,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
+import edu.stanford.protege.webprotege.common.ChangeRequestId;
 import edu.stanford.protege.webprotege.common.EventId;
 import edu.stanford.protege.webprotege.common.ProjectEvent;
 import edu.stanford.protege.webprotege.common.ProjectId;
@@ -18,15 +19,17 @@
 public record EntityHierarchyChangedEvent(@JsonProperty("eventId") @Nonnull EventId eventId,
                                           @JsonProperty("projectId") @Nonnull ProjectId projectId,
                                           @JsonProperty("hierarchyDescriptor") @Nonnull HierarchyDescriptor hierarchyDescriptor,
-                                          @JsonProperty("changeEvent") @Nonnull GraphModelChangedEvent changeEvent) implements ProjectEvent {
+                                          @JsonProperty("changeEvent") @Nonnull GraphModelChangedEvent changeEvent,
+                                          @JsonProperty("changeRequestId") ChangeRequestId changeRequestId) implements ProjectEvent {
 
     public static final String CHANNEL = "webprotege.events.hierarchies.EntityHierarchyChanged";
 
-    public EntityHierarchyChangedEvent(@JsonProperty("eventId") @Nonnull EventId eventId, @JsonProperty("projectId") @Nonnull ProjectId projectId, @JsonProperty("hierarchyDescriptor") @Nonnull HierarchyDescriptor hierarchyDescriptor, @JsonProperty("changeEvent") @Nonnull GraphModelChangedEvent changeEvent) {
+    public EntityHierarchyChangedEvent(@JsonProperty("eventId") @Nonnull EventId eventId, @JsonProperty("projectId") @Nonnull ProjectId projectId, @JsonProperty("hierarchyDescriptor") @Nonnull HierarchyDescriptor hierarchyDescriptor, @JsonProperty("changeEvent") @Nonnull GraphModelChangedEvent changeEvent, @JsonProperty("changeRequestId") ChangeRequestId changeRequestId) {
         this.eventId = Objects.requireNonNull(eventId);
         this.projectId = Objects.requireNonNull(projectId);
         this.hierarchyDescriptor = Objects.requireNonNull(hierarchyDescriptor);
         this.changeEvent = Objects.requireNonNull(changeEvent);
+        this.changeRequestId = Objects.requireNonNull(changeRequestId);
     }
 
     @Override
diff --git a/src/test/java/edu/stanford/protege/webprotege/dispatch/actions/CreateAnnotationProperties_Serialization_TestCase.java b/src/test/java/edu/stanford/protege/webprotege/dispatch/actions/CreateAnnotationProperties_Serialization_TestCase.java
@@ -34,7 +34,7 @@ public void shouldSerializeAction() throws IOException {
     @Test
     public void shouldSerializeResult() throws IOException {
         var result = new CreateAnnotationPropertiesResult(ProjectId.generate(),
-                ImmutableSet.of());
+                ImmutableSet.of(), ChangeRequestId.generate());
 
     }
 }
diff --git a/src/test/java/edu/stanford/protege/webprotege/dispatch/actions/CreateDataProperties_Serialization_TestCase.java b/src/test/java/edu/stanford/protege/webprotege/dispatch/actions/CreateDataProperties_Serialization_TestCase.java
@@ -33,7 +33,7 @@ public void shouldSerializeAction() throws IOException {
     @Test
     public void shouldSerializeResult() throws IOException {
         var result = new CreateDataPropertiesResult(ProjectId.generate(),
-                ImmutableSet.of());
+                ImmutableSet.of(), ChangeRequestId.generate());
 
     }
 }
diff --git a/src/test/java/edu/stanford/protege/webprotege/dispatch/actions/CreateNamedIndividuals_Serialization_TestCase.java b/src/test/java/edu/stanford/protege/webprotege/dispatch/actions/CreateNamedIndividuals_Serialization_TestCase.java
@@ -34,7 +34,7 @@ public void shouldSerializeAction() throws IOException {
     @Test
     public void shouldSerializeResult() throws IOException {
         var result = new CreateNamedIndividualsResult(ProjectId.generate(),
-                ImmutableSet.of());
+                ImmutableSet.of(), ChangeRequestId.generate());
 
     }
 }
diff --git a/src/test/java/edu/stanford/protege/webprotege/dispatch/actions/CreateObjectProperties_Serialization_TestCase.java b/src/test/java/edu/stanford/protege/webprotege/dispatch/actions/CreateObjectProperties_Serialization_TestCase.java
@@ -44,7 +44,8 @@ public void shouldSerializeAction() throws IOException {
     @Test
     public void shouldSerializeResult() throws IOException {
         var result = new CreateObjectPropertiesResult(ProjectId.generate(),
-                ImmutableSet.of());
+                ImmutableSet.of(),
+                ChangeRequestId.generate());
 
     }
 }
diff --git a/src/test/java/edu/stanford/protege/webprotege/hierarchy/EntityHierarchyChangedEventJsonTest.java b/src/test/java/edu/stanford/protege/webprotege/hierarchy/EntityHierarchyChangedEventJsonTest.java
@@ -1,6 +1,7 @@
 package edu.stanford.protege.webprotege.hierarchy;
 
 import com.google.common.collect.ImmutableList;
+import edu.stanford.protege.webprotege.common.ChangeRequestId;
 import edu.stanford.protege.webprotege.common.EventId;
 import edu.stanford.protege.webprotege.common.ProjectId;
 import org.junit.jupiter.api.Test;
@@ -41,7 +42,7 @@ void testSerializeEntityHierarchyChangedEvent() throws Exception {
         var changeEvent = GraphModelChangedEvent.create(ImmutableList.of(new AddEdge<>(new GraphEdge<>(new GraphNode<>("A"), new GraphNode<>("B")))));
 
         // Create an EntityHierarchyChangedEvent instance
-        EntityHierarchyChangedEvent event = new EntityHierarchyChangedEvent(eventId, projectId, hierarchyDescriptor, changeEvent);
+        EntityHierarchyChangedEvent event = new EntityHierarchyChangedEvent(eventId, projectId, hierarchyDescriptor, changeEvent, ChangeRequestId.generate());
 
         // Serialize to JSON
         JsonContent<EntityHierarchyChangedEvent> json = jacksonTester.write(event);
@@ -67,6 +68,7 @@ void testDeserializeEntityHierarchyChangedEvent() throws Exception {
                     "@type": "webprotege.events.hierarchies.EntityHierarchyChanged",
                     "eventId": "event-id",
                     "projectId": "00000000-1111-2222-3333-444444444444",
+                    "changeRequestId" : "ff0a2d71-d93c-41cd-b66e-2db58e9f4c1e",
                     "hierarchyDescriptor": {
                         "@type": "ClassHierarchyDescriptor",
                         "roots": [
@@ -91,6 +93,7 @@ void testDeserializeEntityHierarchyChangedEvent() throws Exception {
         assertThat(event).isNotNull();
         assertThat(event.eventId().id()).isEqualTo(EVENT_ID);
         assertThat(event.projectId().id()).isEqualTo(PROJECT_ID);
+        assertThat(event.changeRequestId().id()).isEqualTo("ff0a2d71-d93c-41cd-b66e-2db58e9f4c1e");
 
         // Assert HierarchyDescriptor
         assertThat(event.hierarchyDescriptor()).isInstanceOf(ClassHierarchyDescriptor.class);
diff --git a/src/test/java/edu/stanford/protege/webprotege/hierarchy/EntityHierarchyChangedEventTest.java b/src/test/java/edu/stanford/protege/webprotege/hierarchy/EntityHierarchyChangedEventTest.java
@@ -1,6 +1,7 @@
 package edu.stanford.protege.webprotege.hierarchy;
 
 import com.google.common.collect.ImmutableList;
+import edu.stanford.protege.webprotege.common.ChangeRequestId;
 import edu.stanford.protege.webprotege.common.EventId;
 import edu.stanford.protege.webprotege.common.ProjectId;
 import edu.stanford.protege.webprotege.jackson.WebProtegeJacksonApplication;
@@ -33,22 +34,25 @@ void shouldSerializeToJson() throws IOException {
         var event = new EntityHierarchyChangedEvent(EventId.generate(),
                 ProjectId.generate(),
                 ClassHierarchyDescriptor.create(),
-                GraphModelChangedEvent.create(ImmutableList.of()));
+                GraphModelChangedEvent.create(ImmutableList.of()),
+                ChangeRequestId.generate());
         var json = tester.write(event);
         assertThat(json).hasJsonPathStringValue("projectId");
+        assertThat(json).hasJsonPathStringValue("changeRequestId");
         assertThat(json).hasJsonPathStringValue("eventId");
         assertThat(json).hasJsonPathMapValue("hierarchyDescriptor");
     }
 
     @Test
     void shouldDeserializeFromJson() throws IOException {
         var json = """
-                {"@type":"webprotege.events.hierarchies.EntityHierarchyChanged","eventId":"08adfb16-60cf-49f9-b82b-689302d11e91","projectId":"bd6b3b60-735c-42ee-8aa9-df6fcca6b0ee","hierarchyDescriptor":{"@type":"ClassHierarchyDescriptor","roots":[{"@type":"Class","iri":"http://www.w3.org/2002/07/owl#Thing"}]},"changeEvent":{"changes":[]}}
+                {"@type":"webprotege.events.hierarchies.EntityHierarchyChanged","eventId":"08adfb16-60cf-49f9-b82b-689302d11e91","projectId":"bd6b3b60-735c-42ee-8aa9-df6fcca6b0ee","changeRequestId":"30776dce-44a0-4a4e-98c5-022f70ca34b8","hierarchyDescriptor":{"@type":"ClassHierarchyDescriptor","roots":[{"@type":"Class","iri":"http://www.w3.org/2002/07/owl#Thing"}]},"changeEvent":{"changes":[]}}
                 """;
         var obj = tester.read(new StringReader(json));
         var event = obj.getObject();
         assertThat(event.eventId().id()).isEqualTo("08adfb16-60cf-49f9-b82b-689302d11e91");
         assertThat(event.projectId().id()).isEqualTo("bd6b3b60-735c-42ee-8aa9-df6fcca6b0ee");
+        assertThat(event.changeRequestId().id()).isEqualTo("30776dce-44a0-4a4e-98c5-022f70ca34b8");
         assertThat(event.hierarchyDescriptor()).isNotNull();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public void shouldSerializeAction() throws IOException {`
`34`	`34`	`@Test`
`35`	`35`	`public void shouldSerializeResult() throws IOException {`
`36`	`36`	`var result = new CreateAnnotationPropertiesResult(ProjectId.generate(),`
`37`		`- ImmutableSet.of());`
	`37`	`+ ImmutableSet.of(), ChangeRequestId.generate());`
`38`	`38`
`39`	`39`	`}`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public void shouldSerializeAction() throws IOException {`
`33`	`33`	`@Test`
`34`	`34`	`public void shouldSerializeResult() throws IOException {`
`35`	`35`	`var result = new CreateDataPropertiesResult(ProjectId.generate(),`
`36`		`- ImmutableSet.of());`
	`36`	`+ ImmutableSet.of(), ChangeRequestId.generate());`
`37`	`37`
`38`	`38`	`}`
`39`	`39`	`}`