All files / src/web/flowable/roundTrip stateMerging.ts

91.03% Statements 132/145
77.53% Branches 107/138
100% Functions 35/35
90.51% Lines 124/137

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401            4x     10682x       1526x       3052x 3038x     14x       18312x       3052x 3052x             1526x 21x     1505x             1526x       1526x 1526x       1526x                                                               507x       7520x       7520x 13x     7507x       7525x       1504x 2x     1502x                   6016x 5x     6011x 35x     5976x       256x 256x       530x 5x     525x 127x 127x     127x         1x       1x               23x 5x     18x 21x 21x                 37x                   37x                       37x 37x 37x 37x 37x   37x 206x 32x     174x 75x 75x     99x 8x 8x     91x 87x 87x     4x     37x 37x                     7x 7x   7x 9x 9x 9x   9x               9x 9x     7x 10x 10x 9x     1x 1x       1x     7x                   16x 16x   16x 27x 27x 27x   27x       27x 27x     16x 16x 16x         16x                 530x 507x     32x 25x 37x 23x   23x 7x                   16x                 1509x 1424x     85x                   106x 106x 106x 106x         106x   106x 5x 5x 5x 5x 5x                 5x 3x             106x       146x  
import type {
	FlowableElementState,
	FlowableProcessExtensionState,
	XmlIdentified,
} from '../types';
 
const EMPTY_RECORD: Record<string, unknown> = {};
 
function cloneArray<T>(items: T[] | undefined): T[] {
	return items?.map((item) => ({ ...item })) || [];
}
 
function cloneRecord<T extends object>(value: T | undefined): T | Record<string, never> {
	return value ? { ...value } : {};
}
 
function cloneOptionalObject<T extends object>(value: T | null | undefined): T | null {
	if (value === null) {
		return null;
	}
 
	return value ? { ...value } : null;
}
 
function preferValue<T>(incomingValue: T | undefined, originalValue: T | undefined, fallbackValue: T): T {
	return incomingValue ?? originalValue ?? fallbackValue;
}
 
function preferOptionalObject<T extends object>(incomingValue: T | null | undefined, originalValue: T | null | undefined): T | null {
	Eif (incomingValue !== undefined) {
		return cloneOptionalObject(incomingValue);
	}
 
	return cloneOptionalObject(originalValue);
}
 
function preferExtensionElements(incomingValue: string[] | undefined, originalValue: string[] | undefined): string[] {
	if (incomingValue && incomingValue.length > 0) {
		return [...incomingValue];
	}
 
	return [...(originalValue || [])];
}
 
export function mergeElementState(
	originalState: FlowableElementState | undefined,
	incomingState: FlowableElementState | undefined,
): FlowableElementState | undefined {
	Iif (!originalState && !incomingState) {
		return undefined;
	}
 
	const base = originalState || incomingState;
	Iif (!base) {
		return undefined;
	}
 
	return {
		id: preferValue(incomingState?.id, originalState?.id, base.id),
		type: preferValue(incomingState?.type, originalState?.type, base.type),
		activitiAttributes: cloneRecord(incomingState?.activitiAttributes ?? originalState?.activitiAttributes),
		fieldExtensions: cloneArray(incomingState?.fieldExtensions ?? originalState?.fieldExtensions),
		taskListeners: cloneArray(incomingState?.taskListeners ?? originalState?.taskListeners),
		executionListeners: cloneArray(incomingState?.executionListeners ?? originalState?.executionListeners),
		formProperties: cloneArray(incomingState?.formProperties ?? originalState?.formProperties),
		inputParameters: cloneArray(incomingState?.inputParameters ?? originalState?.inputParameters),
		outputParameters: cloneArray(incomingState?.outputParameters ?? originalState?.outputParameters),
		multiInstance: preferOptionalObject(incomingState?.multiInstance, originalState?.multiInstance),
		conditionExpression: preferValue(incomingState?.conditionExpression, originalState?.conditionExpression, ''),
		script: preferValue(incomingState?.script, originalState?.script, ''),
		timerDefinition: preferOptionalObject(incomingState?.timerDefinition, originalState?.timerDefinition),
		errorRef: preferValue(incomingState?.errorRef, originalState?.errorRef, ''),
		signalRef: preferValue(incomingState?.signalRef, originalState?.signalRef, ''),
		messageRef: preferValue(incomingState?.messageRef, originalState?.messageRef, ''),
		terminateAll: preferValue(incomingState?.terminateAll, originalState?.terminateAll, ''),
		compensateActivityRef: preferValue(incomingState?.compensateActivityRef, originalState?.compensateActivityRef, ''),
		isForCompensation: preferValue(incomingState?.isForCompensation, originalState?.isForCompensation, ''),
		failedJobRetryTimeCycle: preferValue(incomingState?.failedJobRetryTimeCycle, originalState?.failedJobRetryTimeCycle, ''),
		exceptionMaps: cloneArray(incomingState?.exceptionMaps ?? originalState?.exceptionMaps),
		documentation: preferValue(incomingState?.documentation, originalState?.documentation, ''),
		preservedAttributes: {
			...originalState?.preservedAttributes,
			...incomingState?.preservedAttributes,
		},
		preservedExtensionElements: preferExtensionElements(incomingState?.preservedExtensionElements, originalState?.preservedExtensionElements),
	};
}
 
