-
Notifications
You must be signed in to change notification settings - Fork 402
/
env-controller.js
369 lines (343 loc) · 10.8 KB
/
env-controller.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
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
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
"use strict";
const { CloudFormation, waitUntilStackUpdateComplete, DescribeStacksCommand, UpdateStackCommand } = require("@aws-sdk/client-cloudformation");
// These are used for test purposes only
let defaultResponseURL;
let defaultLogGroup;
let defaultLogStream;
const AliasParamKey = "Aliases";
// Per the doc at https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html
// the size of the response body should not exceed 4096 bytes.
// Therefore, we should ignore any outputs that we don't need.
let ignoredEnvOutputs = new Set(["EnabledFeatures", "LastForceDeployID"]);
/**
* Upload a CloudFormation response object to S3.
*
* @param {object} event the Lambda event payload received by the handler function
* @param {object} context the Lambda context received by the handler function
* @param {string} responseStatus the response status, either 'SUCCESS' or 'FAILED'
* @param {string} physicalResourceId CloudFormation physical resource ID
* @param {object} [responseData] arbitrary response data object
* @param {string} [reason] reason for failure, if any, to convey to the user
* @returns {Promise} Promise that is resolved on success, or rejected on connection error or HTTP error response
*/
let report = function (
event,
context,
responseStatus,
physicalResourceId,
responseData,
reason
) {
return new Promise((resolve, reject) => {
const https = require("https");
const { URL } = require("url");
var responseBody = JSON.stringify({
Status: responseStatus,
Reason: reason,
PhysicalResourceId: physicalResourceId || context.logStreamName,
StackId: event.StackId,
RequestId: event.RequestId,
LogicalResourceId: event.LogicalResourceId,
Data: responseData,
});
const parsedUrl = new URL(event.ResponseURL || defaultResponseURL);
const options = {
hostname: parsedUrl.hostname,
port: 443,
path: parsedUrl.pathname + parsedUrl.search,
method: "PUT",
headers: {
"Content-Type": "",
"Content-Length": responseBody.length,
},
};
https
.request(options)
.on("error", reject)
.on("response", (res) => {
res.resume();
if (res.statusCode >= 400) {
reject(new Error(`Error ${res.statusCode}: ${res.statusMessage}`));
} else {
resolve();
}
})
.end(responseBody, "utf8");
});
};
/**
* Update the environment stack's parameters by adding or removing {workload} from the provided {parameters}.
*
* @param {string} stackName Name of the stack.
* @param {string} workload Name of the copilot workload.
* @param {string[]} envControllerParameters List of parameters from the environment stack to update.
*
* @returns {parameters} The updated parameters.
*/
const controlEnv = async function (
stackName,
workload,
aliases,
envControllerParameters
) {
var cfn = new CloudFormation();
aliases = aliases || [];
envControllerParameters = envControllerParameters || [];
while (true) {
var describeStackResp = await cfn
.send(new DescribeStacksCommand({
StackName: stackName
}));
if (describeStackResp.Stacks.length !== 1) {
throw new Error(`Cannot find environment stack ${stackName}`);
}
const updatedEnvStack = describeStackResp.Stacks[0];
const envParams = JSON.parse(JSON.stringify(updatedEnvStack.Parameters));
const envSet = setOfParameterKeysWithWorkload(envParams, workload);
const controllerSet = new Set(
envControllerParameters.filter((param) => param.endsWith("Workloads"))
);
const parametersToRemove = [...envSet].filter(
(param) => !controllerSet.has(param)
);
const parametersToAdd = [...controllerSet].filter(
(param) => !envSet.has(param)
);
const exportedValues = getExportedValues(updatedEnvStack);
// If there are no changes in env-controller managed parameters, the custom
// resource may have been triggered because the env template is upgraded,
// and the service template is attempting to retrieve the latest Outputs
// from the env stack (see PR #3957). Return the updated Outputs instead
// of triggering an env-controller update of the environment.
const shouldUpdateAliases = needUpdateAliases(envParams, workload, aliases);
if (
parametersToRemove.length + parametersToAdd.length === 0 &&
!shouldUpdateAliases
) {
return exportedValues;
}
for (const envParam of envParams) {
if (envParam.ParameterKey === AliasParamKey) {
if (shouldUpdateAliases) {
envParam.ParameterValue = updateAliases(
envParam.ParameterValue,
workload,
aliases
);
}
continue;
}
if (parametersToRemove.includes(envParam.ParameterKey)) {
const values = new Set(
envParam.ParameterValue.split(",").filter(Boolean)
); // Filter out the empty string
// in the output array to prevent a leading comma in the parameters list.
values.delete(workload);
envParam.ParameterValue = [...values].join(",");
}
if (parametersToAdd.includes(envParam.ParameterKey)) {
const values = new Set(
envParam.ParameterValue.split(",").filter(Boolean)
);
values.add(workload);
envParam.ParameterValue = [...values].join(",");
}
}
try {
await cfn
.send(new UpdateStackCommand({
StackName: stackName,
Parameters: envParams,
UsePreviousTemplate: true,
RoleARN: exportedValues["CFNExecutionRoleARN"],
Capabilities: updatedEnvStack.Capabilities,
}));
} catch (err) {
if (
!err.message.match(
/^Stack.*is in UPDATE_IN_PROGRESS state and can not be updated/
)
) {
throw err;
}
// If the other workload is updating the env stack, wait until update completes.
await exports.waitForStackUpdate(cfn, stackName);
continue;
}
// Wait until update complete, then return the updated env stack output.
await exports.waitForStackUpdate(cfn, stackName);
describeStackResp = await cfn
.send(new DescribeStacksCommand({
StackName: stackName,
}));
if (describeStackResp.Stacks.length !== 1) {
throw new Error(`Cannot find environment stack ${stackName}`);
}
return getExportedValues(describeStackResp.Stacks[0]);
}
};
const waitForStackUpdate = async function (cfn, stackName) {
await waitUntilStackUpdateComplete({
client: cfn,
maxWaitTime: 30 * 29,
minDelay: 30,
maxDelay: 30,
},{
StackName: stackName,
});
};
/**
* Environment controller handler, invoked by Lambda.
*/
exports.handler = async function (event, context) {
var responseData = {};
const props = event.ResourceProperties;
const physicalResourceId =
event.PhysicalResourceId ||
`envcontoller/${props.EnvStack}/${props.Workload}`;
try {
switch (event.RequestType) {
case "Create":
responseData = await Promise.race([
exports.deadlineExpired(),
controlEnv(
props.EnvStack,
props.Workload,
props.Aliases,
props.Parameters
),
]);
break;
case "Update":
responseData = await Promise.race([
exports.deadlineExpired(),
controlEnv(
props.EnvStack,
props.Workload,
props.Aliases,
props.Parameters
),
]);
break;
case "Delete":
responseData = await Promise.race([
exports.deadlineExpired(),
controlEnv(
props.EnvStack,
props.Workload,
[] // Set to empty to denote that Workload should not be included in any env stack parameter.
),
]);
break;
default:
throw new Error(`Unsupported request type ${event.RequestType}`);
}
await report(event, context, "SUCCESS", physicalResourceId, responseData);
} catch (err) {
console.log(`Caught error ${err}.`);
console.log(
`Responding FAILED for physical resource id: ${physicalResourceId}`
);
await report(
event,
context,
"FAILED",
physicalResourceId,
null,
`${err.message} (Log: ${defaultLogGroup || context.logGroupName}/${
defaultLogStream || context.logStreamName
})`
);
}
};
function setOfParameterKeysWithWorkload(cfnParams, workload) {
const envSet = new Set();
cfnParams.forEach((param) => {
if (!param.ParameterKey.endsWith("Workloads")) {
return;
}
let values = new Set(param.ParameterValue.split(","));
if (!values.has(workload)) {
return;
}
envSet.add(param.ParameterKey);
});
return envSet;
}
function needUpdateAliases(cfnParams, workload, aliases) {
for (const param of cfnParams) {
if (param.ParameterKey !== AliasParamKey) {
continue;
}
let obj = JSON.parse(param.ParameterValue || "{}");
if ((obj[workload] || []).toString() !== aliases.toString()) {
return true;
}
}
return false;
}
const updateAliases = function (cfnAliases, workload, aliases) {
let obj = JSON.parse(cfnAliases || "{}");
if (aliases.length !== 0) {
obj[workload] = aliases;
} else {
obj[workload] = undefined;
}
const updatedAliases = JSON.stringify(obj);
return updatedAliases === "{}" ? "" : updatedAliases;
};
const getExportedValues = function (stack) {
const exportedValues = {};
stack.Outputs.forEach((output) => {
if (ignoredEnvOutputs.has(output.OutputKey)) {
return;
}
exportedValues[output.OutputKey] = output.OutputValue;
});
return exportedValues;
};
/**
* Update parameter by adding workload to the parameter values.
*
* @param {string} requestType type of the request.
* @param {string} workload name of the workload.
* @param {string} paramValue value of the parameter.
*
* @returns {string} The updated parameter.
* @returns {bool} whether the parameter is modified.
*/
exports.deadlineExpired = function () {
return new Promise(function (resolve, reject) {
setTimeout(
reject,
14 * 60 * 1000 + 30 * 1000 /* 14.5 minutes*/,
new Error("Lambda took longer than 14.5 minutes to update environment")
);
});
};
/**
* @private
*/
exports.withDefaultResponseURL = function (url) {
defaultResponseURL = url;
};
/**
* @private
*/
exports.withDefaultLogStream = function (logStream) {
defaultLogStream = logStream;
};
/**
* @private
*/
exports.withDefaultLogGroup = function (logGroup) {
defaultLogGroup = logGroup;
};
/**
* @private
*/
exports.waitForStackUpdate = function(cfn, stackName) {
return waitForStackUpdate(cfn, stackName);
}