heroku local fails to parse Procfile comments (lines starting with #)

[stereoscott]

Bug

heroku local throws a parse error on comment lines in Procfiles, which foreman has always supported.

Error: line 1 parse error: # -t is timeout, -c is concurrency

Procfile

web: bundle exec puma -C config/puma.rb
# -t is timeout, -c is concurrency
worker: bundle exec sidekiq -t 25 -q critical -q default

Cause

In src/lib/local/load-foreman-procfile.ts, the parser throws on any line containing a word character that doesn't match ^\s*\w+:. Comment lines (starting with #) contain word characters but don't match
that pattern.

const lines = content.split(/\r?\n/).filter((line, i) => {
  if (line.match(/\w/)) {
    if (!line.match(/^\s*\w+:/)) {
      throw new Error('line ' + (i + 1) + ' parse error: ' + line)
    }
  }
  return line.match(/\w/)
})

Suggested fix

Skip comment lines before the validation check:

const lines = content.split(/\r?\n/).filter((line, i) => {
  if (line.match(/^\s*#/)) return false
  if (line.match(/\w/)) {
    if (!line.match(/^\s*\w+:/)) {
      throw new Error('line ' + (i + 1) + ' parse error: ' + line)
    }
  }
  return line.match(/\w/)
})

Expected behavior

Comment lines starting with # should be ignored, consistent with the original foreman behavior and the Procfile format.

If this was intentional, it should be listed in the changelog as Procfiles that worked before will now raise an error.

[michaelmalave]

Thanks for reporting this @stereoscott. We'll investigate and get back to you on this as soon as possible.

[stereoscott]

@michaelmalave all good, no rush or urgency at all, just wanted to mention it as i'm not sure how many folks have comments in their procfile.

[sdcorey]

Thanks for the quick fix. Until it hits the streets, we have removed our Procfile comments locally. Will heroku apps running on the cloud be ok if they have comments in their procfiles, or might we need to push commentless procfiles to our heroku remotes for a time?

[michaelmalave]

@sdcorey Good question, this issue is specific to the heroku cli. Those on Heroku will not be affected and should continue to work as expected.

[k80bowman]

We just released v11.2.0 of the CLI, which contains a fix for this problem. I'm going to go ahead and close this issue, but if this continues to be a problem, please either re-open this issue or create a new one.