[Fix #2175] Hide json variables for DB not supporting it

apache · Feb 24, 2025 · 5a58418 · 5a58418
1 parent 1f2bad3
commit 5a58418
Show file tree

Hide file tree

Showing 13 changed files with 46 additions and 23 deletions.
diff --git a/...ndex-graphql/src/main/java/org/kie/kogito/index/graphql/AbstractGraphQLSchemaManager.java b/...ndex-graphql/src/main/java/org/kie/kogito/index/graphql/AbstractGraphQLSchemaManager.java
@@ -40,8 +40,8 @@
 import org.kie.kogito.index.model.UserTaskInstance;
 import org.kie.kogito.index.service.DataIndexServiceException;
 import org.kie.kogito.index.storage.DataIndexStorageService;
-import org.kie.kogito.index.storage.StorageServiceCapability;
 import org.kie.kogito.persistence.api.StorageFetcher;
+import org.kie.kogito.persistence.api.StorageServiceCapability;
 import org.kie.kogito.persistence.api.query.Query;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -116,6 +116,12 @@ protected final void addCountQueries(TypeDefinitionRegistry typeRegistry) {
         }
     }
 
+    protected final void addJsonQueries(TypeDefinitionRegistry typeRegistry) {
+        if (cacheService.capabilities().contains(StorageServiceCapability.JSON_QUERY)) {
+            typeRegistry.merge(loadSchemaDefinitionFile("json.schema.graphqls"));
+        }
+    }
+
     protected final void addCountQueries(Builder builder) {
         if (supportsCount()) {
             builder.dataFetcher("CountProcessInstances", this::countProcessInstances);

diff --git a/data-index/data-index-graphql/src/main/resources/basic.schema.graphqls b/data-index/data-index-graphql/src/main/resources/basic.schema.graphqls
@@ -69,7 +69,6 @@ input ProcessDefinitionArgument {
     serviceUrl: StringArgument
     description: StringArgument
     type: StringArgument
-    metadata: JSON
 }
 
 type ProcessInstance {
@@ -183,7 +182,6 @@ input ProcessInstanceArgument {
     id: IdArgument
     processId: StringArgument
     processName: StringArgument
-    variables: JSON
     parentProcessInstanceId: IdArgument
     rootProcessInstanceId: IdArgument
     rootProcessId: StringArgument

diff --git a/data-index/data-index-graphql/src/main/resources/json.schema.graphqls b/data-index/data-index-graphql/src/main/resources/json.schema.graphqls
@@ -0,0 +1,7 @@
+extend input ProcessInstanceArgument {
+  variables: JSON
+}
+
+extend input ProcessDefinitionArgument {
+  metadata: JSON
+}
diff --git a/...e-common/src/main/java/org/kie/kogito/index/service/graphql/GraphQLSchemaManagerImpl.java b/...e-common/src/main/java/org/kie/kogito/index/service/graphql/GraphQLSchemaManagerImpl.java
@@ -75,6 +75,7 @@ public GraphQLSchema createSchema() {
         typeDefinitionRegistry.merge(loadSchemaDefinitionFile("basic.schema.graphqls"));
         typeDefinitionRegistry.merge(loadSchemaDefinitionFile("domain.schema.graphqls"));
         addCountQueries(typeDefinitionRegistry);
+        addJsonQueries(typeDefinitionRegistry);
         loadAdditionalMutations(typeDefinitionRegistry);
 
         RuntimeWiring runtimeWiring = RuntimeWiring.newRuntimeWiring()

diff --git a/...index-storage-api/src/main/java/org/kie/kogito/index/storage/DataIndexStorageService.java b/...index-storage-api/src/main/java/org/kie/kogito/index/storage/DataIndexStorageService.java
@@ -25,6 +25,7 @@
 import org.kie.kogito.index.model.ProcessDefinition;
 import org.kie.kogito.index.model.ProcessDefinitionKey;
 import org.kie.kogito.persistence.api.Storage;
+import org.kie.kogito.persistence.api.StorageServiceCapability;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 

diff --git a/...ndex-storage-api/src/main/java/org/kie/kogito/index/storage/StorageServiceCapability.java b/...ndex-storage-api/src/main/java/org/kie/kogito/index/storage/StorageServiceCapability.java
diff --git a/...jpa-common/src/main/java/org/kie/kogito/index/jpa/storage/JPADataIndexStorageService.java b/...jpa-common/src/main/java/org/kie/kogito/index/jpa/storage/JPADataIndexStorageService.java
@@ -18,17 +18,16 @@
  */
 package org.kie.kogito.index.jpa.storage;
 
-import java.util.EnumSet;
 import java.util.Set;
 
 import org.kie.kogito.index.model.Job;
 import org.kie.kogito.index.model.ProcessDefinition;
 import org.kie.kogito.index.model.ProcessDefinitionKey;
 import org.kie.kogito.index.storage.DataIndexStorageService;
 import org.kie.kogito.index.storage.ProcessInstanceStorage;
-import org.kie.kogito.index.storage.StorageServiceCapability;
 import org.kie.kogito.index.storage.UserTaskInstanceStorage;
 import org.kie.kogito.persistence.api.Storage;
+import org.kie.kogito.persistence.api.StorageServiceCapability;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
@@ -87,6 +86,6 @@ public Storage<String, String> getProcessIdModelCache() {
 
     @Override
     public Set<StorageServiceCapability> capabilities() {
-        return EnumSet.of(StorageServiceCapability.COUNT);
+        return processInstanceStorage.capabilities();
     }
 }
diff --git a/...a-common/src/main/java/org/kie/kogito/index/jpa/storage/ProcessInstanceEntityStorage.java b/...a-common/src/main/java/org/kie/kogito/index/jpa/storage/ProcessInstanceEntityStorage.java
@@ -20,6 +20,7 @@
 
 import java.time.ZonedDateTime;
 import java.util.ArrayList;
+import java.util.EnumSet;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
@@ -47,6 +48,7 @@
 import org.kie.kogito.index.model.MilestoneStatus;
 import org.kie.kogito.index.model.ProcessInstance;
 import org.kie.kogito.index.storage.ProcessInstanceStorage;
+import org.kie.kogito.persistence.api.StorageServiceCapability;
 
 import io.quarkus.arc.DefaultBean;
 
@@ -234,4 +236,8 @@ private void indexVariable(ProcessInstanceEntity pi, ProcessInstanceVariableEven
     private void indexSla(ProcessInstanceEntity orInit, ProcessInstanceSLAEventBody data) {
         // SLA does nothing for now
     }
+
+    public Set<StorageServiceCapability> capabilities() {
+        return EnumSet.of(StorageServiceCapability.COUNT);
+    }
 }
diff --git a/...on/src/test/java/org/kie/kogito/index/jpa/query/AbstractProcessInstanceEntityQueryIT.java b/...on/src/test/java/org/kie/kogito/index/jpa/query/AbstractProcessInstanceEntityQueryIT.java
@@ -18,14 +18,8 @@
  */
 package org.kie.kogito.index.jpa.query;
 
-import java.util.List;
-import java.util.UUID;
-
 import org.junit.jupiter.api.Test;
-import org.kie.kogito.event.process.ProcessInstanceVariableDataEvent;
 import org.kie.kogito.index.jpa.storage.ProcessInstanceEntityStorage;
-import org.kie.kogito.index.storage.ProcessInstanceStorage;
-import org.kie.kogito.index.test.TestUtils;
 import org.kie.kogito.index.test.query.AbstractProcessInstanceQueryIT;
 
 import jakarta.inject.Inject;
@@ -44,12 +38,6 @@ public ProcessInstanceEntityStorage getStorage() {
 
     @Test
     void testCount() {
-        String processId = "persons";
-        String processInstanceId = UUID.randomUUID().toString();
-        ProcessInstanceStorage storage = getStorage();
-        ProcessInstanceVariableDataEvent variableEvent = TestUtils.createProcessInstanceVariableEvent(processInstanceId, processId, "John", 28, false,
-                List.of("Super", "Astonishing", "TheRealThing"));
-        storage.indexVariable(variableEvent);
         assertThat(storage.query().count()).isOne();
     }
 }
diff --git a/...src/main/java/org/kie/kogito/index/postgresql/PostgresqlProcessInstanceEntityStorage.java b/...src/main/java/org/kie/kogito/index/postgresql/PostgresqlProcessInstanceEntityStorage.java
@@ -18,10 +18,14 @@
  */
 package org.kie.kogito.index.postgresql;
 
+import java.util.EnumSet;
+import java.util.Set;
+
 import org.kie.kogito.index.jpa.mapper.ProcessInstanceEntityMapper;
 import org.kie.kogito.index.jpa.model.ProcessInstanceEntityRepository;
 import org.kie.kogito.index.jpa.storage.ProcessInstanceEntityStorage;
 import org.kie.kogito.index.model.ProcessInstance;
+import org.kie.kogito.persistence.api.StorageServiceCapability;
 import org.kie.kogito.persistence.api.query.Query;
 
 import jakarta.enterprise.context.ApplicationScoped;
@@ -39,4 +43,8 @@ public PostgresqlProcessInstanceEntityStorage(ProcessInstanceEntityRepository re
     public Query<ProcessInstance> query() {
         return new PostgresqlJsonJPAQuery<>(repository, mapToModel, entityClass);
     }
+
+    public Set<StorageServiceCapability> capabilities() {
+        return EnumSet.allOf(StorageServiceCapability.class);
+    }
 }
diff --git a/...ntime/src/main/java/org/kie/kogito/index/addon/graphql/GraphQLAddonSchemaManagerImpl.java b/...ntime/src/main/java/org/kie/kogito/index/addon/graphql/GraphQLAddonSchemaManagerImpl.java
@@ -35,6 +35,7 @@ public GraphQLSchema createSchema() {
         TypeDefinitionRegistry typeDefinitionRegistry = new TypeDefinitionRegistry();
         typeDefinitionRegistry.merge(loadSchemaDefinitionFile("basic.schema.graphqls"));
         addCountQueries(typeDefinitionRegistry);
+        addJsonQueries(typeDefinitionRegistry);
         loadAdditionalMutations(typeDefinitionRegistry);
 
         RuntimeWiring runtimeWiring = RuntimeWiring.newRuntimeWiring()

diff --git a/.../persistence-commons-api/src/main/java/org/kie/kogito/persistence/api/StorageFetcher.java b/.../persistence-commons-api/src/main/java/org/kie/kogito/persistence/api/StorageFetcher.java
@@ -18,6 +18,9 @@
  */
 package org.kie.kogito.persistence.api;
 
+import java.util.EnumSet;
+import java.util.Set;
+
 import org.kie.kogito.persistence.api.query.Query;
 
 import io.smallrye.mutiny.Multi;
@@ -45,6 +48,10 @@ public interface StorageFetcher<K, V> {
      */
     Query<V> query();
 
+    default Set<StorageServiceCapability> capabilities() {
+        return EnumSet.noneOf(StorageServiceCapability.class);
+    }
+
     /**
      * Gets an element by key. If the element is not present in the storage, then `null` is returned.
      *

diff --git a/...ce-commons-api/src/main/java/org/kie/kogito/persistence/api/StorageServiceCapability.java b/...ce-commons-api/src/main/java/org/kie/kogito/persistence/api/StorageServiceCapability.java
@@ -0,0 +1,6 @@
+package org.kie.kogito.persistence.api;
+
+public enum StorageServiceCapability {
+    COUNT,
+    JSON_QUERY
+}