Sort features by folders and feature name

[fredrikeriksson]

🤔 What's the problem you're trying to solve?

When using Reqnroll for unit tests tied closely to domains' rules and requirements one might easily ends up with hundreds of feature files.

Currently the rendered order of all features is always the same as the order in the .ndjson file.
As far as I understand there is an assumption that produced cucumber messages is just a stream which then dictates the order in said file and thus the order of the rendered html.

This is probably fine for non parallell test runs as the order should then reflect the iterated file paths.
However for test runs that run in parallell this results in an unordered list of features.

I raised this originally in reqnroll/Reqnroll#233 .

✨ What's your proposed solution?

Always sort by folders and feature name.

⛏ Have you considered any alternatives or workarounds?

Leave the sorting to the producer (Reqnroll in this case) somehow, either by default or by configuration.

However this forces every other producer to solve the same problem.

📚 Any additional context?

No response

[mpkorstanje]

@gasparnagy the simplest solution would be to do sorting would be to do the sorting in the frontend. Round about here I think:

react-components/src/hooks/useFilteredDocuments.ts

Line 22 in b09198e

;(query ? searchable.search(query) : Promise.resolve(gherkinQuery.getGherkinDocuments())).then(

Sorting wise, I think the canonical ordering is by document URI. Do you think you can make a PR for that?

[gasparnagy]

react-components/src/hooks/useFilteredDocuments.ts

I have also considered this. My other candidate would have been to keep the documents ordered at https://github.com/cucumber/gherkin-utils/blob/3754911ca6ae22cecb3174b9f36410a76b0aab17/javascript/src/Query.ts#L96

But the useFilteredDocuments.ts is probably better (and much easier anyway).

Sorting wise, I think the canonical ordering is by document URI.

I agree.

Background: Our problem is that for Reqnroll the discovery phase of collecting the tests is done by the test framework, so Reqnroll will only get notified about the features when the first scenario is executed, so the order how we emit the document envelopes will be at the end pretty random, especially in parallel execution situations that are common.

Do you think you can make a PR for that?

Yes, sure. I will.