-
Notifications
You must be signed in to change notification settings - Fork 36
/
devops.js
595 lines (576 loc) · 28 KB
/
devops.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
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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
import File from './file.js';
import path from 'node:path';
import inquirer from 'inquirer';
import { Util } from './util.js';
import Cli from './cli.js';
import { simpleGit } from 'simple-git';
const git = simpleGit();
import Builder from '../Builder.js';
import MetadataType from '../MetadataTypeInfo.js';
import jsonToTable from 'json-to-table';
/**
* @typedef {import('../../types/mcdev.d.js').AuthObject} AuthObject
* @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
* @typedef {import('../../types/mcdev.d.js').Cache} Cache
* @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
* @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
* @typedef {import('../../types/mcdev.d.js').DeltaPkgItem} DeltaPkgItem
* @typedef {import('../../types/mcdev.d.js').Mcdevrc} Mcdevrc
* @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
* @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
* @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
* @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
* @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
* @typedef {import('../../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
* @typedef {import('../../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
* @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
* @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
* @typedef {import('../../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
*/
/**
* DevOps helper class
*/
const DevOps = {
/**
* Extracts the delta between a commit and the current state for deployment.
* Interactive commit selection if no commits are passed.
*
* @param {Mcdevrc} properties central properties object
* @param {string} [range] git commit range
* @param {boolean} [saveToDeployDir] if true, copy metadata changes into deploy directory
* @param {string} [filterPathsCSV] filter file paths that start with any specified path (comma separated)
* @param {number} [commitHistory] cli option to override default commit history value in config
* @returns {Promise.<DeltaPkgItem[]>} -
*/
async getDeltaList(properties, range, saveToDeployDir, filterPathsCSV, commitHistory) {
const rangeUserInput = range;
const filterPaths = filterPathsCSV
? filterPathsCSV.split(',').map((filePath) =>
path
.normalize(properties.directories.retrieve + filePath)
.split('\\')
.join('/')
)
: [properties.directories.retrieve];
if (range) {
if (!range.includes('..')) {
// we limit the user here somewhat by always comparing to current branch if no range was given
// this should make it easier in most scenrios though
range = range + '..HEAD';
}
Util.logger.info(
`Analyzing changes in directories: ${filterPaths} based on commit range: ${range}`
);
} else {
// get the last 10 commits by default to choose from. Default can be changed in mcdev config.
// Current commit is skipped due to no changes
const commits = await git.log([
'--skip=1',
`-${commitHistory || properties.options.deployment.commitHistory || 10}`,
]);
const display = commits.all.map((commit) => ({
name: commit.date + ' / ' + commit.message + ' / ' + commit.author_name,
value: commit.hash,
}));
// @ts-expect-error type checking this push() makes things very complicated...
display.push(new inquirer.Separator(' ==== '));
const responses = await inquirer.prompt([
{
type: 'list',
message: 'Select base commit for comparison with current commit',
name: 'commit',
pageSize: 10,
choices: display,
},
]);
range = `${responses.commit}..HEAD`;
}
const metadata = {};
// TODO: add filter based on if metadata type is deployable or not
const gitActionsCounter = {
delete: 0,
'add/update': 0,
move: 0,
};
/**
* @type {DeltaPkgItem[]}
*/
const delta = (await git.diffSummary([range])).files
// populate additional info for all changed files
.map((/** @type {DeltaPkgItem} */ file) => {
// If file was moved it's path needs to be parsed
file.moved = file.file.includes('=>');
if (file.moved) {
const p = file.file;
// TODO: rewrite remaining substring() to slice()
const paths = {
base: p.slice(0, Math.max(0, p.indexOf('{'))),
before: p.substring(p.indexOf('{') + 1, p.indexOf('=>') - 1), // eslint-disable-line unicorn/prefer-string-slice
after: p.substring(p.indexOf('=>') + 3, p.indexOf('}')), // eslint-disable-line unicorn/prefer-string-slice
end: p.slice(Math.max(0, p.indexOf('}') + 1)),
};
file.fromPath = path
.normalize(`${paths.base}${paths.before}${paths.end}`)
.split('\\')
.join('/');
file.file = path
.normalize(`${paths.base}${paths.after}${paths.end}`)
.split('\\')
.join('/');
} else {
file.fromPath = '-';
file.file = path.normalize(file.file).split('\\').join('/');
}
// get metadata type from file name
file.type = file.file.split('/')[3];
return file;
})
// Filter to only handle files that start with at least one of the passed filterPaths.
// ! Filter happens after initial parse, because if file was moved its new path has to be calculated
.filter((file) => filterPaths.some((path) => file.file.startsWith(path)))
.filter((file) => !file.file.endsWith('.error.log'))
.filter((file) => !file.file.endsWith('.md'))
// ensure badly named files on unsupported metadata types are not in our subset
.filter((/** @type {DeltaPkgItem} */ file) => {
if (MetadataType[file.type]) {
return true;
} else {
Util.logger.debug(
`Unknown metadata-type found for (${file.file}): ` + file.type
);
return false;
}
})
.map(async (/** @type {DeltaPkgItem} */ file) => {
// Gets external key based on file name und the assumption that filename = externalKey
if (file.type === 'folder') {
file.externalKey = null;
file.name = path.basename(file.file).split('.').shift();
} else {
// find the key in paths like:
// - retrieve/cred/bu/asset/block/016aecc7-7063-4b78-93f4-aa119ea933c7.asset-block-meta.html
// - retrieve/cred/bu/asset/message/003c1ef5-f538-473a-91da-26942024a64a/blocks/views.html.slots.[bottom-8frq7iw2k99].asset-message-meta.html
// - retrieve/cred/bu/query/03efd5f1-ba1f-487a-9c9a-36aeb2ae5192.query-meta.sql
file.externalKey =
file.type === 'asset'
? file.file.split('/')[5].split('.')[0] // assets have an additional folder level for their subtype
: file.file.split('/')[4].split('.')[0];
file.name = null;
}
// Check if file doesn't exist in reported path, that means it was a git deletion
// TODO: improve git action detection by switching from diffSummary to diff with --summary result parsing
if (!(await File.pathExists(file.file))) {
file.gitAction = 'delete';
} else if (file.moved) {
file.gitAction = 'move';
} else {
file.gitAction = 'add/update';
}
gitActionsCounter[file.gitAction]++;
file._credential = file.file.split('/')[1];
file._businessUnit = file.file.split('/')[2];
// Parse retrieve directory to also populate the name field (not possible for deleted files)
if (file.gitAction !== 'delete' && file.type !== 'folder') {
// folders are saved with their name as file-name, not with their key, hence this section can be skipped for folders
const buPath = `${properties.directories.retrieve}/${file._credential}/${file._businessUnit}/`;
if (!metadata[file._credential]) {
metadata[file._credential] = {};
}
if (!metadata[file._credential][file._businessUnit]) {
metadata[file._credential][file._businessUnit] = {};
}
if (!metadata[file._credential][file._businessUnit][file.type]) {
try {
await MetadataType[file.type].readBUMetadataForType(
buPath,
false,
metadata[file._credential][file._businessUnit]
);
} catch (ex) {
// silently catch directory-not-found errors here
Util.logger.debug(ex.message);
}
}
const fileContent =
metadata[file._credential][file._businessUnit][file.type][file.externalKey];
if (fileContent) {
file.name = fileContent[MetadataType[file.type].definition.nameField];
}
}
return file;
});
if (
!gitActionsCounter['add/update'] &&
!gitActionsCounter.move &&
!gitActionsCounter.delete
) {
Util.logger.warn(
`- ❌ No changes found. Check what branch you are currently on and if the target branch name (${rangeUserInput}${
range === rangeUserInput ? '' : ' converted to ' + range
}) was correct`
);
return [];
}
// Write into delta.json to serve as documentation
const directoryDeltaPkg = File.normalizePath([
properties.directories.docs,
'deltaPackage/',
]);
await File.writeJSONToFile(directoryDeltaPkg, 'delta_package', delta);
this.document(directoryDeltaPkg, delta);
Util.logger.info(
`- ✔️ Identified changes: Add/Update=${gitActionsCounter['add/update']}, Move=${gitActionsCounter['move']}, Delete=${gitActionsCounter['delete']}`
);
if (gitActionsCounter.delete > 0) {
Util.logger.warn(
'Please note that deletions have to be done manually on the SFMC website.'
);
}
Util.logger.info(`Saved report in ${path.join(directoryDeltaPkg, 'delta_package.md')}`);
// Copy filtered list of files into deploy directory
// only do that if we do not use templating
if (saveToDeployDir) {
// if templating is not used, we need to add related files to the delta package
const typeKeysMap = {};
/** @type {Object.<string, BuObject>} */
const buObjects = {};
for (const file of delta) {
if (file.gitAction === 'delete' || file.type === 'folder') {
continue;
}
if (typeKeysMap[file.type]) {
typeKeysMap[file.type].push(file.externalKey);
} else {
typeKeysMap[file.type] = [file.externalKey];
}
if (!buObjects[`${file._credential}/${file._businessUnit}`]) {
buObjects[`${file._credential}/${file._businessUnit}`] =
await Cli.getCredentialObject(
properties,
`${file._credential}/${file._businessUnit}`
);
}
}
// a bit crude but works for now
for (const buObject of Object.values(buObjects)) {
for (const type in typeKeysMap) {
MetadataType[type].buObject = buObject;
MetadataType[type].properties = properties;
const additionalFiles = await MetadataType[type].getFilesToCommit(
typeKeysMap[type]
);
if (additionalFiles?.length) {
delta.push(
...additionalFiles
.map((filePath) => ({
file: path.normalize(filePath).split('\\').join('/'),
type,
gitAction: 'add/update',
}))
.filter(
// avoid adding files that we already have in the list
(addFile) =>
!delta.find((existFile) => existFile.file === addFile.file)
)
);
}
}
}
let responses;
if (!Util.skipInteraction) {
// deploy folder is in targets for definition creation
// recommend to purge their content first
responses = await inquirer.prompt([
{
type: 'confirm',
name: 'isPurgeDeployFolder',
message:
'Do you want to empty the deploy folder (ensures no files from previous deployments remain)?',
default: true,
},
]);
}
if (Util.skipInteraction || responses.isPurgeDeployFolder) {
// Clear output folder structure for selected sub-type
for (const buObject of Object.values(buObjects)) {
await File.remove(
File.normalizePath([
properties.directories.deploy,
buObject.credential,
buObject.businessUnit,
])
);
}
}
/** @type {Promise.<{status:'ok'|'skipped'|'failed', statusMessage:string, file:string}>[]} */
const copied = delta
.filter((file) => !file.file.endsWith('.md')) // filter documentation files
.map((file) =>
File.copyFile(
file.file,
path
.normalize(file.file)
.replace(
path.normalize(properties.directories.retrieve),
path.normalize(properties.directories.deploy)
)
)
);
const results = await Promise.all(copied);
const failed = results.filter((result) => result.status === 'failed');
const skipped = results.filter((result) => result.status === 'skipped');
Util.logger.info(
`Copied changes to deploy directory (${
results.length - skipped.length - failed.length
} copied)`
);
Util.logger.debug(
`Copied changes to deploy directory (${
results.length - skipped.length - failed.length
} copied, ${skipped.length} skipped, ${failed.length} failed)`
);
if (skipped.length > 0) {
for (const file of skipped) {
Util.logger.debug(`Skipped - ${file.statusMessage} - ${file.file}`);
}
}
if (failed.length > 0) {
for (const file of failed) {
Util.logger.error(`Failed - ${file.statusMessage} - ${file.file}`);
}
}
}
return delta;
},
/**
* wrapper around DevOps.getDeltaList, Builder.buildTemplate and M
*
* @param {Mcdevrc} properties project config file
* @param {string} range git commit range
* @param {DeltaPkgItem[]} [diffArr] instead of running git diff the method can also get a list of files to process
* @param {number} [commitHistory] cli option to override default commit history value in config
* @returns {Promise.<DeltaPkgItem[]>} -
*/
async buildDeltaDefinitions(properties, range, diffArr, commitHistory) {
const skipInteraction = Util.skipInteraction;
// check if sourceTargetMapping is valid
if (
!properties.options.deployment.sourceTargetMapping ||
!Object.keys(properties.options.deployment.sourceTargetMapping).length
) {
Util.logger.error('Bad configuration of options.deployment.sourceTargetMapping');
return;
}
const sourceMarketListArr = Object.keys(properties.options.deployment.sourceTargetMapping);
/** @type {DeltaPkgItem[]} */
const deltaDeployAll = [];
for (const sourceML of sourceMarketListArr) {
// check if sourceTargetMapping has valid values
// #1 check source marketlist
try {
Util.verifyMarketList(sourceML, properties);
// remove potentially existing "description"-entry
delete properties.marketList[sourceML].description;
const sourceMarketBuArr = Object.keys(properties.marketList[sourceML]);
if (sourceMarketBuArr.length !== 1) {
throw new Error('Only 1 BU is allowed per source marketList');
}
if ('string' !== typeof properties.marketList[sourceML][sourceMarketBuArr[0]]) {
throw new TypeError('Only 1 market per BU is allowed per source marketList');
}
} catch (ex) {
Util.logger.error('Deployment Source: ' + ex.message);
return;
}
// #2 check corresponding target marketList
let targetML;
try {
targetML = properties.options.deployment.sourceTargetMapping[sourceML];
if ('string' !== typeof targetML) {
throw new TypeError(
'Please define one target marketList per source in deployment.sourceTargetMapping (No arrays allowed)'
);
}
Util.verifyMarketList(targetML, properties);
// remove potentially existing "description"-entry
delete properties.marketList[targetML].description;
} catch (ex) {
Util.logger.error('Deployment Target: ' + ex.message);
}
}
// all good let's loop a second time for actual execution
for (const sourceMlName of sourceMarketListArr) {
const targetMlName = properties.options.deployment.sourceTargetMapping[sourceMlName];
const sourceBU = Object.keys(properties.marketList[sourceMlName])[0];
const sourceMarket = Object.values(properties.marketList[sourceMlName])[0];
const delta = Array.isArray(diffArr)
? diffArr
: await DevOps.getDeltaList(properties, range, false, sourceBU, commitHistory);
// If only chaing templating and buildDefinition if required
if (!delta || delta.length === 0) {
// info/error messages was printed by DevOps.createDeltaPkg() already
return;
}
Util.logger.info('=============');
// Put files into maps. One map with BU -> type -> file (for retrieveAsTemplate)
// Other map only with type -> file (for buildDefinitionBulk)
const buTypeDelta = {}; // for bt, with BU info
const typeDelta = {}; // for bdb, without BU info - thats taken from the marketList
let deltaCounter = 0;
const deltaDeploy = delta
// Only template/build files that were added/updated/moved. no deletions
// ! doesn't work for folder, because their name parsing doesnt work at the moment
.filter((file) => file.gitAction !== 'delete' && file.name);
deltaDeployAll.push(...deltaDeploy);
for (const file of deltaDeploy) {
const buPath = `${file._credential}/${file._businessUnit}`;
if (!buTypeDelta[buPath]) {
// init object
buTypeDelta[buPath] = {};
}
if (!buTypeDelta[buPath][file.type]) {
// init array
buTypeDelta[buPath][file.type] = [];
}
buTypeDelta[buPath][file.type].push(file.externalKey);
}
// Run buildTemplate for each business unit for each type
Util.logger.info('Retrieve template from Git delta');
// ! needs to be for (.. in ..) loop so that it gets executed in series
for (const bu in buTypeDelta) {
for (const type in buTypeDelta[bu]) {
// get unique list (original search might include more than one entry for types with docs or extracted code)
const keyArr = [...new Set(buTypeDelta[bu][type])];
Util.logger.info(
`⚡ mcdev bt ${bu} ${type} "${keyArr.join(',')}" ${sourceMarket}`
);
await Builder.buildTemplate(bu, type, keyArr, sourceMarket);
// ensure we have the right key for bd/bdb that matches the name used for rt
if (keyArr.length) {
if (!typeDelta[type]) {
// init array
typeDelta[type] = [];
}
typeDelta[type].push(...keyArr);
deltaCounter += keyArr.length;
}
}
}
if (deltaCounter) {
Util.logger.info(`- ✔️ Templates created: ${deltaCounter}`);
} else {
Util.logger.warn(
`- No Templates or Deploy Definitions created for ${sourceMlName}`
);
continue;
}
// Run build definitions bulk for each type
Util.logger.info('=============');
Util.logger.info('Build deploy definitions from delta templates');
if (
properties.directories.templateBuilds == properties.directories.deploy ||
(Array.isArray(properties.directories.templateBuilds) &&
properties.directories.templateBuilds.includes(properties.directories.deploy))
) {
let responses;
if (!skipInteraction) {
// deploy folder is in targets for definition creation
// recommend to purge their content first
responses = await inquirer.prompt([
{
type: 'confirm',
name: 'isPurgeDeployFolder',
message:
'Do you want to empty the deploy folder (ensures no files from previous deployments remain)?',
default: true,
},
]);
}
if (skipInteraction || responses.isPurgeDeployFolder) {
// Clear output folder structure for selected sub-type
await File.remove(File.normalizePath([properties.directories.deploy]));
}
}
const bdPromises = [];
for (const type in typeDelta) {
Util.logger.info(
`⚡ mcdev bdb ${targetMlName} ${type} "${typeDelta[type].join(',')}"`
);
// omitting "await" to speed up creation
bdPromises.push(
Builder.buildDefinitionBulk(targetMlName, type, typeDelta[type].join(','))
);
}
await Promise.all(bdPromises);
Util.logger.info(`- ✔️ Deploy definitions created`);
if (
properties.directories.templateBuilds == properties.directories.deploy ||
(Array.isArray(properties.directories.templateBuilds) &&
properties.directories.templateBuilds.includes(properties.directories.deploy))
) {
Util.logger.info(`You can now run deploy on the prepared BUs`);
} else {
Util.logger.info(
`Your templated defintions are now ready to be copied into the deploy folder. Hint: You can have this auto-copied if you adjust directories.templateBuilds in your config.`
);
}
}
if (!deltaDeployAll.length) {
Util.logger.error(
'- ❌ No Templates or Deploy Definitions created. Check if you expected no changes.'
);
}
return deltaDeployAll;
},
/**
* create markdown file for deployment listing
*
* @param {string} directory -
* @param {object} jsonReport -
* @returns {void}
*/
document(directory, jsonReport) {
const tabled = jsonToTable(jsonReport);
let output = `# Deployment Report\n\n`;
let tableSeparator = '';
for (const column of tabled[0]) {
if (column !== '') {
output += `| ${column} `;
tableSeparator += '| --- ';
}
}
output += `|\n${tableSeparator}|\n`;
for (let i = 1; i < tabled.length; i++) {
for (let field of tabled[i]) {
if (field !== '') {
// @ts-expect-error bad typing in jsonToTable
field = field === true ? '✓' : field === false ? '✗' : field;
output += `| ${field} `;
}
}
output += '|\n';
}
try {
// write to disk (asynchronously)
File.writeToFile(directory, 'delta_package', 'md', output);
} catch (ex) {
Util.logger.error(`DevOps.document():: error | ` + ex.message);
}
},
/**
* should return only the json for all but asset, query and script that are saved as multiple files
* additionally, the documentation for dataExtension and automation should be returned
*
* @param {Mcdevrc} properties central properties object
* @param {BuObject} buObject references credentials
* @param {string} metadataType metadata type to build
* @param {string[]} keyArr customerkey of the metadata
* @returns {Promise.<string[]>} list of all files that need to be committed in a flat array ['path/file1.ext', 'path/file2.ext']
*/
getFilesToCommit(properties, buObject, metadataType, keyArr) {
MetadataType[metadataType].properties = properties;
MetadataType[metadataType].buObject = buObject;
return MetadataType[metadataType].getFilesToCommit(keyArr);
},
};
export default DevOps;