[WIP] fix: add script to install node_modules in mounted mfes #232
Conversation
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.
| @@ -0,0 +1,11 @@ | |||
| {%- for app_name, app in iter_mfes() %} | |||
There was a problem hiding this comment.
why is this patch needed?
| 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.
| 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.
|
|
||
|
|
||
| @tutor_hooks.Actions.CONFIG_LOADED.add() | ||
| def _run_jobs_in_mounted_mfes(config: Config) -> None: |
There was a problem hiding this comment.
I'm not a big fan of adding callbacks to the CONFIG_LOADED action. It means we have to manually parse MOUNTS and this is bound to fail in many edge cases. Also, we have to start using Context objects, which is VERY dirty.
Instead, I suggest the following:
@tutor_hooks.Filters.CLI_DO_INIT_TASKS.add()
def _mfe_npm_install(tasks):
for mfe in get_mfes():
if hooks.Filters.COMPOSE_MOUNTS.apply([], f"frontend-app-{mfe}"):
tasks.append((mfe, "... contents of npm-install.sh..."))
What do you think?
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. 🙌