#58: normalize cross-type references with r__ for transactionalSMS

Accenture · May 21, 2024 · 4661aa1 · 4661aa1
1 parent e5ee9c3
commit 4661aa1
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 43 deletions.
diff --git a/lib/metadataTypes/TransactionalSMS.js b/lib/metadataTypes/TransactionalSMS.js
@@ -59,21 +59,34 @@ class TransactionalSMS extends TransactionalMessage {
             );
         }
 
-        // subscriptions: mobileCode
-        if (metadata.subscriptions?.shortCode) {
+        // subscriptions: mobileKeyword
+        if (metadata.subscriptions?.r__mobileKeyword_c__codeKeyword) {
             // we merely want to be able to show an error if it does not exist
+            cache.searchForField(
+                'mobileKeyword',
+                metadata.subscriptions.r__mobileKeyword_c__codeKeyword,
+                'c__codeKeyword',
+                'c__codeKeyword'
+            );
+            const codeKeywordArr =
+                metadata.subscriptions.r__mobileKeyword_c__codeKeyword.split('.');
+            metadata.subscriptions.shortCode = codeKeywordArr[0];
+            metadata.subscriptions.keyword = codeKeywordArr[1];
+            // make sure the code actually exists
             cache.searchForField('mobileCode', metadata.subscriptions.shortCode, 'code', 'code');
-            // subscriptions: mobileKeyword
-            if (metadata.subscriptions?.keyword) {
-                // we merely want to be able to show an error if it does not exist
-                cache.searchForField(
-                    'mobileKeyword',
-                    metadata.subscriptions.shortCode + '.' + metadata.subscriptions.keyword,
-                    'c__codeKeyword',
-                    'id'
-                );
-            }
+        } else if (metadata.subscriptions?.r__mobileCode_code) {
+            // subscriptions: mobileCode
+            // in case we dont have r__mobileKeyword_c__codeKeyword set
+            metadata.subscriptions.shortCode = cache.searchForField(
+                'mobileCode',
+                metadata.subscriptions.r__mobileCode_code,
+                'code',
+                'code'
+            );
         }
+        delete metadata.subscriptions.r__mobileKeyword_c__codeKeyword;
+        delete metadata.subscriptions.r__mobileCode_code;
+
         return metadata;
     }
     /**
@@ -139,30 +152,38 @@ class TransactionalSMS extends TransactionalMessage {
                     'code',
                     'code'
                 );
+                metadata.subscriptions.r__mobileCode_code = metadata.subscriptions.shortCode;
+                delete metadata.subscriptions.shortCode;
             } catch {
                 Util.logger.warn(
                     ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
                         metadata[this.definition.keyField]
                     }): Could not find mobileCode ${metadata.subscriptions.shortCode}.`
                 );
             }
-        }
-        // subscriptions: mobileKeyword
-        if (metadata.subscriptions?.keyword) {
-            try {
-                // we merely want to be able to show a warning if it does not exist
-                cache.searchForField(
-                    'mobileKeyword',
-                    metadata.subscriptions.shortCode + '.' + metadata.subscriptions.keyword,
-                    'c__codeKeyword',
-                    'id'
-                );
-            } catch {
-                Util.logger.warn(
-                    ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
-                        metadata[this.definition.keyField]
-                    }): Could not find mobileKeyword ${metadata.subscriptions.keyword}.`
-                );
+            // subscriptions: mobileKeyword
+            if (metadata.subscriptions?.keyword) {
+                try {
+                    // we merely want to be able to show a warning if it does not exist
+                    metadata.subscriptions.r__mobileKeyword_c__codeKeyword = cache.searchForField(
+                        'mobileKeyword',
+                        (metadata.subscriptions.shortCode ||
+                            metadata.subscriptions.r__mobileCode_code) +
+                            '.' +
+                            metadata.subscriptions.keyword,
+                        'c__codeKeyword',
+                        'c__codeKeyword'
+                    );
+                    delete metadata.subscriptions.r__mobileCode_code;
+                    delete metadata.subscriptions.shortCode;
+                    delete metadata.subscriptions.keyword;
+                } catch {
+                    Util.logger.warn(
+                        ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
+                            metadata[this.definition.keyField]
+                        }): Could not find mobileKeyword ${metadata.subscriptions.keyword}.`
+                    );
+                }
             }
         }
 

diff --git a/lib/metadataTypes/definitions/TransactionalSMS.definition.js b/lib/metadataTypes/definitions/TransactionalSMS.definition.js
@@ -101,5 +101,11 @@ export default {
             retrieving: true,
             template: true,
         },
+        'subscriptions.r__mobileKeyword_c__codeKeyword': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
     },
 };
diff --git a/.../deploy/testInstance/testBU/transactionalSMS/testExisting_tsms.transactionalSMS-meta.json b/.../deploy/testInstance/testBU/transactionalSMS/testExisting_tsms.transactionalSMS-meta.json
@@ -6,10 +6,9 @@
     "createdDate": "2022-11-07T02:24:00",
     "modifiedDate": "2022-11-07T02:25:00",
     "subscriptions": {
-        "shortCode": "4912312345678",
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "TESTEXISTING_KEYWORD"
+        "r__mobileKeyword_c__codeKeyword": "4912312345678.TESTEXISTING_KEYWORD"
     }
 }
diff --git a/...kRoot/deploy/testInstance/testBU/transactionalSMS/testNew_tsms.transactionalSMS-meta.json b/...kRoot/deploy/testInstance/testBU/transactionalSMS/testNew_tsms.transactionalSMS-meta.json
@@ -6,10 +6,9 @@
     "createdDate": "2022-11-07T02:24:00",
     "modifiedDate": "2022-11-07T02:25:00",
     "subscriptions": {
-        "shortCode": "4912312345678",
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "TESTEXISTING_KEYWORD"
+        "r__mobileKeyword_c__codeKeyword": "4912312345678.TESTEXISTING_KEYWORD"
     }
 }
diff --git a/test/resources/9999999/transactionalSMS/build-expected.json b/test/resources/9999999/transactionalSMS/build-expected.json
@@ -4,10 +4,9 @@
     "description": "foobar",
     "status": "Active",
     "subscriptions": {
-        "shortCode": "4912312345678",
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "TESTTEMPLATED_KEYWORD"
+        "r__mobileKeyword_c__codeKeyword": "4912312345678.TESTTEMPLATED_KEYWORD"
     }
 }
diff --git a/test/resources/9999999/transactionalSMS/get-expected.json b/test/resources/9999999/transactionalSMS/get-expected.json
@@ -6,10 +6,9 @@
     "createdDate": "2022-11-07T02:24:00",
     "modifiedDate": "2022-11-07T02:25:00",
     "subscriptions": {
-        "shortCode": "4912312345678",
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "TESTEXISTING_KEYWORD"
+        "r__mobileKeyword_c__codeKeyword": "4912312345678.TESTEXISTING_KEYWORD"
     }
 }
diff --git a/test/resources/9999999/transactionalSMS/patch-expected.json b/test/resources/9999999/transactionalSMS/patch-expected.json
@@ -6,10 +6,9 @@
     "createdDate": "2022-11-07T02:24:00",
     "modifiedDate": "2022-11-07T02:25:00",
     "subscriptions": {
-        "shortCode": "4912312345678",
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "TESTEXISTING_KEYWORD"
+        "r__mobileKeyword_c__codeKeyword": "4912312345678.TESTEXISTING_KEYWORD"
     }
 }
diff --git a/test/resources/9999999/transactionalSMS/post-expected.json b/test/resources/9999999/transactionalSMS/post-expected.json
@@ -6,10 +6,9 @@
     "createdDate": "2022-11-07T02:24:00",
     "modifiedDate": "2022-11-07T02:25:00",
     "subscriptions": {
-        "shortCode": "4912312345678",
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "TESTEXISTING_KEYWORD"
+        "r__mobileKeyword_c__codeKeyword": "4912312345678.TESTEXISTING_KEYWORD"
     }
 }
diff --git a/test/resources/9999999/transactionalSMS/template-expected.json b/test/resources/9999999/transactionalSMS/template-expected.json
@@ -4,10 +4,9 @@
     "description": "{{{description}}}",
     "status": "Active",
     "subscriptions": {
-        "shortCode": "4912312345678",
         "countryCode": "",
         "autoAddSubscriber": true,
         "updateSubscriber": true,
-        "keyword": "{{{prefixUpper}}}KEYWORD"
+        "r__mobileKeyword_c__codeKeyword": "4912312345678.{{{prefixUpper}}}KEYWORD"
     }
 }