LJ-386 Fix privacy request receipt notifications #5777
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
|
Looks good 👍 |
galvana
approved these changes
Feb 19, 2025
There was a problem hiding this comment.
Thanks for the quick turnaround! I just made one small commit to fix the change log so we could run the tests. I made a recommendation so we'd be able to catch other instances where we're calling the dispatch_message with incorrect params. Don't let that hold this up though.
Comment on lines
+68
to
+73
| db=db, | ||
| action_type=schema.action_type, | ||
| to_identity=Identity.model_validate(to_identity), | ||
| service_type=service_type, | ||
| message_body_params=schema.body_params, | ||
| property_id=property_id, |
There was a problem hiding this comment.
While we're here, let's add an * to dispatch_message so the optional arguments are required to be passed in as keyword args
def dispatch_message(
db: Session,
action_type: MessagingActionType,
*,
to_identity: Optional[Identity],
service_type: Optional[str],
message_body_params: Optional[
Union[
AccessRequestCompleteBodyParams,
ConsentEmailFulfillmentBodyParams,
SubjectIdentityVerificationBodyParams,
RequestReceiptBodyParams,
RequestReviewDenyBodyParams,
ErasureRequestBodyParams,
UserInviteBodyParams,
ErrorNotificationBodyParams,
]
] = None,
subject_override: Optional[str] = None,
property_id: Optional[str] = None,
) -> None:
Comment on lines
+220
to
+223
| if valid_body_params and not isinstance(self.body_params, valid_body_params): | ||
| raise ValueError( | ||
| f"Invalid body params for action type {self.action_type}. Expected {valid_body_params.__name__}, got {type(self.body_params).__name__}" | ||
| ) |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #5777 +/- ##
==========================================
+ Coverage 84.57% 86.81% +2.24%
==========================================
Files 394 394
Lines 24402 24412 +10
Branches 2637 2638 +1
==========================================
+ Hits 20638 21194 +556
+ Misses 3195 2649 -546
Partials 569 569 ☔ View full report in Codecov by Sentry. |
fides
|
||||||||||||||||||||||||||||||
| Project |
fides
|
| Branch Review |
main
|
| Run status |
|
| Run duration | 00m 50s |
| Commit |
|
| Committer | erosselli |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
5
|
Upgrade your plan to view test results. | |
| View all changes introduced in this branch ↗︎ | |
erosselli
added a commit
that referenced
this pull request
Feb 19, 2025
Co-authored-by: Adrian Galvan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes LJ-386
Description Of Changes
Fixed cryptic error when processing a DSR if
send_request_receipt_notificationwas set totrue. The cause of the error was usingSetin the type ofRequestReceiptBodyParams, becauseSetis not JSON serializable.Code Changes
src/fides/api/schemas/messaging/messaging.py:RequestReceiptBodyParamsto useListinstead ofSet. This is what fixes the issueFidesopsMessageclass to check the provided params match theaction_typeRequestReviewDenyBodyParamsso it doesn't allow extra params. That way other types don't get mistakenly assigned to this typesrc/fides/api/service/messaging/message_dispatch_service.py-> drive-by change, changeddispatch_messageto be called with kwargs cause we were puttingproperty_idin the wrong placeSteps to Confirm
send_request_receipt_notification = trueunder[notifications]Pre-Merge Checklist
CHANGELOG.mdupdatedmaindowngrade()migration is correct and works