HTML Reporter: Make it more obvious why diff is suppressed

[shivamdixit]

If the depth of an object is more than 'Max Depth' specified in Qunit.dump then the diff is not displayed. This behavior is confusing. This PR will display a message to the user so that user knows why it is not displayed.

Refer: #793 (comment)

I'm confused with what text to display to the user since the user might not be aware of max depth. Any suggestions?

Screenshot:

[scottgonzalez]

Ideally it says what the current max depth is and provides a link to rerun with a higher max depth or no max depth.

[shivamdixit]

@scottgonzalez I've updated the PR. Screenshot:

1. Added maxDepth in url parameter, maxDepth = -1 implies run the tests without any maxDepth.
2. Although maxDepth = someVal in URL parameters will work, but not explicitly showing the option of inputting the value from user because the UI will be cluttered as we will need to add input box, button etc.
3. Showing QUnit.dump.maxDepth as hint, in case user wants to change maxDepth.
4. The color of Rerun looks dull in the message, any suggestions for a different color?
5. As QUnit.dump is not in scope when we are parsing URL params, hence I've added extra property QUnit.config.maxDepth.

@jzaefferer Please provide your valuable suggestions as well.

[shivamdixit]

I think the tests are failing because of the timeout. How can I re-run the tests?

[jzaefferer]

This should use setUrl() to generate QUnit specific URLs that include other URL parameters already present (filters etc.).

[jzaefferer]

@shivamdixit thanks for the PR. I have very little bandwidth to review anything this week. I added one comment above. I'd like to discuss the general concept for tackling this issue, but that has to wait a few days.

[scottgonzalez]

That screenshot looks great. You should wrap QUnit.config.maxDepth in <code> instead of quotes.

Fixing the styling of the rerun link should be very simple, but let's wait for the team to discuss.

[shivamdixit]

@jzaefferer @scottgonzalez Thanks for your suggestions. I've updated the code.

[jzaefferer]

Let's add some CSS to display the Rerun link properly, just change color to something with more contrast.

[shivamdixit]

How is it looking?

[leobalter]

LGTM