Skip to content

Commit

Permalink
#38: merge fixKeys with #runOnBU to allow executing it for multiple BUs
Browse files Browse the repository at this point in the history
  • Loading branch information
@JoernBerkefeld
JoernBerkefeld committed Aug 1, 2023
1 parent 9ba85ad commit 04f939c
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 42 deletions.
30 changes: 24 additions & 6 deletions docs/dist/documentation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,9 @@ Provides default functionality that can be overwritten by child metadata type cl
<dt><a href="#Mcdev.">Mcdev.(selectedType, buObject)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
<dd><p>helper for <a href="Mcdev.#runOnBU">Mcdev.#runOnBU</a></p>
</dd>
<dt><a href="#Mcdev.">Mcdev.(cred, bu, type, [keyArr])</a> ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code></dt>
<dd><p>Updates the key to match the name field</p>
</dd>
<dt><a href="#Automation.">Automation.(metadata)</a> ⇒ <code>boolean</code></dt>
<dd><p>helper for <a href="#Automation.postRetrieveTasks">postRetrieveTasks</a> and <a href="#Automation.execute">execute</a></p>
</dd>
Expand Down Expand Up @@ -519,7 +522,7 @@ main class
* [.schedule(businessUnit, [selectedType], [keys])](#Mcdev.schedule) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>
* [.execute(businessUnit, [selectedType], [keys])](#Mcdev.execute) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>
* [.pause(businessUnit, [selectedType], [keys])](#Mcdev.pause) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>
* [.fixKeys(businessUnit, type, [keys])](#Mcdev.fixKeys) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>
* [.fixKeys(businessUnit, selectedType, [keys])](#Mcdev.fixKeys) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>

<a name="Mcdev.setSkipInteraction"></a>

Expand Down Expand Up @@ -815,16 +818,16 @@ pause an item

<a name="Mcdev.fixKeys"></a>

### Mcdev.fixKeys(businessUnit, type, [keys]) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>
### Mcdev.fixKeys(businessUnit, selectedType, [keys]) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>
Updates the key to match the name field

**Kind**: static method of [<code>Mcdev</code>](#Mcdev)
**Returns**: <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code> - key: business unit name, value: list of affected item keys
**Returns**: <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code> - key: business unit name, value: list of paused item keys

| Param | Type | Description |
| --- | --- | --- |
| businessUnit | <code>string</code> | name of BU |
| type | <code>TYPE.SupportedMetadataTypes</code> | limit execution to given metadata type |
| selectedType | <code>TYPE.SupportedMetadataTypes</code> | limit to given metadata types |
| [keys] | <code>Array.&lt;string&gt;</code> | customerkey of the metadata |

<a name="Asset"></a>
Expand Down Expand Up @@ -8435,7 +8438,7 @@ run a method across BUs

| Param | Type | Description |
| --- | --- | --- |
| methodName | <code>&#x27;execute&#x27;</code> \| <code>&#x27;pause&#x27;</code> | what to run |
| methodName | <code>&#x27;execute&#x27;</code> \| <code>&#x27;pause&#x27;</code> \| <code>&#x27;fixKeys&#x27;</code> | what to run |
| businessUnit | <code>string</code> | name of BU |
| [selectedType] | <code>TYPE.SupportedMetadataTypes</code> | limit to given metadata types |
| [keys] | <code>Array.&lt;string&gt;</code> | customerkey of the metadata |
Expand All @@ -8450,7 +8453,7 @@ helper for [Mcdev.#runMethod](Mcdev.#runMethod)

| Param | Type | Description |
| --- | --- | --- |
| methodName | <code>&#x27;execute&#x27;</code> \| <code>&#x27;pause&#x27;</code> | what to run |
| methodName | <code>&#x27;execute&#x27;</code> \| <code>&#x27;pause&#x27;</code> \| <code>&#x27;fixKeys&#x27;</code> | what to run |
| cred | <code>string</code> | name of Credential |
| bu | <code>string</code> | name of BU |
| [type] | <code>TYPE.SupportedMetadataTypes</code> | limit execution to given metadata type |
Expand All @@ -8469,6 +8472,21 @@ helper for [Mcdev.#runOnBU](Mcdev.#runOnBU)
| selectedType | <code>TYPE.SupportedMetadataTypes</code> | limit execution to given metadata type |
| buObject | <code>TYPE.BuObject</code> | properties for auth |

<a name="Mcdev."></a>

## Mcdev.(cred, bu, type, [keyArr]) ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code>
Updates the key to match the name field

**Kind**: global function
**Returns**: <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> - list of keys that were affected

| Param | Type | Description |
| --- | --- | --- |
| cred | <code>string</code> | name of Credential |
| bu | <code>string</code> | name of BU |
| type | <code>TYPE.SupportedMetadataTypes</code> | limit execution to given metadata type |
| [keyArr] | <code>Array.&lt;string&gt;</code> | customerkey of the metadata |

<a name="Automation."></a>

## Automation.(metadata) ⇒ <code>boolean</code>
Expand Down
102 changes: 66 additions & 36 deletions lib/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -774,10 +774,21 @@ class Mcdev {
static async pause(businessUnit, selectedType, keys) {
return this.#runMethod('pause', businessUnit, selectedType, keys);
}
/**
* Updates the key to match the name field
*
* @param {string} businessUnit name of BU
* @param {TYPE.SupportedMetadataTypes} selectedType limit to given metadata types
* @param {string[]} [keys] customerkey of the metadata
* @returns {Promise.<Object.<string, string[]>>} key: business unit name, value: list of paused item keys
*/
static async fixKeys(businessUnit, selectedType, keys) {
return this.#runMethod('fixKeys', businessUnit, selectedType, keys);
}
/**
* run a method across BUs
*
* @param {'execute'|'pause'} methodName what to run
* @param {'execute'|'pause'|'fixKeys'} methodName what to run
* @param {string} businessUnit name of BU
* @param {TYPE.SupportedMetadataTypes} [selectedType] limit to given metadata types
* @param {string[]} [keys] customerkey of the metadata
Expand All @@ -788,19 +799,29 @@ class Mcdev {
let lang_past;
let lang_present;
let requireKeyOrLike;
let checkMetadataSupport;
const resultObj = {};

switch (methodName) {
case 'execute': {
lang_past = 'executed';
lang_present = 'executing';
requireKeyOrLike = true;
checkMetadataSupport = true;
break;
}
case 'pause': {
lang_past = 'paused';
lang_present = 'pausing';
requireKeyOrLike = true;
checkMetadataSupport = true;
break;
}
case 'fixKeys': {
lang_past = 'fixed keys';
lang_present = 'fixing keys';
requireKeyOrLike = true;
checkMetadataSupport = false;
break;
}
}
Expand All @@ -815,7 +836,10 @@ class Mcdev {
if (!Util._isValidType(selectedType)) {
return resultObj;
}
if (!Object.prototype.hasOwnProperty.call(MetadataTypeInfo[selectedType], methodName)) {
if (
checkMetadataSupport &&
!Object.prototype.hasOwnProperty.call(MetadataTypeInfo[selectedType], methodName)
) {
Util.logger.error(
` ☇ skipping ${selectedType}: ${methodName} is not supported yet for ${selectedType}`
);
Expand Down Expand Up @@ -921,7 +945,7 @@ class Mcdev {
/**
* helper for {@link Mcdev.#runMethod}
*
* @param {'execute'|'pause'} methodName what to run
* @param {'execute'|'pause'|'fixKeys'} methodName what to run
* @param {string} cred name of Credential
* @param {string} bu name of BU
* @param {TYPE.SupportedMetadataTypes} [type] limit execution to given metadata type
Expand All @@ -948,18 +972,27 @@ class Mcdev {
}
Util.logger.info(`:: ${methodName} ${type} on ${cred}/${bu}`);
MetadataTypeInfo[type].client = auth.getSDK(buObject);
if (Util.OPTIONS.like && Object.keys(Util.OPTIONS.like).length) {
keyArr = await this.#retrieveKeysWithLike(type, buObject);
} else {
MetadataTypeInfo[type].properties = properties;
MetadataTypeInfo[type].buObject = buObject;
}
if (!keyArr || (Array.isArray(keyArr) && !keyArr.length)) {
throw new Error('No keys were provided');
}

// result will be undefined (false) if methodName is not supported for the type
resultArr.push(...(await MetadataTypeInfo[type][methodName](keyArr)));
MetadataTypeInfo[type].properties = properties;
MetadataTypeInfo[type].buObject = buObject;
switch (methodName) {
case 'fixKeys': {
{
resultArr.push(...(await this.#fixKeys(cred, bu, type, keyArr)));

break;
}
}
default: {
if (Util.OPTIONS.like && Object.keys(Util.OPTIONS.like).length) {
keyArr = await this.#retrieveKeysWithLike(type, buObject);
}
if (!keyArr || (Array.isArray(keyArr) && !keyArr.length)) {
throw new Error('No keys were provided');
} // result will be undefined (false) if methodName is not supported for the type
resultArr.push(...(await MetadataTypeInfo[type][methodName](keyArr)));
}
}
} catch (ex) {
Util.logger.errorStack(ex, 'mcdev.' + methodName + ' failed');
}
Expand Down Expand Up @@ -1025,7 +1058,7 @@ class Mcdev {
Util.getGrayMsg(
`Identified ${keyArr.length} ${selectedType}${
keyArr.length === 1 ? '' : 's'
} that match${selectedType}${keyArr.length === 1 ? 'es' : ''} the like-filter`
} that match${keyArr.length === 1 ? 'es' : ''} the like-filter`
)
);

Expand All @@ -1034,34 +1067,31 @@ class Mcdev {
/**
* Updates the key to match the name field
*
* @param {string} businessUnit name of BU
* @param {string} cred name of Credential
* @param {string} bu name of BU
* @param {TYPE.SupportedMetadataTypes} type limit execution to given metadata type
* @param {string[]} [keys] customerkey of the metadata
* @returns {Promise.<Object.<string, string[]>>} key: business unit name, value: list of affected item keys
* @param {string[]} [keyArr] customerkey of the metadata
* @returns {Promise.<string[]>} list of keys that were affected
*/
static async fixKeys(businessUnit, type, keys) {
Util.startLogger();
Util.logger.info('mcdev:: fixKeys');
let actuallyFixedKeys = [];
const result = {};
result[businessUnit] = actuallyFixedKeys;
static async #fixKeys(cred, bu, type, keyArr) {
const properties = await config.getProperties();
let actuallyFixedKeys = [];
const resultArr = [];
if (!(await config.checkProperties(properties))) {
// return null here to avoid seeing 2 error messages for the same issue
return result;
return resultArr;
}
if (!type || !Util._isValidType(type)) {
return result;
return resultArr;
}

if (
MetadataTypeDefinitions[type].keyIsFixed === true ||
MetadataTypeDefinitions[type].keyField === MetadataTypeDefinitions[type].idField
) {
Util.logger.error(`Key cannot be updated for this type`);
return result;
return resultArr;
}
let [cred, bu] = businessUnit ? businessUnit.split('/') : [null, null];

const buObject = await Cli.getCredentialObject(
properties,
Expand All @@ -1075,36 +1105,36 @@ class Mcdev {
bu = buObject.businessUnit;
}
Util.logger.info(
`Updating keys for ${type} on ${cred}/${bu}` +
(keys ? Util.getKeysString(keys) : '') +
`:: Fixing keys for ${type} on ${cred}/${bu}` +
(keyArr ? Util.getKeysString(keyArr) : '') +
`\n`
);
try {
MetadataTypeInfo[type].client = auth.getSDK(buObject);
} catch (ex) {
Util.logger.error(ex.message);
return result;
return resultArr;
}
try {
Util.logger.info(`Retrieving latest versions of ${type} from server`);
const retriever = new Retriever(properties, buObject);
const retrieved = await retriever.retrieve([type], keys, null, false);
const retrieved = await retriever.retrieve([type], keyArr, null, false);

const metadataMap = Object.values(retrieved)[0][0];
const keysForDeploy = MetadataTypeInfo[type].getKeysForFixing(metadataMap);
if (keysForDeploy.length < 1) {
Util.logger.error(
`No items found with a key-name mismatch that match your criteria.`
);
return result;
return resultArr;
}
this.setOptions({
changeKeyField: MetadataTypeDefinitions[type].nameField,
fromRetrieve: true,
});
const deployed = await Deployer.deploy(businessUnit, [type], keysForDeploy);
const deployed = await Deployer.deploy(cred + '/' + bu, [type], keysForDeploy);
actuallyFixedKeys = Object.keys(Object.values(Object.values(deployed)[0])[0]);
result[cred + '/' + bu] = actuallyFixedKeys;
resultArr.push(...actuallyFixedKeys);
const dependentTypes = await Util.getDependentMetadata(type);
if (actuallyFixedKeys && actuallyFixedKeys.length) {
Util.logger.info(
Expand All @@ -1124,7 +1154,7 @@ class Mcdev {
Util.logger.errorStack(ex, 'mcdev.fixKeys failed');
}
Util.logger.info(`:: Done\n`);
return result;
return resultArr;
}
}

Expand Down

0 comments on commit 04f939c

Please sign in to comment.