function cloneIdentifiedCollection<T extends XmlIdentified>(items: T[]): T[] {
	return items.map((item) => ({ ...item }));
}
 
function cloneValue<T>(value: T): T {
	Iif (Array.isArray(value)) {
		return [...value] as T;
	}
 
	if (value && typeof value === 'object') {
		return { ...value } as T;
	}
 
	return value;
}
 
function areValuesEquivalent<T>(left: T, right: T): boolean {
	return JSON.stringify(left) === JSON.stringify(right);
}
 
export function mergeSerializedValue<T>(originalValue: T, serializedValue: T, incomingValue: T): T {
	if (!areValuesEquivalent(incomingValue, originalValue)) {
		return cloneValue(incomingValue);
	}
 
	return cloneValue(serializedValue);
}
 
export function mergeSerializedOverlayValue<T>(
	originalValue: T,
	serializedValue: T,
	incomingValue: T,
	preserveOriginalOnEmptySerialized: boolean,
	isEmpty: (value: T) => boolean,
): T {
	if (!areValuesEquivalent(incomingValue, originalValue)) {
		return cloneValue(incomingValue);
	}
 
	if (preserveOriginalOnEmptySerialized && isEmpty(serializedValue)) {
		return cloneValue(originalValue);
	}
 
	return cloneValue(serializedValue);
}
 
function stripXmlIdentity<T extends XmlIdentified>(item: T): Omit<T, 'xmlIdentity'> {
	const { xmlIdentity: _xmlIdentity, ...rest } = item;
	return rest;
}
 
function areCollectionsEquivalent<T extends XmlIdentified>(left: T[], right: T[]): boolean {
	if (left.length !== right.length) {
		return false;
	}
 
	return left.every((item, index) => {
		const other = right[index];
		Iif (!other) {
			return false;
		}
		return JSON.stringify(stripXmlIdentity(item)) === JSON.stringify(stripXmlIdentity(other));
	});
}
 
function areItemsEquivalent<T extends XmlIdentified>(left: T | undefined, right: T | undefined): boolean {
	Iif (!left || !right) {
		return left === right;
	}
 
	return JSON.stringify(stripXmlIdentity(left)) === JSON.stringify(stripXmlIdentity(right));
}
 
function areCollectionKeysEquivalent<T extends XmlIdentified>(
	left: T[],
	right: T[],
	getKey: (item: T) => string,
): boolean {
	if (left.length !== right.length) {
		return false;
	}
 
	return left.every((item, index) => {
		const other = right[index];
		return Boolean(other) && getKey(item) === getKey(other);
	});
}
 
