HTML cannot be rendered if a 'text/json' attachment is present

[mitchgrout]

👓 What did you see?

Given an object which represents some JSON object, attach(object, "text/json") will correctly add an attachment envelope to the output message stream, and will be included in the HTML body. However, attempting to open this report (at least in Chrome) results in only a white screen being rendered.

If for example, object = { "foo": 42 }, then within the message stream we have (prettified):

{
  "attachment": {
    "body": {"foo":42},
    "contentEncoding": "IDENTITY",
    "mediaType": "text/json",
    "testCaseStartedId": "a92d9794-86d9-4c14-a913-1f8ddb736289",
    "testStepId": "5996f98b-fe36-48e3-94be-b3b2433344c2"
  }
}

✅ What did you expect to see?

The page should continue to be loadable, and either display the attached text/json in a plaintext form or in any other way.

📦 Which tool/library version are you using?

cucumber-html-formatter v19.2.0

🔬 How could we reproduce it?

1. Create features/test.feature with:

# features/test.feature
Feature: Reproduction of problem
  Scenario: Example scenario
    When nothing happens

2. Create features/step_definitions/all.rb with:

When('nothing happens') { }

3. Create features/support/env.rb with:

After do |test|
  context = {
    "foo" => 42,
  }

  attach(context, "text/json")
end

4. Run cucumber -f html -o cucumber.html
5. Load the cucumber.html into a browser of choice, and check that:
   1. only a white screen is displayed, and
   2. the attachment message is present in the message list, and
   3. if the attachment message is removed, the page is rendered correctly

📚 Any additional context?

No response

[mpkorstanje]

@luke-hill It looks like body is a hash rather than a string. That would suggest cucumber-ruby is writing the message wrong.

@mitchgrout as a workaround can you turn the hash into a string when calling attach?

[mitchgrout]

@luke-hill It looks like body is a hash rather than a string. That would suggest cucumber-ruby is writing the message wrong.

@mitchgrout as a workaround can you turn the hash into a string when calling attach?

It does appear that an explicit #to_json does the trick, as it results in the "body" being set to a string rather than an object:

{
  "attachment": {
    "body": "{\"foo\":42}",
    "contentEncoding": "IDENTITY",
    "mediaType": "text/json",
    "testCaseStartedId": "d175d079-76cf-43ba-b6b6-77064365b781",
    "testStepId": "0b071290-cd83-4db0-b7c1-b24fd9a8bf98"
  }
}

[luke-hill]

It's likely there is an issue.

The html-formatter has another issue whereby errors aren't being rendered correctly.

@mitchgrout so you know my rough priority / timelines.

1. Get cucumber ruby v10 out (I'm hoping this is soon, a week or so)
2. Then refactor a bunch of stuff regarding versions (Want to make sure we're using late/latest versions of most things)
3. Look at the html-formatter, fix a bunch of issues

I appreciate this is a long timeline, just lots of stuff for me to tackle.

If you have capacity and want to look into the html formatter feel free. There are issues there with errors (I think it's using the wrong property)