feat: decouple push logic to be platform agnostic #5120
+448
−337
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
…form agnostic this controller was ties to web, and was not compatible for react-native. We now have moves the logic that touches firebase and browser built-ins to an isolated file, and expect platforms to inject this into the controller This breaks the controller and forces the platform to inject how push notifications should be received and clicked
reduces complexity that the platform needs to write.
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
Prithpal-Sooriya
commented
Jan 9, 2025
| @@ -67,6 +67,16 @@ | |||
| "default": "./dist/NotificationServicesPushController/index.cjs" | |||
| } | |||
| }, | |||
| "./push-services/web": { | |||
There was a problem hiding this comment.
exposing new subpath exports to differ between web and mobile specific helpers.
There was a problem hiding this comment.
This can be done iteratively. We have done web, since there was existing code that we refactored and gutted from this controller.
We will do Mobile after PoC'ing this and seeing if there is value from it.
There was a problem hiding this comment.
Also to note that these subpaths are fully isolated and not used anywhere, so they should be tree-shakeable for bundle splitting.
However specific modules for web/mobile might run into lavamoat issues... or maybe not... we'll see.
Prithpal-Sooriya
commented
Jan 9, 2025
| * determine the config used for push notification services | ||
| */ | ||
| platform: 'extension' | 'mobile'; | ||
| pushService: PushService; |
There was a problem hiding this comment.
The controller now must be initialised with this Push Service interface.
The /web/push-helpers can assist extension when injecting.
We will see if we can do the same for mobile.
Prithpal-Sooriya
commented
Jan 9, 2025
| NotificationServicesPushControllerMessenger, | ||
| } from '..'; | ||
|
|
||
| export const buildPushPlatformNotificationsControllerMessenger = |
There was a problem hiding this comment.
This mock was lifted out of a test file, and exported, so it can be reused in other tests.
Prithpal-Sooriya
commented
Jan 9, 2025
| import { | ||
| listenToPushNotificationsClicked, | ||
| listenToPushNotificationsReceived, | ||
| } from './push/push-web'; |
There was a problem hiding this comment.
In the initial design, we did a decent start at decoupling the webby parts from this controller (to make it agnostic). However the issue was we were directly importing and using the web module directly!
Prithpal-Sooriya
commented
Jan 9, 2025
Comment on lines
+187
to
+197
| export function createSubscribeToPushNotifications(props: { | ||
| onReceivedHandler: ( | ||
| notification: Types.INotification, | ||
| ) => void | Promise<void>; | ||
| onClickHandler: ( | ||
| e: NotificationEvent, | ||
| notification: Types.INotification, | ||
| ) => void; | ||
| messenger: NotificationServicesPushControllerMessenger; | ||
| }) { | ||
| return async function (env: PushNotificationEnv) { |
There was a problem hiding this comment.
This is a scary interface, but see tests on how to use it.
- This is a func that returns a func (curried function), mostly since we need the return function to have the same interface for web and mobile so we can correctly inject it.
- The
propswe expose is to add some extra customisability from the platform. E.g. when you receive a notification what icon or thing show we show; when you click a notification, where should this navigate you to.- It allows the platform to take control of showing/interacting, but the core can still control publishing events; and when to invoke the methods the platform provides.
There was a problem hiding this comment.
A lot of word vomit here, I'll record a video once this has been PoC'ed and ready for review.
…ouple-push-logic-to-be-platform-agnostic
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
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.
Explanation
Decouples web push notifications so that the controller is platform agnostic.
This controller was tied heavily to web, and was not compatible for mobile use (react-native). We have now isolated and moved the web specific code into a single file (
web/push-helpers.ts), and we expect the platforms to inject the push service interface into the controller (which allows platforms to controller how to display push notifications and click on push notifications).This is a large restructuring and is a breaking change.
References
Changelog
@metamask/notification-services-controllerPushServiceNotificationServicesPushControllerconfig property to inject aPushServiceinterface during controller creation.@metamask/notification-services-controller/push-services/webto help web platforms inject push-services into the push controller.Checklist