Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: set the session locale from the Open edX preferred language #1017

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: set the session locale from the Open edX preferred language #1017

wants to merge 4 commits into from

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Jan 30, 2025 •
edited
Loading

Description

If the full language locale is supported, use it in the session locale.
Otherwise, use the language part of the locale, if that is supported.

Falls back to "en" as the current default.

Closes openedx/openedx-aspects#298

Testing instructions

  1. Login to the LMS.
  2. From the Account settings, e.g http://apps.local.openedx.io:1997/account/ , update your preferred language to one of your configured `SUPERSET_SUPPORTED_LANGUAGES'.
  3. Login to superset, e.g. http://superset.local.openedx.io:8088/login
    Note that the language used in the Superset UI matches your chosen preferred language.
    There may be missing translations -- Superset's translation coverage is not 100%.
  4. From the Account settings, e.g http://apps.local.openedx.io:1997/account/ , update your preferred language to a language that is only partially-supported in Superset, e.g. Español (España) ('es-es').
  5. Logout of Superset, and log back in.
    Note that your default language in Superset is now Spanish ('es').

Author Notes & Concerns

  1. Unfortunately the solution proposed on Superset i18n: Save user's chosen language to user settings openedx-aspects#298 cannot easily be done, because Superset's User model is a FAB model, so adding fields is not straightforward. This was the next best solution I could come up with for Aspects.
  2. Is falling back to the "language" part of a given locale always OK?
  3. Should we also pass our django LANGUAGE_CODE through to the BABEL_DEFAULT_LOCALE (if it's one of the supported languages)?
    This would allow Aspects site operators to use a default other than "en".

@pomegranited
feat: set the session locale from the Open edX preferred language
b62182e 
If the full language locale is supported, use it.
Otherwise, use the language part of the locale.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 30, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jan 30, 2025 •
edited
Loading

Thanks for the pull request, @pomegranited!

This repository is currently maintained by @bmtcril.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@pomegranited pomegranited requested review from saraburns1, a team and bmtcril January 30, 2025 08:36
@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Jan 30, 2025
@bmtcril bmtcril requested a review from Yagnesh1998 January 30, 2025 15:09
@itsjeyd itsjeyd added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Feb 6, 2025
@bmtcril
Copy link
Contributor

bmtcril commented Feb 18, 2025

Looks good and makes sense, thanks! In regards to your concerns:

  • Is falling back to the "language" part of a given locale always OK?

I think it's the best we can do given the constraints, and is still probably better than falling back to the default language in most cases.

  • Should we also pass our django LANGUAGE_CODE through to the BABEL_DEFAULT_LOCALE (if it's one of the supported languages)? This would allow Aspects site operators to use a default other than "en".

Yes! This makes perfect sense to me, fwiw they can do this now by just overwriting BABEL_DEFAULT_LOCALE in the superset-config / superset-docker-config patches. The change of passing in this value shouldn't change that escape hatch since the patches are after the definition of BABEL_DEFAULT_LOCALE in the config.

@pomegranited
feat: pass LANGUAGE_CODE|lower through to BABEL_DEFAULT_LOCALE
7b1d422 
if LANGUAGE_CODE is one of the SUPERSET_SUPPORTED_LANGUAGES
@pomegranited
Copy link
Contributor Author

@bmtcril Thank you for your review!

Yes! This makes perfect sense to me, fwiw they can do this now by just overwriting BABEL_DEFAULT_LOCALE in the superset-config / superset-docker-config patches. The change of passing in this value shouldn't change that escape hatch since the patches are after the definition of BABEL_DEFAULT_LOCALE in the config.

How's 7b1d422 look?

@bmtcril
Copy link
Contributor

bmtcril commented Feb 19, 2025

How's 7b1d422 look?

Looks good! Still approved. 🙂 When you merge would you mind adding a note to the translation section here to include the new information on the settings? https://github.com/openedx/openedx-aspects/blob/main/docs/technical_documentation/how-tos/production_configuration.rst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmtcril bmtcril bmtcril approved these changes

@saraburns1 saraburns1 Awaiting requested review from saraburns1

@Yagnesh1998 Yagnesh1998 Awaiting requested review from Yagnesh1998

Assignees
No one assigned
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U waiting for eng review PR is ready for review. Review and merge it, or suggest changes.
Projects
Contributions
Status: In Eng Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Superset i18n: Save user's chosen language to user settings
4 participants
@pomegranited @openedx-webhooks @bmtcril @itsjeyd