-
Notifications
You must be signed in to change notification settings - Fork 34
/
Event.js
425 lines (406 loc) · 17.8 KB
/
Event.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
'use strict';
import MetadataType from './MetadataType.js';
import { Util } from '../util/util.js';
import File from '../util/file.js';
import cache from '../util/cache.js';
import deepEqual from 'deep-equal';
/**
* @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
* @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
* @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
* @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').SoapRequestParams} SoapRequestParams
* @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
*/
/**
* Event MetadataType
*
* @augments MetadataType
*/
class Event extends MetadataType {
static reCacheDataExtensions = [];
/**
* Retrieves Metadata of Event Definition.
* Endpoint /interaction/v1/eventDefinitions return all Event Definitions with all details.
* Currently it is not needed to loop over Imports with endpoint /interaction/v1/eventDefinitions/{id}
*
* @param {string} retrieveDir Directory where retrieved metadata directory will be saved
* @param {void | string[]} [_] unused parameter
* @param {void | string[]} [__] unused parameter
* @param {string} [key] customer key of single item to retrieve
* @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
*/
static retrieve(retrieveDir, _, __, key) {
Util.logBeta(this.definition.type);
try {
return super.retrieveREST(
retrieveDir,
`/interaction/v1/eventDefinitions${
key ? '/key:' + encodeURIComponent(key) : ''
}?extras=all`,
null,
key
);
} catch (ex) {
// if the event does not exist, the API returns the error "Request failed with status code 400 (ERR_BAD_REQUEST)" which would otherwise bring execution to a hold
if (key && ex.code === 'ERR_BAD_REQUEST') {
Util.logger.info(
`Downloaded: ${this.definition.type} (0)${Util.getKeysString(key)}`
);
} else {
throw ex;
}
}
return;
}
/**
* Retrieves event definition metadata for caching
*
* @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
*/
static retrieveForCache() {
return this.retrieve(null);
}
/**
* Retrieve a specific Event Definition by Name
*
* @param {string} templateDir Directory where retrieved metadata directory will be saved
* @param {string} name name of the metadata file
* @param {TemplateMap} templateVariables variables to be replaced in the metadata
* @returns {Promise.<MetadataTypeItemObj>} Promise of metadata
*/
static async retrieveAsTemplate(templateDir, name, templateVariables) {
Util.logBeta(this.definition.type);
const res = await this.client.rest.get(
'/interaction/v1/eventDefinitions?name=' + encodeURIComponent(name)
);
const event = res.items.filter((item) => item.name === name);
try {
if (!event || event.length === 0) {
throw new Error(`No Event Definitions Found with name "${name}"`);
} else if (event.length > 1) {
throw new Error(
`Multiple Event Definitions with name "${name}"` +
`please rename to be unique to avoid issues`
);
} else if (event?.length === 1) {
const originalKey = event[0][this.definition.keyField];
const metadataItemTemplated = Util.replaceByObject(
this.postRetrieveTasks(event[0]),
templateVariables
);
if (!metadataItemTemplated.r__dataExtension_key) {
throw new Error(
`Event.postRetrieveTasks:: No Data Extension found for ${this.definition.type}: ${metadataItemTemplated.name}. This cannot be templated.`
);
}
// remove all fields listed in Definition for templating
this.keepTemplateFields(metadataItemTemplated);
await File.writeJSONToFile(
[templateDir, this.definition.type].join('/'),
originalKey + '.' + this.definition.type + '-meta',
metadataItemTemplated
);
Util.logger.info(` - templated ${this.definition.type}: ${name}`);
return { metadata: metadataItemTemplated, type: this.definition.type };
} else {
throw new Error(
`Encountered unknown error when retrieveing ${
this.definition.typeName
} "${name}": ${JSON.stringify(res.body)}`
);
}
} catch (ex) {
Util.logger.error('Event.retrieveAsTemplate:: ' + ex);
return null;
}
}
/**
* Delete a metadata item from the specified business unit
*
* @param {string} key Identifier of item
* @returns {Promise.<boolean>} deletion success status
*/
static deleteByKey(key) {
Util.logBeta(this.definition.type);
return super.deleteByKeyREST(
'/interaction/v1/eventDefinitions/key:' + encodeURIComponent(key),
key,
false
);
}
/**
* Deploys metadata - merely kept here to be able to print {@link Util.logBeta} once per deploy
*
* @param {MetadataTypeMap} metadata metadata mapped by their keyField
* @param {string} deployDir directory where deploy metadata are saved
* @param {string} retrieveDir directory where metadata after deploy should be saved
* @returns {Promise.<MetadataTypeMap>} Promise of keyField => metadata map
*/
static async deploy(metadata, deployDir, retrieveDir) {
Util.logBeta(this.definition.type);
return super.deploy(metadata, deployDir, retrieveDir);
}
/**
* Creates a single Event Definition
*
* @param {MetadataTypeItem} metadata a single Event Definition
* @returns {Promise} Promise
*/
static create(metadata) {
return super.createREST(metadata, '/interaction/v1/eventDefinitions/');
}
/**
* Updates a single Event Definition (using PUT method since PATCH isn't supported)
*
* @param {MetadataTypeItem} metadataEntry a single Event Definition
* @returns {Promise} Promise
*/
static async update(metadataEntry) {
return super.updateREST(
metadataEntry,
'/interaction/v1/eventDefinitions/key:' +
encodeURIComponent(metadataEntry[this.definition.keyField]),
'put'
);
}
/**
* prepares an event definition for deployment
*
* @param {MetadataTypeItem} metadata a single eventDefinition
* @returns {MetadataTypeItem} parsed version
*/
static preDeployTasks(metadata) {
// Note: lots has to be done in createOrUpdate based on what action is required
metadata.arguments ||= {};
metadata.arguments.eventDefinitionKey = metadata.eventDefinitionKey;
// standard values
metadata.isVisibleInPicker ||= false;
metadata.isPlatformObject ||= false;
metadata.mode ||= 'Production';
return metadata;
}
/**
* helper for {@link MetadataType.upsert}
*
* @param {MetadataTypeMap} metadataMap list of metadata
* @param {string} metadataKey key of item we are looking at
* @param {boolean} hasError error flag from previous code
* @param {MetadataTypeItemDiff[]} metadataToUpdate list of items to update
* @param {MetadataTypeItem[]} metadataToCreate list of items to create
* @returns {Promise.<'create'|'update'|'skip'>} action to take
*/
static async createOrUpdate(
metadataMap,
metadataKey,
hasError,
metadataToUpdate,
metadataToCreate
) {
const createOrUpdateAction = await super.createOrUpdate(
metadataMap,
metadataKey,
hasError,
metadataToUpdate,
metadataToCreate
);
const metadataItem = metadataMap[metadataKey];
if (createOrUpdateAction === 'update') {
if (metadataItem.r__dataExtension_key) {
metadataItem.dataExtensionId = cache.searchForField(
'dataExtension',
metadataItem.r__dataExtension_key,
'CustomerKey',
'ObjectID'
);
metadataItem.dataExtensionName = cache.searchForField(
'dataExtension',
metadataItem.r__dataExtension_key,
'CustomerKey',
'Name'
);
metadataItem.arguments.dataExtensionId = metadataItem.dataExtensionId;
if (metadataItem.schema) {
metadataItem.schema.id = metadataItem.dataExtensionId;
metadataItem.schema.name = metadataItem.dataExtensionName;
}
}
if (metadataItem.schema?.fields?.length) {
const normalizedKey = File.reverseFilterIllegalFilenames(
metadataMap[metadataKey][this.definition.keyField]
);
const cachedVersion = cache.getByKey(this.definition.type, normalizedKey);
if (cachedVersion?.schema?.fields?.length) {
const cacheClone = structuredClone(cachedVersion);
cacheClone.schema.fields = cacheClone.schema.fields.map((field) => {
delete field.isDevicePreference;
return field;
});
if (!deepEqual(metadataItem?.schema?.fields, cacheClone?.schema?.fields)) {
Util.logger.warn(
` - ${this.definition.type} ${metadataItem[this.definition.keyField]}: schema fields differ from server version. Resetting as this will not be reflected on dataExtension.`
);
metadataItem.schema.fields = cacheClone.schema.fields;
}
}
}
} else if (createOrUpdateAction === 'create') {
try {
if (metadataItem.r__dataExtension_key) {
metadataItem.dataExtensionId = cache.searchForField(
'dataExtension',
metadataItem.r__dataExtension_key,
'CustomerKey',
'ObjectID'
);
metadataItem.dataExtensionName = cache.searchForField(
'dataExtension',
metadataItem.r__dataExtension_key,
'CustomerKey',
'Name'
);
if (metadataItem.schema) {
delete metadataItem.schema;
Util.logger.info(
` - ${this.definition.type} ${metadataItem[this.definition.keyField]}: dataExtension ${metadataItem.r__dataExtension_key} found, ignoring schema-section in ${this.definition.type} json`
);
}
}
} catch {
// no action
}
if (metadataItem.schema) {
if (metadataItem.r__dataExtension_key) {
metadataItem.schema.name = metadataItem.r__dataExtension_key;
}
Util.logger.warn(
`Data Extension ${metadataItem.schema.name || metadataItem[this.definition.keyField]} not found on BU. Creating it automatically based on schema-definition.`
);
// we want the event api to create the DE for us based on the schema
this.reCacheDataExtensions.push({
eventKey: metadataItem[this.definition.keyField],
deKey: metadataItem.schema.name || metadataItem[this.definition.keyField],
});
}
}
return createOrUpdateAction;
}
/**
* Gets executed after deployment of metadata type
*
* @param {MetadataTypeMap} upsertResults metadata mapped by their keyField as returned by update/create
* @param {MetadataTypeMap} originalMetadata metadata to be updated (contains additioanl fields)
* @param {{created: number, updated: number}} createdUpdated counter representing successful creates/updates
* @returns {Promise.<void>} -
*/
static async postDeployTasks(upsertResults, originalMetadata, createdUpdated) {
// CREATE ONLY - if dataExtensions were auto-
if (this.reCacheDataExtensions.length && createdUpdated.created > 0) {
Util.logger.warn(' - Re-caching dependent Metadata: dataExtension');
const deRetrieve = await DataExtension.retrieveForCache();
cache.setMetadata('dataExtension', deRetrieve.metadata);
const reDownloadDeKeys = [];
// try to update key & name of the auto-generated dataExtension
for (const { eventKey, deKey } of this.reCacheDataExtensions) {
if (!upsertResults[eventKey]) {
continue;
}
const eventItem = upsertResults[eventKey];
const newDeKey = cache.searchForField(
'dataExtension',
eventItem.dataExtensionId,
'ObjectID',
'CustomerKey'
);
// get dataExtension from cache which conveniently already has the ObjectID set
const deObj = cache.getByKey('dataExtension', newDeKey);
const oldName = deObj[DataExtension.definition.nameField];
// prepare a clone of the DE to update name & key to match the event
const clone = structuredClone(deObj);
clone[DataExtension.definition.keyField] = deKey;
clone[DataExtension.definition.nameField] = deKey;
try {
// update DE on server
await DataExtension.update(clone, true);
Util.logger.info(
` - changed dataExtension ${newDeKey} (${oldName}) key/name to ${deKey}`
);
// update cache
deObj[DataExtension.definition.keyField] = deKey;
deObj[DataExtension.definition.nameField] = deKey;
reDownloadDeKeys.push(deObj[DataExtension.definition.keyField]);
} catch {
// fallback, set DE key to value of DE name
const clone = structuredClone(deObj);
clone[DataExtension.definition.keyField] = oldName;
try {
// update DE on server
await DataExtension.update(clone, true);
Util.logger.info(
` - changed dataExtension ${newDeKey} (${oldName}) key to ${oldName}`
);
// update cache
deObj[DataExtension.definition.keyField] =
deObj[DataExtension.definition.nameField];
reDownloadDeKeys.push(deObj[DataExtension.definition.keyField]);
} catch {
Util.logger.debug(
` - failed to change dataExtension ${newDeKey} (${oldName}) key/name`
);
}
}
}
this.reCacheDataExtensions.length = 0;
// ensure we have downloaded auto-created DEs
if (reDownloadDeKeys.length) {
const retriever = new Retriever(this.properties, this.buObject);
await retriever.retrieve(['dataExtension'], reDownloadDeKeys);
}
}
}
/**
* parses retrieved Metadata before saving
*
* @param {MetadataTypeItem} metadata a single event definition
* @returns {MetadataTypeItem} parsed metadata
*/
static postRetrieveTasks(metadata) {
try {
metadata.r__dataExtension_key = cache.searchForField(
'dataExtension',
metadata.dataExtensionId,
'ObjectID',
'CustomerKey'
);
delete metadata.dataExtensionId;
delete metadata.dataExtensionName;
delete metadata.arguments.dataExtensionId;
if (metadata.schema) {
delete metadata.schema.id;
}
} catch (ex) {
Util.logger.verbose(
` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
metadata[this.definition.keyField]
}): ${ex.message}.`
);
}
if (!metadata.isPlatformObject) {
delete metadata.isPlatformObject;
}
if (metadata.mode === 'Production') {
delete metadata.mode;
}
return metadata;
}
}
// Assign definition to static attributes
import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
import DataExtension from './DataExtension.js';
import Retriever from './../Retriever.js';
Event.definition = MetadataTypeDefinitions.event;
export default Event;