Merge pull request #29 from contentstack/development

Allow specifying environment when trying to redeploy, allow specifying PORT when running cloud functions and bug fixes

Author: dhruvparekh12

.github/workflows/release.yml

@@ -52,7 +52,7 @@ jobs:
         id: release-plugin
         uses: JS-DevTools/npm-publish@v2.2.0
         with:
-          token: ${{ secrets.NPM_TOKEN }}
+          token: "${{ secrets.NPM_TOKEN }}"
           access: public
       - name: get-npm-version
         id: package-version
@@ -61,4 +61,5 @@ jobs:
         id: github-release
         env:
           GITHUB_TOKEN: ${{ secrets.PKG_TOKEN }}
-        run:  gh release create v${{ steps.release-plugin.outputs.version }} --title "Release ${{ steps.release-plugin.outputs.version }}" --generate-notes
+          VERSION: ${{ steps.release-plugin.outputs.version }}
+        run: gh release create v"$VERSION" --title "Release $VERSION" --generate-notes

.github/workflows/sca-scan.yml

@@ -12,4 +12,4 @@ jobs:
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
         with:
-          args: --all-projects --fail-on=all
+          args: --all-projects --fail-on=all --strict-out-of-sync=false

package-lock.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": {
@@ -34,7 +34,7 @@
     "@types/express-serve-static-core": "^4.17.34",
     "adm-zip": "^0.5.16",
     "chalk": "^4.1.2",
-    "cross-fetch": "^3.1.8",
+    "cross-fetch": "^4.1.0",
     "dotenv": "^16.4.7",
     "express": "^4.21.1",
     "form-data": "^4.0.0",

package.json

@@ -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 {
       });
     }
   }
-}
+}

src/adapters/base-class.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> {

src/adapters/file-upload.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> {

src/adapters/github.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,

src/adapters/pre-check.ts

@@ -20,7 +20,7 @@ import {
 import config from './config';
 import { GraphqlApiClient, Logger } from './util';
 import { getLaunchHubUrl } from './util/common-utility';
-import { ConfigType, LogFn, Providers } from './types';
+import { ConfigType, LogFn, Providers, GraphqlHeaders } from './types';
 
 export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)['baseFlags'] & T['flags']>;
 export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
@@ -198,20 +198,27 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
    * @memberof BaseCommand
    */
   async prepareApiClients(): Promise<void> {
+    let headers: GraphqlHeaders = {
+      'X-CS-CLI': this.context.analyticsInfo
+    } 
+
+    const { uid, organizationUid } = this.sharedConfig.currentConfig;
+
+    if (uid) {
+      headers['x-project-uid'] = uid;
+    }
+
+    if (organizationUid) {
+      headers['organization_uid'] = organizationUid;
+    }
+
     this.apolloClient = await new GraphqlApiClient({
-      headers: {
-        'X-CS-CLI': this.context.analyticsInfo,
-        'x-project-uid': this.sharedConfig.currentConfig.uid,
-        organization_uid: this.sharedConfig.currentConfig.organizationUid,
-      },
+      headers,
       baseUrl: this.sharedConfig.manageApiBaseUrl,
     }).apolloClient;
+
     this.apolloLogsClient = await new GraphqlApiClient({
-      headers: {
-        'X-CS-CLI': this.context.analyticsInfo,
-        'x-project-uid': this.sharedConfig.currentConfig.uid,
-        organization_uid: this.sharedConfig.currentConfig.organizationUid,
-      },
+      headers,
       baseUrl: this.sharedConfig.logsApiBaseUrl,
     }).apolloClient;
   }

src/base-command.ts

@@ -1,18 +1,15 @@
-import { FlagInput, Flags } from '@contentstack/cli-utilities';
-
-import { BaseCommand } from '../../base-command';
+import { FlagInput } from '@contentstack/cli-utilities';
 import Contentfly from '../../util/cloud-function';
+import { Flags, Command } from '@oclif/core';
 
-export default class Functions extends BaseCommand<typeof Functions> {
+export default class Functions extends Command {
   static description = 'Serve cloud functions';
 
   static examples = [
     '$ csdx launch:functions',
     '$ csdx launch:functions --port=port',
     '$ csdx launch:functions --data-dir <path/of/current/working/dir>',
-    '$ csdx launch:functions --config <path/to/launch/config/file>',
     '$ csdx launch:functions --data-dir <path/of/current/working/dir> -p "port number"',
-    '$ csdx launch:functions --config <path/to/launch/config/file> --port=port',
   ];
 
   static flags: FlagInput = {
@@ -21,13 +18,19 @@ export default class Functions extends BaseCommand<typeof Functions> {
       default: '3000',
       description: 'Port number',
     }),
+    'data-dir': Flags.string({
+      char: 'd',
+      description: 'Current working directory',
+    }),
   };
 
   async run(): Promise<void> {
-    this.sharedConfig.config =
-      this.flags['data-dir'] || this.flags.config
-        ? this.flags.config?.split(`${this.sharedConfig.configName}`)[0] || this.flags['data-dir']
-        : process.cwd();
-    await new Contentfly(this.sharedConfig.config as string).serveCloudFunctions(+this.flags.port);
+    const { flags } = await this.parse(Functions);
+    const currentWorkingDirectory = process.cwd();
+    const projectBasePath = flags['data-dir'] || currentWorkingDirectory;
+
+    const port = process.env.PORT || flags.port;
+
+    await new Contentfly(projectBasePath).serveCloudFunctions(port);
   }
 }