fix: procfile comment parsing (#3641)

* this fixes the mocking difference causing flappy tests and adds chore to the title of the release PR

* fixing procfile parsing by ignoring comment lines and updating local Procfile fixture and tests to prevent regressions

Author: michaelmalave

scripts/create-release-pr

@@ -58,4 +58,4 @@ git add . -u
 echo "Creating git commit and pushing to GitHub..."
 git commit -m "v${PACKAGE_VERSION}"
 git push origin "${BRANCH_NAME}"
-gh pr create --title="release v${PACKAGE_VERSION}" --body "release v${PACKAGE_VERSION}"
+gh pr create --title="chore: release v${PACKAGE_VERSION}" --body "chore: release v${PACKAGE_VERSION}"

src/lib/local/load-foreman-procfile.ts

@@ -2,6 +2,10 @@ import fs from 'fs'
 
 function parseProcfile(content: string): Record<string, string> {
   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)

test/fixtures/local/Procfile

@@ -1,3 +1,4 @@
+# Example Procfile used by local command tests
 web: echo "it works (web)! port: $PORT"
 worker: echo "it works (worker)!"
 release: echo "it works (release)!"

test/unit/commands/apps/diff.unit.test.ts

@@ -133,7 +133,7 @@ describe('apps:diff', function () {
     api
       .get(`/apps/${app1Name}/releases`).matchHeader('range', /version/).reply(404, {id: 'not_found', message: 'Couldn\'t find that app.'})
       .get(`/apps/${app2Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId2))
-      .get(`/apps/${app2Name}/slugs/${slugId2}`).reply(200, slugBody(sameChecksum))
+      .get(`/apps/${app2Name}/slugs/${slugId2}`).optionally().reply(200, slugBody(sameChecksum))
 
     const {error} = await runCommand(AppsDiff, [app1Name, app2Name])
 

test/unit/lib/local/load-foreman-procfile.unit.test.ts

@@ -0,0 +1,70 @@
+import {expect} from 'chai'
+import fs from 'fs'
+import os from 'os'
+import path from 'path'
+
+import {loadProc} from '../../../../src/lib/local/load-foreman-procfile.js'
+
+describe('load-foreman-procfile', function () {
+  let tempDir: string
+
+  beforeEach(function () {
+    tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'heroku-local-procfile-'))
+  })
+
+  afterEach(function () {
+    fs.rmSync(tempDir, {force: true, recursive: true})
+  })
+
+  it('ignores top-level comment lines', function () {
+    const procfilePath = path.join(tempDir, 'Procfile')
+    fs.writeFileSync(procfilePath, [
+      '# Example Procfile for tests',
+      'web: npm run start',
+      'worker: npm run worker',
+      '',
+    ].join('\n'))
+
+    const procHash = loadProc(procfilePath)
+    expect(procHash).to.deep.equal({
+      web: 'npm run start',
+      worker: 'npm run worker',
+    })
+  })
+
+  it('ignores indented comment lines', function () {
+    const procfilePath = path.join(tempDir, 'Procfile')
+    fs.writeFileSync(procfilePath, [
+      '  # process descriptions',
+      'web: npm run start',
+      '',
+    ].join('\n'))
+
+    const procHash = loadProc(procfilePath)
+    expect(procHash).to.deep.equal({
+      web: 'npm run start',
+    })
+  })
+
+  it('retains existing parse errors for malformed lines', function () {
+    const procfilePath = path.join(tempDir, 'Procfile')
+    fs.writeFileSync(procfilePath, [
+      'web: npm run start',
+      'not a valid procfile line',
+      '',
+    ].join('\n'))
+
+    expect(() => loadProc(procfilePath)).to.throw('line 2 parse error: not a valid procfile line')
+  })
+
+  it('supports additional colons in process commands', function () {
+    const procfilePath = path.join(tempDir, 'Procfile')
+    fs.writeFileSync(procfilePath, [
+      'web: node server.js --url=http://localhost:3000',
+      '',
+    ].join('\n'))
+
+    const procHash = loadProc(procfilePath)
+    expect(procHash.web).to.equal('node server.js --url=http://localhost:3000')
+  })
+})