feat: upgrade to Palm

With this new release, we make use of persistent bind-mounts to make it
much easier to work on MFE forks. In addition, adding new MFEs is no
longer done with `*_MFE_APP` settings, which was awkward, but with
appropriate plugins.

Close #111.

Additional changes:

- feat: Add support for the ORA Grading MFE: The MFE is accessible by
  instructors in ORA exercises that have explicit staff grading steps.
  The corresponding waffle flag is installed and enabled by default.

- feat: Add support for the Communications MFE: The MFE is usable by
  instructors to send bulk email to learners in a course. The feature
  itself (the ability to send bulk email) pre-dates this MFE, and must be
  enabled as usual for the "Email" tab to become visible in the Instructor
  Dashboard.  The difference is that with this change, the tab will
  include a link to the MFE by default.

- chore: upgrade node to v18

.gitlab-ci.yml

@@ -2,7 +2,7 @@ variables:
     TUTOR_PLUGIN: mfe
     TUTOR_IMAGES: mfe account-dev course-authoring-dev discussions-dev authn-dev gradebook-dev learning-dev profile-dev
     TUTOR_PYPI_PACKAGE: tutor-mfe
-    OPENEDX_RELEASE: olive
+    OPENEDX_RELEASE: palm
     GITHUB_REPO: overhangio/tutor-mfe
 
 include:

CHANGELOG.md

@@ -19,6 +19,14 @@ instructions, because git commits are used to generate release notes:
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-16.0.0'></a>
+## v16.0.0 (2023-06-14)
+
+- 💥[Feature] upgrade to Palm. With this new release, we make use of persistent bind-mounts to make it much easier to work on MFE forks. In addition, adding new MFEs is no longer done with `*_MFE_APP` settings, which was awkward, but with appropriate plugins. (by @regisb)
+    - Add support for the ORA Grading MFE: The MFE is accessible by instructors in ORA exercises that have explicit staff grading steps.  The corresponding waffle flag is installed and enabled by default. (by @arbrandes)
+    - Add support for the Communications MFE: The MFE is usable by instructors to send bulk email to learners in a course. The feature itself (the ability to send bulk email) pre-dates this MFE, and must be enabled as usual for the "Email" tab to become visible in the Instructor Dashboard.  The difference is that with this change, the tab will include a link to the MFE by default.
+    - upgrade node to v18
+
 <a id='changelog-15.0.7'></a>
 ## v15.0.7 (2023-05-26)
 

README.rst

@@ -5,13 +5,15 @@ This plugin makes it possible to easily add micro frontend (MFE) applications on
 
 In addition, this plugin comes with a few MFEs which are enabled by default:
 
+- `Authn <https://github.com/openedx/frontend-app-authn/>`__
 - `Account <https://github.com/openedx/frontend-app-account/>`__
+- `Communications <https://github.com/openedx/frontend-app-communications/>`__
+- `Course Authoring <https://github.com/openedx/frontend-app-course-authoring/>`__
+- `Discussions <https://github.com/openedx/frontend-app-discussions/>`__
 - `Gradebook <https://github.com/openedx/frontend-app-gradebook/>`__
 - `Learning <https://github.com/openedx/frontend-app-learning/>`__
+- `ORA Grading <https://github.com/openedx/frontend-app-ora-grading/>`__
 - `Profile <https://github.com/openedx/frontend-app-profile/>`__
-- `Course Authoring <https://github.com/openedx/frontend-app-course-authoring/>`__
-- `Discussions <https://github.com/openedx/frontend-app-discussions/>`__
-- `Authn <https://github.com/openedx/frontend-app-authn/>`__
 
 Instructions for using each of these MFEs are given below.
 
