changed recordIdentityLinkCreated to also include the process/case instance (#4117)

Author: WelschChristopher

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/history/CmmnHistoryManager.java

@@ -16,6 +16,7 @@
 import java.util.Date;
 
 import org.flowable.cmmn.api.repository.CaseDefinition;
+import org.flowable.cmmn.api.runtime.CaseInstance;
 import org.flowable.cmmn.engine.impl.persistence.entity.CaseInstanceEntity;
 import org.flowable.cmmn.engine.impl.persistence.entity.MilestoneInstanceEntity;
 import org.flowable.cmmn.engine.impl.persistence.entity.PlanItemInstanceEntity;
@@ -51,6 +52,8 @@ public interface CmmnHistoryManager {
 
     void recordIdentityLinkCreated(IdentityLinkEntity identityLink);
 
+    void recordIdentityLinkCreated(CaseInstanceEntity caseInstance, IdentityLinkEntity identityLink);
+
     void recordIdentityLinkDeleted(IdentityLinkEntity identityLink);
 
     void recordEntityLinkCreated(EntityLinkEntity entityLink);

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/history/CompositeCmmnHistoryManager.java

@@ -17,6 +17,7 @@
 import java.util.Date;
 
 import org.flowable.cmmn.api.repository.CaseDefinition;
+import org.flowable.cmmn.api.runtime.CaseInstance;
 import org.flowable.cmmn.engine.impl.persistence.entity.CaseInstanceEntity;
 import org.flowable.cmmn.engine.impl.persistence.entity.MilestoneInstanceEntity;
 import org.flowable.cmmn.engine.impl.persistence.entity.PlanItemInstanceEntity;
@@ -109,6 +110,13 @@ public void recordIdentityLinkCreated(IdentityLinkEntity identityLink) {
         }
     }
 
+    @Override
+    public void recordIdentityLinkCreated(CaseInstanceEntity caseInstance, IdentityLinkEntity identityLink) {
+        for (CmmnHistoryManager historyManager : historyManagers) {
+            historyManager.recordIdentityLinkCreated(caseInstance, identityLink);
+        }
+    }
+
     @Override
     public void recordIdentityLinkDeleted(IdentityLinkEntity identityLink) {
         for (CmmnHistoryManager historyManager : historyManagers) {

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/history/DefaultCmmnHistoryManager.java

@@ -21,6 +21,7 @@
 import org.flowable.cmmn.api.history.HistoricMilestoneInstance;
 import org.flowable.cmmn.api.history.HistoricPlanItemInstance;
 import org.flowable.cmmn.api.repository.CaseDefinition;
+import org.flowable.cmmn.api.runtime.CaseInstance;
 import org.flowable.cmmn.engine.CmmnEngineConfiguration;
 import org.flowable.cmmn.engine.impl.persistence.entity.CaseInstanceEntity;
 import org.flowable.cmmn.engine.impl.persistence.entity.HistoricCaseInstanceEntity;
@@ -177,6 +178,11 @@ public void recordBulkDeleteHistoricCaseInstances(Collection<String> caseInstanc
 
     @Override
     public void recordIdentityLinkCreated(IdentityLinkEntity identityLink) {
+        this.recordIdentityLinkCreated(null, identityLink);
+    }
+
+    @Override
+    public void recordIdentityLinkCreated(CaseInstanceEntity caseInstance, IdentityLinkEntity identityLink) {
         if (getHistoryConfigurationSettings().isHistoryEnabledForIdentityLink(identityLink)
                 && (identityLink.getScopeId() != null || identityLink.getTaskId() != null)) {
             HistoricIdentityLinkService historicIdentityLinkService = cmmnEngineConfiguration.getIdentityLinkServiceConfiguration().getHistoricIdentityLinkService();

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/util/IdentityLinkUtil.java

@@ -17,6 +17,7 @@
 import org.flowable.cmmn.api.runtime.CaseInstance;
 import org.flowable.cmmn.api.runtime.PlanItemInstance;
 import org.flowable.cmmn.engine.CmmnEngineConfiguration;
+import org.flowable.cmmn.engine.impl.persistence.entity.CaseInstanceEntity;
 import org.flowable.common.engine.api.scope.ScopeTypes;
 import org.flowable.common.engine.impl.identity.Authentication;
 import org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity;
@@ -33,14 +34,13 @@
  */
 public class IdentityLinkUtil {
 
-    public static IdentityLinkEntity createCaseInstanceIdentityLink(CaseInstance caseInstance, String userId, String groupId, String type,
+    public static IdentityLinkEntity createCaseInstanceIdentityLink(CaseInstanceEntity caseInstanceEntity, String userId, String groupId, String type,
             CmmnEngineConfiguration cmmnEngineConfiguration) {
 
         IdentityLinkEntity identityLinkEntity = cmmnEngineConfiguration.getIdentityLinkServiceConfiguration()
-                .getIdentityLinkService().createScopeIdentityLink(null, caseInstance.getId(), ScopeTypes.CMMN, userId, groupId, type);
-        
-        CommandContextUtil.getCmmnHistoryManager().recordIdentityLinkCreated(identityLinkEntity);
-        
+                .getIdentityLinkService().createScopeIdentityLink(null, caseInstanceEntity.getId(), ScopeTypes.CMMN, userId, groupId, type);
+
+        CommandContextUtil.getCmmnHistoryManager().recordIdentityLinkCreated(caseInstanceEntity, identityLinkEntity);
         return identityLinkEntity;
     }
 

modules/flowable-cmmn-engine/src/test/java/org/flowable/cmmn/test/history/CompositeCmmnHistoryManagerTest.java

@@ -118,6 +118,16 @@ void recordIdentityLinkCreated() {
         verify(historyManager2).recordIdentityLinkCreated(same(identityLink));
     }
 
+    @Test
+    void recordIdentityLinkCreatedWithCaseInstance() {
+        CaseInstanceEntity caseInstance = new CaseInstanceEntityImpl();
+        IdentityLinkEntity identityLink = new IdentityLinkEntityImpl();
+        compositeHistoryManager.recordIdentityLinkCreated(caseInstance, identityLink);
+
+        verify(historyManager1).recordIdentityLinkCreated(same(caseInstance), same(identityLink));
+        verify(historyManager2).recordIdentityLinkCreated(same(caseInstance), same(identityLink));
+    }
+
     @Test
     void recordIdentityLinkDeleted() {
         IdentityLinkEntity identityLink = new IdentityLinkEntityImpl();

modules/flowable-engine/src/main/java/org/flowable/engine/impl/history/CompositeHistoryManager.java

@@ -288,6 +288,13 @@ public void recordIdentityLinkCreated(IdentityLinkEntity identityLink) {
         }
     }
 
+    @Override
+    public void recordIdentityLinkCreated(ExecutionEntity processInstance, IdentityLinkEntity identityLink) {
+        for (HistoryManager historyManager : historyManagers) {
+            historyManager.recordIdentityLinkCreated(processInstance,identityLink);
+        }
+    }
+
     @Override
     public void recordIdentityLinkDeleted(IdentityLinkEntity identityLink) {
         for (HistoryManager historyManager : historyManagers) {

modules/flowable-engine/src/main/java/org/flowable/engine/impl/history/DefaultHistoryManager.java

@@ -389,6 +389,11 @@ public void recordFormPropertiesSubmitted(ExecutionEntity processInstance, Map<S
     // Identity link related history
     @Override
     public void recordIdentityLinkCreated(IdentityLinkEntity identityLink) {
+        recordIdentityLinkCreated(null, identityLink);
+    }
+
+    @Override
+    public void recordIdentityLinkCreated(ExecutionEntity processInstance, IdentityLinkEntity identityLink) {
         // It makes no sense storing historic counterpart for an identity link that is related
         // to a process definition only as this is never kept in history
         if (getHistoryConfigurationSettings().isHistoryEnabledForIdentityLink(identityLink)

modules/flowable-engine/src/main/java/org/flowable/engine/impl/history/HistoryManager.java

@@ -198,6 +198,11 @@ void recordHistoricDetailVariableCreate(VariableInstanceEntity variable, Executi
      */
     void recordIdentityLinkCreated(IdentityLinkEntity identityLink);
 
+    /**
+     * Record the creation of a new {@link IdentityLink} for the processInstance, if audit history is enabled.
+     */
+    void recordIdentityLinkCreated(ExecutionEntity processInstance, IdentityLinkEntity identityLinkEntity);
+
     /**
      * Record the deletion of a {@link IdentityLink}, if audit history is enabled
      */

modules/flowable-engine/src/main/java/org/flowable/engine/impl/util/IdentityLinkUtil.java

@@ -37,7 +37,7 @@ public static IdentityLinkEntity createProcessInstanceIdentityLink(ExecutionEnti
         IdentityLinkEntity identityLinkEntity = processEngineConfiguration.getIdentityLinkServiceConfiguration().getIdentityLinkService(
                 ).createProcessInstanceIdentityLink(processInstanceExecution.getId(), userId, groupId, type);
 
-        CommandContextUtil.getHistoryManager().recordIdentityLinkCreated(identityLinkEntity);
+        CommandContextUtil.getHistoryManager().recordIdentityLinkCreated(processInstanceExecution, identityLinkEntity);
         processInstanceExecution.getIdentityLinks().add(identityLinkEntity);
 
         return identityLinkEntity;

modules/flowable-engine/src/test/java/org/flowable/engine/test/history/CompositeHistoryManagerTest.java

@@ -388,6 +388,16 @@ void recordIdentityLinkCreated() {
         verify(historyManager2).recordIdentityLinkCreated(same(identityLink));
     }
 
+    @Test
+    void recordIdentityLinkCreatedWithProcessInstance() {
+        ExecutionEntity processInstance = new ExecutionEntityImpl();
+        IdentityLinkEntity identityLink = new IdentityLinkEntityImpl();
+        compositeHistoryManager.recordIdentityLinkCreated(processInstance, identityLink);
+
+        verify(historyManager1).recordIdentityLinkCreated(same(processInstance), same(identityLink));
+        verify(historyManager2).recordIdentityLinkCreated(same(processInstance), same(identityLink));
+    }
+
     @Test
     void recordIdentityLinkDeleted() {
         IdentityLinkEntity identityLink = new IdentityLinkEntityImpl();