Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(engine): Populating process instance id in jobs #4334

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

feat(engine): Populating process instance id in jobs #4334

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4e97dc1
feat(engine): Populating process instance id in jobs
punitdarira May 13, 2024
af36f9b
feat(engine): Setting process definition ID in job log
punitdarira Jun 2, 2024
bdde986
fix(engine): Moved setting of processDefinitionId to RestartJobHandler
punitdarira Jun 29, 2024
100fa5b
fix(engine): Remove sysout
punitdarira Jun 29, 2024
bd1c38d
feat(engine): Assert for instance and definitionid in job
punitdarira Jul 9, 2024
c374253
feat(engine): Tests
punitdarira Sep 2, 2024
3af25b9
feat(engine): Tests
punitdarira Sep 2, 2024
d211061
feat(engine): Tests
punitdarira Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions engine/src/main/java/org/camunda/bpm/engine/impl/batch/AbstractBatchJobHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
import org.camunda.bpm.engine.impl.util.ClockUtil;
import org.camunda.bpm.engine.impl.util.JsonUtil;

import static org.camunda.bpm.engine.impl.RestartProcessInstancesBatchConfigurationJsonConverter.PROCESS_DEFINITION_ID;
yanavasileva marked this conversation as resolved.
Show resolved Hide resolved

/**
* Common methods for batch job handlers based on list of ids, providing serialization, configuration instantiation, etc.
*
Expand Down Expand Up @@ -169,6 +171,13 @@ protected void createJobEntities(BatchEntity batch, T configuration, String depl
ByteArrayEntity configurationEntity = saveConfiguration(byteArrayManager, jobConfiguration);

JobEntity job = createBatchJob(batch, configurationEntity);

if (jobConfiguration.getIds() != null && jobConfiguration.getIds().size() == 1) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like this will be required to avoid populating the ids for entities that are not process instance:

Suggested change
if (jobConfiguration.getIds() != null && jobConfiguration.getIds().size() == 1) {
if (jobConfiguration.getIds() != null && jobConfiguration.getIds().size() == 1
&& !(this instanceof DecisionSetRemovalTimeJobHandler)
&& !(this instanceof DeleteHistoricDecisionInstancesJobHandler)
&& !(this instanceof SetJobRetriesJobHandler)
&& !(this instanceof SetExternalTaskRetriesJobHandler)
// && !(this instanceof BatchSetRemovalTimeJobHandler)
) {

job.setProcessInstanceId(jobConfiguration.getIds().get(0));
String processDefinitionId = JsonUtil.getString(JsonUtil.asObject(batch.getConfigurationBytes()), PROCESS_DEFINITION_ID, null);
yanavasileva marked this conversation as resolved.
Show resolved Hide resolved
job.setProcessDefinitionId(processDefinitionId);
yanavasileva marked this conversation as resolved.
Show resolved Hide resolved
}

job.setDeploymentId(deploymentId);
postProcessJob(configuration, job, jobConfiguration);
jobManager.insertAndHintJobExecutor(job);
Expand Down
5 changes: 1 addition & 4 deletions ...ain/java/org/camunda/bpm/engine/impl/batch/message/MessageCorrelationBatchJobHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,7 @@ protected MessageCorrelationBatchConfiguration createJobConfiguration(MessageCor

@Override
protected void postProcessJob(MessageCorrelationBatchConfiguration configuration, JobEntity job, MessageCorrelationBatchConfiguration jobConfiguration) {
// if there is only one process instance to adjust, set its ID to the job so exclusive scheduling is possible
if (jobConfiguration.getIds() != null && jobConfiguration.getIds().size() == 1) {
job.setProcessInstanceId(jobConfiguration.getIds().get(0));
}

}

@Override
Expand Down
5 changes: 1 addition & 4 deletions ...e/src/main/java/org/camunda/bpm/engine/impl/batch/variables/BatchSetVariablesHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,7 @@ public String getType() {

@Override
protected void postProcessJob(BatchConfiguration configuration, JobEntity job, BatchConfiguration jobConfiguration) {
// if there is only one process instance to adjust, set its ID to the job so exclusive scheduling is possible
if (jobConfiguration.getIds() != null && jobConfiguration.getIds().size() == 1) {
job.setProcessInstanceId(jobConfiguration.getIds().get(0));
}

}

protected ByteArrayEntity findByteArrayById(String byteArrayId, CommandContext commandContext) {
Expand Down
28 changes: 28 additions & 0 deletions ...rc/test/java/org/camunda/bpm/engine/test/api/runtime/RestartProcessInstanceAsyncTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
import org.camunda.bpm.engine.batch.Batch;
import org.camunda.bpm.engine.batch.history.HistoricBatch;
import org.camunda.bpm.engine.delegate.ExecutionListener;
import org.camunda.bpm.engine.history.HistoricJobLog;
import org.camunda.bpm.engine.history.HistoricProcessInstanceQuery;
import org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl;
import org.camunda.bpm.engine.impl.cfg.multitenancy.TenantIdProvider;
Expand Down Expand Up @@ -1150,6 +1151,33 @@ public void shouldSetExecutionStartTimeInBatchAndHistory() {
Assertions.assertThat(historicBatch.getExecutionStartTime()).isEqualToIgnoringMillis(TEST_DATE);
}

@Test
public void shouldSetProcessInstanceAndDefinitionIdInHistoryJobLog() {
// given

ProcessDefinition processDefinition = testRule.deployAndGetDefinition(ProcessModels.TWO_TASKS_PROCESS);
ProcessInstance processInstance = runtimeService.createProcessInstanceById(processDefinition.getId())
.startBeforeActivity("userTask1")
.execute();
runtimeService.deleteProcessInstance(processInstance.getId(), "test");
Batch batch = runtimeService.restartProcessInstances(processDefinition.getId())
.startAfterActivity("userTask2")
.processInstanceIds(processInstance.getId())
.executeAsync();
helper.executeSeedJob(batch);
List<Job> executionJobs = helper.getExecutionJobs(batch);

yanavasileva marked this conversation as resolved.
Show resolved Hide resolved
// when
helper.executeJob(executionJobs.get(0));

// then
HistoricJobLog jobLog = historyService.createHistoricJobLogQuery().jobDefinitionType(Batch.TYPE_PROCESS_INSTANCE_RESTART).list().get(0);
System.out.println(jobLog);

assertEquals(processInstance.getProcessDefinitionId(), jobLog.getProcessDefinitionId());
assertEquals(processInstance.getRootProcessInstanceId(), jobLog.getProcessInstanceId());
Comment on lines +1179 to +1180
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ The checks are performed for the historic job log, I would expect to check the jobs as well.

}

protected void assertBatchCreated(Batch batch, int processInstanceCount) {
assertNotNull(batch);
assertNotNull(batch.getId());
Expand Down