Merge pull request #207 from overhangio/redwood

Upgrade to redwood

Author: regisb

CHANGELOG.md

@@ -19,6 +19,13 @@ instructions, because git commits are used to generate release notes:
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-18.0.0'></a>
+## v18.0.0 (2024-06-19)
+
+- 💥[Feature] Upgrade to Redwood (by @hinakhadim)
+- [Feature] Enable `atlas pull` on all Micro-frontends. (by @omarithawi)
+- 💥[Feature] Use `ATLAS_OPTIONS` for `atlas pull`. This breaks the `i18n-merge.js` custom locale Tutor MFE feature in favor of [OEP-58](https://docs.openedx.org/en/latest/developers/concepts/oep58.html) `atlas pull` options. (by @omarithawi)
+
 <a id='changelog-17.0.1'></a>
 ## v17.0.1 (2024-03-26)
 

README.rst

@@ -130,6 +130,7 @@ Adding new MFEs
 
 - 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 below.
 - As of Tutor v17 (Quince release) you must make sure that the git URL of your MFE repository ends with ``.git``. Otherwise the plugin build will fail.
+- As of Tutor v18 (Redwood release) all MFEs must provide a ``make pull_translations`` command. Otherwise the plugin build will fail. Providing an empty command is enough to bypass this requirement. See the `Custom translations section <#mfe-custom-translations>`_ for more information.
 
 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 or tag) and development port. For example:
 
@@ -163,32 +164,26 @@ To disable an existing MFE, remove the corresponding entry from the ``MFE_APPS``
         mfes.pop("profile")
         return mfes
 
-Adding custom translations to your MFEs
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This plugin makes it possible to change existing and add new translation strings to MFEs. Here is how to do it:
-
-1. Identify the ID of the string you would like to translate. For instance, the ID of the "Account Information" string in the account MFE is "account.settings.section.account.information" (see `source <https://github.com/edx/frontend-app-account/blob/1444831833cad4746b9ed14618a499b425ccc907/src/account-settings/AccountSettingsPage.messages.jsx#L34>`__).
-2. Create a folder and i18n file corresponding to your MFE app and language in the Tutor root. This location of this file should be ``/path/to/tutor/env/plugins/mfe/build/mfe/i18n/<app name>/<language code>.json``. For instance, to add French ("fr") translation strings to the account MFE, run::
-
-    cd "$(tutor config printroot)/env/plugins/mfe/build/mfe/i18n/"
-    mkdir account
-    touch account/fr.json
+Using custom translations to your MFEs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-3. Add your entries to this file in JSON format, where the key is the string ID and the value is the actual string. For instance:
+.. _mfe-custom-translations:
 
-.. code-block::json
+During docker image build, this plugin runs ``make pull_translations`` for each Micro-frontend. This
+program is used in the ``Dockerfile`` to pull translations from the `openedx/openedx-translations repository <https://github.com/openedx/openedx-translations>`_ via `openedx-atlas <https://github.com/openedx/openedx-atlas>`_.
 
-    {
-      "account.settings.section.account.information": "Information du compte"
-    }
+The ``make pull_translations`` command passes the ``ATLAS_OPTIONS`` environment variable to the ``atlas pull`` command. This allows specifying a custom repository or branch to pull translations from.
 
-4. Rebuild the MFE image and restart the MFE with::
+Translations in the MFE plugin as well as other Tutor plugins can be customized with the following configuration 
+variables:
 
-    tutor images build mfe
-    tutor local start -d
+- ``ATLAS_REVISION`` (default: ``"main"`` on nightly and ``"{{ OPENEDX_COMMON_VERSION }}"`` if a named release is used)
+- ``ATLAS_REPOSITORY`` (default: ``"openedx/openedx-translations"``).
+- ``ATLAS_OPTIONS`` (default: ``""``) Pass additional arguments to ``atlas pull``. Refer to the `atlas documentations <https://github.com/openedx/openedx-atlas>`_ for more information.
 
-Your custom translation strings should now appear in your app.
+The
+`Getting and customizing Translations <https://docs.tutor.edly.io/configuration.html#getting-and-customizing-translations>`_
+section in the Tutor configuration documentation explains how to do this.
 
 Customising MFEs
 ~~~~~~~~~~~~~~~~

setup.py

@@ -40,8 +40,8 @@ def load_about():
     packages=find_packages(exclude=["tests*"]),
     include_package_data=True,
     python_requires=">=3.8",
