[KIE-1492] Allow KieRuntimeBuilder to also create and provide Statele…

…ssKieSession
apache · Sep 25, 2024 · 98024d0 · 98024d0
1 parent 011e17a
commit 98024d0
Show file tree

Hide file tree

Showing 17 changed files with 214 additions and 156 deletions.
diff --git a/...ools-model-codegen/src/main/java/org/drools/model/codegen/execmodel/ModelSourceClass.java b/...ools-model-codegen/src/main/java/org/drools/model/codegen/execmodel/ModelSourceClass.java
@@ -211,6 +211,10 @@ public String getDefaultKieSessionName() {
             return defaultKieSessionName;
         }
 
+        public String getDefaultKieStatelessSessionName() {
+            return defaultKieStatelessSessionName;
+        }
+
         public Map<String, BlockStmt> getkSessionConfs() {
             return kSessionConfs;
         }

diff --git a/...model-codegen/src/main/java/org/drools/model/codegen/project/ProjectRuntimeGenerator.java b/...model-codegen/src/main/java/org/drools/model/codegen/project/ProjectRuntimeGenerator.java
@@ -90,31 +90,33 @@ private void writeInitKieBasesMethod(ClassOrInterfaceDeclaration clazz) {
     }
 
     private void writeGetDefaultKieBaseMethod(ClassOrInterfaceDeclaration clazz) {
-        MethodDeclaration getDefaultKieBaseMethod = clazz.findAll(MethodDeclaration.class).stream()
-                .filter(m -> m.getNameAsString().equals("getKieBase"))
-                .filter(m -> m.getParameters().isEmpty())
-                .findFirst()
-                .orElseThrow(() -> new InvalidTemplateException(generator, "Cannot find getKieBase method"));
-
         if (modelMethod.getDefaultKieBaseName() != null) {
-            getDefaultKieBaseMethod.findFirst(StringLiteralExpr.class)
+            findDefaultKieMethod(clazz, "getKieBase").findFirst(StringLiteralExpr.class)
                     .orElseThrow(() -> new InvalidTemplateException(generator, "Cannot find string inside getKieBase method"))
                     .setString(modelMethod.getDefaultKieBaseName());
         }
     }
 
     private void writeNewDefaultKieSessionMethod(ClassOrInterfaceDeclaration clazz) {
-        MethodDeclaration newDefaultKieSessionMethod = clazz.findAll(MethodDeclaration.class).stream()
-                .filter(m -> m.getNameAsString().equals("newKieSession"))
-                .filter(m -> m.getParameters().isEmpty())
-                .findFirst()
-                .orElseThrow(() -> new InvalidTemplateException(generator, "Cannot find newKieSession method"));
-
         if (modelMethod.getDefaultKieSessionName() != null) {
-            newDefaultKieSessionMethod.findFirst(StringLiteralExpr.class)
+            findDefaultKieMethod(clazz, "newKieSession").findFirst(StringLiteralExpr.class)
                     .orElseThrow(() -> new InvalidTemplateException(generator, "Cannot find string inside newKieSession method"))
                     .setString(modelMethod.getDefaultKieSessionName());
         }
+
+        if (modelMethod.getDefaultKieStatelessSessionName() != null) {
+            findDefaultKieMethod(clazz, "newStatelessKieSession").findFirst(StringLiteralExpr.class)
+                    .orElseThrow(() -> new InvalidTemplateException(generator, "Cannot find string inside newStatelessKieSession method"))
+                    .setString(modelMethod.getDefaultKieStatelessSessionName());
+        }
+    }
+
+    private MethodDeclaration findDefaultKieMethod(ClassOrInterfaceDeclaration clazz, String methodName) {
+        return clazz.findAll(MethodDeclaration.class).stream()
+                .filter(m -> m.getNameAsString().equals(methodName))
+                .filter(m -> m.getParameters().isEmpty())
+                .findFirst()
+                .orElseThrow(() -> new InvalidTemplateException(generator, "Cannot find " + methodName + " method"));
     }
 
     private void writeGetKieBaseForSessionMethod(ClassOrInterfaceDeclaration clazz) {

diff --git a/...ls-model-codegen/src/main/resources/class-templates/rules/ProjectRuntimeJavaTemplate.java b/...ls-model-codegen/src/main/resources/class-templates/rules/ProjectRuntimeJavaTemplate.java
@@ -25,6 +25,7 @@
 import org.kie.api.KieBase;
 import org.kie.api.runtime.KieSession;
 import org.kie.api.runtime.KieRuntimeBuilder;
+import org.kie.api.runtime.StatelessKieSession;
 import org.drools.modelcompiler.KieBaseBuilder;
 
 public class ProjectRuntime implements KieRuntimeBuilder {
@@ -62,8 +63,21 @@ public KieSession newKieSession(String sessionName) {
         if (kbase == null) {
             throw new RuntimeException("Unknown KieSession with name '" + sessionName + "'");
         }
-        KieSession ksession = kbase.newKieSession(getConfForSession(sessionName), null);
-        return ksession;
+        return kbase.newKieSession(getConfForSession(sessionName), null);
+    }
+
+    @Override
+    public StatelessKieSession newStatelessKieSession() {
+        return newStatelessKieSession("$defaultStatelessKieSession$");
+    }
+
+    @Override
+    public StatelessKieSession newStatelessKieSession(String sessionName) {
+        KieBase kbase = getKieBaseForSession(sessionName);
+        if (kbase == null) {
+            throw new RuntimeException("Unknown StatelessKieSession with name '" + sessionName + "'");
+        }
+        return kbase.newStatelessKieSession(getConfForSession(sessionName));
     }
 
     private KieBase getKieBaseForSession(String sessionName) {

diff --git a/...model-codegen/src/main/resources/class-templates/rules/ProjectRuntimeQuarkusTemplate.java b/...model-codegen/src/main/resources/class-templates/rules/ProjectRuntimeQuarkusTemplate.java
@@ -25,6 +25,7 @@
 import org.kie.api.KieBase;
 import org.kie.api.runtime.KieSession;
 import org.kie.api.runtime.KieRuntimeBuilder;
+import org.kie.api.runtime.StatelessKieSession;
 import org.drools.modelcompiler.KieBaseBuilder;
 
 @jakarta.enterprise.context.ApplicationScoped
@@ -63,8 +64,21 @@ public KieSession newKieSession(String sessionName) {
         if (kbase == null) {
             throw new RuntimeException("Unknown KieSession with name '" + sessionName + "'");
         }
-        KieSession ksession = kbase.newKieSession(getConfForSession(sessionName), null);
-        return ksession;
+        return kbase.newKieSession(getConfForSession(sessionName), null);
+    }
+
+    @Override
+    public StatelessKieSession newStatelessKieSession() {
+        return newStatelessKieSession("$defaultStatelessKieSession$");
+    }
+
+    @Override
+    public StatelessKieSession newStatelessKieSession(String sessionName) {
+        KieBase kbase = getKieBaseForSession(sessionName);
+        if (kbase == null) {
+            throw new RuntimeException("Unknown StatelessKieSession with name '" + sessionName + "'");
+        }
+        return kbase.newStatelessKieSession(getConfForSession(sessionName));
     }
 
     private KieBase getKieBaseForSession(String sessionName) {

diff --git a/...-model-codegen/src/main/resources/class-templates/rules/ProjectRuntimeSpringTemplate.java b/...-model-codegen/src/main/resources/class-templates/rules/ProjectRuntimeSpringTemplate.java
@@ -25,6 +25,7 @@
 import org.kie.api.KieBase;
 import org.kie.api.runtime.KieSession;
 import org.kie.api.runtime.KieRuntimeBuilder;
+import org.kie.api.runtime.StatelessKieSession;
 import org.drools.modelcompiler.KieBaseBuilder;
 
 @org.springframework.stereotype.Component
@@ -63,8 +64,21 @@ public KieSession newKieSession(String sessionName) {
         if (kbase == null) {
             throw new RuntimeException("Unknown KieSession with name '" + sessionName + "'");
         }
-        KieSession ksession = kbase.newKieSession(getConfForSession(sessionName), null);
-        return ksession;
+        return kbase.newKieSession(getConfForSession(sessionName), null);
+    }
+
+    @Override
+    public StatelessKieSession newStatelessKieSession() {
+        return newStatelessKieSession("$defaultStatelessKieSession$");
+    }
+
+    @Override
+    public StatelessKieSession newStatelessKieSession(String sessionName) {
+        KieBase kbase = getKieBaseForSession(sessionName);
+        if (kbase == null) {
+            throw new RuntimeException("Unknown StatelessKieSession with name '" + sessionName + "'");
+        }
+        return kbase.newStatelessKieSession(getConfForSession(sessionName));
     }
 
     private KieBase getKieBaseForSession(String sessionName) {

diff --git a/...quarkus-deployment/src/main/java/org/drools/quarkus/deployment/DroolsAssetsProcessor.java b/...quarkus-deployment/src/main/java/org/drools/quarkus/deployment/DroolsAssetsProcessor.java
@@ -205,6 +205,9 @@ private Map<String, KieBaseModel> readKieBaseModels() {
                             case "default":
                                 kieSessionModel.setDefault( config.getValue(propertyName, Boolean.class) );
                                 break;
+                            case "stateless":
+                                kieSessionModel.setType( config.getValue(propertyName, Boolean.class) ? KieSessionModel.KieSessionType.STATELESS : KieSessionModel.KieSessionType.STATEFUL );
+                                break;
                             case "clockType":
                                 kieSessionModel.setClockType( ClockTypeOption.get(config.getValue(propertyName, String.class) ) );
                                 break;

diff --git a/drools-quarkus-extension/drools-quarkus-integration-test/pom.xml b/drools-quarkus-extension/drools-quarkus-integration-test/pom.xml
@@ -41,6 +41,10 @@
       <groupId>org.drools</groupId>
       <artifactId>drools-quarkus</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.drools</groupId>
+      <artifactId>drools-commands</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-decisiontables</artifactId>

diff --git a/...arkus-extension/drools-quarkus-integration-test/src/main/resources/application.properties b/...arkus-extension/drools-quarkus-integration-test/src/main/resources/application.properties
@@ -21,12 +21,16 @@ drools.prototypes=allowed
 
 drools.kbase.canDrinkKB.packages=org.drools.drl
 drools.kbase.canDrinkKB.ksession.canDrinkKS.default=true
+drools.kbase.canDrinkKB.ksession.statelessCanDrinkKS.stateless=true
+drools.kbase.canDrinkKB.ksession.statelessCanDrinkKS.default=true
 
 drools.kbase.canDrinkKBDTable.packages=org.drools.dtable
-drools.kbase.canDrinkKBDTable.ksession=canDrinkKSDTable
+drools.kbase.canDrinkKBDTable.ksession.canDrinkKSDTable.stateless=false
+drools.kbase.canDrinkKBDTable.ksession.statelessCanDrinkKSDTable.stateless=true
 
 drools.kbase.canDrinkKBYaml.packages=org.drools.yaml
 drools.kbase.canDrinkKBYaml.ksession=canDrinkKSYaml
+drools.kbase.canDrinkKBYaml.ksession.statelessCanDrinkKSYaml.stateless=true
 
 drools.kbase.canDrinkKBPrototype.packages=org.drools.prototype
 drools.kbase.canDrinkKBPrototype.prototypes=allowed

diff --git a/...on/drools-quarkus-integration-test/src/test/java/org/drools/quarkus/test/RuntimeTest.java b/...on/drools-quarkus-integration-test/src/test/java/org/drools/quarkus/test/RuntimeTest.java
@@ -24,11 +24,16 @@
 import io.quarkus.test.junit.QuarkusTest;
 import jakarta.inject.Inject;
 import org.junit.jupiter.api.Test;
+import org.kie.api.KieServices;
+import org.kie.api.command.KieCommands;
 import org.kie.api.definition.KiePackage;
+import org.kie.api.internal.utils.KieService;
 import org.kie.api.prototype.PrototypeFact;
 import org.kie.api.prototype.PrototypeFactInstance;
 import org.kie.api.runtime.KieRuntimeBuilder;
 import org.kie.api.runtime.KieSession;
+import org.kie.api.runtime.RuntimeSession;
+import org.kie.api.runtime.StatelessKieSession;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.kie.api.prototype.PrototypeBuilder.prototype;
@@ -42,30 +47,59 @@ public class RuntimeTest {
     @Test
     public void testDrlEvaluation() {
         // canDrinkKS is the default session
-        testSimpleDrl(runtimeBuilder.newKieSession(), "org.drools.drl");
+        testSimpleDrl(runtimeBuilder.newKieSession(), "org.drools.drl", true);
     }
 
     @Test
     public void testDTableEvaluation() {
-        testSimpleDrl(runtimeBuilder.newKieSession("canDrinkKSDTable"), "org.drools.dtable");
+        testSimpleDrl(runtimeBuilder.newKieSession("canDrinkKSDTable"), "org.drools.dtable", true);
     }
 
     @Test
     public void testYamlEvaluation() {
-        testSimpleDrl(runtimeBuilder.newKieSession("canDrinkKSYaml"), "org.drools.yaml");
+        testSimpleDrl(runtimeBuilder.newKieSession("canDrinkKSYaml"), "org.drools.yaml", true);
     }
 
-    private void testSimpleDrl(KieSession ksession, String assetPackage) {
-        List<String> pkgNames = ksession.getKieBase().getKiePackages().stream().map(KiePackage::getName).collect(Collectors.toList());
+    @Test
+    public void testStatelessDrlEvaluation() {
+        // statelessCanDrinkKS is the default stateless session
+        testSimpleDrl(runtimeBuilder.newStatelessKieSession(), "org.drools.drl", false);
+    }
+
+    @Test
+    public void testStatelessDTableEvaluation() {
+        testSimpleDrl(runtimeBuilder.newStatelessKieSession("statelessCanDrinkKSDTable"), "org.drools.dtable", false);
+    }
+
+    @Test
+    public void testStatelessYamlEvaluation() {
+        testSimpleDrl(runtimeBuilder.newStatelessKieSession("statelessCanDrinkKSYaml"), "org.drools.yaml", false);
+    }
+
+    private void testSimpleDrl(RuntimeSession session, String assetPackage, boolean stateful) {
+        if (stateful) {
+            assertThat(session).isInstanceOf(KieSession.class);
+        } else {
+            assertThat(session).isInstanceOf(StatelessKieSession.class);
+        }
+
+        List<String> pkgNames = session.getKieBase().getKiePackages().stream().map(KiePackage::getName).collect(Collectors.toList());
 
         assertThat(pkgNames).hasSize(2).containsExactlyInAnyOrder("org.drools.quarkus.test", assetPackage);
 
+        KieCommands kieCommands = KieServices.get().getCommands();
+
         Result result = new Result();
-        ksession.insert(result);
-        ksession.insert(new Person("Mark", 17));
-        ksession.fireAllRules();
+        session.execute( kieCommands.newBatchExecution(
+                kieCommands.newInsert(result),
+                kieCommands.newInsert(new Person("Mark", 17)),
+                kieCommands.newFireAllRules() ) );
 
         assertThat(result.toString()).isEqualTo("Mark can NOT drink");
+
+        if (stateful) {
+            ((KieSession) session).dispose();
+        }
     }
 
     @Test

diff --git a/kie-api/src/main/java/org/kie/api/command/KieCommands.java b/kie-api/src/main/java/org/kie/api/command/KieCommands.java
@@ -29,6 +29,8 @@
 import org.kie.api.runtime.process.WorkItemHandler;
 import org.kie.api.runtime.rule.FactHandle;
 
+import static java.util.Arrays.asList;
+
 /**
  * KieCommands is a factory for Commands that can be used by classes that implement CommandExecutor. Typically more than one Command
  * will want to be executed, where is where the BatchExecution comes in, which takes a List of commands, think of it as CompositeCommand.
@@ -115,6 +117,10 @@ Command newQuery(String identifier,
                      String name,
                      Object[] arguments);
 
+    default BatchExecutionCommand newBatchExecution(Command... commands) {
+        return newBatchExecution( asList(commands) );
+    }
+
     BatchExecutionCommand newBatchExecution(List< ? extends Command> commands);
 
     BatchExecutionCommand newBatchExecution(List< ? extends Command> commands, String lookup);

diff --git a/kie-api/src/main/java/org/kie/api/runtime/KieRuntime.java b/kie-api/src/main/java/org/kie/api/runtime/KieRuntime.java
@@ -18,53 +18,23 @@
  */
 package org.kie.api.runtime;
 
-import java.util.Map;
-
-import org.kie.api.KieBase;
 import org.kie.api.event.KieRuntimeEventManager;
-import org.kie.api.runtime.KieSessionConfiguration;
 import org.kie.api.runtime.process.ProcessRuntime;
 import org.kie.api.runtime.rule.RuleRuntime;
 import org.kie.api.time.SessionClock;
 
-public interface KieRuntime
-    extends
-    RuleRuntime,
-    ProcessRuntime,
-    KieRuntimeEventManager {
+public interface KieRuntime extends RuntimeSession, RuleRuntime, ProcessRuntime, KieRuntimeEventManager {
 
     /**
      * @return the session clock instance assigned to this session
      */
     <T extends SessionClock> T getSessionClock();
 
-    /**
-     * Sets a global value in this session
-     * @param identifier the global identifier
-     * @param value the value assigned to the global identifier
-     */
-    void setGlobal(String identifier,
-                   Object value);
-
     Object getGlobal(String identifier);
 
-    Globals getGlobals();
-
     Calendars getCalendars();
 
     Environment getEnvironment();
 
-    /**
-     * @return the KieBase reference from which this stateful session was created.
-     */
-    KieBase getKieBase();
-
-    void registerChannel(String name,
-                         Channel channel);
-
-    void unregisterChannel(String name);
-
-    Map< String, Channel> getChannels();
-
     KieSessionConfiguration getSessionConfiguration();
 }
diff --git a/kie-api/src/main/java/org/kie/api/runtime/KieRuntimeBuilder.java b/kie-api/src/main/java/org/kie/api/runtime/KieRuntimeBuilder.java
@@ -27,6 +27,9 @@ public interface KieRuntimeBuilder {
     KieSession newKieSession();
     KieSession newKieSession(String sessionName);
 
+    StatelessKieSession newStatelessKieSession();
+    StatelessKieSession newStatelessKieSession(String sessionName);
+
     default KieSession newKieSession(KieSessionConfiguration conf) {
         return getKieBase().newKieSession(conf, null);
     }