Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

feat: add atlas pull support - FC-0012 #4051

Merged
merged 1 commit into from
Dec 7, 2023
Merged

feat: add atlas pull support - FC-0012 #4051

merged 1 commit into from
Dec 7, 2023

Conversation

shadinaif
Copy link
Contributor

@shadinaif shadinaif commented Nov 12, 2023 •
edited
Loading

Add atlas pull support. (atlas pull) will be performed only if OPENEDX_ATLAS_PULL environment variable is set

  • Tested on devstack, docker build is working fine
  • Tested on devstack, make extract_translation is still running fine with latest i18-tools==1.3.0
  • Tested on devstack, OPENEDX_ATLAS_PULL=yes make pull_translation is working fine
  • Tested on devstack, OPENEDX_ATLAS_PULL=yes make pull_translation is deleting old translations and pulling the latest translations

References

This pull request is part of the FC-0012 project which is sparked by the Translation Infrastructure update OEP-58.

Check the links above for full information about the overall project.

Internalization is being rearchitected in Open edX Python, XBlock, Micro-frontend, and other projects. There are a number of immediately visible changes:

  • Remove source and language translations from the repositories, hence no .json, .po or .mo files will be committed into the repos.
  • Add standardized make extract_translations in all repositories
  • Push user-facing messages strings into openedx/openedx-translations.
  • Integrate root repositories with openedx/openedx-atlas to pull translations on build/deploy time

Breaking Changes

One of the primary goals of the project is to avoid breaking changes. If you noticed any suspicious code, please raise your concern. But before that, please know the strategy we're following to avoid breaking changes

For XBlocks:

  • The standard translation path must be conf/locale. Therefore, we are creating a link from conf/locale to translations so Atlas can find the path without disrupting the current way of having translations locally within the XBlocks
  • openedx-translations will have a related PR that adds the XBlock to the pipeline. This will not affect the current way of managing/updating translations
  • At the end of the project, a clear change log will be added and all translations will be handled by Atlas. Thus, the local translation will be removed from the repo within the version bump
  • A notification for the community will be published to ensure that everyone knows why translations directories are removed from all repos

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 12, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 12, 2023 •
edited
Loading

Thanks for the pull request, @shadinaif! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58 branch 7 times, most recently from 40d12bc to 1428ebd Compare November 13, 2023 07:54
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Nov 13, 2023
@shadinaif shadinaif mentioned this pull request Nov 15, 2023
Merged
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58 branch 3 times, most recently from bce186c to d2783e7 Compare November 15, 2023 07:42
@shadinaif shadinaif marked this pull request as ready for review November 15, 2023 07:42
@shadinaif shadinaif requested a review from a team as a code owner November 15, 2023 07:42
@shadinaif
Copy link
Contributor Author

please review @OmarIthawi , @brian-smith-tcril

@brian-smith-tcril
Copy link

@shadinaif looks like the CI failed

@brian-smith-tcril brian-smith-tcril removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Nov 15, 2023
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58 branch 3 times, most recently from 91a68c9 to 5dfa5ed Compare November 18, 2023 15:47
@shadinaif
Copy link
Contributor Author

Fixed. Please run tests again @OmarIthawi , @brian-smith-tcril

@brian-smith-tcril
Copy link

@colinbrash you are listed as "review required from" on the spreadsheet for this repo. I'm hoping to get this merged soon, thanks!

OmarIthawi
OmarIthawi suggested changes Nov 20, 2023
View reviewed changes
Copy link
Contributor

@OmarIthawi OmarIthawi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shadinaif I've tested it locally and it worked except for the compilemssage step

Do you mind checking the error bellow?

$ docker build -t temp-ecommerce .
$ docker run -it docker.io/library/temp-ecommerce bash
# atlas --version
v0.5.0
# make OPENEDX_ATLAS_PULL=yes pull_translations

Error:

  File "manage.py", line 11, in <module>
    execute_from_command_line(sys.argv)
  File "/edx/app/ecommerce/venvs/ecommerce/lib/python3.8/site-packages/django/core/management/__init__.py", line 419, in execute_from_command_line
    utility.execute()
  File "/edx/app/ecommerce/venvs/ecommerce/lib/python3.8/site-packages/django/core/management/__init__.py", line 363, in execute
    settings.INSTALLED_APPS
  File "/edx/app/ecommerce/venvs/ecommerce/lib/python3.8/site-packages/django/conf/__init__.py", line 82, in __getattr__
    self._setup(name)
  File "/edx/app/ecommerce/venvs/ecommerce/lib/python3.8/site-packages/django/conf/__init__.py", line 69, in _setup
    self._wrapped = Settings(settings_module)
  File "/edx/app/ecommerce/venvs/ecommerce/lib/python3.8/site-packages/django/conf/__init__.py", line 170, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
  File "/usr/lib/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 848, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/edx/app/ecommerce/ecommerce/ecommerce/settings/devstack.py", line 6, in <module>
    from ecommerce.settings.production import *
  File "/edx/app/ecommerce/ecommerce/ecommerce/settings/production.py", line 60, in <module>
    with codecs.open(CONFIG_FILE, encoding='utf-8') as f:
  File "/usr/lib/python3.8/codecs.py", line 905, in open
    file = builtins.open(filename, mode, buffering)
FileNotFoundError: [Errno 2] No such file or directory: '/edx/etc/ecommerce.yml'
make: *** [Makefile:134: pull_translations] Error 1

@shadinaif
Copy link
Contributor Author

Thank you for the tests 😃 @OmarIthawi

It's running fine after copying the file from devstack repo to /edx/etc/ecommerce.yml inside the docker container. The file does not exist by default. Check the instructions here. It's set by devstack here

@OmarIthawi
Copy link
Contributor

I'll test again and let you know.

OmarIthawi
OmarIthawi approved these changes Nov 21, 2023
View reviewed changes
Copy link
Contributor

@OmarIthawi OmarIthawi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works on devstack. Thanks @shadinaif!!

@shadinaif
Copy link
Contributor Author

Hi @brian-smith-tcril , I've rebased on master, please run tests and merge

@shadinaif shadinaif changed the title feat: add atlas pull support feat: add atlas pull support - FC-0012 Dec 1, 2023
@shadinaif
feat: add atlas pull support
85b3fab 
Refs: FC-0012 OEP-58
@shadinaif
Copy link
Contributor Author

rebased again

@brian-smith-tcril brian-smith-tcril merged commit e5b4f29 into openedx-unsupported:master Dec 7, 2023
10 checks passed
@openedx-webhooks
Copy link

@shadinaif 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@shadinaif shadinaif deleted the shadinaif/FC-0012-OEP-58 branch December 14, 2023 10:19
@OmarIthawi OmarIthawi mentioned this pull request Dec 15, 2023
Closed
zubair-ce07 added a commit that referenced this pull request Jan 16, 2024
@zubair-ce07
chore: PR to upgrade django oscar to version 3.2
2493b06 
feat: resloved reserved keywords conflict

feat: add data mmigration to make basket_lineattribute value json compatible

docs: updated readme for 2u/release contributions (#3927)

docs: add decision record for master branch split

feat: add atlas pull support (#4051)

Refs: FC-0012 OEP-58

feat: added refund functionality
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@brian-smith-tcril brian-smith-tcril brian-smith-tcril approved these changes

@OmarIthawi OmarIthawi OmarIthawi approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@shadinaif @openedx-webhooks @brian-smith-tcril @OmarIthawi @mphilbrick211