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
377import isEqual from 'lodash/isEqual';
import pick from 'lodash/pick';
import type {
IConnections,
INode,
INodeParameters,
IWorkflowBase,
NodeParameterValueType,
} from '.';
import { compareConnections, type ConnectionsDiff } from './connections-diff';
export type WorkflowDiffBase = Omit<
IWorkflowBase,
'id' | 'active' | 'activeVersionId' | 'isArchived' | 'name'
> & { name: string | null };
export type DiffableNode = Pick<INode, 'id' | 'parameters' | 'name'>;
export type DiffableWorkflow<N extends DiffableNode = DiffableNode> = {
nodes: N[];
connections: IConnections;
createdAt: Date;
authors?: string;
};
export const enum NodeDiffStatus {
Eq = 'equal',
Modified = 'modified',
Added = 'added',
Deleted = 'deleted',
}
export type NodeDiff<T> = {
status: NodeDiffStatus;
node: T;
};
export type WorkflowDiff<T> = Map<string, NodeDiff<T>>;
export function compareNodes<T extends DiffableNode>(
base: T | undefined,
target: T | undefined,
): boolean {
const propsToCompare = ['name', 'type', 'typeVersion', 'webhookId', 'credentials', 'parameters'];
const baseNode = pick(base, propsToCompare);
const targetNode = pick(target, propsToCompare);
return isEqual(baseNode, targetNode);
}
export function compareWorkflowsNodes<T extends DiffableNode>(
base: T[],
target: T[],
nodesEqual: (base: T | undefined, target: T | undefined) => boolean = compareNodes,
): WorkflowDiff<T> {
const baseNodes = base.reduce<Map<string, T>>((acc, node) => {
acc.set(node.id, node);
return acc;
}, new Map());
const targetNodes = target.reduce<Map<string, T>>((acc, node) => {
acc.set(node.id, node);
return acc;
}, new Map());
const diff: WorkflowDiff<T> = new Map();
for (const [id, node] of baseNodes.entries()) {
if (!targetNodes.has(id)) {
diff.set(id, { status: NodeDiffStatus.Deleted, node });
} else if (!nodesEqual(baseNodes.get(id), targetNodes.get(id))) {
diff.set(id, { status: NodeDiffStatus.Modified, node });
} else {
diff.set(id, { status: NodeDiffStatus.Eq, node });
}
}
for (const [id, node] of targetNodes.entries()) {
if (!baseNodes.has(id)) {
diff.set(id, { status: NodeDiffStatus.Added, node });
}
}
return diff;
}
export class WorkflowChangeSet<T extends DiffableNode> {
readonly nodes: WorkflowDiff<T>;
readonly connections: ConnectionsDiff;
constructor(from: DiffableWorkflow<T>, to: DiffableWorkflow<T>) {
if (from === to) {
// avoid expensive deep comparison
this.nodes = new Map(
from.nodes.map((node) => [node.id, { node, status: NodeDiffStatus.Eq }]),
);
this.connections = { added: {}, removed: {} };
} else {
this.nodes = compareWorkflowsNodes(from.nodes, to.nodes);
this.connections = compareConnections(from.connections, to.connections);
}
}
}
/**
* Determines whether the second node is a "superset" of the first one, i.e. whether no data
* is lost if we were to replace `prev` with `next`.
*
* Specifically this is the case if
* - Both nodes have the exact same keys
* - All values are either strings where `next.x` contains `prev.x`, or hold the exact same value
*/
function nodeIsSuperset<T extends DiffableNode>(prevNode: T, nextNode: T) {
const { parameters: prevParams, ...prev } = prevNode;
const { parameters: nextParams, ...next } = nextNode;
// abort if the nodes don't match besides parameters
if (!compareNodes({ ...prev, parameters: {} }, { ...next, parameters: {} })) return false;
const params = Object.keys(prevParams);
// abort if keys differ
if (params.some((x) => !Object.prototype.hasOwnProperty.call(nextParams, x))) return false;
if (Object.keys(nextParams).some((x) => !Object.prototype.hasOwnProperty.call(prevParams, x)))
return false;
for (const key of params) {
const left = prevParams[key];
const right = nextParams[key];
// non-strings must be exactly equal to not be lost data
if (typeof left === 'string' && typeof right === 'string') {
// strings must only be contained in the new string
if (!right.includes(left)) return false;
} else if (left !== right) return false;
}
return true;
}
function mergeAdditiveChanges<N extends DiffableNode = DiffableNode>(
_prev: DiffableWorkflow<N>,
next: DiffableWorkflow<N>,
diff: WorkflowChangeSet<N>,
) {
for (const d of diff.nodes.values()) {
if (d.status === NodeDiffStatus.Deleted) return false;
if (d.status === NodeDiffStatus.Added) continue;
const nextNode = next.nodes.find((x) => x.id === d.node.id);
if (!nextNode) throw new Error('invariant broken - no next node');
if (d.status === NodeDiffStatus.Modified && !nodeIsSuperset(d.node, nextNode)) return false;
}
if (Object.keys(diff.connections.removed).length > 0) return false;
return true;
}
// We want to avoid merging versions from different editing "sessions"
//
const makeSkipTimeDifference = (timeDiffMs: number) => {
return <N extends DiffableNode = DiffableNode>(
prev: DiffableWorkflow<N>,
next: DiffableWorkflow<N>,
) => {
const timeDifference = next.createdAt.getTime() - prev.createdAt.getTime();
return Math.abs(timeDifference) > timeDiffMs;
};
};
const makeMergeShortTimeSpan = (timeDiffMs: number) => {
return <N extends DiffableNode = DiffableNode>(
prev: DiffableWorkflow<N>,
next: DiffableWorkflow<N>,
) => {
const timeDifference = next.createdAt.getTime() - prev.createdAt.getTime();
return Math.abs(timeDifference) < timeDiffMs;
};
};
// Takes a mapping from minimumSize to the minimum time between versions and
// applies the largest one applicable to the given workflow
function makeMergeDependingOnSizeRule<W extends DiffableWorkflow>(mapping: Map<number, number>) {
const pairs = [...mapping.entries()]
.sort((a, b) => b[0] - a[0])
.map(([count, time]) => [count, makeMergeShortTimeSpan(time)] as const);
return <N extends DiffableNode = DiffableNode>(
prev: DiffableWorkflow<N>,
next: DiffableWorkflow<N>,
_wcs: WorkflowChangeSet<N>,
metaData: DiffMetaData,
) => {
if (metaData.workflowSizeScore === undefined) {
console.warn('Called mergeDependingOnSizeRule rule without providing required metaData');
return false;
}
for (const [count, time] of pairs) {
if (metaData.workflowSizeScore > count) return time(prev, next);
}
return false;
};
}
function skipDifferentUsers<N extends DiffableNode = DiffableNode>(
prev: DiffableWorkflow<N>,
next: DiffableWorkflow<N>,
) {
return next.authors !== prev.authors;
}
export const RULES = {
mergeAdditiveChanges,
makeMergeDependingOnSizeRule,
};
export const SKIP_RULES = {
makeSkipTimeDifference,
skipDifferentUsers,
};
// MetaData fields are only included if requested
export type DiffMetaData = Partial<{
workflowSizeScore: number;
}>;
export type DiffRule<
W extends WorkflowDiffBase = WorkflowDiffBase,
N extends W['nodes'][number] = W['nodes'][number],
> = (prev: W, next: W, diff: WorkflowChangeSet<N>, metaData: Partial<DiffMetaData>) => boolean;
// Rough estimation of a node's size in abstract "character" count
// Does not care about key names which do technically factor in when stringified
export function determineNodeSize(parameters: INodeParameters | NodeParameterValueType): number {
if (!parameters) return 1;
if (typeof parameters === 'string') {
return parameters.length;
} else if (typeof parameters !== 'object' || parameters instanceof Date) {
return 1;
} else if (Array.isArray(parameters)) {
return parameters.reduce<number>((acc, v) => acc + determineNodeSize(v as INodeParameters), 1);
} else {
// Record case
return Object.values(parameters).reduce<number>(
(acc, v) => acc + determineNodeSize(v as NodeParameterValueType),
1,
);
}
}
function determineNodeParametersSize<W extends WorkflowDiffBase>(workflow: W) {
return workflow.nodes.reduce((acc, x) => acc + determineNodeSize(x.parameters), 0);
}
export function groupWorkflows<W extends WorkflowDiffBase = WorkflowDiffBase>(
workflows: W[],
rules: Array<DiffRule<W>>,
skipRules: Array<DiffRule<W>> = [],
metaDataFields?: Partial<Record<keyof DiffMetaData, boolean>>,
): { removed: W[]; remaining: W[] } {
if (workflows.length === 0) return { removed: [], remaining: [] };
if (workflows.length === 1) {
return {
removed: [],
remaining: workflows,
};
}
const remaining = [...workflows];
const removed: W[] = [];
const n = remaining.length;
const metaData = {
// check latest and an "average" workflow to get a somewhat accurate representation
// without counting through the entire history
workflowSizeScore: metaDataFields?.workflowSizeScore
? Math.max(
determineNodeParametersSize(workflows[Math.floor(workflows.length / 2)]),
determineNodeParametersSize(workflows[workflows.length - 1]),
)
: undefined,
} satisfies DiffMetaData;
diffLoop: for (let i = n - 1; i > 0; --i) {
const wcs = new WorkflowChangeSet(remaining[i - 1], remaining[i]);
for (const shouldSkip of skipRules) {
if (shouldSkip(remaining[i - 1], remaining[i], wcs, metaData)) continue diffLoop;
}
for (const rule of rules) {
const shouldMerge = rule(remaining[i - 1], remaining[i], wcs, metaData);
if (shouldMerge) {
const left = remaining.splice(i - 1, 1)[0];
removed.push(left);
break;
}
}
}
return { removed, remaining };
}
/**
* Checks if workflows have non-positional differences (changes to nodes or connections,
* excluding position changes).
* Returns true if there are meaningful changes, false if only positions changed.
*/
export function hasNonPositionalChanges(
oldNodes: INode[],
newNodes: INode[],
oldConnections: IConnections,
newConnections: IConnections,
): boolean {
// Check for node changes (compareNodes already excludes position)
const nodesDiff = compareWorkflowsNodes(oldNodes, newNodes);
for (const diff of nodesDiff.values()) {
if (diff.status !== NodeDiffStatus.Eq) {
return true;
}
}
// Check for connection changes (connections don't have position data)
if (!isEqual(oldConnections, newConnections)) {
return true;
}
return false;
}
/**
* Checks if any credential IDs changed between old and new workflow nodes.
* Compares node by node - returns true if for any node:
* - A credential was added (new credential type not in old node)
* - A credential was removed (old credential type not in new node)
* - A credential was changed (same credential type but different credential ID)
*/
export function hasCredentialChanges(oldNodes: INode[], newNodes: INode[]): boolean {
const newNodesMap = new Map(newNodes.map((node) => [node.id, node]));
for (const oldNode of oldNodes) {
const newNode = newNodesMap.get(oldNode.id);
// Skip nodes that were deleted - deletion is not a credential change
if (!newNode) continue;
const oldCreds = oldNode.credentials ?? {};
const newCreds = newNode.credentials ?? {};
const oldCredTypes = Object.keys(oldCreds);
const newCredTypes = Object.keys(newCreds);
// Check for removed credentials (in old but not in new)
for (const credType of oldCredTypes) {
if (!(credType in newCreds)) {
return true; // Credential removed
}
// Check for changed credentials (same type but different ID)
if (oldCreds[credType]?.id !== newCreds[credType]?.id) {
return true; // Credential changed
}
}
// Check for added credentials (in new but not in old)
for (const credType of newCredTypes) {
if (!(credType in oldCreds)) {
return true; // Credential added
}
}
}
return false;
}