Fix directDependencies, externalReferences, metadata missing from /api/v1/project/{uuid} response when not already cached
#4071
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…se when not already cached Since DependencyTrack#4049, the endpoint returns only properties that are part of the `ALL` fetch group. `Project#directDependencies` was missing from this fetch group, and thus was not returned by the API, **unless the project was previously created or updated**. The API ended up returning the `directDependencies` field after modification of the project, which happened because `directDependencies` was in the L2 cache at that point. Besides fixing the issue at hand, this change also extends the existing endpoint test to ensure that **all** fields are returned as expected. Signed-off-by: nscuro <[email protected]>
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesCodacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more Footnotes
|
nscuro
changed the title
directDependencies missing from /api/v1/project/{uuid} response when not already cacheddirectDependencies, externalReferences, metadata missing from /api/v1/project/{uuid} response when not already cached
2 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes
directDependencies,externalReferences, andmetadatamissing from/api/v1/project/{uuid}response when not already cached.Since #4049, the endpoint returns only properties that are part of the
ALLfetch group. The fields mentioned above were missing from this fetch group, and thus were not returned by the API, unless the project was previously created or updated.The API ended up returning the fields field after modification of the project, which happened because they were in the L2 cache at that point.
Besides fixing the issue at hand, this change also extends the existing endpoint test to ensure that all fields are returned as expected.
Addressed Issue
Fixes #4074
Additional Details
N/A
Checklist
This PR implements an enhancement, and I have provided tests to verify that it works as intendedThis PR introduces changes to the database model, and I have added corresponding update logicThis PR introduces new or alters existing behavior, and I have updated the documentation accordingly