[PM-26429] Add validation to policy data and metadata #6460
Conversation
This file contains hidden or 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
…policy data and metadata.
…lid data types in PolicyRequestModel and SavePolicyRequest.
…AndSerializePolicyData nullable
jrmccannon
reviewed
Oct 16, 2025
test/Api.IntegrationTest/AdminConsole/Controllers/PoliciesControllerTests.cs
Show resolved
Hide resolved
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #6460 +/- ##
==========================================
+ Coverage 51.99% 52.02% +0.02%
==========================================
Files 1876 1877 +1
Lines 82633 82651 +18
Branches 7316 7316
==========================================
+ Hits 42969 42997 +28
+ Misses 38008 37995 -13
- Partials 1656 1659 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
New Issues (3)Checkmarx found the following issues in this Pull Request
|
…ing of invalid data types in policy updates.
…ata and metadata based on policy type.
…stModel to utilize PolicyDataValidator for data validation and serialization, removing redundant methods and improving code clarity.
jrmccannon
reviewed
Oct 17, 2025
…d Metadata properties with empty dictionaries.
jrmccannon
reviewed
Oct 17, 2025
| /// <param name="policyType">The type of policy</param> | ||
| /// <returns>Serialized JSON string if data is valid, null if data is null or empty</returns> | ||
| /// <exception cref="BadRequestException">Thrown when data validation fails</exception> | ||
| public static string? ValidateAndSerialize(Dictionary<string, object>? data, PolicyType policyType) |
There was a problem hiding this comment.
You can remove the nullable and null check now.
| /// <param name="metadata">The policy metadata to validate</param> | ||
| /// <param name="policyType">The type of policy</param> | ||
| /// <returns>Deserialized metadata model, or EmptyMetadataModel if metadata is null, empty, or validation fails</returns> | ||
| public static IPolicyMetadataModel ValidateAndDeserializeMetadata(Dictionary<string, object>? metadata, PolicyType policyType) |
…validation methods
jrmccannon
previously approved these changes
Oct 17, 2025
…empty data and metadata, and remove null assignments in test cases for improved clarity.
…ic details in BadRequestException messages.
…st responses by checking for specific field names in the response content.
|
@jrmccannon, I have updated the error message to explicitly say which field had the wrong type. |
jrmccannon
approved these changes
Oct 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
🎟️ Tracking
https://bitwarden.atlassian.net/browse/PM-26429
📔 Objective
⏰ Reminders before review
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes