Merge pull request #167 from amtrack/feat/retry-listmetadata-for-single-query-when-chunk-failed

feat: retry listing metadata per query when a chunk of queries failed

Author: amtrack

src/jsforce-utils.ts

@@ -29,9 +29,25 @@ export async function listMetadataInChunks(conn: Connection, queries: ListMetada
   const CHUNK_SIZE = 3;
   const result: FileProperties[] = [];
   for (const chunkOfQueries of chunk(queries, CHUNK_SIZE)) {
-    const chunkOfMetadataComponents = await conn.metadata.list(chunkOfQueries);
-    if (chunkOfMetadataComponents) {
-      result.push(...ensureArray(chunkOfMetadataComponents));
+    try {
+      const chunkOfMetadataComponents = await conn.metadata.list(chunkOfQueries);
+      if (chunkOfMetadataComponents) {
+        result.push(...ensureArray(chunkOfMetadataComponents));
+      }
+    } catch (_) {
+      // fall back to 1 query to identify root cause
+      for (const query of chunkOfQueries) {
+        try {
+          const metadataComponents = await conn.metadata.list(query);
+          result.push(...ensureArray(metadataComponents));
+        } catch (e) {
+          throw new Error(
+            `Failed to list metadata components for ${query.type}${query.folder ? `:${query.folder}` : ""}: ${
+              e.message
+            }`,
+          );
+        }
+      }
     }
   }
   return result;

test/jsforce-utils.e2e-spec.ts

@@ -0,0 +1,32 @@
+import { expect } from "chai";
+import { listMetadataInChunks } from "../src/jsforce-utils";
+import { Org } from "@salesforce/core";
+
+describe("jsforce-utils", () => {
+  describe("listMetadataInChunks()", () => {
+    it("lists more than 4 queries in chunks of 3", async () => {
+      const org = await Org.create({});
+      const conn = org.getConnection();
+      const result = await listMetadataInChunks(conn, [
+        { type: "ApexClass" },
+        { type: "CustomObject" },
+        { type: "ApexPage" },
+        { type: "ApexTrigger" },
+      ]);
+      expect(result).length.to.be.greaterThanOrEqual(1);
+    });
+    it("retries per query when a chunk of queries failed", async () => {
+      const org = await Org.create({});
+      const conn = org.getConnection();
+      let err;
+      try {
+        await listMetadataInChunks(conn, [{ type: "ThisTypeDoesNotExist" }]);
+      } catch (e) {
+        err = e;
+      }
+      expect(() => {
+        throw err;
+      }).to.throw(/Failed to list.*ThisTypeDoesNotExist.*INVALID_TYPE.*ThisTypeDoesNotExist/, err.message);
+    });
+  });
+});