-
Notifications
You must be signed in to change notification settings - Fork 3
/
getWorkflow.js
223 lines (182 loc) · 8.25 KB
/
getWorkflow.js
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
'use strict';
const hoek = require('@hapi/hoek');
/**
* Remove the ~ prefix for logical OR on select node names.
* @method filterNodeName
* @param {String} name A Node Name, e.g. foo, ~foo, ~pr, ~commit, ~release, ~tag, ~sd@1234:foo
* @return {String} A filtered node name, e.g. foo, foo, ~pr, ~commit, ~release, ~tag, ~sd@1234:foo
*/
const filterNodeName = name => (/^~((pr|commit|release|tag)(?:$|:)|(sd@))/.test(name) ? name : name.replace('~', ''));
/**
* Build external nodes for its downstream jobs, DFS to traverse its children
* @method buildExternalNodes
* @param {Array} children Array of downstream jobs. ex: [sd@456:test, sd@789:test]
* @param {Set} nodes List of graph nodes
* @param {TriggerFactory} triggerFactory triggerFactory to figure out its downstream jobs
* @return {Promise} List of graph nodes
*/
const buildExternalNodes = async (children, nodes, triggerFactory) => {
await Promise.all(
children.map(async dest => {
nodes.add(dest.replace('~sd@', 'sd@'));
const newChildren = await triggerFactory.getDestFromSrc(dest);
await buildExternalNodes(newChildren, nodes, triggerFactory);
})
);
};
/**
* Get the list of nodes for the graph
* @method calculateNodes
* @param {Object} jobs Hash of job configs
* @param {TriggerFactory} triggerFactory Trigger Factory to find external triggers
* @param {Number} pipelineId Id of the current pipeline
* @return {Array} List of nodes (jobs)
*/
const calculateNodes = async (jobs, triggerFactory, pipelineId) => {
const nodes = new Set(['~pr', '~commit']);
// for backward compatibility. TODO: remove this block later
if (!triggerFactory) {
Object.keys(jobs).forEach(name => {
nodes.add(name);
if (Array.isArray(jobs[name].requires)) {
jobs[name].requires.forEach(n => nodes.add(filterNodeName(n)));
}
});
return [...nodes].map(name => ({ name }));
}
// new implementation. allow external join
await Promise.all(
Object.keys(jobs).map(async jobName => {
nodes.add(jobName);
// upstream nodes
if (Array.isArray(jobs[jobName].requires)) {
jobs[jobName].requires.forEach(n => nodes.add(filterNodeName(n)));
}
// downstream nodes
const srcName = `sd@${pipelineId}:${jobName}`;
// Calculate which downstream jobs are triggered BY current job
// Only need to take care of external triggers, since internal will be taken care automatically
const externalDownstreamOr = await triggerFactory.getDestFromSrc(`~${srcName}`);
const externalDownstreamAnd = await triggerFactory.getDestFromSrc(srcName);
externalDownstreamOr.forEach(dest => {
nodes.add(dest.replace('~sd@', 'sd@'));
});
await buildExternalNodes(externalDownstreamAnd, nodes, triggerFactory);
})
);
return [...nodes].map(name => {
const m = { name };
const displayName = hoek.reach(jobs[name], 'annotations>screwdriver.cd/displayName', {
separator: '>',
default: undefined
});
if (displayName !== undefined) {
m.displayName = displayName;
}
return m;
});
};
/**
* Build external edges for its downstream jobs, DFS to traverse its children
* @method buildExternalEdges
* @param {String} root Source name. (e.g. main or sd@111:main)
* @param {Array} children Array of downstream jobs. (e.g.: [sd@456:test, sd@789:test])
* @param {Array} edges List of graph edges in the form { src, dest }
* @param {TriggerFactory} triggerFactory triggerFactory to figure out its downstream jobs
* @return {Promise} List of graph edges { src, dest }
*/
const buildExternalEdges = async (root, children, edges, triggerFactory) => {
await Promise.all(
children.map(async dest => {
edges.push({ src: root, dest: dest.replace('~sd@', 'sd@') });
const newChildren = await triggerFactory.getDestFromSrc(dest);
await buildExternalEdges(dest, newChildren, edges, triggerFactory);
})
);
};
/**
* Calculate edges of directed graph based on "requires" property of jobs
* @method calculateEdges
* @param {Object} jobs Hash of job configurations
* @param {TriggerFactory} triggerFactory Trigger Factory to find external triggers
* @param {Number} pipelineId Id of the current pipeline
* @return {Array} List of graph edges { src, dest }
*/
const calculateEdges = async (jobs, triggerFactory, pipelineId) => {
const edges = [];
// for backward compatibility. TODO: remove this block later
if (!triggerFactory) {
Object.keys(jobs).forEach(j => {
const job = jobs[j];
const dest = j;
if (Array.isArray(job.requires)) {
const specialTriggers = new Set(job.requires.filter(name => name.charAt(0) === '~'));
const normalTriggers = new Set(job.requires.filter(name => name.charAt(0) !== '~'));
const isJoin = normalTriggers.size > 1;
specialTriggers.forEach(src => {
edges.push({ src: filterNodeName(src), dest });
});
normalTriggers.forEach(src => {
const obj = { src, dest };
if (isJoin) {
obj.join = true;
}
edges.push(obj);
});
}
});
return edges;
}
// new implementation. allow external join
await Promise.all(
Object.keys(jobs).map(async jobName => {
const job = jobs[jobName];
if (Array.isArray(job.requires)) {
// Calculate which upstream jobs trigger the current job
const upstreamOr = new Set(job.requires.filter(name => name.charAt(0) === '~'));
const upstreamAnd = new Set(job.requires.filter(name => name.charAt(0) !== '~'));
const isJoin = upstreamAnd.size > 1;
upstreamOr.forEach(src => {
edges.push({ src: filterNodeName(src), dest: jobName });
});
upstreamAnd.forEach(src => {
const obj = { src, dest: jobName };
if (isJoin) {
obj.join = true;
}
edges.push(obj);
});
}
const srcName = `sd@${pipelineId}:${jobName}`;
// Calculate which downstream jobs are triggered BY current job
// Only need to take care of external triggers, since internal will be taken care automatically
const externalDownstreamOr = await triggerFactory.getDestFromSrc(`~${srcName}`);
const externalDownstreamAnd = await triggerFactory.getDestFromSrc(srcName);
externalDownstreamOr.forEach(dest => {
edges.push({ src: jobName, dest: dest.replace('~sd@', 'sd@') });
});
// Handle join case
await buildExternalEdges(jobName, externalDownstreamAnd, edges, triggerFactory);
})
);
return edges;
};
/**
* Given a pipeline config, return a directed graph configuration that describes the workflow
* @method getWorkflow
* @param {Object} pipelineConfig A Pipeline Config
* @param {Object} pipelineConfig.jobs Hash of job configs
* @param {TriggerFactory} triggerFactory Trigger Factory to find external triggers
* @param {Number} pipelineId Id of the current pipeline
* @return {Object} List of nodes and edges {nodes, edges}
*/
const getWorkflow = async (pipelineConfig, triggerFactory, pipelineId) => {
const jobConfig = pipelineConfig.jobs;
if (!jobConfig) {
throw new Error('No Job config provided');
}
const nodes = await calculateNodes(jobConfig, triggerFactory, pipelineId);
const edges = await calculateEdges(jobConfig, triggerFactory, pipelineId);
return { nodes, edges };
};
module.exports = getWorkflow;