#126: correct Folder.saveResults signature to allow saving folders to…

… retrieve directory IF actively included in the list of to be deployed types
Accenture · Sep 19, 2024 · 92ee0a0 · 92ee0a0
1 parent b9c849e
commit 92ee0a0
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 10 deletions.
diff --git a/@types/lib/Deployer.d.ts.map b/@types/lib/Deployer.d.ts.map
diff --git a/@types/lib/metadataTypes/Folder.d.ts b/@types/lib/metadataTypes/Folder.d.ts
diff --git a/@types/lib/metadataTypes/Folder.d.ts.map b/@types/lib/metadataTypes/Folder.d.ts.map
diff --git a/lib/Deployer.js b/lib/Deployer.js
@@ -54,7 +54,8 @@ class Deployer {
         ]);
         // prep folders for auto-creation
         MetadataTypeInfo.folder.client = auth.getSDK(buObject);
-        MetadataTypeInfo.folder.properties = this.properties;
+        MetadataTypeInfo.folder.buObject = buObject;
+        MetadataTypeInfo.folder.properties = properties;
     }
 
     /**
@@ -515,7 +516,7 @@ class Deployer {
         if (i > 0) {
             MetadataTypeInfo.folder.definition.fields._generated.retrieving = true; // ensure we keep that flag in deploy folder
             // await results to allow us to re-read it right after
-            await MetadataTypeInfo.folder.saveResults(folderMetadata, deployDir, null);
+            await MetadataTypeInfo.folder.saveResults(folderMetadata, deployDir);
             MetadataTypeInfo.folder.definition.fields._generated.retrieving = false; // reset flag
             Util.logger.info(`Created folders in deploy dir: ${i}`);
 

diff --git a/lib/metadataTypes/Folder.js b/lib/metadataTypes/Folder.js
@@ -164,7 +164,7 @@ class Folder extends MetadataType {
             }
         }
         if (retrieveDir) {
-            const savedMetadata = await this.saveResults(metadata, retrieveDir, this.buObject.mid);
+            const savedMetadata = await this.saveResults(metadata, retrieveDir);
             Util.logger.info(
                 `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})`
             );
@@ -644,17 +644,18 @@ class Folder extends MetadataType {
      *
      * @param {ListMap} results metadata results from deploy
      * @param {string} retrieveDir directory where metadata should be stored after deploy/retrieve
-     * @param {number | string} mid unused parameter
      * @returns {Promise.<ListMap>} Promise of saved metadata
      */
-    static async saveResults(results, retrieveDir, mid) {
+    static async saveResults(results, retrieveDir) {
+        const mid = this.buObject.mid;
         /** @type {ListMap} */
         const savedResults = {};
         for (const metadataEntry in results) {
             try {
                 // skip saving shared folders as they technically live in parent.
-                // ! Warning: our result set does not have Client.ID in it - bad check?
                 if (results[metadataEntry].Client && mid != results[metadataEntry].Client.ID) {
+                    // deploy: folders auto-generated by deploy do not have .Client set and hence this check will be skipped
+                    // retrieve: Client.ID is set to the MID of the BU that the folder belongs to; we only want folders of the current BU saved here
                     continue;
                 } else if (
                     results[metadataEntry] &&