function createMergedRecordBase<T extends XmlIdentified>(
	originalItem: T | undefined,
	serializedItem: T | undefined,
	incomingItem: T,
): Record<string, unknown> {
	return {
		...((serializedItem ?? originalItem ?? incomingItem) as unknown as Record<string, unknown>),
	};
}
 
function collectMergeKeys(
	originalRecord: Record<string, unknown>,
	serializedRecord: Record<string, unknown>,
	incomingRecord: Record<string, unknown>,
): Set<string> {
	return new Set([
		...Object.keys(originalRecord),
		...Object.keys(serializedRecord),
		...Object.keys(incomingRecord),
	]);
}
 
function mergeSerializedCollectionItem<T extends XmlIdentified>(
	originalItem: T | undefined,
	serializedItem: T | undefined,
	incomingItem: T,
): T {
	const originalRecord = (originalItem ?? EMPTY_RECORD) as Record<string, unknown>;
	const serializedRecord = (serializedItem ?? EMPTY_RECORD) as Record<string, unknown>;
	const incomingRecord = incomingItem as unknown as Record<string, unknown>;
	const mergedRecord = createMergedRecordBase(originalItem, serializedItem, incomingItem);
	const keys = collectMergeKeys(originalRecord, serializedRecord, incomingRecord);
 
	for (const key of keys) {
		if (key === 'xmlIdentity') {
			continue;
		}
 
		if (!originalItem) {
			mergedRecord[key] = incomingRecord[key];
			continue;
		}
 
		if (incomingRecord[key] !== originalRecord[key]) {
			mergedRecord[key] = incomingRecord[key];
			continue;
		}
 
		if (serializedItem && key in serializedRecord) {
			mergedRecord[key] = serializedRecord[key];
			continue;
		}
 
		mergedRecord[key] = incomingRecord[key];
	}
 
	mergedRecord.xmlIdentity = incomingItem.xmlIdentity || serializedItem?.xmlIdentity || originalItem?.xmlIdentity;
	return mergedRecord as T;
}
 
function mergeAlignedSerializedCollectionState<T extends XmlIdentified>(
	originalByKey: Map<string, T>,
	serializedItems: T[],
	incomingItems: T[],
	incomingByKey: Map<string, T>,
	serializedByKey: Map<string, T>,
	getKey: (item: T) => string,
): T[] {
	const mergedItems: T[] = [];
	const includedKeys = new Set<string>();
 
	for (const serializedItem of serializedItems) {
		const key = getKey(serializedItem);
		const originalItem = originalByKey.get(key);
		const incomingItem = incomingByKey.get(key);
 
		Iif (!incomingItem) {
			if (!originalItem) {
				mergedItems.push({ ...serializedItem });
				includedKeys.add(key);
			}
			continue;
		}
 
		mergedItems.push(mergeSerializedCollectionItem(originalItem, serializedItem, incomingItem));
		includedKeys.add(key);
	}
 
	for (const incomingItem of incomingItems) {
		const key = getKey(incomingItem);
		if (includedKeys.has(key)) {
			continue;
		}
 
		const originalItem = originalByKey.get(key);
		Iif (originalItem && areItemsEquivalent(incomingItem, originalItem)) {
			continue;
		}
 
		mergedItems.push(mergeSerializedCollectionItem(originalItem, serializedByKey.get(key), incomingItem));
	}
 
	return mergedItems;
}
 
function mergeReorderedSerializedCollectionState<T extends XmlIdentified>(
	originalByKey: Map<string, T>,
	serializedItems: T[],
	incomingItems: T[],
	serializedByKey: Map<string, T>,
	getKey: (item: T) => string,
): T[] {
	const mergedItems: T[] = [];
	const includedKeys = new Set<string>();
 
	for (const incomingItem of incomingItems) {
		const key = getKey(incomingItem);
		const originalItem = originalByKey.get(key);
		const serializedItem = serializedByKey.get(key);
 
		Iif (!serializedItem && originalItem && areItemsEquivalent(incomingItem, originalItem)) {
			continue;
		}
 
		mergedItems.push(mergeSerializedCollectionItem(originalItem, serializedItem, incomingItem));
		includedKeys.add(key);
	}
 
	for (const serializedItem of serializedItems) {
		const key = getKey(serializedItem);
		Iif (!includedKeys.has(key) && !originalByKey.has(key)) {
			mergedItems.push({ ...serializedItem });
		}
	}
 
	return mergedItems;
}
 
