Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Distribution Diagramm #1803

Merged
merged 18 commits into from
Jun 27, 2024
Merged

Conversation

Kr0nox
Copy link
Member

@Kr0nox Kr0nox commented Jun 8, 2024

This PR improves the distribution diagram by

  • adding a legend to it
  • Giving options for the number of buckets

Addresses parts of #1606

@Kr0nox Kr0nox added enhancement Issue/PR that involves features, improvements and other changes report-viewer PR / Issue deals (partly) with the report viewer and thus involves web-dev technologies labels Jun 8, 2024
@Kr0nox Kr0nox requested review from TwoOfTwelve and a team June 8, 2024 17:17
Copy link
Member

@tsaglam tsaglam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have been testing this PR with quite a few datasets, here are my initial thoughts:

  • The animation when swapping to a different distribution granularity was confusing at the beginning, and still is when trying to compare two different granularities. I assume this is nothing we implemented on purpose and is rather part of an API, right?
  • At finer granularities, the numbers disappear. I notice that I swap back to one where I can see the numbers. This is especially the case when the lower percentage submissions are so many, that the bars for the higher percentage one are barely visible. If we can show the numbers for more or all granularities, this would be better.
  • Generally, I think we can stick to 4 or so granularities, e.g. 10, 20, 25, and 50. But I am not so sure which specific granularities are ideal.
  • For now, we can merge this PR, and the granularities can be adjusted in a later PR (however, before the next release).

@Kr0nox
Copy link
Member Author

Kr0nox commented Jun 18, 2024

The animation when swapping to a different distribution granularity was confusing at the beginning, and still is when trying to compare two different granularities. I assume this is nothing we implemented on purpose and is rather part of an API, right?

This is the default, but can be disabled (would also make the e2e tests faster)

At finer granularities, the numbers disappear. I notice that I swap back to one where I can see the numbers. This is especially the case when the lower percentage submissions are so many, that the bars for the higher percentage one are barely visible. If we can show the numbers for more or all granularities, this would be better.

This was done on purpose, since numbers would overlap and not be readable, but I can disable them for every second bar or something depending on the granularity. Your thoughts on that @tsaglam?

Generally, I think we can stick to 4 or so granularities, e.g. 10, 20, 25, and 50.

I would suggest 10, 25,50, 100 since 20 and 25 are pretty close together

@tsaglam
Copy link
Member

tsaglam commented Jun 18, 2024

This is the default, but can be disabled (would also make the e2e tests faster)

I think I would prefer that.

This was done on purpose, since numbers would overlap and not be readable, but I can disable them for every second bar or something depending on the granularity.

Can we scale the numbers, or is that unnecessarily complicated? Every second is not that helpful, as there is not necessarily a relation between the number of comparisons of neighboring buckets

I would suggest 10, 25,50, 100 since 20 and 25 are pretty close together

Sounds good, we can always adjust if we feel we need different granularities.

@Kr0nox
Copy link
Member Author

Kr0nox commented Jun 22, 2024

Removing the animations made the e2e test for the distribution diagram very flaky, especially on WebKit.
I could ever search for a solution, but that might delay the development of this PR.
I could also disable the tests for now and re-enable them when a solution was found

@tsaglam
Copy link
Member

tsaglam commented Jun 24, 2024

Then I would say we keep the animations for now, and turn this into an issue. We can disable animations whenever we find a suitable solution for the tests.

@tsaglam
Copy link
Member

tsaglam commented Jun 26, 2024

Ready to merge, @Kr0nox?

@Kr0nox
Copy link
Member Author

Kr0nox commented Jun 26, 2024

yes. should I add the animation issue to a new one, or the already existing one about the distribution diagram?

@tsaglam
Copy link
Member

tsaglam commented Jun 27, 2024

yes. should I add the animation issue to a new one, or the already existing one about the distribution diagram?

Both are fine for me, whatever you prefer.

Copy link

sonarqubecloud bot commented Jun 27, 2024

@Kr0nox
Copy link
Member Author

Kr0nox commented Jun 27, 2024

I managed to find the issue in the tests and diasabled the animations

@tsaglam tsaglam merged commit aab7ff4 into develop Jun 27, 2024
49 checks passed
@tsaglam tsaglam deleted the report-viewer/rework-distribution branch June 27, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Issue/PR that involves features, improvements and other changes report-viewer PR / Issue deals (partly) with the report viewer and thus involves web-dev technologies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants