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

chore: simplify follow-up attribute type #2551

Merged
merged 1 commit into from Jan 31, 2024

Conversation

mstykow
Copy link
Collaborator

@mstykow mstykow commented Jan 30, 2024

Summary of changes

  • convert follow-up from string enum to boolean since it only contains one value
  • remove unused criticality boolean calculated during deserialization

Context and reason for change

Reduce code complexity: "followUp" behaves like a boolean and is similar to other attributes like "wasPreferred".

How can the changes be tested

Check that the "needs follow-up" as part of the auditing options still works as expected.

- convert follow-up from string enum to boolean since it only contains one value
- remove unused boolean calculated during deserialization

Signed-off-by: Maxim Stykow <maxim.stykow@tngtech.com>
Copy link
Contributor

@meretp meretp left a comment

Choose a reason for hiding this comment

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

Looks good to me. It probably makes sense to also update the input file schema to use a boolean for followUp, do you know if we already have a ticket to do so?

@mstykow
Copy link
Collaborator Author

mstykow commented Jan 31, 2024

Looks good to me. It probably makes sense to also update the input file schema to use a boolean for followUp, do you know if we already have a ticket to do so?

Since this attribute is used by the pipeline generating the Opossum file, I cannot change the schema here without introducing a breaking change. Thus, I would prefer to keep this change in OpossumUI only.

@mstykow mstykow merged commit 45d2c29 into main Jan 31, 2024
5 checks passed
@mstykow mstykow deleted the chore-simplify-follow-up-attribute branch January 31, 2024 09:55
@meretp
Copy link
Contributor

meretp commented Jan 31, 2024

Since this attribute is used by the pipeline generating the Opossum file, I cannot change the schema here without introducing a breaking change. Thus, I would prefer to keep this change in OpossumUI only.

Yeah, sure, I actually had the pipeline in mind, we could update it everywhere. But as we would probably need to keep some of the code to be backwards compatible, this might not be worth it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants