#1510: ensure we always cache default roles & timezones (relevant for…

… retrieve-user)
Accenture · Aug 30, 2024 · 7c70597 · 7c70597
1 parent 0fc5335
commit 7c70597
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 36 deletions.
diff --git a/@types/lib/metadataTypes/Role.d.ts b/@types/lib/metadataTypes/Role.d.ts
diff --git a/@types/lib/metadataTypes/Role.d.ts.map b/@types/lib/metadataTypes/Role.d.ts.map
diff --git a/lib/metadataTypes/Role.js b/lib/metadataTypes/Role.js
@@ -73,41 +73,6 @@ class Role extends MetadataType {
         const results = await this.client.soap.retrieve('Role', fields, requestParams);
 
         const parsed = this.parseResponseBody(results);
-        if (!retrieveDir) {
-            // retrieve "Marketing Cloud%" roles not returned by SOAP API
-            const { roles, timeZones } = await this.client.rest.get(
-                '/platform/v1/setup/quickflow/data'
-            );
-            // this endpoint does not provide keys
-            const roleNameKeyMap = {
-                'Marketing Cloud Administrator': 'SYS_DEF_IMHADMIN',
-                'Marketing Cloud Channel Manager': 'SYS_DEF_CHANNELMANAGER',
-                'Marketing Cloud Content Editor/Publisher': 'SYS_DEF_CONTENTEDIT',
-                'Marketing Cloud Security Administrator': 'SYS_DEF_SECURITYADMIN',
-                'Marketing Cloud Viewer': 'SYS_DEF_VIEWER',
-            };
-            for (const role of roles) {
-                if (roleNameKeyMap[role.roleName]) {
-                    parsed[roleNameKeyMap[role.roleName]] = {
-                        CustomerKey: roleNameKeyMap[role.roleName],
-                        Name: role.roleName,
-                        ObjectID: role.roleID,
-                        Desscription: role.description,
-                        CreatedDate: '2012-02-21T02:09:19.983',
-                        IsSystemDefined: true,
-                        c__notAssignable: true,
-                    };
-                }
-            }
-            // the languages object is incomplete. the actual list is much longer --> ignoring it here
-            // convert timeZones to object
-            const timeZonesObj = {};
-            for (const timeZone of timeZones) {
-                timeZonesObj[timeZone.id] = timeZone;
-            }
-            // cache timeZones to share it with other type-classes
-            cache.setMetadata('_timezone', timeZonesObj);
-        }
         if (retrieveDir) {
             const savedMetadata = await super.saveResults(parsed, retrieveDir, null);
             Util.logger.info(
@@ -117,9 +82,56 @@ class Role extends MetadataType {
 
             await this.runDocumentOnRetrieve(key, savedMetadata);
         }
+
+        await this.cacheDefaultRolesAndTimezones(parsed);
+
         return { metadata: parsed, type: this.definition.type };
     }
 
+    /**
+     * adds default roles to the list of retrieved roles for proper caching (but not storing)
+     * also caches available timezones for retrieve-user
+     *
+     * @param {MetadataTypeMap} parsed list or previously retrieved items as reference
+     */
+    static async cacheDefaultRolesAndTimezones(parsed) {
+        // retrieve "Marketing Cloud%" roles not returned by SOAP API for cache (required by retrieve-user)
+        // also cache available timezones for retrieve-user
+        Util.logger.info(Util.getGrayMsg(' - Caching default roles and timezones'));
+        const { roles, timeZones } = await this.client.rest.get(
+            '/platform/v1/setup/quickflow/data'
+        );
+        // this endpoint does not provide keys
+        const roleNameKeyMap = {
+            'Marketing Cloud Administrator': 'SYS_DEF_IMHADMIN',
+            'Marketing Cloud Channel Manager': 'SYS_DEF_CHANNELMANAGER',
+            'Marketing Cloud Content Editor/Publisher': 'SYS_DEF_CONTENTEDIT',
+            'Marketing Cloud Security Administrator': 'SYS_DEF_SECURITYADMIN',
+            'Marketing Cloud Viewer': 'SYS_DEF_VIEWER',
+        };
+        for (const role of roles) {
+            if (roleNameKeyMap[role.roleName]) {
+                parsed[roleNameKeyMap[role.roleName]] = {
+                    CustomerKey: roleNameKeyMap[role.roleName],
+                    Name: role.roleName,
+                    ObjectID: role.roleID,
+                    Desscription: role.description,
+                    CreatedDate: '2012-02-21T02:09:19.983',
+                    IsSystemDefined: true,
+                    c__notAssignable: true,
+                };
+            }
+        }
+        // the languages object is incomplete. the actual list is much longer --> ignoring it here
+        // convert timeZones to object
+        const timeZonesObj = {};
+        for (const timeZone of timeZones) {
+            timeZonesObj[timeZone.id] = timeZone;
+        }
+        // cache timeZones to share it with other type-classes
+        cache.setMetadata('_timezone', timeZonesObj);
+    }
+
     /**
      * Gets executed before deploying metadata
      *