[WIP] fix: add script to install node_modules in mounted mfes #232
+72
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hinakhadim
requested review from
regisb,
arbrandes,
DawoudSheraz and
Danyal-Faheem
hinakhadim
changed the title
| def _run_jobs_in_mounted_mfes(config: Config) -> None: | ||
| mounts = get_typed(config, "MOUNTS", list, []) | ||
|
|
||
| pattern = re.compile(r'frontend-app-(\w+)') |
There was a problem hiding this comment.
We can use the REPO_PREFIX variable defined above here instead of a hardcoded string.
| @tutor_hooks.Actions.CONFIG_LOADED.add() | ||
| def _run_jobs_in_mounted_mfes(config: Config) -> None: | ||
| mounts = get_typed(config, "MOUNTS", list, []) | ||
|
|
There was a problem hiding this comment.
We can return here if no mounts exist in the config.
DawoudSheraz
reviewed
Nov 1, 2024
| @@ -0,0 +1,11 @@ | |||
| {%- for app_name, app in iter_mfes() %} | |||
There was a problem hiding this comment.
why is this patch needed?
DawoudSheraz
reviewed
Nov 1, 2024
| pattern = re.compile(r'frontend-app-(\w+)') | ||
| mounted_mfes = [match.group(1) for mount in mounts if (match := pattern.search(mount))] | ||
|
|
||
| mfe_task_file = os.path.join( |
There was a problem hiding this comment.
mfe_npm_install could be a better name as this action is related only to npm install.
DawoudSheraz
reviewed
Nov 1, 2024
| sha1sum "$PACKAGE_LOCK" | awk '{print $1}' | ||
| } | ||
|
|
||
| # Check if node_modules exists and fingerprint is valid |
There was a problem hiding this comment.
this comment can be broken down and mentioned against the appropriate if-elif-else block.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP -> The jobs run on tutor dev only
Description
These code changes introduce improvements to the Tutor MFE (Micro-Frontend) plugin by adding automation and efficiency for managing and running tasks in environments where MFEs are mounted. When MFEs are mounted, it will run
npm clean-installas part of the runtutor dev launch. The "mfe" init tasknpm-install.shis taking care of installing the node_modules, as it is done in the LMSTest Cases:
npm-installscript when MFEs are implicitly and expicitly mounted using the Tutor format:tutor mounts add $(pwd)/frontend-app-*&tutor mounts add [mfe-name]:$(pwd)/frontend-app-*:/openedx/app.tutor dev, nottutor local, as MFEs mount only intutor devenvironment.node_modulesare present, it should installnode_modules.node_modulesdirectory exists but is empty or outdated, it should installnode_modules.package-lock.jsonfile changes slightly, it should trigger reinstallation ofnode_modules.node_modulesare installed and then reinstallation is attempted without changes topackage-lock.json, it should not reinstallnode_modules.Closes #218
Special thanks to @Danyal-Faheem for collaborating with me on this and helping to reach a solution. 🙌