Update final retry call and add async retry tests (#3844)

* update last err msg thrown

* also update in findCIDInNetwork

* update msg to not include multihash bc alrdy in err msg

Author: vicky-g

creator-node/src/fileManager.js

@@ -144,7 +144,7 @@ async function fetchFileFromNetworkAndWriteToDisk({
 
     try {
       await asyncRetry({
-        asyncFn: async (bail) => {
+        asyncFn: async (bail, num) => {
           try {
             await fetchFileFromTargetGatewayAndWriteToDisk({
               contentUrl,
@@ -181,9 +181,16 @@ async function fetchFileFromNetworkAndWriteToDisk({
             }
 
             // Re-throw any other error to continue with retry logic
-            throw new Error(
-              `Failed to fetch content=${multihash} with statusCode=${e.response?.status}. Retrying..`
-            )
+            if (num === numRetries + 1) {
+              // Final error thrown
+              throw new Error(
+                `Failed to fetch content with statusCode=${e.response?.status} after ${num} retries`
+              )
+            } else {
+              throw new Error(
+                `Failed to fetch content with statusCode=${e.response?.status}. Retrying..`
+              )
+            }
           }
         },
         logger,

creator-node/src/utils/asyncRetry.js

@@ -12,7 +12,7 @@ const { logger: genericLogger } = require('../logging')
  * @param {func} param.asyncFn the fn to asynchronously retry
  * @param {Object} param.options optional options. defaults to the params listed below if not explicitly passed in
  * @param {number} [param.options.factor=2] the exponential factor
- * @param {number} [param.options.retries=5] the max number of retries. defaulted to 5
+ * @param {number} [param.options.retries=5] the max number of retries. defaulted to 5. So, this will attempt once and retry 5 times for a total of 6 tries.
  * @param {number} [param.options.minTimeout=1000] minimum number of ms to wait after first retry. defaulted to 1000ms
  * @param {number} [param.options.maxTimeout=5000] maximum number of ms between two retries. defaulted to 5000ms
  * @param {func} [param.options.onRetry] fn that gets called per retry

creator-node/src/utils/cidUtils.ts

@@ -67,7 +67,7 @@ export async function findCIDInNetwork(
 
     try {
       found = await asyncRetry({
-        asyncFn: async (bail: (e: Error) => void) => {
+        asyncFn: async (bail: (e: Error) => void, num: number) => {
           let response
           try {
             response = await axios({
@@ -98,9 +98,16 @@ export async function findCIDInNetwork(
               return
             }
 
-            throw new Error(
-              `Failed to fetch content with statusCode=${e.response?.status}. Retrying..`
-            )
+            if (num === numRetries + 1) {
+              // Final error thrown
+              throw new Error(
+                `Failed to fetch content with statusCode=${e.response?.status} after ${num} retries`
+              )
+            } else {
+              throw new Error(
+                `Failed to fetch content with statusCode=${e.response?.status}. Retrying..`
+              )
+            }
           }
 
           if (!response || !response.data) {

creator-node/test/asyncRetry.test.js

@@ -16,8 +16,59 @@ describe('test asyncRetry', function () {
         minTimeout: 0,
         maxTimeout: 100
       })
+      assert.fail('Should have thrown')
     } catch (e) {
       assert.deepStrictEqual(e.message, 'Will not retry after 3 retries')
     }
   })
+
+  it('on certain retry, do something', async function () {
+    try {
+      let name = ''
+      await asyncRetry({
+        asyncFn: async (bail, num) => {
+          if (num === 3) {
+            name = 'vicky'
+            return
+          }
+
+          name = 'not vicky'
+          throw new Error(`Test ${num}`)
+        },
+        options: {
+          minTimeout: 0,
+          maxTimeout: 100
+        }
+      })
+
+      assert.deepStrictEqual(name, 'vicky')
+    } catch (e) {
+      assert.fail('Should not have thrown')
+    }
+  })
+
+  it('final error message should be what is specified in num retry check', async function () {
+    try {
+      const retries = 3
+      await asyncRetry({
+        asyncFn: async (bail, num) => {
+          console.log('Test num', num)
+          if (num === retries + 1) {
+            throw new Error('vicky')
+          }
+
+          throw new Error(`Test ${num}`)
+        },
+        options: {
+          minTimeout: 0,
+          maxTimeout: 100,
+          retries
+        }
+      })
+
+      assert.fail('Should have thrown')
+    } catch (e) {
+      assert.deepStrictEqual(e.message, 'vicky')
+    }
+  })
 })