feat(notification-services-controller): add support for notifications categories - #9984
Draft
zelkibuilds wants to merge 4 commits into
Draft
feat(notification-services-controller): add support for notifications categories#9984zelkibuilds wants to merge 4 commits into
zelkibuilds wants to merge 4 commits into
Conversation
zelkibuilds
added
the
team-notifications
Contributor
Author
|
@metamaskbot publish-previews |
Contributor
|
Preview builds have been published. Learn how to use preview builds in other projects. Expand for full list of packages and versions. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Current state: The notifications API exposes
GET /api/v4/notifications/categories, a server-driven manifest describing the notification-settings taxonomy (category IDs, platform visibility, and AUS preference keys).NotificationServicesControllerhad no way to consume it. The internalmakeApiCallhelper only supported authenticatedPOST/DELETErequests with a positional body argument, making unauthenticatedGETcalls impossible to express without a workaround.Solution:
Reworked
makeApiCallfrom positional args to an options object using a discriminated union:GET/DELETEaccept an optionalbearerTokenand no body;POSTrequires abodyand accepts an optionalbearerToken. This makes missing-body/unexpected-body misuse a compile error and enables unauthenticatedGETcalls.makeApiCallis package-internal (not re-exported from the package index), so this is not a breaking change to consumers.Added
getNotificationsCategories()service function that calls the new unauthenticatedGET /api/v4/notifications/categoriesendpoint. Returns[]on HTTP or transport errors.Added two new state fields to
NotificationServicesControllerState:metamaskNotificationsCategories: NotificationsCategory[]— persisted, included in state logs/debug snapshots, used in UI.isFetchingMetamaskNotificationsCategories: boolean— UI-only loading flag, not persisted; reset infinallyso it cannot get stuck.Added public
fetchMetamaskNotificationsCategories()controller method that fetches the categories manifest, stores it in state, and returns it. Exposed through the messenger asNotificationServicesController:fetchMetamaskNotificationsCategories(added toMESSENGER_EXPOSED_METHODS).Updated the notification-api schema types (
schema.ts) to include the/api/v4/notifications/categoriesendpoint,NotificationCategory, andNotificationsCategoryschemas. Updated mocks accordingly.Replaced the deprecated
ControllerStateChangeEventimport withControllerStateChangedEvent; the exported type aliasNotificationServicesControllerStateChangeEventis unchanged, so there is no breaking change for consumers.References
Checklist