@@ -32,10 +34,17 @@ To enable this plugin, run::
 
 When running the plugin in production, it is recommended that you set up a catch-all CNAME for subdomains at the DNS provider: see the `Configuring DNS Records <https://docs.tutor.overhang.io/install.html#configuring-dns-records>`__ section in the Tutor documentation for more details.  This way, the plugin will work out of the box with no additional configuration.  Which is to say, if your ``LMS_HOST`` is set to `myopenedx.com` the MFEs this plugin provides will be accessible under `apps.myopenedx.com` by default.
 
-To check what the current value of `MFE_HOST` is actually set to, run the following::
+To check what the current value of `MFE_HOST` is actually set to, run::
 
     tutor config printvalue MFE_HOST
 
+Authn
+~~~~~~~~~
+
+.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/authn.png
+    :alt: Authn MFE screenshot
+
+This is a micro-frontend application responsible for the login, registration and password reset functionality.
 
 Account
 ~~~~~~~
@@ -45,6 +54,30 @@ Account
 
 An MFE to manage account-specific information for every LMS user. Each user's account page is available at ``http(s)://{{ MFE_HOST }}/account``. For instance, when running locally: https://apps.local.overhang.io/account.
 
+Communications
+~~~~~~~~~~~~~~
+
+.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/communications.png
+    :alt: Communications MFE screenshot
+
+The Communications micro-frontend exposes an interface for course teams to communicate with learners.  It achieves this by allowing instructors to send out emails in bulk, either by scheduling them or on demand.
+
+Course Authoring
+~~~~~~~~~~~~~~~~
+
+.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/course-authoring.png
+    :alt: Course Authoring MFE screenshot
+
+This MFE is meant for course authors and maintainers. For a given course, it exposes a "Pages & Resources" menu in Studio where one can enable or disable a variety of features, including, for example, the Wiki and Discussions.  Optionally, it allows authors to replace the legacy HTML, Video, and Problem authoring tools with experimental React-based versions, as well as exposing a new proctoring interface that can be enabled if the `edx-exams <https://github.com/edx/edx-exams>`_ service is available.
+
+Discussions
+~~~~~~~~~~~
+
+.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/discussions.png
+    :alt: Discussions MFE screenshot
+
+The Discussions MFE updates the previous discussions UI with a new look and better features.
+
 Gradebook
 ~~~~~~~~~
 
@@ -61,6 +94,14 @@ Learning
 
 The Learning MFE replaces the former courseware, which is the core part of the LMS where students follow courses.
 
+ORA Grading
+~~~~~~~~~~~
+
+.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/ora-grading.png
+    :alt: ORA Grading MFE screenshot
+
+When enabled, Open Response Assesments ("ORA") that have a staff grading step will link to this new MFE, either when clicking "Grade Available Responses" from the exercise itself, or via a link in the Instructor Dashboard.  It is meant to streamline the grading process with better previews of submitted content.
+
 Profile
 ~~~~~~~~~
 
@@ -69,62 +110,41 @@ Profile
 
 Edit and display user-specific profile information. The profile page of every user is visible at ``http(s)://{{ MFE_HOST }}/profile/u/{{ username }}``. For instance, when running locally, the profile page of the "admin" user is: http://apps.local.overhang.io/profile/u/admin.
 
-Course Authoring
-~~~~~~~~~~~~~~~~
-
-.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/course-authoring.png
-    :alt: Course Authoring MFE screenshot
-
-This MFE is meant for course authors and maintainers. For a given course, it exposes a "Pages & Resources" menu in Studio where one can enable or disable a variety of features, including, for example, the Wiki and Discussions.  Optionally, it allows authors to replace the legacy HTML, Video, and Problem authoring tools with experimental React-based versions, as well as exposing a new proctoring interface that can be enabled if the `edx-exams <https://github.com/edx/edx-exams>`_ service is available.
-
-Discussions
-~~~~~~~~~~~
-
-.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/discussions.png
-    :alt: Discussions MFE screenshot
-
-The Discussions MFE updates the previous discussions UI with a new look and better features.
-
-Authn
-~~~~~~~~~
-
-.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/authn.png
-    :alt: Authn MFE screenshot
-
-This is a micro-frontend application responsible for the login, registration and password reset functionality.
 
 MFE management
 --------------
 
 Adding new MFEs
 ~~~~~~~~~~~~~~~
 