-    install_requires=["tutor>=17.0.0,<18.0.0"],
-    extras_require={"dev": ["tutor[dev]>=17.0.0,<18.0.0"]},
+    install_requires=["tutor>=18.0.0,<19.0.0"],
+    extras_require={"dev": ["tutor[dev]>=18.0.0,<19.0.0"]},
     entry_points={"tutor.plugin.v1": ["mfe = tutormfe.plugin"]},
     classifiers=[
         "Development Status :: 5 - Production/Stable",

tutormfe/__about__.py

@@ -1 +1 @@
-__version__ = "17.0.1"
+__version__ = "18.0.0"

tutormfe/hooks.py

@@ -3,6 +3,7 @@
 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

tutormfe/patches/openedx-lms-development-settings

@@ -36,9 +36,11 @@ MFE_CONFIG["ACCOUNT_SETTINGS_URL"] = ACCOUNT_MICROFRONTEND_URL
 {% endif %}
 
 {% if get_mfe("course-authoring") %}
-MFE_CONFIG["ENABLE_NEW_EDITOR_PAGES"] = True
-MFE_CONFIG["ENABLE_PROGRESS_GRAPH_SETTINGS"] = True
 MFE_CONFIG["COURSE_AUTHORING_MICROFRONTEND_URL"] = "http://{{ MFE_HOST }}:{{ get_mfe("course-authoring")["port"] }}/course-authoring"
+MFE_CONFIG["ENABLE_ASSETS_PAGE"] = "true"
+MFE_CONFIG["ENABLE_HOME_PAGE_COURSE_API_V2"] = "true"
+MFE_CONFIG["ENABLE_PROGRESS_GRAPH_SETTINGS"] = "true"
+MFE_CONFIG["ENABLE_TAGGING_TAXONOMY_PAGES"] = "true"
 {% endif %}
 
 {% if get_mfe("discussions") %}

tutormfe/patches/openedx-lms-production-settings

@@ -37,9 +37,11 @@ MFE_CONFIG["ACCOUNT_SETTINGS_URL"] = ACCOUNT_MICROFRONTEND_URL
 {% endif %}
 
 {% if get_mfe("course-authoring") %}
-MFE_CONFIG["ENABLE_NEW_EDITOR_PAGES"] = True
-MFE_CONFIG["ENABLE_PROGRESS_GRAPH_SETTINGS"] = True
 MFE_CONFIG["COURSE_AUTHORING_MICROFRONTEND_URL"] = "{% if ENABLE_HTTPS %}https://{% else %}http://{% endif %}{{ MFE_HOST }}/course-authoring"
+MFE_CONFIG["ENABLE_ASSETS_PAGE"] = "true"
+MFE_CONFIG["ENABLE_HOME_PAGE_COURSE_API_V2"] = "true"
+MFE_CONFIG["ENABLE_PROGRESS_GRAPH_SETTINGS"] = "true"
+MFE_CONFIG["ENABLE_TAGGING_TAXONOMY_PAGES"] = "true"
 {% endif %}
 
 {% if get_mfe("discussions") %}

tutormfe/templates/mfe/apps/mfe/webpack.dev-tutor.config.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const baseDevConfig = (
   fs.existsSync('./webpack.dev.config.js')
     ? require('./webpack.dev.config.js')
-    : require('@edx/frontend-build/config/webpack.dev.config.js')
+    : require('@openedx/frontend-build/config/webpack.dev.config.js')
 );
 
 module.exports = merge(baseDevConfig, {

tutormfe/templates/mfe/build/mfe/Dockerfile

@@ -20,16 +20,6 @@ RUN mkdir -p /openedx/app /openedx/env
 WORKDIR /openedx/app
 ENV PATH /openedx/app/node_modules/.bin:${PATH}
 
-######## i18n strings
-FROM base AS i18n
-COPY ./i18n /openedx/i18n
-RUN chmod a+x /openedx/i18n/*.js
-RUN echo "copying i18n data" \
-  {%- for app_name, app in iter_mfes() %}
-  && mkdir -p /openedx/i18n/{{ app_name }} \
-  {%- endfor %}
-  echo "done."
-
 {% for app_name, app in iter_mfes() %}
 ####################### {{ app_name }} MFE
 ######## {{ app_name }} (git)
@@ -42,14 +32,6 @@ ADD --keep-git-dir=true {{ app["repository"] }}#{{ app.get("version", MFE_COMMON
 FROM scratch as {{ app_name }}-src
 COPY --from={{ app_name }}-git /openedx/app /
 
-######## {{ app_name }} (i18n)
-FROM base AS {{ app_name }}-i18n
-COPY --from={{ app_name }}-src / /openedx/app
-COPY --from=i18n /openedx/i18n/{{ app_name }} /openedx/i18n/{{ app_name }}
-COPY --from=i18n /openedx/i18n/i18n-merge.js /openedx/i18n/i18n-merge.js
-RUN stat /openedx/app/src/i18n/messages 2> /dev/null || (echo "missing messages folder" && mkdir -p /openedx/app/src/i18n/messages)
-RUN /openedx/i18n/i18n-merge.js /openedx/app/src/i18n/messages /openedx/i18n/{{ app_name }} /openedx/app/src/i18n/messages
-
 ######## {{ app_name }} (common)
 FROM base AS {{ app_name }}-common
 COPY --from={{ app_name }}-src /package.json /openedx/app/package.json
@@ -65,13 +47,8 @@ RUN --mount=type=cache,target=/root/.npm,sharing=shared npm clean-install --no-a
 {{ patch("mfe-dockerfile-post-npm-install") }}
 {{ patch("mfe-dockerfile-post-npm-install-{}".format(app_name)) }}
 COPY --from={{ app_name }}-src / /openedx/app
-COPY --from={{ app_name }}-i18n /openedx/app/src/i18n/messages /openedx/app/src/i18n/messages
 
-# Whenever a new MFE supports Atlas, it should be added to this list.
-# When all MFEs support Atlas, this if-statement should be removed.
-{% if app_name in ["communications"] %}
-RUN make OPENEDX_ATLAS_PULL=true pull_translations
-{% endif %}
+RUN make OPENEDX_ATLAS_PULL=true ATLAS_OPTIONS="--repository={{ ATLAS_REPOSITORY }} --revision={{ ATLAS_REVISION }} {{ ATLAS_OPTIONS }}" pull_translations
 
 EXPOSE {{ app['port'] }}