Skip to content

feat(DataMapper): wrap collection choice mapping with for-each (#2815) #3213

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
mmelko wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(DataMapper): wrap collection choice mapping with for-each (#2815) #3213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
153 changes: 152 additions & 1 deletion packages/ui/src/services/visualization/mapping-action.service.choice.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@ import {
DocumentDefinitionType,
DocumentType,
} from '../../models/datamapper/document';
import { ChooseItem, FieldItem, MappingTree, OtherwiseItem, ValueSelector } from '../../models/datamapper/mapping';
import {
ChooseItem,
FieldItem,
ForEachItem,
MappingTree,
OtherwiseItem,
ValueSelector,
} from '../../models/datamapper/mapping';
import {
ChoiceFieldNodeData,
DocumentNodeData,
Expand Down Expand Up @@ -53,6 +60,38 @@ describe('MappingActionService / choice field mappings', () => {
} as unknown as typeof baseField;
}

function createMockCollectionChoiceField(members: { name: string }[], selectedMemberIndex?: number) {
const baseField = sourceDoc.fields[0];
const memberFields = members.map((m) => ({
...baseField,
name: m.name,
displayName: m.name,
fields: [],
isChoice: false,
maxOccurs: 1,
}));
return {
...baseField,
name: '__choice__',
displayName: 'choice',
isChoice: true,
wrapperKind: 'choice' as const,
selectedMemberIndex,
fields: memberFields,
maxOccurs: 'unbounded' as const,
} as unknown as typeof baseField;
}

function createMockCollectionField() {
const baseField = targetDoc.fields[0];
return {
...baseField,
name: 'collectionField',
displayName: 'collectionField',
maxOccurs: 'unbounded' as const,
} as unknown as typeof baseField;
}

describe('engageMapping with choice source', () => {
let localTargetDocNode: TargetDocumentNodeData;

Expand Down Expand Up @@ -443,4 +482,116 @@ describe('MappingActionService / choice field mappings', () => {
expect(nestedDirect1Item.nodePath.pathSegments).not.toContain(freshInnerChoice.id);
});
});

describe('collection choice wrapper mappings (S2 scenario)', () => {
let localTargetDocNode: TargetDocumentNodeData;

beforeEach(() => {
localTargetDocNode = new TargetDocumentNodeData(targetDoc, tree);
});

it('should create ForEachItem wrapping ChooseItem when mapping collection choice wrapper to collection field', () => {
const collectionChoiceField = createMockCollectionChoiceField([{ name: 'email' }, { name: 'phone' }]);
const choiceNode = new ChoiceFieldNodeData(sourceDocNode, collectionChoiceField);
const collectionTargetField = createMockCollectionField();
const targetFieldNode = new TargetFieldNodeData(localTargetDocNode, collectionTargetField);

MappingActionService.engageMapping(tree, choiceNode, targetFieldNode);

expect(tree.children.length).toEqual(1);
const targetFieldItem = tree.children[0];
expect(targetFieldItem).toBeInstanceOf(FieldItem);
expect(targetFieldItem.children.length).toEqual(1);

const forEachItem = targetFieldItem.children[0];
expect(forEachItem).toBeInstanceOf(ForEachItem);
expect(forEachItem.children.length).toEqual(1);

const chooseItem = forEachItem.children[0] as ChooseItem;
expect(chooseItem).toBeInstanceOf(ChooseItem);
expect(chooseItem.when.length).toEqual(2);
expect(chooseItem.otherwise).toBeInstanceOf(OtherwiseItem);
});

it('ForEachItem expression should be the XPath of the collection choice wrapper', () => {
const collectionChoiceField = createMockCollectionChoiceField([{ name: 'email' }, { name: 'phone' }]);
const choiceNode = new ChoiceFieldNodeData(sourceDocNode, collectionChoiceField);
const collectionTargetField = createMockCollectionField();
const targetFieldNode = new TargetFieldNodeData(localTargetDocNode, collectionTargetField);

MappingActionService.engageMapping(tree, choiceNode, targetFieldNode);

const forEachItem = tree.children[0].children[0] as ForEachItem;
expect(forEachItem.expression).toBeTruthy();
});

it('WhenItem expressions inside ForEachItem should reference the choice members', () => {
const collectionChoiceField = createMockCollectionChoiceField([{ name: 'email' }, { name: 'phone' }]);
const choiceNode = new ChoiceFieldNodeData(sourceDocNode, collectionChoiceField);
const collectionTargetField = createMockCollectionField();
const targetFieldNode = new TargetFieldNodeData(localTargetDocNode, collectionTargetField);

MappingActionService.engageMapping(tree, choiceNode, targetFieldNode);

const forEachItem = tree.children[0].children[0] as ForEachItem;
const chooseItem = forEachItem.children[0] as ChooseItem;
expect(chooseItem.when[0].expression).toEqual('/ns0:email');
expect(chooseItem.when[1].expression).toEqual('/ns0:phone');
const emailSelector = chooseItem.when[0].children.find((c) => c instanceof ValueSelector) as ValueSelector;
const phoneSelector = chooseItem.when[1].children.find((c) => c instanceof ValueSelector) as ValueSelector;
expect(emailSelector.expression).toEqual('/ns0:email');
expect(phoneSelector.expression).toEqual('/ns0:phone');
});

it('should create only ChooseItem (no ForEachItem) when mapping collection choice wrapper to non-collection field (S1)', () => {
const collectionChoiceField = createMockCollectionChoiceField([{ name: 'email' }, { name: 'phone' }]);
const choiceNode = new ChoiceFieldNodeData(sourceDocNode, collectionChoiceField);
const nonCollectionTargetField = targetDoc.fields[0]; // maxOccurs = 1
const targetFieldNode = new TargetFieldNodeData(localTargetDocNode, nonCollectionTargetField);

MappingActionService.engageMapping(tree, choiceNode, targetFieldNode);

expect(tree.children.length).toEqual(1);
const targetFieldItem = tree.children[0];
expect(targetFieldItem).toBeInstanceOf(FieldItem);
expect(targetFieldItem.children.length).toEqual(1);

const chooseItem = targetFieldItem.children[0];
expect(chooseItem).toBeInstanceOf(ChooseItem);
expect(chooseItem).not.toBeInstanceOf(ForEachItem);
expect((chooseItem as ChooseItem).when.length).toEqual(2);
});

it('should create only ChooseItem when mapping non-collection choice wrapper to collection field', () => {
const nonCollectionChoiceField = createMockChoiceField([{ name: 'email' }, { name: 'phone' }]);
const choiceNode = new ChoiceFieldNodeData(sourceDocNode, nonCollectionChoiceField);
const collectionTargetField = createMockCollectionField();
const targetFieldNode = new TargetFieldNodeData(localTargetDocNode, collectionTargetField);

MappingActionService.engageMapping(tree, choiceNode, targetFieldNode);

expect(tree.children.length).toEqual(1);
const targetFieldItem = tree.children[0];
expect(targetFieldItem).toBeInstanceOf(FieldItem);
expect(targetFieldItem.children.length).toEqual(1);

const chooseItem = targetFieldItem.children[0];
expect(chooseItem).toBeInstanceOf(ChooseItem);
expect(chooseItem).not.toBeInstanceOf(ForEachItem);
});

it('should not create duplicate ForEachItem when mapping the same collection choice source twice', () => {
const collectionChoiceField = createMockCollectionChoiceField([{ name: 'email' }, { name: 'phone' }]);
const choiceNode = new ChoiceFieldNodeData(sourceDocNode, collectionChoiceField);
const collectionTargetField = createMockCollectionField();
const targetFieldNode = new TargetFieldNodeData(localTargetDocNode, collectionTargetField);

MappingActionService.engageMapping(tree, choiceNode, targetFieldNode);
MappingActionService.engageMapping(tree, choiceNode, targetFieldNode);

const targetFieldItem = tree.children[0];
const forEachItems = targetFieldItem.children.filter((c) => c instanceof ForEachItem);
expect(forEachItems.length).toEqual(1);
});
});
});
32 changes: 29 additions & 3 deletions packages/ui/src/services/visualization/mapping-action.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,11 @@ export class MappingActionService {
if (sourceNode.choiceField) {
const item = MappingActionService.getOrCreateFieldItem(targetNode);
MappingService.mapToField(sourceNode.field, item);
} else if (
VisualizationUtilService.isCollectionField(sourceNode) &&
VisualizationUtilService.isCollectionField(targetNode)
) {
MappingActionService.createForEachWithChooseFromChoice(sourceNode.field, targetNode);
} else {
MappingActionService.createChooseFromChoice(sourceNode.field, targetNode);
}
Expand Down Expand Up @@ -218,16 +223,37 @@ export class MappingActionService {
const targetItem = MappingActionService.getOrCreateFieldItem(targetNode);
if (targetItem.children.some((c) => c instanceof ChooseItem)) return;
targetItem.children = targetItem.children.filter((c) => !(c instanceof ValueSelector));
const chooseItem = new ChooseItem(targetItem, targetItem instanceof FieldItem ? targetItem.field : undefined);

const chooseItem = MappingActionService.buildChooseFromChoiceMembers(targetItem, sourceField, targetItem);
targetItem.children.push(chooseItem);
}

private static createForEachWithChooseFromChoice(sourceField: IField, targetNode: TargetNodeData) {
const targetItem = MappingActionService.getOrCreateFieldItem(targetNode);
if (targetItem.children.some((c) => c instanceof ForEachItem)) return;
targetItem.children = targetItem.children.filter((c) => !(c instanceof ValueSelector));

const forEachItem = new ForEachItem(targetItem);
MappingService.mapToCondition(forEachItem, sourceField);

const chooseItem = MappingActionService.buildChooseFromChoiceMembers(forEachItem, sourceField, targetItem);
forEachItem.children.push(chooseItem);
targetItem.children.push(forEachItem);
}

private static buildChooseFromChoiceMembers(
parent: MappingItem,
sourceField: IField,
targetItem: MappingItem,
): ChooseItem {
const chooseItem = new ChooseItem(parent, targetItem instanceof FieldItem ? targetItem.field : undefined);
for (const member of sourceField.fields ?? []) {
const whenItem = MappingService.addWhen(chooseItem);
MappingService.mapToCondition(whenItem, member);
MappingService.mapToField(member, whenItem);
}

MappingService.addOtherwise(chooseItem);
targetItem.children.push(chooseItem);
return chooseItem;
}

private static getOrCreateFieldItem(nodeData: TargetNodeData): MappingItem {
Expand Down
Loading