fix(commands): trim input parameters [FUS-358] (#976)

Trim input parameter to ensure valid values

Author: marcolink

src/command-utils.ts

@@ -0,0 +1,3 @@
+export function trimInput(str: string): Promise<string> {
+  return Promise.resolve(str.trim())
+}

src/commands/apply/index.ts

@@ -23,6 +23,7 @@ import {
 } from '../../analytics'
 import { config } from '../../config'
 import cleanStack from 'clean-stack'
+import { trimInput } from '../../command-utils'
 
 initSentry()
 
@@ -46,21 +47,32 @@ export default class Apply extends Command {
   ]
 
   static flags = {
-    space: Flags.string({ default: undefined, description: 'Space id', required: true }),
-    environment: Flags.string({ default: undefined, description: 'Target environment id', required: true }),
+    space: Flags.string({ default: undefined, description: 'Space id', required: true, parse: trimInput }),
+    environment: Flags.string({
+      default: undefined,
+      description: 'Target environment id',
+      required: true,
+      parse: trimInput,
+    }),
     file: Flags.string({ description: 'File path to changeset file', required: true, default: undefined }),
     'cma-token': Flags.string({
       default: undefined,
       description: 'CMA token, defaults to env: $CMA_TOKEN',
       required: true,
       env: 'CMA_TOKEN',
+      parse: trimInput,
     }),
     yes: Flags.boolean({
       description: 'Skips any confirmation before applying the changeset',
       required: false,
       default: false,
     }),
-    host: Flags.string({ default: 'api.contentful.com', description: 'Contentful API host', required: false }),
+    host: Flags.string({
+      default: 'api.contentful.com',
+      description: 'Contentful API host',
+      required: false,
+      parse: trimInput,
+    }),
   }
 
   private async writeFileLog() {
@@ -90,7 +102,7 @@ export default class Apply extends Command {
 
       if (!['Y', 'y'].includes(answer)) {
         this.terminatedByUser = true
-        this.log(chalk.bold.yellow('⚠️  Merge aborted'))
+        this.log(chalk.bold.yellow('⚠️ Merge aborted'))
         return
       }
     }

src/commands/create/index.ts

@@ -23,6 +23,7 @@ import { renderErrorOutputForCreate } from '../../engine/utils/render-error-outp
 import { detectErrorLevel, OutputFormatter, renderFilePaths } from '../../engine/utils'
 import { config } from '../../config'
 import cleanStack from 'clean-stack'
+import { trimInput } from '../../command-utils'
 
 initSentry()
 
@@ -46,18 +47,34 @@ export default class Create extends Command {
   ]
 
   static flags = {
-    space: Flags.string({ default: undefined, description: 'Space id', required: true }),
-    source: Flags.string({ default: undefined, description: 'Source environment id', required: true }),
-    target: Flags.string({ default: undefined, description: 'Target environment id', required: true }),
+    space: Flags.string({ default: undefined, description: 'Space id', required: true, parse: trimInput }),
+    source: Flags.string({
+      default: undefined,
+      description: 'Source environment id',
+      required: true,
+      parse: trimInput,
+    }),
+    target: Flags.string({
+      default: undefined,
+      description: 'Target environment id',
+      required: true,
+      parse: trimInput,
+    }),
     'cda-token': Flags.string({
       default: undefined,
       description: 'CDA token, defaults to env: $CDA_TOKEN',
       required: true,
       env: 'CDA_TOKEN',
+      parse: trimInput,
     }),
     'request-batch-size': Flags.integer({ description: 'Limit for every single request', default: 1000 }),
     'output-file': Flags.string({ default: undefined, description: 'File path to changeset file', required: false }),
-    host: Flags.string({ default: 'api.contentful.com', description: 'Contentful API host', required: false }),
+    host: Flags.string({
+      default: 'api.contentful.com',
+      description: 'Contentful API host',
+      required: false,
+      parse: trimInput,
+    }),
     'query-entries': Flags.string({
       default: undefined,
       description: 'Query parameters for entries based on CDA',

test/unit/commands/apply/index.test.ts

@@ -13,6 +13,7 @@ import { ApplyChangesetContext } from '../../../../src/engine/apply-changeset/ty
 import { createApplyChangesetContext } from '../../fixtures/apply-changeset-context-fixture'
 import * as client from '../../../../src/engine/client'
 import { createMockClient } from '../../fixtures/create-mock-client'
+import * as analytics from '../../../../src/analytics'
 
 const cmd = new ApplyCommand(
   [],
@@ -125,7 +126,7 @@ describe('Apply Command', () => {
 
   fancy
     .stdout()
-    .stdin('Y\n', 10) // small delay to make sure the stdin is read
+    .stdin('Y\n', 10)
     .do(() =>
       new ApplyCommand(
         [
@@ -146,4 +147,30 @@ describe('Apply Command', () => {
       process.stdin.once('data', (data) => expect(data.toString()).to.equal('Y\n'))
       expect(output.stdout).not.to.include('[Skipping confirmation because --yes flag was provided]')
     })
+
+  fancy
+    .stdout()
+    .stdin('Y\n', 10)
+    .stub(analytics, 'trackApplyCommandStarted', (stub) => stub.returns({})) // small delay to make sure the stdin is read
+    .do(() =>
+      new ApplyCommand(
+        [
+          '--space',
+          ' some-space-id',
+          '--environment',
+          'target-env-id ',
+          '--cma-token',
+          'some-cma-token',
+          '--file',
+          'some-file-path',
+        ],
+        {} as unknown as Config, // Runtime config, but not required for tests.
+      ).run(),
+    )
+    .it('should trim input params', () => {
+      expect((analytics.trackApplyCommandStarted as sinon.SinonStub).getCall(0).args[0]).to.contain({
+        space_key: 'some-space-id',
+        target_environment_key: 'target-env-id',
+      })
+    })
 })