Uploaded image for project: 'JBoss BRMS Platform'
  1. JBoss BRMS Platform
  2. RHBRMS-117

Incorrect serialization of Drools STREAM KieSession with expirable events causes NPE

This issue belongs to an archived project. You can view it, but you can't modify it. Learn more

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Critical Critical
    • None
    • 6.0.2
    • BRE
    • None
    • ER1
    • Hide
      Fixed Issues Summary:

      When running a stateful KieSession in STREAM mode and using events with @expires annotations, an invalid serialized session would occur in BRMS. Accordingly, when inserting an event with an @expires annotation and explicitly retracting that Event again from the engine (for example, KieSession.delete), users would receive an invalid serialized session.

      When users later deserialized the session and immediately serialized it again, they would receive a NPE at the following location:
      org.drools.core.reteoo.ObjectTypeNode$ExpireJobContextTimerOutputMarshaller.serialize(ObjectTypeNode.java:669)

      If they deserialized the session and then advanced the pseudo clock to a moment where the original event should have expired, they would receive an NPE at the following location:
      org.drools.core.common.AbstractWorkingMemory$WorkingMemoryReteExpireAction.execute(AbstractWorkingMemory.java:1524)

      Therefore, when the Event was explicitly retracted with KieSession.delete(Event), it was removed from the WM but the Expiry Timer Job was not. That Expiry Timer Job was serialized with a "null" fact handle, which did not cause issues with deserialization; however, the next serialization of the session or triggering of the expire action (such as moving the pseudo clock) would trigger the issue.

      This issue has now been fixed for BRMS 6.0.3.
      Show
      Fixed Issues Summary: When running a stateful KieSession in STREAM mode and using events with @expires annotations, an invalid serialized session would occur in BRMS. Accordingly, when inserting an event with an @expires annotation and explicitly retracting that Event again from the engine (for example, KieSession.delete), users would receive an invalid serialized session. When users later deserialized the session and immediately serialized it again, they would receive a NPE at the following location: org.drools.core.reteoo.ObjectTypeNode$ExpireJobContextTimerOutputMarshaller.serialize(ObjectTypeNode.java:669) If they deserialized the session and then advanced the pseudo clock to a moment where the original event should have expired, they would receive an NPE at the following location: org.drools.core.common.AbstractWorkingMemory$WorkingMemoryReteExpireAction.execute(AbstractWorkingMemory.java:1524) Therefore, when the Event was explicitly retracted with KieSession.delete(Event), it was removed from the WM but the Expiry Timer Job was not. That Expiry Timer Job was serialized with a "null" fact handle, which did not cause issues with deserialization; however, the next serialization of the session or triggering of the expire action (such as moving the pseudo clock) would trigger the issue. This issue has now been fixed for BRMS 6.0.3.

      Platform BZ for Jira https://issues.jboss.org/browse/DROOLS-551

      There is an issue in Drools 6, both in PHREAK and RETEOO mode, which causes NPEs to be thrown when a session is serialized and deserialized.
      The problem occurs when running a stateful KieSession in STREAM mode and using Events with @expires annotations. When you insert an event with an @expires annotation, and you explicitly retract that Event again from the engine (i.e. KieSession.delete), and after that serialize the session, you end up with an invalid serialized session.

      When you later deserialize the session, and immediately serialize it again, a NPE is thrown at: org.drools.core.reteoo.ObjectTypeNode$ExpireJobContextTimerOutputMarshaller.serialize(ObjectTypeNode.java:669). When you deserialize the session and then advance the pseudo clock to a moment where the original event (which we've already retracted from the working memory) should have expired, a NPE is thrown at: org.drools.core.common.AbstractWorkingMemory$WorkingMemoryReteExpireAction.execute(AbstractWorkingMemory.java:1524)

      So, it seems that when the Event is explicitly retracted with KieSesion.delete(event), the event is removed from the WM, but the Expiry Timer Job is not. That ExpiryJob gets serialized with a 'null' fact handle, which does not give issues on de-serialization, but on the next serialization of the session, or when an action is peformed that triggers the expire action (i.e. move the pseudo-clock).

      A reproducer can be found here: http://www.github.com/DuncanDoyle/DroolsSerializationIssue . To reproduce:

      git clone http://www.github.com/DuncanDoyle/DroolsSerializationIssue
      cd DroolsSerializationIssue/DroolSerializationIssue
      mvn clean test -P phreak (runs the test with Drools in PHREAK mode)
      mvn clean test -P reteoo (runs the test with Drools in RETEOO mode)

      In both modes 2 of the 3 tests produce an NPE.

              mfusco@redhat.com Mario Fusco
              rhn-support-alazarot Alessandro Lazarotti
              Archiver:
              rhn-support-ceverson Clark Everson
              Radovan Synek Radovan Synek (Inactive)
              Radovan Synek Radovan Synek (Inactive)
              Cheng Zhang (Inactive), Lukáš Petrovický (Inactive), Mario Fusco

                Created:
                Updated:
                Resolved:
                Archived: