Skip to content

fix(mfe-slots): migrate mitxonline right-sidebar (AskTIM + feedback) slot to canonical right_sidebar.v1 id - #153

Merged
zamanafzal merged 2 commits into
mainfrom
zafzal/11820-migrate-right-sidebar-slot-id
Aug 12, 2026
Merged

fix(mfe-slots): migrate mitxonline right-sidebar (AskTIM + feedback) slot to canonical right_sidebar.v1 id#153
zamanafzal merged 2 commits into
mainfrom
zafzal/11820-migrate-right-sidebar-slot-id

Conversation

@zamanafzal

@zamanafzal zamanafzal commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

What are the relevant tickets?

https://github.com/mitodl/hq/issues/11820

Description (What does it do?)

Migrates the mitxonline Learning MFE right-sidebar override (AskTIM + inline feedback drawer, hosted by SidebarAIDrawerCoordinator) off the deprecated slot ID onto the canonical one, in deployments/mit-ol/mfe_slot_config/legacy/learning-mfe-config.env.jsx. One-line key change; the block contents are byte-for-byte unchanged.

- 'org.openedx.frontend.learning.notifications_discussions_sidebar.v1': {
+ 'org.openedx.frontend.learning.right_sidebar.v1': {

How can this be tested?

Prerequisite — AskTIM (+ feedback) must already render locally in the right sidebar. If it isn't set up, follow the "How can this be tested?" section of mitodl/ol-infrastructure#4232 to get the AI drawer working locally: mount frontend-app-learning, enable ol_openedx_chat, build/stage the smoot-design bundle into public/static/smoot-design/, copy the slot files to the repo root, wire env.config.jsx, and set ENABLE_AI_DRAWER_SLOT=true in .env.development.

Then verify this migration using the new slot ID:

  1. In your local env.config.jsx, apply this PR's one-line change:
    - 'org.openedx.frontend.learning.notifications_discussions_sidebar.v1': {
    + 'org.openedx.frontend.learning.right_sidebar.v1': {
  2. Restart npm run dev (the config is read at startup) and open a course unit.
  3. Confirm AskTIM and the inline feedback drawer still render in the right sidebar and open/close across next/previous unit navigation — identical behavior to before, now resolved via right_sidebar.v1.

Behavioral no-op today: upstream master's RightSidebarSlot still lists the old ID as a deprecated alias, so both IDs resolve to the same slot.

Additional Context

  • The old ID is a deprecated alias (ADR 0010), slated for removal "after one deprecation cycle." mitxonline builds frontend-app-learning from master, so once the alias is dropped the old key matches no slot and the sidebar (AskTIM + feedback) silently disappears with no build error. Switching now future-proofs us.

…ebar.v1 id

The Learning MFE right-sidebar slot was renamed upstream to
`org.openedx.frontend.learning.right_sidebar.v1`; the id we register our
AskTIM/feedback coordinator under,
`org.openedx.frontend.learning.notifications_discussions_sidebar.v1`, is retained
only as a deprecated alias marked for removal after one deprecation cycle
(ADR 0010).

mitxonline builds frontend-app-learning from `master` in CI/QA/Prod, so when the
alias is removed upstream it reaches Prod on the next MFE rebuild — the config key
would match no slot, the framework would fall back to the default <Sidebar />, and
the AskTIM + inline feedback column would silently disappear with no build error.

During the deprecation window both ids resolve to the same RightSidebarSlot, so
switching to the canonical id is a behavioral no-op today and future-proofs us
against the alias removal. The block is mitxonline-gated; other deployments are
unaffected.

Refs mitodl/hq#11820
@zamanafzal zamanafzal changed the title fix(mfe-slots): migrate mitxonline AskTIM slot to canonical right_sidebar.v1 id fix(mfe-slots): migrate mitxonline right-sidebar (AskTIM + feedback) slot to canonical right_sidebar.v1 id Aug 11, 2026
@zamanafzal zamanafzal added the Needs Review An open Pull Request that is ready for review label Aug 11, 2026
@zamanafzal
zamanafzal marked this pull request as ready for review August 11, 2026 08:25
Copilot AI balanced review requested due to automatic review settings August 11, 2026 08:25

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Migrates the MITx Online Learning MFE sidebar integration to the canonical slot ID.

Changes:

  • Replaces the deprecated sidebar slot alias with right_sidebar.v1.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

… RightSidebarSlot

Follow-up to the slot-ID migration: the legacy slot catalog row still documented
the integration under the deprecated `notifications_discussions_sidebar.v1` key
and linked to the old `NotificationsDiscussionsSidebarSlot` path, which would
direct future maintenance back to the alias.

Point it at the canonical `right_sidebar.v1` / `RightSidebarSlot`. Also repoint
the link from the mitodl fork (whose master still only has the old slot, and
which mitxonline does not build from) to the openedx upstream repo, where the
renamed slot exists and which is the actual build source — matching every other
row in this catalog.

Refs mitodl/hq#11820
@asadali145 asadali145 self-assigned this Aug 12, 2026

@asadali145 asadali145 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I am not testing changes as it looks quite straight forward.

@asadali145 asadali145 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I am not testing changes as it looks quite straight forward.

@asadali145 asadali145 added waiting on author and removed Needs Review An open Pull Request that is ready for review labels Aug 12, 2026
@zamanafzal
zamanafzal merged commit 730b2c1 into main Aug 12, 2026
12 checks passed
@zamanafzal
zamanafzal deleted the zafzal/11820-migrate-right-sidebar-slot-id branch August 12, 2026 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants