[WIP] fix: add script to install node_modules in mounted mfes

changelog.d/20250618_184835_danyal.faheem_mounted_mfes_npm_install.md

@@ -0,0 +1 @@
+- [Improvement] Auto install npm dependencies in mounted MFEs during initialization. (by @Danyal-Faheem)

tutormfe/patches/dev-docker-compose-jobs-services

@@ -0,0 +1,13 @@
+# These jobs are required to run the npm install script when mounting MFEs
+{%- set mfe_data = MFEMountData(MOUNTS) %}
+
+{%- for app_name, app, mounts in mfe_data.mounted %}
+{{ app_name }}-job:
+    image: "{{ MFE_DOCKER_IMAGE_DEV_PREFIX }}-{{ app_name }}-dev:{{ MFE_VERSION }}"
+    volumes:
+        {%- for mount in mounts %}
+        - {{ mount }}
+        {%- endfor %}
+    environment:
+        - "NODE_ENV=development"
+{%- endfor %}

tutormfe/patches/local-docker-compose-jobs-services

@@ -0,0 +1,14 @@
+# We only need to define these for local as well otherwise docker throws a not found error when we run the local init jobs
+# These jobs are required to run the npm install script when mounting MFEs
+{%- set mfe_data = MFEMountData(MOUNTS) %}
+
+{%- for app_name, app, mounts in mfe_data.mounted %}
+{{ app_name }}-job:
+    image: "{{ MFE_DOCKER_IMAGE_DEV_PREFIX }}-{{ app_name }}-dev:{{ MFE_VERSION }}"
+    volumes:
+        {%- for mount in mounts %}
+        - {{ mount }}
+        {%- endfor %}
+    environment:
+        - "NODE_ENV=production"
+{%- endfor %}

tutormfe/plugin.py

@@ -2,6 +2,7 @@
 
 import functools
 import os
+import re
 import typing as t
 from glob import glob
 
@@ -334,3 +335,29 @@ def _check_mfe_host(config: Config) -> None:
             f'Warning: MFE_HOST="{mfe_host}" is not a subdomain of LMS_HOST="{lms_host}". '
             "This configuration is not typically recommended and may lead to unexpected behavior."
         )
+
+
+@tutor_hooks.Actions.CONFIG_LOADED.add()
+def _run_jobs_in_mounted_mfes(config: Config) -> None:
+
+    mounts = get_typed(config, "MOUNTS", list, [])
+    mfe_mount_data = MFEMountData(mounts)
+
+    if not mfe_mount_data.mounted:
+        return None
+
+    mfe_npm_install_file = os.path.join(
+        str(
+            importlib_resources.files("tutormfe")
+            / "templates"
+            / "mfe"
+            / "tasks"
+            / "mfe"
+            / "npm-install.sh"
+        )
+    )
+
+    for mfe, _, _ in mfe_mount_data.mounted:
+        with tutor_hooks.Contexts.app("mfe").enter():
+            with open(mfe_npm_install_file, encoding="utf-8") as fi:
+                tutor_hooks.Filters.CLI_DO_INIT_TASKS.add_item((mfe, fi.read()))

tutormfe/templates/mfe/tasks/mfe/npm-install.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+if [ "$NODE_ENV" != "development" ]; then
+    echo "This script is intended to run only in the development environment."
+    exit
+fi
+
+# Paths for the fingerprint and package-lock.json
+FINGERPRINT_FILE="node_modules/.fingerprint"
+PACKAGE_LOCK="package-lock.json"
+
+# Function to generate the SHA1 hash of the package-lock.json file
+generate_fingerprint() {
+  sha1sum "$PACKAGE_LOCK" | awk '{print $1}'
+}
+
+# If node_modules directory is missing, install dependencies
+if [ ! -d "node_modules" ]; then
+  echo "⚠️  node_modules not found! Installing dependencies..."
+  npm clean-install
+
+# If fingerprint file is missing, assume packages may be out of sync and reinstall
+elif [ ! -f "$FINGERPRINT_FILE" ]; then
+  echo "⚠️  Fingerprint file not found! Re-installing dependencies..."
+  npm clean-install
+
+# If both node_modules and fingerprint file exist, compare fingerprints
+else
+  CURRENT_FINGERPRINT=$(generate_fingerprint)
+  STORED_FINGERPRINT=$(cat "$FINGERPRINT_FILE")
+
+  # Reinstall if package-lock.json has changed
+  if [ "$CURRENT_FINGERPRINT" != "$STORED_FINGERPRINT" ]; then
+    echo "⚠️  package-lock.json changed! Re-installing dependencies..."
+    npm clean-install
+  else
+    # Everything is up to date
+    echo "✅ Dependencies are up to date."
+    exit 0
+  fi
+fi
+
+
+# Store the new fingerprint after installation
+generate_fingerprint > "$FINGERPRINT_FILE"
+echo "✅ Dependencies installed and fingerprint updated."