Skip to main content

ol-openedx-feedback

An Open edX plugin that adds a “Send feedback” megaphone to course blocks in the LMS via an XBlockAside. Clicking it opens the feedback drawer in the Learning MFE, which submits the learner’s feedback to the mit-learn service. This plugin renders the trigger and nothing else: no models, no REST API, nothing persisted in edx-platform.

The trigger renders only for authenticated learners — never in Studio author/preview mode, never for anonymous users. It sits right-aligned below the block, or docked beside the AskTIM button on blocks that have one.

Messages

The aside talks to its parent window (the Learning MFE) with window.parent.postMessage, always addressed to settings.LEARNING_MICROFRONTEND_URL and never to "*".

Sent on click, as ol-feedback::drawer-open:

  • payload.courseId — the course key

  • payload.blockUsageKey — the block’s usage key

  • payload.blockType — the XBlock category (e.g. video, problem)

  • payload.blockDisplayName — the Studio display_name. Recorded on the submission so the content team can find the component; the drawer doesn’t display it.

  • payload.visibleTitle — the title the learner can see on the page, or "" when this plugin can’t confirm there is one. This is the only name the drawer displays; see Visible titles.

  • viaKeyboard — true when the click came from the keyboard. The drawer renders cross-origin and so can’t use :focus-visible; it uses this to decide whether to highlight its heading.

Received from the MFE, both so keyboard focus can return to the megaphone (WCAG 2.4.3):

  • ol-feedback::drawer-closed — the drawer has closed; focus the trigger that opened it.

  • ol-feedback::focus-trigger — the drawer’s “return to block” link; focus the trigger but leave the drawer open.

Version Compatibility

For this plugin’s compatibility with Open edX, see the Open edX Release Compatibility table.

Installation

  1. Install the package into the LMS Python environment and restart the LMS:

    pip install ol-openedx-feedback

    The plugin registers itself through its entry points — the xblock_asides.v1 aside plus the lms.djangoapp app config — so INSTALLED_APPS needs no change. The trigger is learner-facing only, so the plugin is LMS-only and is not installed in Studio/CMS.

  2. Enable XBlock asides. No aside renders until they are switched on. In the LMS admin, open XBlock Asides Config (/admin/lms_xblock/xblockasidesconfig/), add an entry, and check Enabled. Keep the block types you want the trigger on out of Disabled blocks (space-separated; defaults to about course_info static_tab).

  3. Turn on the waffle flag. The trigger is gated per course by the ol_openedx_feedback.feedback_enabled course waffle flag, off by default. Enable it for the courses you’re rolling out to, or globally.

Configuration

Both settings below are read from ENV_TOKENS (e.g. in lms.yml) by the plugin’s settings.common hook and exposed as Django settings of the same name.

Excluded block types

The trigger renders on every block type except a set of structural containers. Override the set to exclude more types — for example html:

OL_OPENEDX_FEEDBACK_EXCLUDED_BLOCK_TYPES:
  - course
  - chapter
  - sequential
  - vertical
  - html

Unset, it defaults to course, chapter, sequential and vertical.

Text label

The trigger is icon-only by default. To render the “Feedback” text label beside the megaphone:

OL_OPENEDX_FEEDBACK_SHOW_LABEL: true

Visible titles

For most block types display_name is an authoring label that never appears on the page (“Wk3 intro copy - REVISED, do not reuse”), so showing it in the feedback drawer would confuse the learner. The plugin therefore keeps a curated map of the types that do render a title, and the field holding it — display_name for most, title for openassessment, block_name for survey. Types outside the map send an empty visibleTitle, which the drawer renders as generic block-type wording.

Two details:

  • A type whose title is author-toggleable (drag-and-drop-v2’s show_title) reports its title only when the toggle is on.

  • Keys are usage-key block types (category). The extracted xblocks-contrib variants register under _<name>_extracted entry points but keep the plain category, so they need no separate entry.

The map is not a setting. Each entry asserts that the block type draws that field on the learner’s page, and the value goes verbatim into the drawer’s question text — so a wrong entry leaks the author’s private note, which is the bug the map exists to prevent. Changing it means editing DEFAULT_VISIBLE_TITLE_FIELDS in constants.py and having the claim reviewed. Leaving a type out only costs generic wording.

Metadata

Release files for ol-openedx-feedback 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ol-openedx-feedback 0.3.2
File Size Uploaded Provenance Actions
ol_openedx_feedback-0.3.2.tar.gz 9.5 kB Without provenance Details for ol_openedx_feedback-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ol-openedx-feedback 0.3.2
File Interpreter ABI Platform Actions
ol_openedx_feedback-0.3.2-py3-none-any.whl Python 3 none any Details for ol_openedx_feedback-0.3.2-py3-none-any.whl

Total release size: 22.7 kB

Release files / ol_openedx_feedback-0.3.2.tar.gz

Download URL ol_openedx_feedback-0.3.2.tar.gz
Size 9.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0b584988a2d341aa5af9171b387c9583c18e426b7d53dcacf705de1b0a2e083b
BLAKE2b-256 checksum
How to use checksums
aa7ebf332179cc787145fcc7619155858335591d779cc8c09e8e8c6fb662ef88
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / ol_openedx_feedback-0.3.2-py3-none-any.whl

Download URL ol_openedx_feedback-0.3.2-py3-none-any.whl
Size 13.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9821011865e41dbe437f0ce23f25a04ff125be95bed362e54996cbc2a19f3644
BLAKE2b-256 checksum
How to use checksums
9a109e34186da2d814072c231840e54fac747b565edb069710019ae783c59694
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for ol-openedx-feedback 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page