bugfix: HTML Formatter and its envelopes

[luke-hill]

Description

Fix HTML formatter not running output_envelope correctly

fixes #1890

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)

Please add an entry to the relevant section of CHANGELOG.md as part of this pull request.

Checklist:

Your PR is ready for review once the following checklist is
complete. You can also add some checks if you want to.

• Tests have been added for any changes to behaviour of the code
• New and existing tests are passing locally and on CI
• bundle exec rubocop reports no offenses
• RDoc comments have been updated
• CHANGELOG.md has been updated

[luke-hill]

@oellul this is a quick attempt at fixing it.

One thing to note, is this might not play well with attachments, especially those from hooks. So for now I want to let this sit for a short while

[oellul]

No worries, take your time. My monkey-patch seems to be serving my use case well for now (probably because I don't use attachments)

[luke-hill]

@oellul can you test this branch though with attachments. To see if you can remove your monkeypatch. I want to merge this in as it is an oversight on our end

[oellul]

Sure thing, I'll test it out tomorrow and let you know

[oellul]

@luke-hill You're right, it doesn't play well with attachments.

This step def

When('I attach an image') do
  image_path = File.read('image.jpeg', mode: 'rb')
  attach(image_path, 'image/jpeg')
end

is failing with error message "\xFF" from ASCII-8BIT to UTF-8 (JSON::GeneratorError)

This particular issue is fixed when changing cucumber/formatter/message_builder.rb line 77 to if streamed_file || src.encoding == Encoding::ASCII_8BIT to ensure that it is encoded as base64

[luke-hill]

Not quite sure what went on with merges / interactive rebases but @oellul could you take a look here again. Both with positive and negative scenarios for the html formatter

[oellul]

@luke-hill Please excuse the delay, it's been a busy week so far. I will try get on this before the weekend.

[luke-hill]

Never any timelines in OSS, do it when you can. I'm busy for a couple of weeks now

[oellul]

Hi @luke-hill , attachments seem to be working fine now. However, I did notice another issue where messages in the html report are duplicated.

This seems to be because a Formatter::MessageBuilder instance is being created in runtime.rb, and again due to the HTML formatter now also inheriting MessageBuilder. I was able to fix this locally with this change to create_formatters in runtime.rb to only call message_builder once:

    def create_formatters
      # the formatters defined by the cli options
      formatters
      # Until all messages are generated at the source the message_builder
      # is necessary — skip it when a user formatter already inherits from
      # MessageBuilder (e.g. HTML) to avoid sending every event twice.
      message_builder unless formatters.any? { |f| f.is_a?(Formatter::MessageBuilder) }
      # summary_report and global_hooks_summary_report is use to determine
      # the exit code
      summary_report
      global_hooks_summary_report
      fail_fast_report if @configuration.fail_fast?
      publish_banner_printer unless @configuration.publish_quiet?
    end

I ran some basic tests with other formatters and they seem to still be working properly with this change.

Since I don't have permissions to push to this branch I'll create a PR at some point to beef up the html formatter scenarios