chore(notif-platform): Adds basic skeleton for notification service, fixes typing issues surrounding provider generics #93880
+126
−14
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
…fixes typing issues surrounding provider generics
github-actions
bot
added
the
Scope: Backend
GabeVillalobos
commented
Jun 18, 2025
Comment on lines
+40
to
+47
| def _send_notification( | ||
| cls, | ||
| *, | ||
| notification_content: EmailRenderable, | ||
| notification_type: NotificationType, | ||
| target: NotificationTarget, | ||
| thread_id: str | None = None, | ||
| ) -> None: ... |
There was a problem hiding this comment.
Need to add doc comments, but this should handle actually sending the notification to the provider.
Comment on lines
+8
to
+26
| @staticmethod | ||
| def notify_target( | ||
| target: NotificationTarget, | ||
| template: Any, | ||
| data: Any, | ||
| thread_id: str | None = None, | ||
| ) -> None: | ||
| provider = provider_registry.get(target.provider_key) | ||
| provider.dispatch_notification( | ||
| target=target, template=template, data=data, thread_id=thread_id | ||
| ) | ||
|
|
||
| @staticmethod | ||
| def notify_many_targets( | ||
| targets: list[NotificationTarget], | ||
| template: Any, | ||
| data: Any, | ||
| thread_id: str | None = None, | ||
| ) -> None: ... |
There was a problem hiding this comment.
These should queue tasks per target, but this showcases how to address the typing issues we saw before.
Comment on lines
+35
to
+51
| def dispatch_notification( | ||
| cls, | ||
| *, | ||
| target: NotificationTarget, | ||
| template: Any, | ||
| data: Any, | ||
| thread_id: str | None = None, | ||
| ) -> None: | ||
| renderer = cls.get_renderer(notification_type=template.notification_type) | ||
| notification_content = renderer.render(data=data, template=template) | ||
| cls._send_notification( | ||
| notification_content=notification_content, | ||
| notification_type=template.notification_type, | ||
| target=target, | ||
| thread_id=thread_id, | ||
| ) | ||
|
|
There was a problem hiding this comment.
This allows us to sidestep the generic type ambiguity issues we saw before, since we can guarantee the RenderableT typing here via the cls type.
Comment on lines
+30
to
+31
| default_renderer: NotificationRenderer[RenderableT] | ||
| target_class: type[NotificationTarget] |
There was a problem hiding this comment.
Added future annotations to alleviate this, though I'm not sure we needed quoted forward declarations for these before?
Codecov ReportAttention: Patch coverage is ✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## master #93880 +/- ##
===========================================
+ Coverage 64.03% 88.03% +24.00%
===========================================
Files 10333 10337 +4
Lines 596791 596930 +139
Branches 23196 23196
===========================================
+ Hits 382134 525534 +143400
+ Misses 214198 70937 -143261
Partials 459 459 |
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.
WIP: Adds a shell for notification service, modifies typing for providers to account for generics, and type ambiguity when using them.