Skip to content

Commit

Permalink
fix: update env.config.jsx according to tutor-mfe#240 PR
Browse files Browse the repository at this point in the history
  • Loading branch information
@hinakhadim
hinakhadim committed Dec 9, 2024
1 parent 7e5cc4b commit df5abfb
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 91 deletions.
37 changes: 0 additions & 37 deletions tutorindigo/templates/indigo/env.config.jsx → ...ches/mfe-env-config-buildtime-definitions
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
import React, { useEffect } from 'react';
import Cookies from 'universal-cookie';

import Footer from '@edly-io/indigo-frontend-component-footer';
import { getConfig } from '@edx/frontend-platform';
import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';

let themeCookie = 'indigo-toggle-dark';
let themeCookieExpiry = 90; // days
Expand Down Expand Up @@ -70,35 +65,3 @@ const AddDarkTheme = () => {

return (<div />);
};

const themePluginSlot = {
keepDefault: false,
plugins: [
{
op: PLUGIN_OPERATIONS.Insert,
widget: {
id: 'default_contents',
type: DIRECT_PLUGIN,
priority: 1,
RenderWidget: <Footer />,
},
},
{
op: PLUGIN_OPERATIONS.Insert,
widget: {
id: 'read_theme_cookie',
type: DIRECT_PLUGIN,
priority: 2,
RenderWidget: AddDarkTheme,
},
},
],
};

const config = {
pluginSlots: {
footer_slot: themePluginSlot,
},
};

export default config;
4 changes: 4 additions & 0 deletions tutorindigo/patches/mfe-env-config-buildtime-imports
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import React, { useEffect } from 'react';
import Cookies from 'universal-cookie';

import { getConfig } from '@edx/frontend-platform';
2 changes: 2 additions & 0 deletions tutorindigo/patches/mfe-env-config-runtime-definitions
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

const { default: IndigoFooter } = await import('@edly-io/indigo-frontend-component-footer');
115 changes: 61 additions & 54 deletions tutorindigo/plugin.py
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
from __future__ import annotations

import os
from glob import glob
import typing as t

import importlib_resources
from tutor import hooks
from tutormfe.hooks import PLUGIN_SLOTS
from tutor.__about__ import __version_suffix__

from .__about__ import __version__
Expand Down Expand Up @@ -102,68 +104,27 @@ def _override_openedx_docker_image(
hooks.Filters.CONFIG_OVERRIDES.add_items(list(config["overrides"].items()))


# MFEs that are styled using Indigo
indigo_styled_mfes = ['learning', 'learner-dashboard', 'profile', 'account', 'discussions']

hooks.Filters.ENV_PATCHES.add_items(
[
# MFE will install header version 3.0.x and will include indigo-footer as a
# separate package for use in env.config.jsx
(
"mfe-dockerfile-post-npm-install-learning",
[(
f"mfe-dockerfile-post-npm-install-{mfe}",
"""
RUN npm install '@edx/brand@npm:@edly-io/indigo-brand-openedx@^2.1.1'
RUN npm install '@edx/frontend-component-header@npm:@edly-io/indigo-frontend-component-header@^3.1.3'
RUN npm install @edly-io/indigo-frontend-component-footer@^2.0.0
COPY indigo/env.config.jsx /openedx/app/
""",
),
(
"mfe-dockerfile-post-npm-install-authn",
"""
RUN npm install '@edx/brand@npm:@edly-io/indigo-brand-openedx@^2.1.1'
""",
),
# Tutor-Indigo v2.1 targets the styling updates in discussions and learner-dashboard MFE
# brand-openedx is related to styling updates while others are for header and footer updates
(
"mfe-dockerfile-post-npm-install-discussions",
"""
RUN npm install '@edx/brand@npm:@edly-io/indigo-brand-openedx@^2.1.1'
RUN npm install '@edx/frontend-component-header@npm:@edly-io/indigo-frontend-component-header@^3.1.3'
RUN npm install @edly-io/indigo-frontend-component-footer@^2.0.0
COPY indigo/env.config.jsx /openedx/app/
""",
),
(
"mfe-dockerfile-post-npm-install-learner-dashboard",
"""
RUN npm install '@edx/brand@npm:@edly-io/indigo-brand-openedx@^2.1.1'
RUN npm install @edly-io/indigo-frontend-component-footer@^2.0.0
COPY indigo/env.config.jsx /openedx/app/
""",
),
(
"mfe-dockerfile-post-npm-install-profile",
"""
RUN npm install '@edx/brand@npm:@edly-io/indigo-brand-openedx@^2.1.1'
RUN npm install '@edx/frontend-component-header@npm:@edly-io/indigo-frontend-component-header@^3.1.3'
RUN npm install @edly-io/indigo-frontend-component-footer@^2.0.0
COPY indigo/env.config.jsx /openedx/app/
""",
),
(
"mfe-dockerfile-post-npm-install-account",
"""
RUN npm install '@edx/brand@npm:@edly-io/indigo-brand-openedx@^2.1.1'
RUN npm install '@edx/frontend-component-header@npm:@edly-io/indigo-frontend-component-header@^3.1.3'
RUN npm install @edly-io/indigo-frontend-component-footer@^2.0.0
) for mfe in indigo_styled_mfes]
)

COPY indigo/env.config.jsx /openedx/app/
""",
),
]
hooks.Filters.ENV_PATCHES.add_item(
(
"mfe-dockerfile-post-npm-install-authn",
"RUN npm install '@edx/brand@npm:@edly-io/indigo-brand-openedx@^2.1.1'",
)
)

# Include js file in lms main.html, main_django.html, and certificate.html
Expand Down Expand Up @@ -204,3 +165,49 @@ def _override_openedx_docker_image(
),
]
)


# Apply patches from tutor-indigo
for path in glob(
os.path.join(
str(importlib_resources.files("tutorindigo") / "patches"),
"*",
)
):
with open(path, encoding="utf-8") as patch_file:
hooks.Filters.ENV_PATCHES.add_item(
(os.path.basename(path), patch_file.read())
)


for mfe in indigo_styled_mfes:
PLUGIN_SLOTS.add_item(
(
mfe,
"footer_slot",
"""
{
op: PLUGIN_OPERATIONS.Hide,
widgetId: 'default_contents',
},
{
op: PLUGIN_OPERATIONS.Insert,
widget: {
id: 'default_contents',
type: DIRECT_PLUGIN,
priority: 1,
RenderWidget: <IndigoFooter />,
},
},
{
op: PLUGIN_OPERATIONS.Insert,
widget: {
id: 'read_theme_cookie',
type: DIRECT_PLUGIN,
priority: 2,
RenderWidget: AddDarkTheme,
},
},
"""
),
)

0 comments on commit df5abfb

Please sign in to comment.