-Other Tutor plugin developers can take advantage of this plugin to deploy their own MFEs. To declare a new MFE, a new configuration setting should be created with the "_MFE_APP" suffix. This configuration setting should include the name, git repository (and optionally: git branch) and development port. For example::
+.. warning:: As of Tutor v16 (Palm release) it is no longer possible to add new MFEs by creating ``*_MFE_APP`` settings. Instead, users must implement the approach described here.
+
+Other MFE developers can take advantage of this plugin to deploy their own MFEs. To declare a new MFE, create a Tutor plugin and add your MFE configuration to the ``tutormfe.hooks.MFE_APPS`` filter. This configuration should include the name, git repository (and optionally: git branch) and development port. For example::
 
-    config = {
-        "defaults": {
-            "MYMFE_MFE_APP": {
-                "name": "mymfe",
-                "repository": "https://github.com/myorg/mymfe",
-                "port": 2001,
-                "version": "me/my-custom-branch", # optional
-            }
+    from tutormfe.hooks import MFE_APPS
+
+    @MFE_APPS.add()
+    def _add_my_mfe(mfes):
+        mfes["mymfe"] = {
+            "repository": "https://github.com/myorg/mymfe",
+            "port": 2001,
+            "version": "me/my-custom-branch", # optional, will default to the Open edX current tag.
         }
-    }
+        return mfes
 
-The MFE assets will then be bundled in the "mfe" Docker image whenever it is rebuilt with ``tutor images build mfe``. Assets will be served at ``http(s)://{{ MFE_HOST }}/{{ MYMFE_MFE_APP["name"] }}``. Developers are free to add extra template patches to their plugins, as usual: for instance LMS setting patches to make sure that the LMS correctly connects to the MFEs.
+The MFE assets will then be bundled in the "mfe" Docker image whenever it is rebuilt with ``tutor images build mfe``. Assets will be served at ``http(s)://{{ MFE_HOST }}/mymfe``. Developers are free to add extra template patches to their plugins, as usual: for instance LMS setting patches to make sure that the LMS correctly connects to the MFEs.
 
 Disabling individual MFEs
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To disable an existing MFE, set its corresponding configuration setting to "null". For instance, to disable the MFEs that ship with this plugin::
+To disable an existing MFE, remove the corresponding entry from the ``MFE_APPS`` filter. For instance, to disable some of the MFEs that ship with this plugin::
 
-    tutor config save --set MFE_ACCOUNT_MFE_APP=null
-    tutor config save --set MFE_GRADEBOOK_MFE_APP=null
-    tutor config save --set MFE_PROFILE_MFE_APP=null
-    tutor config save --set MFE_COURSE_AUTHORING_MFE_APP=null
-    tutor config save --set MFE_DISCUSSIONS_MFE_APP=null
-    tutor config save --set MFE_AUTHN_MFE_APP=null
+
+    @MFE_APPS.add()
+    def _remove_some_my_mfe(mfes):
+        mfes.pop("account")
+        mfes.pop("profile")
+        ...
 
 Adding custom translations to your MFEs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -245,31 +265,16 @@ Then, access http://apps.local.overhang.io:1995/profile/u/YOURUSERNAME
 
 You can also bind-mount your own fork of an MFE. For example::
 
-    cd /path/to/frontend-app-profile
-    npm install  # Ensure NPM requirements are installed into your fork.
-    tutor dev start --mount=. profile
+    tutor config save --append MOUNTS=/path/to/frontend-app-profile
+    tutor dev launch
 
-The changes you make to your fork will be automatically picked up and hot-reloaded by your development server.
+With this change, the "profile-dev" image will be automatically re-built during ``launch``. Your host repository will then be bind-mounted at runtime in the "profile" container. This means that changes you make to the host repository will be automatically picked up and hot-reloaded by your development server.
 
 This works for custom MFEs, as well. For example, if you added your own MFE named frontend-app-myapp, then you can bind-mount it like so::
 
-    cd /path/to/frontend-app-myapp
-    npm install
-    tutor dev start --mount=. myapp
-
-However, if you try to bind-mount an unknown MFE, you will see a Docker Compose error such as::
+    tutor config save --append MOUNTS=/path/to/frontend-app-myapp
 
-  ERROR: The Compose file is invalid because:
-  Service myapp has neither an image nor a build context specified. At least one must be provided.
-
-Please note that bind-mounting a fork is only available for development (``tutor dev ...``), since production MFEs are compiled and served out of a single container. If you want to use a fork of an MFE in production, then you will need to set the repository URL in ``$(tutor config printroot)/config.yml``::
-
-    MFE_PROFILE_MFE_APP
-        name: profile
-        repository: "https://github.com/YOUR_FORK_ORGANIZATION/frontend-app-profile"
-        port: 1995
-
-and then rebuild the MFE container image with ``tutor images build mfe``.
+Similarly, in production, the "mfe" Docker image will be rebuilt automatically during ``tutor local launch``.
 
 Uninstall
 ---------
@@ -298,6 +303,9 @@ You will also have to manually remove a few settings::
     tutor local run lms ./manage.py lms waffle_delete --flags discussions.enable_reported_content_email_notifications
     tutor local run lms ./manage.py lms waffle_delete --flags discussions.enable_learners_stats
 
+    # MFE ora-grading
+    tutor local run lms ./manage.py lms waffle_delete --flags openresponseassessment.enhanced_staff_grader
+
 Finally, restart the platform with::
 
     tutor local launch

setup.py

@@ -40,7 +40,7 @@ def load_about():
     packages=find_packages(exclude=["tests*"]),
     include_package_data=True,
     python_requires=">=3.5",
-    install_requires=["tutor>=15.0.0,<16.0.0"],
+    install_requires=["tutor>=16.0.0,<17.0.0"],
     entry_points={"tutor.plugin.v1": ["mfe = tutormfe.plugin"]},
     classifiers=[
         "Development Status :: 3 - Alpha",

tutormfe/__about__.py

@@ -1,9 +1,9 @@
-__version__ = "15.0.7"
+__version__ = "16.0.0"
 __package_version__ = __version__
 
 
 # Handle version suffix for nightly, just like tutor core.
-__version_suffix__ = "nightly"
+__version_suffix__ = ""
 
 if __version_suffix__:
     __version__ += "-" + __version_suffix__

tutormfe/hooks.py

@@ -0,0 +1,14 @@
+"""
+These hooks are stored in a separate module. If they were included in plugin.py, then
+the tutor-mfe hooks would be created in the context of some other plugin that imports
+them.
+"""
+from __future__ import annotations
+import typing as t
+
+from tutor.core.hooks import Filter
+
+
+MFE_ATTRS_TYPE = t.Dict[t.Literal["repository", "port"], t.Union["str", int]]
+
+MFE_APPS: Filter[dict[str, MFE_ATTRS_TYPE], []] = Filter()

tutormfe/patches/local-docker-compose-dev-services

@@ -1,13 +1,16 @@
 # MFE apps
-{% for app in iter_values_named(suffix="MFE_APP") %}
-{{ app["name"] }}:
-    image: "{{ DOCKER_REGISTRY }}overhangio/openedx-{{ app["name"] }}-dev:{{ MFE_VERSION }}"
+{% for app_name, app in iter_mfes() %}
+{{ app_name }}:
+    image: "{{ DOCKER_REGISTRY }}overhangio/openedx-{{ app_name }}-dev:{{ MFE_VERSION }}"
     ports:
         - "{{ app["port"] }}:{{ app["port"] }}"
     stdin_open: true
     tty: true
     volumes:
         - ../plugins/mfe/apps/mfe/webpack.dev-tutor.config.js:/openedx/app/webpack.dev-tutor.config.js:ro
+        {%- for mount in iter_mounts(MOUNTS, app_name) %}
+        - {{ mount }}
+        {%- endfor %}
     restart: unless-stopped
     depends_on:
         - lms

tutormfe/patches/openedx-cms-development-settings

@@ -1,6 +1,9 @@
-{% if MFE_COURSE_AUTHORING_MFE_APP %}
-COURSE_AUTHORING_MICROFRONTEND_URL = "http://{{ MFE_HOST }}:{{ MFE_COURSE_AUTHORING_MFE_APP["port"] }}/{{ MFE_COURSE_AUTHORING_MFE_APP["name"] }}"
-CORS_ORIGIN_WHITELIST.append("http://{{ MFE_HOST }}:{{ MFE_COURSE_AUTHORING_MFE_APP["port"] }}")
-LOGIN_REDIRECT_WHITELIST.append("{{ MFE_HOST }}:{{ MFE_COURSE_AUTHORING_MFE_APP["port"] }}")
-CSRF_TRUSTED_ORIGINS.append("{{ MFE_HOST }}:{{ MFE_COURSE_AUTHORING_MFE_APP["port"] }}")
+# MFE-specific settings
+{% for app_name, app in iter_mfes() %}
+{% if app_name == "course-authoring" %}
+COURSE_AUTHORING_MICROFRONTEND_URL = "http://{{ MFE_HOST }}:{{ app["port"] }}/course-authoring"
+CORS_ORIGIN_WHITELIST.append("http://{{ MFE_HOST }}:{{ app["port"] }}")
+LOGIN_REDIRECT_WHITELIST.append("{{ MFE_HOST }}:{{ app["port"] }}")
+CSRF_TRUSTED_ORIGINS.append("{{ MFE_HOST }}:{{ app["port"] }}")
 {% endif %}
+{% endfor %}

tutormfe/patches/openedx-cms-production-settings

@@ -1,6 +1,9 @@
-{% if MFE_COURSE_AUTHORING_MFE_APP %}
-COURSE_AUTHORING_MICROFRONTEND_URL = "{% if ENABLE_HTTPS %}https://{% else %}http://{% endif %}{{ MFE_HOST }}/{{ MFE_COURSE_AUTHORING_MFE_APP["name"] }}"
+# MFE-specific settings
+{% for app_name, app in iter_mfes() %}
+{% if app_name == "course-authoring" %}
+COURSE_AUTHORING_MICROFRONTEND_URL = "{% if ENABLE_HTTPS %}https://{% else %}http://{% endif %}{{ MFE_HOST }}/course-authoring"
 {% endif %}
+{% endfor %}
 
 LOGIN_REDIRECT_WHITELIST.append("{{ MFE_HOST }}")
 CORS_ORIGIN_WHITELIST.append("{% if ENABLE_HTTPS %}https://{% else %}http://{% endif %}{{ MFE_HOST }}")

tutormfe/patches/openedx-lms-common-settings

@@ -3,7 +3,12 @@
 # the frontend. (5 minutes, hardcoded)
 ENABLE_MFE_CONFIG_API = True
 MFE_CONFIG_API_CACHE_TIMEOUT = 1
-{% if MFE_AUTHN_MFE_APP %}
+
+# MFE-specific settings
+{% for app_name, app in iter_mfes() %}
+{% if app_name == "authn" %}
 FEATURES['ENABLE_AUTHN_MICROFRONTEND'] = True
+{% elif app_name == "communications" %}
+FEATURES['ENABLE_NEW_BULK_EMAIL_EXPERIENCE'] = True
 {% endif %}
-
+{% endfor %}