Skip to content

Commit

Permalink
Fix(run): arguments are incorrectly gathered leading to duplicates (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
justinwilaby authored Aug 30, 2024
1 parent 2aa043a commit 85f36c5
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 28 deletions.
8 changes: 4 additions & 4 deletions packages/cli/src/commands/local/run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import {FileCompletion} from '@heroku-cli/command/lib/completions'
import {Command, Flags} from '@oclif/core'
import color from '@heroku-cli/color'
import {fork as foreman} from '../../lib/local/fork-foreman'
import {revertSortedArgs} from '../../lib/run/helpers'
import * as fs from 'fs'

export default class Run extends Command {
Expand All @@ -27,9 +26,10 @@ export default class Run extends Command {
async run() {
const execArgv: string[] = ['run']
const {argv, flags} = await this.parse(Run)
const userArgvInputOrder = revertSortedArgs(process.argv, argv as string[])
const maybeOptionsIndex = process.argv.indexOf('--')
const commandArgs = (maybeOptionsIndex === -1 ? argv : process.argv.slice(maybeOptionsIndex + 1)) as string[]

if (userArgvInputOrder.length === 0) {
if (commandArgs.length === 0) {
const errorMessage = 'Usage: heroku local:run [COMMAND]\nMust specify command to run'
this.error(errorMessage, {exit: -1})
}
Expand All @@ -44,7 +44,7 @@ export default class Run extends Command {
if (flags.port) execArgv.push('--port', flags.port)

execArgv.push('--') // disable node-foreman flag parsing
execArgv.push(...userArgvInputOrder as string[]) // eslint-disable-line unicorn/no-array-push-push
execArgv.push(...commandArgs as string[]) // eslint-disable-line unicorn/no-array-push-push

await foreman(execArgv)
}
Expand Down
8 changes: 4 additions & 4 deletions packages/cli/src/commands/run/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {ux} from '@oclif/core'
import debugFactory from 'debug'
import * as Heroku from '@heroku-cli/schema'
import Dyno from '../../lib/run/dyno'
import {buildCommand, revertSortedArgs} from '../../lib/run/helpers'
import {buildCommand} from '../../lib/run/helpers'

const debug = debugFactory('heroku:run')

Expand Down Expand Up @@ -33,14 +33,14 @@ export default class Run extends Command {

async run() {
const {argv, flags} = await this.parse(Run)
const userArgvInputOrder = revertSortedArgs(process.argv, argv as string[])

const maybeOptionsIndex = process.argv.indexOf('--')
const command = buildCommand((maybeOptionsIndex === -1 ? argv : process.argv.slice(maybeOptionsIndex + 1)) as string[])
const opts = {
'exit-code': flags['exit-code'],
'no-tty': flags['no-tty'],
app: flags.app,
attach: true,
command: buildCommand(userArgvInputOrder as string[]),
command,
env: flags.env,
heroku: this.heroku,
listen: flags.listen,
Expand Down
14 changes: 0 additions & 14 deletions packages/cli/src/lib/run/helpers.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,6 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import {ux} from '@oclif/core'

// this function exists because oclif sorts argv
export function revertSortedArgs(processArgs: Array<string>, argv: Array<string>) {
const originalInputOrder = []

// this reorders the arguments in the order the user inputted
for (const processArg of processArgs) {
if (argv.includes(processArg)) {
originalInputOrder.push(processArg)
}
}

return originalInputOrder
}

export function buildCommand(args: Array<string>) {
if (args.length === 1) {
// do not add quotes around arguments if there is only one argument
Expand Down
6 changes: 0 additions & 6 deletions packages/cli/test/integration/run.integration.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import {expect, test} from '@oclif/test'
import * as runHelper from '../../src/lib/run/helpers'
import {unwrap} from '../helpers/utils/unwrap'

const testFactory = () => {
Expand All @@ -14,35 +13,30 @@ const testFactory = () => {

describe('run', function () {
testFactory()
.stub(runHelper, 'revertSortedArgs', () => ['echo 1 2 3'])
.command(['run', '--app=heroku-cli-ci-smoke-test-app', 'echo 1 2 3'])
.it('runs a command', async ctx => {
expect(ctx.stdout).to.include('1 2 3')
})

testFactory()
.stub(runHelper, 'revertSortedArgs', () => ['ruby -e "puts ARGV[0]" "{"foo": "bar"} " '])
.command(['run', '--app=heroku-cli-ci-smoke-test-app', 'ruby -e "puts ARGV[0]" "{"foo": "bar"} " '])
.it('runs a command with spaces', ctx => {
expect(unwrap(ctx.stdout)).to.contain('{foo: bar}')
})

testFactory()
.stub(runHelper, 'revertSortedArgs', () => ['{foo:bar}'])
.command(['run', '--app=heroku-cli-ci-smoke-test-app', 'ruby -e "puts ARGV[0]" "{"foo":"bar"}"'])
.it('runs a command with quotes', ctx => {
expect(ctx.stdout).to.contain('{foo:bar}')
})

testFactory()
.stub(runHelper, 'revertSortedArgs', () => ['-e FOO=bar', 'env'])
.command(['run', '--app=heroku-cli-ci-smoke-test-app', '-e FOO=bar', 'env'])
.it('runs a command with env vars', ctx => {
expect(unwrap(ctx.stdout)).to.include('FOO=bar')
})

testFactory()
.stub(runHelper, 'revertSortedArgs', () => ['invalid-command command not found'])
.command(['run', '--app=heroku-cli-ci-smoke-test-app', '--exit-code', 'invalid-command'])
.exit(127)
.it('gets 127 status for invalid command', ctx => {
Expand Down

0 comments on commit 85f36c5

Please sign in to comment.