export function mergeSerializedCollectionState<T extends XmlIdentified>(
	originalItems: T[],
	serializedItems: T[],
	incomingItems: T[],
	getKey: (item: T) => string,
): T[] {
	if (areCollectionsEquivalent(incomingItems, originalItems)) {
		return cloneIdentifiedCollection(serializedItems);
	}
 
	const originalByKey = new Map(originalItems.map((item) => [getKey(item), item]));
	const serializedByKey = new Map(serializedItems.map((item) => [getKey(item), item]));
	const incomingByKey = new Map(incomingItems.map((item) => [getKey(item), item]));
	const incomingStructureMatchesOriginal = areCollectionKeysEquivalent(incomingItems, originalItems, getKey);
 
	if (incomingStructureMatchesOriginal) {
		return mergeAlignedSerializedCollectionState(
			originalByKey,
			serializedItems,
			incomingItems,
			incomingByKey,
			serializedByKey,
			getKey,
		);
	}
 
	return mergeReorderedSerializedCollectionState(originalByKey, serializedItems, incomingItems, serializedByKey, getKey);
}
 
export function mergePreservedExtensionElements(
	baseElements: string[],
	serializedElements: string[],
	serializedHadExtensionContainer = serializedElements.length > 0,
	preserveMissingContainerElements = true,
): string[] {
	if (serializedElements.length === 0 && !serializedHadExtensionContainer && preserveMissingContainerElements) {
		return [...baseElements];
	}
 
	return [...serializedElements];
}
 
export function mergeSerializedProcessExtensionStates(
	originalItems: FlowableProcessExtensionState[],
	serializedItems: FlowableProcessExtensionState[],
	incomingItems: FlowableProcessExtensionState[],
	serializedProcessIdsWithExtensionElements: Set<string>,
	preserveMissingContainerElements = true,
): FlowableProcessExtensionState[] {
	const originalByProcessId = new Map(originalItems.map((item) => [item.processId || '', item] as const));
	const serializedByProcessId = new Map(serializedItems.map((item) => [item.processId || '', item] as const));
	const incomingByProcessId = new Map(incomingItems.map((item) => [item.processId || '', item] as const));
	const processIds = new Set<string>([
		...originalByProcessId.keys(),
		...serializedByProcessId.keys(),
		...incomingByProcessId.keys(),
	]);
	const mergedItems: FlowableProcessExtensionState[] = [];
 
	for (const processId of processIds) {
		const originalPreserved = originalByProcessId.get(processId)?.preservedExtensionElements || [];
		const incomingPreserved = incomingByProcessId.get(processId)?.preservedExtensionElements || originalPreserved;
		const serializedPreserved = serializedByProcessId.get(processId)?.preservedExtensionElements || [];
		const serializedHadExtensionContainer = serializedProcessIdsWithExtensionElements.has(processId);
		const mergedPreserved = areValuesEquivalent(incomingPreserved, originalPreserved)
			? mergePreservedExtensionElements(
				originalPreserved,
				serializedPreserved,
				serializedHadExtensionContainer,
				preserveMissingContainerElements,
			)
			: [...incomingPreserved];
 
		if (mergedPreserved.length > 0) {
			mergedItems.push({
				processId,
				preservedExtensionElements: mergedPreserved,
			});
		}
	}
 
	return mergedItems;
}
 
export function getStableCollectionKey<T extends XmlIdentified>(item: T, fallbackKey: string): string {
	return item.xmlIdentity || fallbackKey;
}