[DEPR]: frontend-plugin-notifications

Open
#145 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Domain
frontend, release

Research direction

This is a tracking ticket for a removal that cannot start until Willow ships and Xylon opens, so there is nothing to patch today. Read openedx/public-engineering#580 for the shared schedule, then confirm the three dependents named here: the @edx/frontend-component-header package.json entry that keeps @edx/frontend-plugin-notifications alive, the 2.x branch of this repo, and tutor-contrib-platform-notifications. Done means all three are retired together with the legacy header in Xylon, not before.

Written by the indexing model from the issue text.

Description

depr
RFC Start Date

N/A -- Already Accepted

Target Plan Accepted Date

N/A -- Already Accepted

Target Transition Unblocked Date

Already unblocked: the frontend-base app landed in main on 2026-07-09 (#107).

Earliest Breaking Changes Unblocked Date

After Willow is released. The breaking change is the removal of the legacy plugin and its 2.x branch, together with the legacy header, in Xylon.

Rationale

The notifications tray has been converted from a legacy frontend plugin into a frontend-base app (#107), as tracked in openedx/frontend-base#228. This ticket is part of openedx/public-engineering#580, which explains the schedule, why this is a Fast Track DEPR, and everything the conversions have in common.

Description

TLDR: the legacy notifications plugin, @edx/frontend-plugin-notifications, is deprecated in Willow and will be removed in Xylon. Until then it lives on in the 2.x branch, and whatever works there keeps working there. Its replacement is a different package, @openedx/frontend-app-notifications, built from main.

This one isn't a regular MFE conversion, so a few things in openedx/public-engineering#580 read differently here. There is no legacy-mfe branch: 2.x plays that part (see #127). And the plugin can't go away before the legacy header does, because @edx/frontend-component-header depends on it. In other words: the plugin is removed in Xylon together with the legacy header and the legacy MFEs, not before.

How it was consumed, and how it is now

There were three ways to get the legacy tray. Since v8.2.0, the legacy header renders it by default, so every legacy MFE that uses the header shows the bell with no setup. Before that, the Tutor plugin tutor-contrib-platform-notifications installed the package into every MFE image and added the tray to three header slots. Or you could do it by hand in an MFE's env.config.jsx, as the legacy README describes.

All three keep working for legacy MFEs until Xylon.

On a frontend-base site, notifications is an app like any other: install @openedx/frontend-app-notifications and list notificationsApp in the apps of your site.config. The shell header knows nothing about notifications, so if the app isn't listed, there's no bell. On Tutor, the app is one of tutor-mfe's FRONTEND_APPS and is enabled by default.

The new package needs frontend-base and can't be used inside a legacy MFE. And since it's a new package rather than a new major version of the old one, bumping @edx/frontend-plugin-notifications won't get you there.

Exports

The legacy package exported NotificationsTray (also as the default export), Notifications, useAppNotifications and useNotification. The new one exports only notificationsApp, with no default export, and deep imports are blocked by the package's exports map.

This is final: the four are not coming back. If you embedded the tray or its hooks in a component of your own, there's no replacement for that. The way to move, hide or replace the bell is a slot operation in site.config.

Plugin slots

The plugin never defined slots of its own. What changed is where it plugs in. These are the legacy header slots it used:

Legacy header slot How the tray got there
org.openedx.frontend.layout.header_notifications_tray.v1 The slot's default content, from header v8.2.0 on
org.openedx.frontend.layout.header_desktop_secondary_menu.v1 Inserted by tutor-contrib-platform-notifications
org.openedx.frontend.layout.header_learning_help.v1 Inserted by tutor-contrib-platform-notifications
org.openedx.frontend.layout.studio_header_search_button_slot.v1 Inserted by tutor-contrib-platform-notifications

On a frontend-base site, none of them apply. The app inserts the bell into the shell header by itself, for logged-in users, as two widgets:

Shell header slot Widget
org.openedx.frontend.slot.header.desktopRight.v1 org.openedx.frontend.notifications.widget.notificationsBell.desktop.v1
org.openedx.frontend.slot.header.mobileRight.v1 org.openedx.frontend.notifications.widget.notificationsBell.mobile.v1

There's only one header in frontend-base, so this covers course and authoring pages too.

If you hid or replaced the tray through header_notifications_tray.v1, do the same to those two widgets from site.config. The legacy slot IDs belong to the header, and their mapping is in openedx/public-engineering#580.

Configuration

The legacy plugin read two keys from its host MFE, and the new app has no configuration of its own.

LMS_BASE_URL is now lmsBaseUrl in site.config.

ACCOUNT_SETTINGS_URL, which the gear icon linked to, is replaced by the org.openedx.frontend.role.account route role. The role is required: something has to provide it, either the Account app in the same site or an externalRoutes entry. tutor-mfe takes care of this for you.

One visible difference: when the Account app is part of the same site, the gear icon opens it in the same tab. It used to always open a new one.

Nothing else was dropped: the plugin never had a Redux store, never talked to third-party services, and the app calls the same backend endpoints as before.

How do I transition?

On Tutor, there's nothing to do for the bell itself: Willow enables the new app by default, and the legacy MFEs that remain get the legacy tray from their header, as long as they're on @edx/frontend-component-header 8.2.0 or later. Learning, Discussions, ORA Grading and Authoring are.

tutor-contrib-platform-notifications is being retired, and you can simply remove it. Nothing it did needs a new home. The waffle flags it created no longer exist, since notifications are on by default as of Verawood. tutor-mfe now sets NOTIFICATIONS_DEFAULT_FROM_EMAIL. SHOW_EMAIL_CHANNEL has had no reader since Verawood. And SHOW_PUSH_CHANNEL is an Account app setting that's off by default, same as the plugin's default: if you had turned it on, set it in MFE_CONFIG yourself.

If you install the tray by hand, keep @edx/frontend-plugin-notifications for your legacy MFEs until Xylon, and add notificationsApp to your frontend-base site.

If you customized the tray's placement, redo it as site.config slot operations against the two widgets above, before Xylon.

Task List

Done: #107 (frontend-base), under openedx/frontend-base#228, and #127 (branch layout).

To do in Xylon: remove @edx/frontend-plugin-notifications along with the legacy header, and retire the 2.x branch and tutor-contrib-platform-notifications.

Dominant language
TypeScript
Stars
3
Forks
10
Avg merge
1m
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openedx/frontend-app-notifications

All issues in openedx/frontend-app-notifications

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.