#984: moved type specific stuff into child class

Accenture · Aug 27, 2023 · 9abe1e5 · JoernBerkefeld · Aug 28, 2023 · JoernBerkefeld
1 parent 3023492
commit 9abe1e5
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 8 deletions.
diff --git a/docs/dist/documentation.md b/docs/dist/documentation.md
@@ -3086,6 +3086,7 @@ ImportFile MetadataType
  * [.preDeployTasks(metadata)](#ImportFile.preDeployTasks) ⇒ <code>Promise</code>
  * [.getKeysToSetNotifications(metadataMap)](#ImportFile.getKeysToSetNotifications) ⇒ <code>Array.&lt;string&gt;</code>
  * [.parseMetadata(metadata)](#ImportFile.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>
+ * [.createOrUpdate(metadataMap, metadataKey, hasError, metadataToUpdate, metadataToCreate)](#ImportFile.createOrUpdate) ⇒ <code>&#x27;create&#x27;</code> \| <code>&#x27;update&#x27;</code> \| <code>&#x27;skip&#x27;</code>
 
 <a name="ImportFile.retrieve"></a>
 
@@ -3197,6 +3198,22 @@ parses retrieved Metadata before saving
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | a single import definition |
 
+<a name="ImportFile.createOrUpdate"></a>
+
+### ImportFile.createOrUpdate(metadataMap, metadataKey, hasError, metadataToUpdate, metadataToCreate) ⇒ <code>&#x27;create&#x27;</code> \| <code>&#x27;update&#x27;</code> \| <code>&#x27;skip&#x27;</code>
+helper for [upsert](#MetadataType.upsert)
+
+**Kind**: static method of [<code>ImportFile</code>](#ImportFile) 
+**Returns**: <code>&#x27;create&#x27;</code> \| <code>&#x27;update&#x27;</code> \| <code>&#x27;skip&#x27;</code> - action to take 
+
+| Param | Type | Description |
+| --- | --- | --- |
+| metadataMap | <code>TYPE.MetadataTypeMap</code> | list of metadata |
+| metadataKey | <code>string</code> | key of item we are looking at |
+| hasError | <code>boolean</code> | error flag from previous code |
+| metadataToUpdate | <code>Array.&lt;TYPE.MetadataTypeItemDiff&gt;</code> | list of items to update |
+| metadataToCreate | <code>Array.&lt;TYPE.MetadataTypeItem&gt;</code> | list of items to create |
+
 <a name="Journey"></a>
 
 ## Journey ⇐ [<code>MetadataType</code>](#MetadataType)

diff --git a/lib/cli.js b/lib/cli.js
@@ -603,7 +603,7 @@ yargs
  type: 'string',
  group: 'Options for updateNotifications:',
  describe:
- "remove notification email addresses and/or notes. Possible options: 'all', 'errorEmail', 'completionEmail', 'notes'",
+ "remove notification email addresses and/or notes. Possible options: 'all', 'errorEmail', 'completionEmail', 'notes' for automation. For the rest of types any value would do (true/all/etc.)",
  })
  .option('like', {
  type: 'string',

diff --git a/lib/index.js b/lib/index.js
@@ -1199,6 +1199,7 @@ class Mcdev {
  ) {
  // if no options were provided there is nothing to update
  Util.logger.error(`No email addresses, run notes or a clear option was provided`);
+ return [];
  }
 
  return await this.#runMethod('updateNotifications', businessUnit, selectedType, keys);

diff --git a/lib/metadataTypes/ImportFile.js b/lib/metadataTypes/ImportFile.js
@@ -263,6 +263,33 @@ class ImportFile extends MetadataType {
  delete metadata.updateTypeId;
  return metadata;
  }
+ /**
+ * helper for {@link MetadataType.upsert}
+ *
+ * @param {TYPE.MetadataTypeMap} metadataMap list of metadata
+ * @param {string} metadataKey key of item we are looking at
+ * @param {boolean} hasError error flag from previous code
+ * @param {TYPE.MetadataTypeItemDiff[]} metadataToUpdate list of items to update
+ * @param {TYPE.MetadataTypeItem[]} metadataToCreate list of items to create
+ * @returns {'create' | 'update' | 'skip'} action to take
+ */
+ static createOrUpdate(metadataMap, metadataKey, hasError, metadataToUpdate, metadataToCreate) {
+ if (Util.OPTIONS.clear) {
+ metadataMap[metadataKey].sendEmailNotification = false;
+ metadataMap[metadataKey].notificationEmailAddress = '';
+ } else if (Util.OPTIONS.completionEmail) {
+ metadataMap[metadataKey].sendEmailNotification = true;
+ metadataMap[metadataKey].notificationEmailAddress = Util.OPTIONS.completionEmail;
+ }
+ const createOrUpdateAction = super.createOrUpdate(
+ metadataMap,
+ metadataKey,
+ hasError,
+ metadataToUpdate,
+ metadataToCreate
+ );
+ return createOrUpdateAction;
+ }
 }
 
 // Assign definition to static attributes

diff --git a/lib/metadataTypes/MetadataType.js b/lib/metadataTypes/MetadataType.js
@@ -691,13 +691,6 @@ class MetadataType {
  if (!this.hasChanged(cachedVersion, metadataMap[metadataKey])) {
  hasError = true;
  }
- if (Util.OPTIONS.clear) {
- metadataMap[metadataKey].sendEmailNotification = false;
- metadataMap[metadataKey].notificationEmailAddress = '';
- } else if (Util.OPTIONS.completionEmail) {
- metadataMap[metadataKey].sendEmailNotification = true;
- metadataMap[metadataKey].notificationEmailAddress = Util.OPTIONS.completionEmail;
- }
  if (Util.OPTIONS.changeKeyField) {
  if (this.definition.keyField == this.definition.idField) {
  Util.logger.error(