Handle output from hooks appropriately

[brasmusson]

Update the legacy_formatter to pass messages and embeddings from hooks to formatters, just before
describing exceptions (if any) to formatters.

• Update legacy_formatter to pass hook output to formatters
• Update the JSON formatter/gherkin_formatter_adapter so that it does not crash on Before hook output
• Update the Pretty formatter to handle the hook output appropriately, the hook output is currently delayed to next step/scenario (Handle hook output appropriately in the Pretty formatter #738)
• Update the HTML formatter to handle the hook output appropriately, the hook output is currently delayed to next step/scenario (Fix the HTML formatters handling of output from hooks #746)

For instance the Pretty and HTML formatter currently print output from the before hooks after the first step, and output from the AfterStep/After hooks are delayed to the next step/scenario.

The big show stopper is that output from before hooks makes the JSON formatter crash ("[] not defined on NilClass") in the gherkin library. A similar problem when using Cucumber-JVM has already been identified: cucumber/gherkin#289

[mattwynne]

Thanks for digging into this @brasmusson. It would be ace to get this fixed for 2.0, but I won't cry if we don't - it's new behaviour, not a regression. I play to start re-writing the formatters against the new core reporter API once we ship 2.0, so this kind of thing would definitely get fixed at that stage.

[brasmusson]

The fix in cucumber/common@02ab9c6 does not make the JSON output right, but the least wrong without making changes in the Gherkin library. And since Cucumber does not crash (exception propagated all the way up to main), it does not block this PR to be merged.

[brasmusson]

v1.3.x does not handle output from hooks very well, with these changes v2.0 handles them, if not identically, equally good (or bad). Still these changes represent an improvement, previously the output from AfterStep and After hook seem to be lost altogether. I think this changes can be merged, and the Pretty and HTML formatters improved later (before or after the release of v2.0).

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.