Chore: retry deployment logs polling (#128)

yaronya · web-flow · commit d9ced4108f50 · 2022-12-29T14:25:25.000+02:00
diff --git a/node/README.md b/node/README.md
@@ -154,8 +154,8 @@ You can compile and run the CLI from source by cloning the repo from Github and
 ```bash
 # Clone the repo from github
 # Make sure env0 lib is not installed globally
-yarn install
-yarn link # link your local copy of the CLI to your terminal path
+npm install
+npm link # link your local copy of the CLI to your terminal path
 ```
 
 ### Development flow:
diff --git a/node/npm-shrinkwrap.json b/node/npm-shrinkwrap.json
diff --git a/node/package.json b/node/package.json
@@ -38,6 +38,7 @@
     "fs-extra": "9.0.1",
     "inquirer": "7.3.3",
     "lodash": "4.17.21",
+    "p-retry": "4.6.2",
     "update-notifier": "6.0.2",
     "winston": "3.3.4"
   },
diff --git a/node/src/lib/deploy-utils.js b/node/src/lib/deploy-utils.js
@@ -1,7 +1,7 @@
 const Env0ApiClient = require('./api-client');
 const logger = require('./logger');
 const { options } = require('../config/constants');
-const { convertStringToBoolean, removeEmptyValuesFromObj } = require('./general-utils');
+const { convertStringToBoolean, removeEmptyValuesFromObj, withRetry } = require('./general-utils');
 const { isEmpty } = require('lodash');
 
 const {
@@ -33,6 +33,18 @@ class DeployUtils {
     return await apiClient.callApi('get', `environments/deployments/${deploymentLogId}`);
   }
 
+  async getDeploymentSteps(deploymentLogId) {
+    return await apiClient.callApi('get', `deployments/${deploymentLogId}/steps`)
+  }
+
+  async getDeploymentStepLog(deploymentLogId, stepName, startTime) {
+    return await apiClient.callApi(
+        'get',
+        `deployments/${deploymentLogId}/steps/${stepName}/log`,
+        { params: { startTime } }
+    )
+  }
+
   async updateEnvironment(environment, data) {
     await apiClient.callApi('put', `environments/${environment.id}`, { data });
   }
@@ -90,14 +102,12 @@ class DeployUtils {
     let startTime = undefined;
 
     do {
-      const steps = await apiClient.callApi('get', `deployments/${deploymentLogId}/steps`);
+      const steps = await withRetry(() => this.getDeploymentSteps(deploymentLogId));
       const { status } = steps.find(step => step.name === stepName);
       const stepInProgress = status === 'IN_PROGRESS';
 
-      const { events, nextStartTime, hasMoreLogs } = await apiClient.callApi(
-        'get',
-        `deployments/${deploymentLogId}/steps/${stepName}/log`,
-        { params: { startTime } }
+      const { events, nextStartTime, hasMoreLogs } = await withRetry(
+          () => this.getDeploymentStepLog(deploymentLogId, stepName, startTime)
       );
 
       events.forEach(event => logger.info(event.message));
@@ -112,7 +122,7 @@ class DeployUtils {
   async processDeploymentSteps(deploymentLogId, stepsToSkip) {
     const doneSteps = [];
 
-    const steps = await apiClient.callApi('get', `deployments/${deploymentLogId}/steps`);
+    const steps = await this.getDeploymentSteps(deploymentLogId);
 
     for (const step of steps) {
       const alreadyLogged = stepsToSkip.includes(step.name);
@@ -144,7 +154,7 @@ class DeployUtils {
     }
 
     while (true) {
-      const { type, status } = await this.getDeployment(deployment.id);
+      const { type, status } = await withRetry(() => this.getDeployment(deployment.id));
 
       if (status === 'QUEUED') logger.info('Queued deployment is still waiting for earlier deployments to finish...');
 
diff --git a/node/src/lib/general-utils.js b/node/src/lib/general-utils.js
@@ -1,11 +1,16 @@
+const pRetry = require('p-retry');
+
 const convertStringToBoolean = str => {
   if (str === 'true') return true;
   if (str === 'false') return false;
 };
 
 const removeEmptyValuesFromObj = payload => JSON.parse(JSON.stringify(payload));
 
+const withRetry = (promiseFn) => pRetry(promiseFn, { retries: 2 });
+
 module.exports = {
   convertStringToBoolean,
-  removeEmptyValuesFromObj
+  removeEmptyValuesFromObj,
+  withRetry
 };
diff --git a/node/tests/lib/deploy-utils.spec.js b/node/tests/lib/deploy-utils.spec.js
@@ -161,6 +161,42 @@ describe('deploy utils', () => {
         { params: { startTime: mockNextStartTime } }
       );
     });
+
+    describe('when there is a failure', () => {
+      it('should retry when polling on deployment steps fails', async () => {
+        mockCallApi.mockRejectedValueOnce(new Error('fail!'));
+        mockCallApi.mockResolvedValueOnce([mockStep]);
+        mockCallApi.mockResolvedValueOnce({
+          events: [],
+          hasMoreLogs: false
+        });
+
+        await deployUtils.writeDeploymentStepLog(mockDeploymentId, mockStep.name);
+
+        expect(mockCallApi).toHaveBeenNthCalledWith(1, 'get', `deployments/${mockDeploymentId}/steps`)
+        expect(mockCallApi).toHaveBeenNthCalledWith(2, 'get', `deployments/${mockDeploymentId}/steps`)
+      });
+
+      it('should retry when polling on deployment step log fails', async () => {
+        mockCallApi.mockResolvedValueOnce([mockStep]);
+        mockCallApi.mockRejectedValueOnce(new Error('fail!'));
+        mockCallApi.mockResolvedValueOnce({
+          events: [],
+          hasMoreLogs: false
+        });
+
+        await deployUtils.writeDeploymentStepLog(mockDeploymentId, mockStep.name);
+
+        expect(mockCallApi).toHaveBeenNthCalledWith(2, 'get', `deployments/${mockDeploymentId}/steps/${mockStep.name}/log`, {
+          params: { startTime: undefined }
+        })
+        expect(mockCallApi).toHaveBeenNthCalledWith(3, 'get', `deployments/${mockDeploymentId}/steps/${mockStep.name}/log`, {
+          params: { startTime: undefined }
+        })
+      });
+    })
+
+
   });
 
   describe('create and deploy environment', () => {
diff --git a/node/yarn.lock b/node/yarn.lock
