Task/1748 resolve send classification in transactionalemail

lib/metadataTypes/SendClassification.js

@@ -54,9 +54,11 @@ class SendClassification extends MetadataType {
      */
     static async retrieveForCache() {
         const typeMap = await this.retrieve(null);
-        for (const item of Object.values(typeMap.metadata)) {
-            // run postRetrieveTasks to cross-update deliveryProfile cache
-            this.postRetrieveTasks(item);
+        if (cache.getCache().deliveryProfile) {
+            for (const item of Object.values(typeMap.metadata)) {
+                // run postRetrieveTasks to cross-update deliveryProfile cache
+                this.updateDeliveryProfileIdInCache(item);
+            }
         }
         return typeMap;
     }
@@ -142,21 +144,17 @@ class SendClassification extends MetadataType {
         );
         delete metadata.SendClassificationType;
 
-        if (cache.getCache().senderProfile) {
-            // when sendClassification was only cached it can happen that we don't have the senderProfile cache yet
-            try {
-                metadata.r__senderProfile_key = cache.searchForField(
-                    'senderProfile',
-                    metadata.SenderProfile.ObjectID,
-                    'ObjectID',
-                    'CustomerKey'
-                );
-                delete metadata.SenderProfile;
-            } catch (ex) {
-                Util.logger.warn(
-                    ` - ${this.definition.type} ${metadata.CustomerKey}: ${ex.message}`
-                );
-            }
+        // when sendClassification was only cached it can happen that we don't have the senderProfile cache yet
+        try {
+            metadata.r__senderProfile_key = cache.searchForField(
+                'senderProfile',
+                metadata.SenderProfile.ObjectID,
+                'ObjectID',
+                'CustomerKey'
+            );
+            delete metadata.SenderProfile;
+        } catch (ex) {
+            Util.logger.warn(` - ${this.definition.type} ${metadata.CustomerKey}: ${ex.message}`);
         }
         try {
             metadata.r__deliveryProfile_key = cache.searchForField(
@@ -166,14 +164,7 @@ class SendClassification extends MetadataType {
                 'key'
             );
             // add ObjectID to deliveryProfile cache because it cannot be retrieved any other way and this way we can resolve it in journeys
-            const dp = cache.getByKey('deliveryProfile', metadata.DeliveryProfile.CustomerKey);
-            if (dp) {
-                dp.ObjectID = metadata.DeliveryProfile.ObjectID;
-            } else {
-                Util.logger.debug(
-                    ` - ${this.definition.type} ${metadata.CustomerKey}: Could not find deliveryProfile ${metadata.DeliveryProfile.CustomerKey} in cache`
-                );
-            }
+            this.updateDeliveryProfileIdInCache(metadata);
 
             delete metadata.DeliveryProfile;
         } catch (ex) {
@@ -182,6 +173,22 @@ class SendClassification extends MetadataType {
 
         return metadata;
     }
+
+    /**
+     * this is the only known way to get the object ID for a deliveryProfile
+     *
+     * @param {MetadataTypeItem} metadata a single sendClassification item
+     */
+    static updateDeliveryProfileIdInCache(metadata) {
+        const dp = cache.getByKey('deliveryProfile', metadata.DeliveryProfile.CustomerKey);
+        if (dp) {
+            dp.ObjectID = metadata.DeliveryProfile.ObjectID;
+        } else {
+            Util.logger.debug(
+                ` - ${this.definition.type} ${metadata.CustomerKey}: Could not find deliveryProfile ${metadata.DeliveryProfile.CustomerKey} in cache`
+            );
+        }
+    }
 }
 
 // Assign definition to static attributes

lib/metadataTypes/TransactionalEmail.js

@@ -109,6 +109,18 @@ class TransactionalEmail extends TransactionalMessage {
         metadata.options ||= {};
         metadata.options.createJourney = true; // only send this during create or else we might end up with an unexpected outcome
 
+        // subscriptions: sendClassification
+        if (metadata.r__sendClassification_key) {
+            // we merely want to be able to show an error if it does not exist
+            metadata.classification = cache.searchForField(
+                'sendClassification',
+                metadata.r__sendClassification_key,
+                'CustomerKey',
+                'CustomerKey'
+            );
+            delete metadata.r__sendClassification_key;
+        }
+
         return metadata;
     }
 
@@ -234,6 +246,26 @@ class TransactionalEmail extends TransactionalMessage {
             }
             delete metadata.journey;
         }
+        // sendClassification
+        if (metadata.classification) {
+            metadata.r__sendClassification_key = metadata.classification;
+            try {
+                // we merely want to be able to show a warning if it does not exist
+                metadata.r__sendClassification_key = cache.searchForField(
+                    'sendClassification',
+                    metadata.classification,
+                    'CustomerKey',
+                    'CustomerKey'
+                );
+            } catch (ex) {
+                Util.logger.warn(
+                    ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
+                        metadata[this.definition.keyField]
+                    }): ${ex.message}.`
+                );
+            }
+            delete metadata.classification;
+        }
 
         return metadata;
     }

lib/metadataTypes/definitions/TransactionalEmail.definition.js

@@ -1,12 +1,13 @@
 export default {
     bodyIteratorField: 'definitions',
-    dependencies: ['asset-message', 'dataExtension', 'list', 'journey'],
+    dependencies: ['asset-message', 'dataExtension', 'list', 'journey', 'sendClassification'],
     dependencyGraph: {
         // classic email cannot be deployed anymore
         asset: ['r__asset_key'],
         dataExtension: ['subscriptions.r__dataExtension_key'],
         list: ['subscriptions.r__list_PathName'],
         journey: ['r__journey_key'],
+        sendClassification: ['r__sendClassification_key'],
     },
     hasExtended: false,
     idField: 'definitionId',
@@ -168,5 +169,11 @@ export default {
             retrieving: true,
             template: true,
         },
+        r__sendClassification_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
     },
 };

test/resources/9999999/transactionalEmail/build-expected.json

@@ -2,7 +2,6 @@
     "name": "testTemplated_temail",
     "definitionKey": "testTemplated_temail",
     "description": "foobar",
-    "classification": "Default Transactional",
     "status": "Active",
     "subscriptions": {
         "r__dataExtension_key": "testTemplated_dataExtension",
@@ -14,5 +13,6 @@
         "trackLinks": true
     },
     "r__asset_key": "testTemplated_asset_message",
-    "r__journey_key": "testTemplated_temail"
+    "r__journey_key": "testTemplated_temail",
+    "r__sendClassification_key": "Default Transactional"
 }

test/resources/9999999/transactionalEmail/get-expected.json

@@ -2,7 +2,6 @@
     "name": "testExisting_temail",
     "definitionKey": "testExisting_temail",
     "description": "bla bla",
-    "classification": "Default Transactional",
     "status": "Active",
     "createdDate": "2020-09-10T03:29:00",
     "modifiedDate": "2020-09-10T03:29:00",
@@ -16,5 +15,6 @@
         "trackLinks": true
     },
     "r__asset_key": "testExisting_asset_message",
-    "r__journey_key": "testExisting_temail"
+    "r__journey_key": "testExisting_temail",
+    "r__sendClassification_key": "Default Transactional"
 }

test/resources/9999999/transactionalEmail/patch-expected.json

@@ -2,7 +2,6 @@
     "name": "testExisting_temail",
     "definitionKey": "testExisting_temail",
     "description": "updated via deploy",
-    "classification": "Default Transactional",
     "status": "Active",
     "createdDate": "2020-09-10T03:29:00",
     "modifiedDate": "2020-09-10T03:29:00",
@@ -16,5 +15,6 @@
         "trackLinks": true
     },
     "r__asset_key": "testExisting_asset_message",
-    "r__journey_key": "testExisting_temail"
+    "r__journey_key": "testExisting_temail",
+    "r__sendClassification_key": "Default Transactional"
 }

test/resources/9999999/transactionalEmail/post-expected.json

@@ -2,7 +2,6 @@
     "name": "testNew_temail",
     "definitionKey": "testNew_temail",
     "description": "created on deploy",
-    "classification": "Default Transactional",
     "status": "Active",
     "createdDate": "2022-12-06T06:08:00",
     "modifiedDate": "2022-12-06T06:08:00",
@@ -16,5 +15,6 @@
         "trackLinks": true
     },
     "r__asset_key": "testExisting_asset_message",
-    "r__journey_key": "testNew_RANDOM_interaction"
+    "r__journey_key": "testNew_RANDOM_interaction",
+    "r__sendClassification_key": "Default Transactional"
 }

test/resources/9999999/transactionalEmail/template-expected.json

@@ -2,7 +2,6 @@
     "name": "{{{prefix}}}temail",
     "definitionKey": "{{{prefix}}}temail",
     "description": "{{{description}}}",
-    "classification": "Default Transactional",
     "status": "Active",
     "subscriptions": {
         "r__dataExtension_key": "{{{prefix}}}dataExtension",
@@ -14,5 +13,6 @@
         "trackLinks": true
     },
     "r__asset_key": "{{{prefix}}}asset_message",
-    "r__journey_key": "{{{prefix}}}temail"
+    "r__journey_key": "{{{prefix}}}temail",
+    "r__sendClassification_key": "Default Transactional"
 }

test/type.journey.test.js

@@ -581,7 +581,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                34,
+                35,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

test/type.transactionalEmail.test.js

@@ -36,7 +36,7 @@ describe('type: transactionalEmail', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                12,
+                13,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -75,7 +75,7 @@ describe('type: transactionalEmail', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                14,
+                15,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -137,7 +137,7 @@ describe('type: transactionalEmail', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                12,
+                13,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;