Merge pull request #28 from contentstack/CL-1571

dhruvparekh12 · dhruvparekh12 · commit bb81feeb9cee · 2025-03-21T16:59:28.000+05:30
feat:Allow specifying environment using flag for redeploying existing project
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-launch",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Launch related operations",
   "author": "Contentstack CLI",
   "bin": {
diff --git a/src/adapters/base-class.ts b/src/adapters/base-class.ts
@@ -26,6 +26,7 @@ import {
   fileFrameworkQuery,
   createDeploymentMutation,
   cmsEnvironmentVariablesQuery,
+  environmentsQuery
 } from '../graphql';
 import {
   LogFn,
@@ -36,6 +37,7 @@ import {
   EmitMessage,
   DeploymentLogResp,
   ServerLogResp,
+  Environment,
 } from '../types';
 
 export default class BaseClass {
@@ -85,14 +87,14 @@ export default class BaseClass {
    * @return {*}  {Promise<void>}
    * @memberof GitHub
    */
-  async createNewDeployment(skipGitData = false, uploadUid?: string): Promise<void> {
+  async createNewDeployment(skipGitData = false, environmentUid:string, uploadUid?: string): Promise<void> {
     const deployment: Record<string, any> = {
-      environment: (first(this.config.currentConfig.environments) as Record<string, any>)?.uid,
+      environment: environmentUid
     };
 
     if (uploadUid) {
       deployment.uploadUid = uploadUid;
-    }
+    } 
 
     await this.apolloClient
       .mutate({
@@ -394,7 +396,7 @@ export default class BaseClass {
       data.project = this.config.currentConfig;
     }
 
-    writeFileSync(this.config.config, JSON.stringify(data), {
+    writeFileSync(this.config.config, JSON.stringify(data, null, 2), {
       encoding: 'utf8',
       flag: 'w',
     });
@@ -675,7 +677,7 @@ export default class BaseClass {
       },
       baseUrl: this.config.manageApiBaseUrl,
     }).apolloClient;
-    this.config.environment = (last(this.config.currentConfig.environments) as Record<string, any>)?.uid;
+    this.config.environment = (await this.getEnvironment()).uid;
     this.config.deployment = (last(this.config.currentConfig.deployments) as Record<string, any>)?.uid;
     const logs = new LogPolling({
       config: this.config,
@@ -744,6 +746,42 @@ export default class BaseClass {
     this.exit(1);
   }
 
+  async getEnvironment(): Promise<Environment> | never {
+    const environmentFlagInput = this.config['environment'];
+
+    if (!environmentFlagInput) {
+      const defaultEnvironment = (first(this.config.currentConfig.environments) as Environment);
+      this.setEnvironmentOnConfig(defaultEnvironment as Environment);
+      return defaultEnvironment;
+    }
+    const environmentList = await this.fetchEnvironments();
+    let environment = environmentList.find((env: Environment) => env.name === environmentFlagInput || env.uid === environmentFlagInput);
+    
+    if (!environment) {
+      this.log(`Environment "${environmentFlagInput}" not found in this project. Please provide a valid environment name or UID.`, 'error');
+      this.exit(1);
+    }
+    
+    environment = environment as Environment;
+    this.setEnvironmentOnConfig(environment);
+    return environment;
+  }
+
+  async setEnvironmentOnConfig(environment: Environment): Promise<void> {
+    this.config.environment = environment.uid;
+  }
+
+  async fetchEnvironments(): Promise<Environment[]> | never {
+    try {
+        const { data } = await this.apolloClient.query({ query: environmentsQuery });
+        const environments = map(data.Environments.edges, 'node');
+        return environments;
+      } catch (error: unknown) {
+        this.log(error instanceof Error ? error.message : String(error), 'error');
+        process.exit(1);
+      }
+  }
+
   /**
    * @method showDeploymentUrl - show deployment URL and open it on browser
    *
@@ -791,4 +829,4 @@ export default class BaseClass {
       });
     }
   }
-}
+}
diff --git a/src/adapters/file-upload.ts b/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 {
@@ -26,18 +26,22 @@ export default class FileUpload extends BaseClass {
    */
   async run(): Promise<void> {
     if (this.config.isExistingProject) {
-      await this.handleExistingProject();
+      const environment = await this.getEnvironment();
+      await this.handleExistingProject(environment.uid);
     } else {
       await this.handleNewProject();
     }
 
     this.prepareLaunchConfig();
     await this.showLogs();
+    if(this.config.currentDeploymentStatus === DeploymentStatus.FAILED) {
+      this.exit(1);
+    }
     this.showDeploymentUrl();
     this.showSuggestion();
   }
 
-  private async handleExistingProject(): Promise<void> {
+  private async handleExistingProject(environment: string): Promise<void> {
     await this.initApolloClient();
 
     let redeployLatest = this.config['redeploy-latest'];
@@ -63,7 +67,7 @@ export default class FileUpload extends BaseClass {
       await this.uploadFile(zipName, zipPath, signedUploadUrlData);
     }
 
-    await this.createNewDeployment(true, uploadUid);
+    await this.createNewDeployment(true, environment, uploadUid);
   }
 
   private async confirmRedeployment(): Promise<void> {
diff --git a/src/adapters/github.ts b/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 {
   /**
@@ -22,18 +23,22 @@ export default class GitHub extends BaseClass {
    */
   async run(): Promise<void> {
     if (this.config.isExistingProject) {
-      await this.handleExistingProject();
+      const environment = await this.getEnvironment();
+      await this.handleExistingProject(environment.uid);
     } else {
       await this.handleNewProject();
     }
 
     this.prepareLaunchConfig();
     await this.showLogs();
+    if(this.config.currentDeploymentStatus === DeploymentStatus.FAILED) {
+      this.exit(1);
+    }
     this.showDeploymentUrl();
     this.showSuggestion();
   }
 
-  private async handleExistingProject(): Promise<void> {
+  private async handleExistingProject(environmentUid:string): Promise<void> {
     await this.initApolloClient();
 
     const redeployLastUpload = this.config['redeploy-last-upload'];
@@ -48,7 +53,7 @@ export default class GitHub extends BaseClass {
       await this.confirmLatestRedeployment();
     }
 
-    await this.createNewDeployment();
+    await this.createNewDeployment(false, environmentUid);
   }
 
   private async confirmLatestRedeployment(): Promise<void> {
diff --git a/src/adapters/pre-check.ts b/src/adapters/pre-check.ts
@@ -62,7 +62,7 @@ export default class PreCheck extends BaseClass {
       this.log('Current Project details:', { bold: true, color: 'green' });
       this.log(''); // Empty line
       const { name, projectType, repository, environments } = this.config.currentConfig;
-      const [environment] = environments;
+      const environment = await this.getEnvironment();
 
       const detail: Record<string, any> = {
         'Project Name': name,
diff --git a/src/commands/launch/index.ts b/src/commands/launch/index.ts
@@ -18,8 +18,9 @@ export default class Launch extends BaseCommand<typeof Launch> {
     '<%= config.bin %> <%= command.id %> --type <options: GitHub|FileUpload>',
     '<%= config.bin %> <%= command.id %> --data-dir <path/of/current/working/dir> --type <options: GitHub|FileUpload>',
     '<%= config.bin %> <%= command.id %> --data-dir <path/of/current/working/dir> --redeploy-latest',
-    '<%= config.bin %> <%= command.id %> --data-dir <path/of/current/working/dir> --redeploy-latest --redeploy-last-upload',
+    '<%= config.bin %> <%= command.id %> --data-dir <path/of/current/working/dir> --redeploy-last-upload',
     '<%= config.bin %> <%= command.id %> --config <path/to/launch/config/file> --type <options: GitHub|FileUpload>',
+    '<%= config.bin %> <%= command.id %> --environment=<value> --redeploy-latest',
     '<%= config.bin %> <%= command.id %> --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value>',
     '<%= config.bin %> <%= command.id %> --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --server-command=<value>',
     '<%= config.bin %> <%= command.id %> --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Import variables from a stack" --alias=<value>',
diff --git a/src/types/launch.ts b/src/types/launch.ts
@@ -82,6 +82,23 @@ type SignedUploadUrlData = {
   uploadUid: string;
 };
 
+export type Environment = {
+  uid: string;
+  name: string;
+  frameworkPreset: string;
+};
+
+export enum DeploymentStatus {
+  QUEUED = 'QUEUED',
+  LIVE = 'LIVE',
+  DEPLOYED = 'DEPLOYED',
+  ARCHIVED = 'ARCHIVED',
+  DEPLOYING = 'DEPLOYING',
+  SKIPPED = 'SKIPPED',
+  FAILED = 'FAILED',
+  CANCELLED = 'CANCELLED',
+}
+
 export {
   LogFn,
   ExitFn,
diff --git a/src/util/logs-polling-utilities.ts b/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',
diff --git a/test/unit/adapters/file-upload.test.ts b/test/unit/adapters/file-upload.test.ts
diff --git a/test/unit/adapters/github.test.ts b/test/unit/adapters/github.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@contentstack/cli-launch",`
`3`		`- "version": "1.6.0",`
	`3`	`+ "version": "1.7.0",`
`4`	`4`	`"description": "Launch related operations",`
`5`	`5`	`"author": "Contentstack CLI",`
`6`	`6`	`"bin": {`