fix(download-logs): retry download logs fixes #711

Author: Dawid

src/cloudmanager-helpers.js

@@ -14,7 +14,7 @@ const Config = require('@adobe/aio-lib-core-config')
 const { init } = require('@adobe/aio-lib-cloudmanager')
 const { cli } = require('cli-ux')
 const { context, getToken, Ims } = require('@adobe/aio-lib-ims')
-const logger = require('@adobe/aio-lib-core-logging')('@adobe/aio-lib-cloudmanager', { provider: 'debug' })
+const logger = require('@adobe/aio-lib-core-logging')('@adobe/aio-lib-cloudmanager', { level: process.env.LOG_LEVEL })
 const moment = require('moment')
 const _ = require('lodash')
 const { CLI } = require('@adobe/aio-lib-ims/src/context')
@@ -51,7 +51,7 @@ const GROUP_DISPLAY_NAMES = Object.keys(GROUP_DISPLAY_NAMES_TO_FRIENDLY_NAME_MAP
 
 let authMode = SERVICE_ACCOUNT
 
-function toJson (item) {
+function toJson(item) {
   let c = item
   if (typeof c === 'string') {
     c = JSON.parse(c)
@@ -60,21 +60,21 @@ function toJson (item) {
   return c
 }
 
-function getBaseUrl () {
+function getBaseUrl() {
   const configStr = Config.get('cloudmanager')
 
   return (configStr && toJson(configStr).base_url) || 'https://cloudmanager.adobe.io'
 }
 
-function getProgramId (flags) {
+function getProgramId(flags) {
   const programId = flags.programId || Config.get('cloudmanager_programid')
   if (!programId) {
     throw new validationCodes.MISSING_PROGRAM_ID()
   }
   return programId
 }
 
-function getOutputFormat (flags) {
+function getOutputFormat(flags) {
   if (flags.json) {
     return 'json'
   }
@@ -87,7 +87,7 @@ function getOutputFormat (flags) {
  * This doesn't work quite correctly -- when output in both JSON and YAML, the result is a JSON-encoded array in a string whereas one
  * would expect a JSON or YAML. This seems like a bug in oclif that will hopefully get addressed.
  */
-function columnWithArray (key, options, flags) {
+function columnWithArray(key, options, flags) {
   const mapperFunction = options.mapperFunction || (i => i)
   if (flags.json || flags.yaml) {
     return options
@@ -102,7 +102,7 @@ function columnWithArray (key, options, flags) {
   }
 }
 
-function createKeyValueObjectFromFlag (flag) {
+function createKeyValueObjectFromFlag(flag) {
   if (flag.length % 2 === 0) {
     let i
     const tempObj = {}
@@ -127,27 +127,27 @@ function createKeyValueObjectFromFlag (flag) {
   }
 }
 
-function sanitizeEnvironmentId (environmentId) {
+function sanitizeEnvironmentId(environmentId) {
   let envId = environmentId
   if (envId && envId.startsWith('e')) {
     envId = envId.substring(1)
   }
   return envId
 }
 
-function getDefaultEnvironmentId (flags) {
+function getDefaultEnvironmentId(flags) {
   return Config.get('cloudmanager_environmentid')
 }
 
-function getCliOrgId () {
+function getCliOrgId() {
   return Config.get('cloudmanager_orgid') || Config.get('console.org.code')
 }
 
-function setCliOrgId (orgId, local) {
+function setCliOrgId(orgId, local) {
   Config.set('cloudmanager_orgid', orgId, local)
 }
 
-async function initSdk (contextName) {
+async function initSdk(contextName) {
   let apiKey
   let orgId
   let accessToken
@@ -182,7 +182,7 @@ async function initSdk (contextName) {
   return await init(orgId, apiKey, accessToken, baseUrl)
 }
 
-function formatAction (stepState) {
+function formatAction(stepState) {
   if (stepState.action === 'deploy') {
     return `${_.startCase(stepState.environmentType)} ${_.startCase(stepState.action)}`
   } else if (stepState.action === 'contentAudit') {
@@ -192,33 +192,33 @@ function formatAction (stepState) {
   }
 }
 
-function formatTime (property) {
+function formatTime(property) {
   return (object) => object[property] ? moment(object[property]).format('LLL') : ''
 }
 
-function formatDuration (object) {
+function formatDuration(object) {
   return object.startedAt && object.finishedAt
     ? moment.duration(moment(object.finishedAt).diff(object.startedAt)).humanize()
     : ''
 }
 
-function formatStatus (object) {
+function formatStatus(object) {
   return _.startCase(object.status.toLowerCase())
 }
 
-function enableCliAuth () {
+function enableCliAuth() {
   authMode = CLI_AUTH
 }
 
-function disableCliAuth () {
+function disableCliAuth() {
   authMode = undefined
 }
 
-function isCliAuthEnabled () {
+function isCliAuthEnabled() {
   return authMode === CLI_AUTH
 }
 
-async function getCloudManagerAuthorizedOrganizations (contextName) {
+async function getCloudManagerAuthorizedOrganizations(contextName) {
   if (isCliAuthEnabled()) {
     contextName = CLI
   } else {
@@ -243,23 +243,23 @@ async function getCloudManagerAuthorizedOrganizations (contextName) {
   })
 }
 
-function isCloudManagerGroupDisplayName (groupDisplayName) {
+function isCloudManagerGroupDisplayName(groupDisplayName) {
   return GROUP_DISPLAY_NAMES.includes(groupDisplayName)
 }
 
-function getCloudManagerRoles (org) {
+function getCloudManagerRoles(org) {
   if (!org.groups) {
     return []
   }
   const roles = org.groups.map(group => group.groupDisplayName).filter(isCloudManagerGroupDisplayName).map(groupDisplayName => GROUP_DISPLAY_NAMES_TO_FRIENDLY_NAME_MAPPING[groupDisplayName])
   return _.uniq(roles)
 }
 
-function getFullOrgIdentity (org) {
+function getFullOrgIdentity(org) {
   return `${org.orgRef.ident}@${org.orgRef.authSrc}`
 }
 
-async function getActiveOrganizationId (contextName) {
+async function getActiveOrganizationId(contextName) {
   if (isCliAuthEnabled()) {
     return getCliOrgId()
   } else {
@@ -272,7 +272,7 @@ async function getActiveOrganizationId (contextName) {
   }
 }
 
-function handleError (_error, errorFn) {
+function handleError(_error, errorFn) {
   if (cli.action.running) {
     cli.action.stop('failed')
   }
@@ -307,7 +307,7 @@ function handleError (_error, errorFn) {
   })
 }
 
-async function executeWithRetries (fn, maxRetries = 5) {
+async function executeWithRetries(fn, maxRetries = 5) {
   let retries = 0
   let startTime = Date.now()
   while (retries < maxRetries) {
@@ -329,13 +329,16 @@ async function executeWithRetries (fn, maxRetries = 5) {
   throw new validationCodes.MAX_RETRY_REACHED()
 }
 
-function shouldResetRetires (startTime, resetInterval = 3600000) {
-  const elapsedTime = Date.now() - startTime
-  if (elapsedTime >= resetInterval) {
-    logger.debug(`Resetting retries after ${resetInterval / 1000} seconds.`)
-    return true
+async function executeWithRetry(fn, retries = 3, delay = 1000) {
+  for (let i = 0; i < retries; i++) {
+    try {
+      return await fn()
+    } catch (error) {
+      logger.debug(`Retrying due to error: ${error.message || 'Unknown error'} (attempt ${i + 1}/${retries})`)
+      if (i === retries - 1) throw error
+      await new Promise(resolve => setTimeout(resolve, delay))
+    }
   }
-  return false
 }
 
 module.exports = {
@@ -361,4 +364,5 @@ module.exports = {
   getFullOrgIdentity,
   handleError,
   executeWithRetries,
+  executeWithRetry,
 }

src/commands/cloudmanager/environment/download-logs.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 
 const { flags } = require('@oclif/command')
-const { initSdk, getProgramId, sanitizeEnvironmentId } = require('../../../cloudmanager-helpers')
+const { initSdk, getProgramId, sanitizeEnvironmentId, executeWithRetry } = require('../../../cloudmanager-helpers')
 const { cli } = require('cli-ux')
 const path = require('path')
 const commonFlags = require('../../../common-flags')
@@ -50,8 +50,10 @@ class DownloadLogs extends BaseCommand {
   }
 
   async downloadLogs (programId, environmentId, service, logName, days, outputDirectory, imsContextName = null) {
-    const sdk = await initSdk(imsContextName)
-    return sdk.downloadLogs(programId, environmentId, service, logName, days, outputDirectory)
+    return executeWithRetry(async () => {
+      const sdk = await initSdk(imsContextName)
+      return sdk.downloadLogs(programId, environmentId, service, logName, days, outputDirectory)
+    })
   }
 }