Skip to content

chore(history): populate process instance treepath #1029

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

Open
HeleneW-dot wants to merge 2 commits into
base: main
Choose a base branch
from
+54 −4
Open

chore(history): populate process instance treepath #1029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9109f8
chore(history): populate process instance treepath
HeleneW-dot Feb 20, 2026
8d69be7
chore(PR): implement PR comments
HeleneW-dot Feb 27, 2026
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
21 changes: 20 additions & 1 deletion ...rc/main/java/io/camunda/migration/data/impl/history/migrator/ProcessInstanceMigrator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.Objects;
import org.camunda.bpm.engine.history.HistoricActivityInstance;
import org.camunda.bpm.engine.history.HistoricProcessInstance;
import org.springframework.stereotype.Service;
Expand Down Expand Up @@ -90,6 +91,7 @@ public Long migrateTransactionally(HistoricProcessInstance c7ProcessInstance) {
var builder = new ProcessInstanceDbModelBuilder();

Long processInstanceKey = getNextKey();
Long rootProcessInstanceKey = null;
builder.processInstanceKey(processInstanceKey);
if (processDefinitionKey != null) {
builder.processDefinitionKey(processDefinitionKey);
Expand All @@ -112,6 +114,7 @@ public Long migrateTransactionally(HistoricProcessInstance c7ProcessInstance) {
} else if (c7RootProcessInstanceId != null && isMigrated(c7RootProcessInstanceId, HISTORY_PROCESS_INSTANCE)) {
ProcessInstanceEntity rootProcessInstance = findProcessInstanceByC7Id(c7RootProcessInstanceId);
if (rootProcessInstance != null && rootProcessInstance.processInstanceKey() != null) {
rootProcessInstanceKey = rootProcessInstance.processInstanceKey();
builder.rootProcessInstanceKey(rootProcessInstance.processInstanceKey());
}
}
Expand All @@ -123,7 +126,8 @@ public Long migrateTransactionally(HistoricProcessInstance c7ProcessInstance) {

builder
.historyCleanupDate(c8HistoryCleanupDate)
.endDate(c8EndTime);
.endDate(c8EndTime)
.treePath(generateTreepath(rootProcessInstanceKey, processInstanceKey));

ProcessInstanceDbModel dbModel = convert(C7Entity.of(c7ProcessInstance), builder);

Expand Down Expand Up @@ -176,5 +180,20 @@ protected void resolveParentFlowNodeInstanceKey(
}
}

/**
* Generates a tree path for process instances in the format:
* PI_rootProcessInstanceKey/PI_processInstanceKey or
* PI_processInstanceKey if this instance is the root of the hierarchy
*
* @param rootProcessInstanceKey the root process instance key
* @param processInstanceKey the process instance key
* @return the tree path string
*/
public static String generateTreepath(Long rootProcessInstanceKey, Long processInstanceKey) {
return rootProcessInstanceKey == null || Objects.equals(rootProcessInstanceKey, processInstanceKey) ?
"PI_" + processInstanceKey :
"PI_" + rootProcessInstanceKey + "/PI_" + processInstanceKey;
Copy link
Member

@venetrius venetrius Feb 26, 2026

Choose a reason for hiding this comment

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

❌ If the hierarchy has more then 2 levels for example a chain A→B→C, process C's treePath would be PI_A/PI_C, skipping B.

Copy link
Contributor Author

@HeleneW-dot HeleneW-dot Feb 27, 2026

Choose a reason for hiding this comment

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

See the ticket description/slack link, the treepath is truncated to only keep root and leaf

Copy link
Member

@venetrius venetrius Feb 27, 2026

Choose a reason for hiding this comment

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

Sorry, I missed that 👍

}

}

1 change: 0 additions & 1 deletion ...io/camunda/migration/data/impl/interceptor/history/entity/ProcessInstanceTransformer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ public void execute(HistoricProcessInstance entity, ProcessInstanceDbModelBuilde
.tenantId(getTenantId(entity.getTenantId()))
.version(entity.getProcessDefinitionVersion())
.tags(getDefaultTags(entity))
.treePath(null)
.numIncidents(0)
.partitionId(C7_HISTORY_PARTITION_ID);
}
Expand Down
36 changes: 34 additions & 2 deletions ...src/test/java/io/camunda/migration/data/qa/history/entity/HistoryProcessInstanceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,32 @@ public void shouldCheckCalledProcessParentElementKey() {
assertThat(searchHistoricProcessInstances("calledProcessInstanceId")).isEmpty();
}

@Test
public void shouldPopulateTreePathForCallActivity() {
// given
deployer.deployCamunda7Process("callActivityProcess.bpmn");
deployer.deployCamunda7Process("calledActivitySubprocess.bpmn");
runtimeService.startProcessInstanceByKey("callingProcessId");

// when
historyMigrator.migrate();
historyMigrator.retry();

// then
List<ProcessInstanceEntity> parentProcessInstances = searchHistoricProcessInstances("callingProcessId");
List<ProcessInstanceEntity> subProcessInstances = searchHistoricProcessInstances("calledProcessInstanceId");
assertThat(parentProcessInstances).hasSize(1);
assertThat(subProcessInstances).hasSize(1);

ProcessInstanceEntity parent = parentProcessInstances.getFirst();
ProcessInstanceEntity sub = subProcessInstances.getFirst();

assertThat(parent.treePath()).isNotNull().isEqualTo("PI_" + parent.processInstanceKey());

assertThat(sub.treePath()).isNotNull()
.isEqualTo("PI_" + parent.processInstanceKey() + "/PI_" + sub.processInstanceKey());
}

@Test
public void shouldPopulateRootProcessInstanceKeyForCallActivity() {
// given
Expand All @@ -196,7 +222,7 @@ public void shouldPopulateRootProcessInstanceKeyForCallActivity() {

// Sub process should have rootProcessInstanceKey pointing to the parent
assertThat(sub.rootProcessInstanceKey()).isEqualTo(parent.processInstanceKey());

// Verify that flow nodes also have rootProcessInstanceKey
List<FlowNodeInstanceEntity> subFlowNodes = searchHistoricFlowNodes(sub.processInstanceKey());
assertThat(subFlowNodes).isNotEmpty();
Expand Down Expand Up @@ -310,7 +336,13 @@ protected void verifyProcessInstanceFields(ProcessInstanceEntity processInstance
}

assertThat(processInstance.hasIncident()).isEqualTo(hasIncidents);
assertThat(processInstance.treePath()).isNull();

assertThat(processInstance.treePath()).isNotNull();
if (hasParent) {
assertThat(processInstance.treePath()).matches("PI_\\d+/PI_" + processInstance.processInstanceKey());
} else {
assertThat(processInstance.treePath()).isEqualTo("PI_" + processInstance.processInstanceKey());
}
}

@Test
Expand Down