Fix BDD step definitions to wait for recorder promise chain #5445
+3
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation/Description of the PR
Problem
BDD step definitions require explicit await on all
I.*method calls, even when the return value isn't needed. Without await, actions execute out of order because the step function completes before queued recorder actions finish.This contradicts the documented behavior and differs from how regular CodeceptJS scenarios work, where the recorder handles promise chaining automatically.
Minimal Reproducible Example
Feature File
Stepdef
Actual Output (npx codeceptjs run --features --steps)
Expected Output
Root Cause
In
gherkin.jsfunction awaits the step function but doesn't wait for the recorder promise chain to complete:Solution
After awaiting the step function, also await
recorder.promise()to ensure all queued actions complete before the step finishes. This aligns BDD step execution with how hooks inasyncWrapper.jsalready handle the recorder (seeinjectHookwhich returnsrecorder.promise()).After this fix:
awaitis only needed when you need the return value (e.g.,await I.grabTextFrom())Related Documentation
From https://codecept.io/bdd/#step-definitions - the examples show step definitions without await
Applicable helpers: None
Applicable plugins: None
Type of change
Checklist:
npm run docs)npm run lint)npm test)