Environment variables in MFEs

sambapete · August 18, 2023, 4:04pm

This is probably related to the same issue I recently had with Order History in the frontend-app-ecommerce.

In this case, I am trying to setup the INFO_EMAIL variable for the GitHub - openedx/frontend-app-authn: Open edX micro-frontend application for new login and registration experience. and I cannot find how to do it properly.

Using a plugin and trying to setup
MFE_CONFIG[“INFO_EMAIL”] = “support@edulib.org”
doesn’t work for me.

I cannot determine which patch to use in my plugin or how to specify it exclusively for the authn MFE.

Any suggestions?

P.S. I would like not to have to fork the repo in order to force the variable in the .env file. That’s what I had to do for the Order History in frontend-app-ecommerce.

sambapete · August 18, 2023, 4:40pm

I am going to use a graphical example based on the Tutor demo site

On the right side, underneath the “Envoyez” button, you can see “For additional help, contact Open edX Demo Site support at”. In the code of the frontend-app-authn it refers to the INFO_EMAIL environment variable. You can see that even on the Demo Site, it is not set up properly.

@regis @arbrandes how would you setup that variable so that it can be used by MFE_CONFIG ?

I’ve tried adding it with a plugin through mfe-lms-development-setting, mfe-lms-production-settings and openedx-lms-production-settings without any success. The only thing that works for me thus far is forking the MFE and forcing the values in the .env file of the repo. Is there a better solution without forking the MFE? Inquiring minds want to know…

arbrandes · August 18, 2023, 4:59pm

A patch to mfe-lms-production-settings should have worked, from what I can tell by looking at the code. (getConfig() is being called as it should.) Are you sure this wasn’t just the config cache taking a while to refresh?

Did you also try site_configuration, by any chance?

sambapete · August 18, 2023, 5:03pm

Possible. As I am working on a test server right now, I can try a few things.

Something I found bizarre is in GitHub - openedx/frontend-app-authn: Open edX micro-frontend application for new login and registration experience. I discovered that MFE_CONFIG_API_URL is supposed to be setup as /api/v1/mfe_config

But when I try to set it myself I then discovered
ubuntu@ip-10-0-0-48:~/.local/share/tutor/env$ grep -r MFE_CONFIG_API_URL

plugins/mfe/build/mfe/Dockerfile:ENV MFE_CONFIG_API_URL=/api/mfe_config/v1

apps/openedx/settings/lms/production.py:MFE_CONFIG[“MFE_CONFIG_API_URL”] = “/api/v1/mfe_config”

apps/openedx/settings/lms/development.py:MFE_CONFIG[“MFE_CONFIG_API_URL”] = “/api/v1/mfe_config”

so, is it /api/mfe_config/v1 or /api/v1/mfe_config ?

sambapete · August 18, 2023, 5:07pm

I haven’t tried through site_configuration. I will try it.

arbrandes · August 18, 2023, 5:21pm

The tutor-mfe proxy expects it to be /api/mfe_config/v1, as per the Dockerfile template and the CaddyFile. It is also the URL set in the LMS. So this is what should be set on the MFEs.

sambapete · August 18, 2023, 5:48pm

Thanks. That makes the documentation for MFE_CONFIG_API_URL in frontend-app-authn#environment-variablessetup-notes to be wrong then.

arbrandes · August 18, 2023, 5:51pm

Yup, definitely wrong!

sambapete · August 18, 2023, 5:58pm

@arbrandes might have been right about the config cache taking a while to refresh.

I also added
INFO_EMAIL: support@edulib.org
to config,yml just to be sure.

I saved the configuration. I did a fresh rebuild of my images after stopping Tutor completely. The value of INFO_EMAIL suddenly appeared.

Thanks @arbrandes

regis · August 19, 2023, 4:28am

A fix by @misilot is in progress in the MFE plugin: Add INFO_EMAIL and PASSWORD_RESET_SUPPORT_LINK by misilot · Pull Request #141 · overhangio/tutor-mfe · GitHub

system · November 17, 2023, 4:29am

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
We really really need some docs on MFE env settings Build-Test-Release	5	1173	May 18, 2021
Setting environment variable Site Operations Help	2	731	February 24, 2020
How to get information of platform to create .env file Tutor Help how-to	1	101	January 23, 2024
Change login MFE to use image layout Tutor Help how-to , tutor	5	39	September 30, 2024
How to add env patch to a mfe in Palm Tutor Help tutor	5	311	August 28, 2023

Environment variables in MFEs

Related topics