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

Ensure modifying project endpoints are transactional #4194

Merged
merged 1 commit into from
Sep 30, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Sep 30, 2024

Description

Ensures modifying project endpoints are transactional.

The /api/v1/project endpoints used to modify Project resources have historically not been transactional, potentially causing inconsistencies or too frequent commits (since every object modification implicitly creates a transaction behind the scenes).

Wrap code in runInTransaction or callInTransaction to ensure the desired transactional behavior.

Addressed Issue

N/A

Additional Details

N/A

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

The `/api/v1/project` endpoints used to modify `Project` resources have historically not been transactional, potentially causing inconsistencies or too frequent commits (since every object modification implicitly creates a transaction behind the scenes).

Wrap code in `runInTransaction` or `callInTransaction` to ensure the desired transactional behavior.

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro added the enhancement New feature or request label Sep 30, 2024
@nscuro nscuro added this to the 4.12 milestone Sep 30, 2024
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
Report missing for 6e31fd71 78.01% (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (6e31fd7) Report Missing Report Missing Report Missing
Head commit (a69bb04) 22415 17718 79.05%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#4194) 191 149 78.01%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

Footnotes

  1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct.

@nscuro nscuro merged commit 6ac3e7a into DependencyTrack:master Sep 30, 2024
10 checks passed
@nscuro nscuro deleted the projectresource-trx branch September 30, 2024 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant