MFE failing login_refresh with 404 error

Jeff_Cohen · July 3, 2022, 9:47pm

When trying to access a course page, the browser developer console is reporting a 404 error when trying to post to the login_refresh endpoint. When looking a little deeper, the interesting thing is that it is actually try to post to the wrong endpoint http://{MFE_LEARNING_HOST}/learning/course/course-v1:edX+DemoX+Demo_Course/'http://{LMS_HOST}/login_refresh' including the extra quotes.

I put a breakpoint to see the value in config.js REFRESH_ACCESS_TOKEN_ENDPOINT: process.env.REFRESH_ACCESS_TOKEN_ENDPOINT, which is showing to contain extra encapsulating single quotes "'http://{LMS_HOST}/login_refresh'" which is not getting interpreted as a url, and therefore getting appended as the path on the end of the current endpoint when executing the post request.

I was able to resolve the issue by modifying tutormfe/templates/mfe/build/mfe/env/development to remove the single quotes from each line. After running tutor config save and rebooting the learning image, the single quotes are gone and the post request is executing successfully.

Is this the right way to fix the issue? Is anyone else experiencing the same error? I’d be happy to open a pr if I’m on the right track, but wanted to check first.

Sorry if I am missing a more simple solution to this error.

Thanks in advance for your guidance.

note: MFE_LEARNING_HOST and LMS_HOST are used above to obfuscate my address, but the values are correct in my runtime environment

Jeff_Cohen · July 3, 2022, 11:02pm

To add to this issue, my jwt token was still not getting recognized after the successful login_refresh api call. I have found that the cause was similar extra single quotes. This time the value of ACCESS_TOKEN_COOKIE_NAME was "'edx-jwt-cookie-header-payload'". So when the code looked for the cookie, it was not finding a cookie name that matched (including the extra quotes).

Since that setting is found in tutormfe/templates/mfe/build/mfe/env/production it would seem that the quotes need to be removed from there as well. However, I’m still not clear on the implications of removing these quotes and whether they will break any other flows. So I am extra hesitant to remove them from the production settings file.

I’m also unclear why this issue understanding the production settings only appears to happen when running tutor dev but not tutor local.

Jeff_Cohen · July 4, 2022, 2:14am

I have confirmed that when I revert my changes so that the production config file includes the single quotes and then run the platform with tutor local everything works as expected. With my breakpoints, I see that the values do not show extra single quotes. So I wonder if the difference between the two environments, has something to do with how the config files are loaded by the different processes.

If I am reading the files correctly, it appears the env config files are loaded for the dev process in the dev/docker-compose.yml. In contrast, the prod env is loaded as part of the build of the image in Dockerfile.

110035 · July 4, 2022, 5:25am

Jeff, i am not using tutor, i deployed the latest branch/master, i had the refresh_token problem too, my way is:
1: set lms/envs/common.py JWT_IN_COOKIE_EXPIRATION=606024
2: set frontend-app-learning .env.development `SESSION_COOKIE_DOMAIN=‘xxx’ //set your dormain
this works for me.

Jeff_Cohen · July 5, 2022, 9:44pm

@regis I reverted all of my changes to run vanilla tutor dev as you recommended on my other post Using tutor dev on remote AWS instance - #8 by regis. However, I’m still encountering this issue with extra single-quotation-marks in the env config, though when the quotes are removed from the development template as I mentioned in my original post local.overhang.io works as expected. Can you please advise if I’m missing an easy solution?

Thank you once again for your patience and guidance!

Jeff_Cohen · July 7, 2022, 9:12pm

I found this docker issue report which explains the change in docker-compose env_file behavior in handling quotation marks. I have been using the latest docker-compose version in the apt repository which is only version 1.25.0. The fix for escaping quotations was introduced in 1.26.0. Upgrading to docker-compose version 1.29.2 has resolved the issue. Here are instructions to install using curl rather than apt to get the later version.

regis · July 11, 2022, 12:05pm

This is super interesting, I was not aware that older versions of docker-compose treated env files by including the quotes (both " and ') in their values.

It seems to me that we could attempt to be backward compatible by removing all single quotes from the tutor-mfe env files (production and development). @Jeff_Cohen would you like to open a pull request to address this issue?

@arbrandes did you see this? tl;dr: older versions of docker-compose include quotes in the values defined in environment files. Thus, to be backward compatible, we should not write:

KEY='value'

but:

KEY=value

in the following files:

github.com

overhangio/tutor-mfe/blob/master/tutormfe/templates/mfe/build/mfe/env/development

DISCOVERY_API_BASE_URL='{% if DISCOVERY_HOST is defined %}http://{{ DISCOVERY_HOST }}:8381{% endif %}'
LMS_BASE_URL='http://{{ LMS_HOST }}:8000'
LOGIN_URL='http://{{ LMS_HOST }}:8000/login'
LOGO_URL='http://{{ LMS_HOST }}:8000/theming/asset/images/logo.png'
LOGO_TRADEMARK_URL='http://{{ LMS_HOST }}:8000/theming/asset/images/logo.png'
LOGOUT_URL='http://{{ LMS_HOST }}:8000/logout'
MARKETING_SITE_BASE_URL='http://{{ LMS_HOST }}:8000'
NODE_ENV=development
REFRESH_ACCESS_TOKEN_ENDPOINT='http://{{ LMS_HOST }}:8000/login_refresh'
STUDIO_BASE_URL='http://{{ CMS_HOST }}:8001'

{{ patch("mfe-env-development") }}

github.com

overhangio/tutor-mfe/blob/master/tutormfe/templates/mfe/build/mfe/env/production

{# https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/micro_frontends/index.html#required-environment-variables #}
ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload'
BASE_URL='{{ MFE_HOST }}'
CSRF_TOKEN_API_PATH='/csrf/api/v1/token'
CREDENTIALS_BASE_URL=''
DISCOVERY_API_BASE_URL='{% if DISCOVERY_HOST is defined %}{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ DISCOVERY_HOST }}{% endif %}'
ECOMMERCE_BASE_URL=''
ENABLE_NEW_RELIC='false'
FAVICON_URL='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/favicon.ico'
LANGUAGE_PREFERENCE_COOKIE_NAME='openedx-language-preference'
LMS_BASE_URL='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}'
LOGIN_URL='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/login'
LOGO_URL='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/theming/asset/images/logo.png'
LOGO_TRADEMARK_URL='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/theming/asset/images/logo.png'
LOGO_WHITE_URL=''
LOGOUT_URL='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/logout'
MARKETING_SITE_BASE_URL='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}'
NODE_ENV=production
PUBLISHER_BASE_URL=''
REFRESH_ACCESS_TOKEN_ENDPOINT='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/login_refresh'

This file has been truncated. show original

Jeff_Cohen · July 11, 2022, 1:18pm

Hi @regis. Thank you for the invitation to open a pr. I have created it here. Please let me know if there is a template or other details you prefer pr’s follow.

As this issue showed, my environment might be set up different than other developers. For extra diligence, could you please test that my branch works well in your workspace before merging into master?

Topic		Replies	Views
Tutor mfe plugin fresh startup error Tutor Help tutor , mfe , tutor-mfe , tutor-plugin	8	1312	October 22, 2022
Changing mfe host url Development tutor	2	544	October 22, 2022
Payment MFE returns 404 Site Operations Help ecommerce , tutor	14	558	June 12, 2023
Error in authn MFE during registration in tutor quince.2 Development mfe , tutor-mfe	2	89	March 4, 2024
MFE pages and resources Site Operators tutor	2	542	January 26, 2023

MFE failing login_refresh with 404 error

Related Topics