fix: Exit with non zero status code when the deployment fails and poll for 1 second more before deployment logs polling stops

Author: dhruvparekh12

src/adapters/file-upload.ts

@@ -14,7 +14,7 @@ import { print } from '../util';
 import BaseClass from './base-class';
 import { getFileList } from '../util/fs';
 import { createSignedUploadUrlMutation, importProjectMutation } from '../graphql';
-import { SignedUploadUrlData, FileUploadMethod } from '../types/launch';
+import { SignedUploadUrlData, FileUploadMethod, DeploymentStatus } from '../types/launch';
 import config from '../config';
 
 export default class FileUpload extends BaseClass {
@@ -34,6 +34,9 @@ export default class FileUpload extends BaseClass {
 
     this.prepareLaunchConfig();
     await this.showLogs();
+    if(this.config.currentDeploymentStatus === DeploymentStatus.FAILED) {
+      this.exit(1);
+    }
     this.showDeploymentUrl();
     this.showSuggestion();
   }

src/adapters/github.ts

@@ -12,6 +12,7 @@ import { print } from '../util';
 import BaseClass from './base-class';
 import { getRemoteUrls } from '../util/create-git-meta';
 import { repositoriesQuery, userConnectionsQuery, importProjectMutation } from '../graphql';
+import { DeploymentStatus } from '../types';
 
 export default class GitHub extends BaseClass {
   /**
@@ -30,6 +31,9 @@ export default class GitHub extends BaseClass {
 
     this.prepareLaunchConfig();
     await this.showLogs();
+    if(this.config.currentDeploymentStatus === DeploymentStatus.FAILED) {
+      this.exit(1);
+    }
     this.showDeploymentUrl();
     this.showSuggestion();
   }

src/types/launch.ts

@@ -88,6 +88,17 @@ export type Environment = {
   frameworkPreset: string;
 };
 
+export enum DeploymentStatus {
+  QUEUED = 'QUEUED',
+  LIVE = 'LIVE',
+  DEPLOYED = 'DEPLOYED',
+  ARCHIVED = 'ARCHIVED',
+  DEPLOYING = 'DEPLOYING',
+  SKIPPED = 'SKIPPED',
+  FAILED = 'FAILED',
+  CANCELLED = 'CANCELLED',
+}
+
 export {
   LogFn,
   ExitFn,

src/util/logs-polling-utilities.ts

@@ -4,6 +4,7 @@ import { ApolloClient, ObservableQuery } from '@apollo/client/core';
 
 import { LogPollingInput, ConfigType } from '../types';
 import { deploymentQuery, deploymentLogsQuery, serverlessLogsQuery } from '../graphql';
+import { setTimeout as sleep } from "timers/promises";
 
 export default class LogPolling {
   private config: ConfigType;
@@ -79,6 +80,7 @@ export default class LogPolling {
       }
       this.deploymentStatus = data?.Deployment?.status;
       if (this.config.deploymentStatus.includes(this.deploymentStatus)) {
+        this.config.currentDeploymentStatus = this.deploymentStatus;
         statusWatchQuery.stopPolling();
       }
     });
@@ -109,7 +111,7 @@ export default class LogPolling {
     >,
   ): void {
     let timestamp: number = 0;
-    logsWatchQuery.subscribe(({ data, errors, error }) => {
+    logsWatchQuery.subscribe(async({ data, errors, error }) => {
       ux.action.start('Loading deployment logs...');
 
       if (error) {
@@ -152,6 +154,7 @@ export default class LogPolling {
         }
 
         if (this.config.deploymentStatus.includes(this.deploymentStatus)) {
+          await sleep(1_000);
           logsWatchQuery.stopPolling();
           this.$event.emit('deployment-logs', {
             message: 'DONE',

test/unit/adapters/file-upload.test.ts

@@ -7,7 +7,7 @@ import { FileUpload, BaseClass } from '../../../src/adapters';
 import { BaseCommand } from '../../../src/base-command';
 import { isNull } from 'util';
 import { log } from 'console';
-import { FileUploadMethod } from '../../../src/types/launch';
+import { DeploymentStatus, FileUploadMethod } from '../../../src/types/launch';
 
 describe('File Upload', () => {
   let inquireStub, exitStub, prepareApiClientsStub, prepareConfigStub, getConfigStub;
@@ -216,6 +216,44 @@ describe('File Upload', () => {
         expect(showSuggestionStub.calledOnce).to.be.true;
       });
 
+      it('should exit with non zero status code if deployment fails', async () => {
+        getEnvironmentStub.resolves(defaultEnvironment);
+        let adapterConstructorOptions = {
+          config: {
+            isExistingProject: true,
+            currentConfig: { uid: '123244', organizationUid: 'bltxxxxxxxx' },
+            'redeploy-latest': true,
+            currentDeploymentStatus: DeploymentStatus.FAILED,
+          },
+        };
+        let exitStatusCode;
+
+        try {
+          await new FileUpload(adapterConstructorOptions).run();
+        } catch (err) {
+          exitStatusCode = err.message;
+        }
+
+        expect(getEnvironmentStub.calledOnce).to.be.true;
+        expect(processExitStub.calledOnceWithExactly(1)).to.be.true;
+        expect(exitStatusCode).to.equal('1');
+        expect(initApolloClientStub.calledOnce).to.be.true;
+        expect(createSignedUploadUrlStub.calledOnce).to.be.true;
+        expect(archiveStub.calledOnce).to.be.true;
+        expect(uploadFileStub.calledOnce).to.be.true;
+        expect(uploadFileStub.args[0]).to.deep.equal([zipName, zipPath, signedUploadUrlData]);
+        expect(createNewDeploymentStub.calledOnce).to.be.true;
+        expect(createNewDeploymentStub.args[0]).to.deep.equal([
+          true,
+          defaultEnvironment.uid,
+          signedUploadUrlData.uploadUid,
+        ]);
+        expect(prepareLaunchConfigStub.calledOnce).to.be.true;
+        expect(showLogsStub.calledOnce).to.be.true;
+        expect(showDeploymentUrlStub.calledOnce).to.be.false;
+        expect(showSuggestionStub.calledOnce).to.be.false;
+      });
+
       it('should exit with an error message when both --redeploy-last-upload and --redeploy-latest flags are passed', async () => {
         getEnvironmentStub.resolves(defaultEnvironment);
 

test/unit/adapters/github.test.ts

@@ -6,6 +6,7 @@ import { githubAdapterMockData } from '../mock/index';
 import { GitHub, BaseClass } from '../../../src/adapters';
 import { BaseCommand } from '../../../src/base-command';
 import fs from 'fs';
+import { DeploymentStatus } from '../../../src/types';
 
 describe('GitHub', () => {
   let inquireStub, prepareApiClientsStub, prepareConfigStub, getConfigStub;
@@ -155,6 +156,38 @@ describe('GitHub', () => {
         expect(showSuggestionStub.calledOnce).to.be.true;
       });
 
+      it('should exit with non zero status code if deployment fails', async () => {
+        getEnvironmentStub.resolves(defaultEnvironment);
+        let adapterConstructorOptions = {
+          config: {
+            isExistingProject: true,
+            'redeploy-latest': true,
+            currentDeploymentStatus: DeploymentStatus.FAILED
+          },
+        };
+        let exitStatusCode;
+
+        try {
+          await new GitHub(adapterConstructorOptions).run();
+        } catch (err) {
+          exitStatusCode = err.message;
+        }
+
+        expect(getEnvironmentStub.calledOnce).to.be.true
+        expect(processExitStub.calledOnceWithExactly(1)).to.be.true;
+        expect(exitStatusCode).to.equal('1');
+        expect(initApolloClientStub.calledOnce).to.be.true;
+        expect(createNewDeploymentStub.calledOnce).to.be.true;
+        expect(createNewDeploymentStub.args[0]).to.deep.equal([
+          false,
+          defaultEnvironment.uid
+        ]);
+        expect(prepareLaunchConfigStub.calledOnce).to.be.true;
+        expect(showLogsStub.calledOnce).to.be.true;
+        expect(showDeploymentUrlStub.calledOnce).to.be.false;
+        expect(showSuggestionStub.calledOnce).to.be.false;
+      });
+
       it('should abort github flow for existing project when flag redeploy-last-upload is passed', async () => {
         getEnvironmentStub.resolves(defaultEnvironment)