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

Old mcc maps can be migrated to new metric names #3685

Closed
ChristianHuehn opened this issue Aug 12, 2024 · 4 comments · Fixed by #3803
Closed

Old mcc maps can be migrated to new metric names #3685

ChristianHuehn opened this issue Aug 12, 2024 · 4 comments · Fixed by #3803
Assignees
Labels
documentation pr-analysis Issues that touch the analysis pr(oject). priority:urgent Should be addressed ASAP

Comments

@ChristianHuehn
Copy link
Collaborator

ChristianHuehn commented Aug 12, 2024

Feature request

Description

As a user who has an old codecharta map with mcc, I want a script that allows me to migrate it in the repository with a documentation in the docs, so that I can migrate and compare them easier

Acceptance criteria

  • we have a script that migrates old mcc metrics into our new format. Located in our repo
  • There is an documentation for it

Assumptions & Exclusions

Development notes (optional Task Breakdown)

  • [ ]
  • [ ]
  • [ ]

Open questions

@ChristianHuehn ChristianHuehn added the priority:urgent Should be addressed ASAP label Aug 12, 2024
@Nereboss
Copy link
Contributor

I think the acceptance criteria for this issue should be adjusted a little for two reasons:

About the migration script: We already have the StructureModifier which can adjust the structure of an existing cc.json.
I propose that we do not provide a script to update the mcc but add it as an option in the StructureModifier.

For making the user aware: When the user imports a map, to give them the options to abort or import anyway we would need some kind of popup. This can get annoying for several reasons (popups are annoying in general; it would reappear for every new map, even when the user already knows what will happen; if someone has the visualisation in a pipeline somewhere the popup could mess with that; etc.).
I propose we handle it more like a notification that is out of the way but still makes the user aware and would tell them how to update the map with the StructureModifier. Similar to how IntelliJ shows notifications in the bottom right that are noticeable, but not invasive like a popup.

@Nereboss Nereboss self-assigned this Sep 2, 2024
Nereboss added a commit that referenced this issue Sep 9, 2024
Nereboss added a commit that referenced this issue Sep 9, 2024
Nereboss added a commit that referenced this issue Sep 10, 2024
Nereboss added a commit that referenced this issue Sep 10, 2024
Nereboss added a commit that referenced this issue Sep 11, 2024
Nereboss added a commit that referenced this issue Sep 11, 2024
Nereboss added a commit that referenced this issue Sep 11, 2024
Nereboss added a commit that referenced this issue Sep 11, 2024
Nereboss added a commit that referenced this issue Sep 11, 2024
Nereboss added a commit that referenced this issue Sep 11, 2024
@Nereboss
Copy link
Contributor

The script that can rename mcc to complexity or sonar_coplexity has been implemented into the structureModifier, so the first part of this issue is done
What is left is to notify the user in the frontend when they load multiple maps with some containing mcc and some the new names

@Nereboss Nereboss removed their assignment Sep 12, 2024
@ChristianHuehn ChristianHuehn added pr-visualization Issues that touch the visualization pr(oject) which means web and desktop features. pr-analysis Issues that touch the analysis pr(oject). labels Sep 25, 2024
@ChristianHuehn ChristianHuehn added documentation and removed pr-visualization Issues that touch the visualization pr(oject) which means web and desktop features. labels Sep 26, 2024
@phanlezz
Copy link
Collaborator

Closed via #3728 and #3773

@ChristianHuehn
Copy link
Collaborator Author

I took an old map https://github.com/user-attachments/files/17414626/old.cc.json and it failed

java.lang.NullPointerException: Input file contains null value for an attribute type! Please ensure the input is a valid cc.json file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation pr-analysis Issues that touch the analysis pr(oject). priority:urgent Should be addressed ASAP
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants