Error processing test.finish event: TypeError: finish is not a function #5461

Activity

1. kobenguyent commented on Apr 7, 2026

   

   kobenguyent

   on Apr 7, 2026

   Collaborator

   More actions

   noticed this was introduced by #4713
2. kobenguyent commented on Apr 7, 2026

   

   kobenguyent

   on Apr 7, 2026

   Collaborator

   More actions

   @incoming-th may you try this fix locally?

   Here's why:

   The Bug

   finish is declared as a module-level variable (line 18) but is only assigned inside pauseSession() (line 86), where it's set to the resolve function of a Promise:

   return new Promise(resolve => {
       finish = resolve  // ← only assigned here
       return askForStep()
   })

   The Race Condition

   The event.test.finished listener is registered at line 39 and calls finish() at line 40:

   event.dispatcher.on(event.test.finished, () => {
       finish()  // ← called here
       recorder.session.restore('pause')
       rl.close()
       history.save()
   })

   This will throw TypeError: finish is not a function if event.test.finished fires before pauseSession() has ever been called — because finish is still undefined at that point.

   When Can This Happen?

   • A test finishes very quickly (e.g., skipped, errored early) before recorder.add('Start new session', ...) has had a chance to invoke pauseSession().
   • The pause() function is called, the event listener is registered, but the recorder hasn't yet executed the pauseSession callback by the time the test.finished event fires.

   Fix

   Guard the finish() call with a type check:

   event.dispatcher.on(event.test.finished, () => {
       if (typeof finish === 'function') finish()  // ← safe guard
       recorder.session.restore('pause')
       rl.close()
       history.save()
   })

   The same guard should also be applied to the parseInput call at line 97, which has the same vulnerability.

   👍React with 👍1Reacted by Incoming
3. incoming-th

   added a commit that references this issue on Apr 7, 2026

   Add safeguards fo finish in pause.js codeceptjs#5461

   2a33065
4. incoming-th commented on Apr 7, 2026

   

   incoming-th

   on Apr 7, 2026

   ContributorAuthor

   More actions

   @kobenguyent Thanks for looking into this. The safeguard is fine.

   🎉React with 🎉1Reacted by kobenguyent
5. incoming-th

   added a commit that references this issue on Jun 7, 2026

   resolve codeceptjs#5461

   This issue will close once commit 8ca768e is merged into the '3.x' branch.

   8ca768e
6. DavertMik

   added a commit that references this issue on Jun 7, 2026

   resolve #5461 (#5612)

   ...

   This issue will close once commit 4491b3f is merged into the '4.x' branch.

   4491b3f
7. DavertMik

   closed this as completedin #5612on Jun 7, 2026