FITB: Dynamic substitutions require node modules be installed. (#1018)

* FITB: Dynamic substitutions require node modules be installed.

* FITB: Match formatting with black

* Some bookkeeping

---------

Co-authored-by: Oscar Levin <oscar.levin@unco.edu>

Author: dbrianwalton

CHANGELOG.md

@@ -9,6 +9,10 @@ Instructions: Add a subsection under `[Unreleased]` for additions, fixes, change
 
 ## [Unreleased]
 
+### Changed
+
+- Generating dynamic substitutions now uses node instead of playwright.  Node 22.10 or greater is required.
+
 ## [2.22.0] - 2025-07-05
 
 Includes updates to core through commit: [e6f9288](https://github.com/PreTeXtBook/pretext/commit/e6f92889e1e4978f71d7417be410ca379d6e9eff)

pretext/__init__.py

@@ -19,7 +19,7 @@
 VERSION = get_version("pretext", Path(__file__).parent.parent)
 
 
-CORE_COMMIT = "e6f92889e1e4978f71d7417be410ca379d6e9eff"
+CORE_COMMIT = "75e5bb36da237e2ddb11bec9454c8981c0d4897c"
 
 
 def activate() -> None:

pretext/constants.py

@@ -26,6 +26,7 @@
         "codelens",
         "datafile",
         "myopenmath",
+        "dynamic-subs",
     ],
     "pdf": [
         "webwork",

pretext/project/__init__.py

@@ -995,6 +995,7 @@ def generate_assets(
         # The dynamic-subs asset output is required for the subsequent asset generation, so needs to be near the top.
         if "dynamic-subs" in assets_to_generate:
             try:
+                utils.ensure_dynsub_node_modules()
                 core.dynamic_substitutions(
                     xml_source=self.source_abspath(),
                     pub_file=self.publication_abspath().as_posix(),

pretext/resources/__init__.py

@@ -74,6 +74,22 @@ def install(reinstall: bool = False, npm_install: bool = False) -> None:
             log.warning(f"Unable to install npm packages for theme building: {e}")
             log.debug(e, exc_info=True)
             return
+        # Dynamic substitution script requires node versions > 22.10
+        os.chdir(_RESOURCE_BASE_PATH / "core" / "script" / "dynsub")
+        try:
+            npm_cmd = shutil.which("npm")
+            if npm_cmd is None:
+                log.warning(
+                    "Cannot find npm. Will not be able to extract dynamic substitutions."
+                )
+                raise FileNotFoundError
+            subprocess.run([npm_cmd, "install"])
+        except Exception as e:
+            log.warning(
+                f"Unable to install npm packages for dynamic substitutions: {e}"
+            )
+            log.debug(e, exc_info=True)
+            return
 
 
 def resource_base_path() -> Path:

pretext/utils.py

@@ -559,6 +559,54 @@ def ensure_css_node_modules() -> None:
             log.debug("", exc_info=True)
 
 
+def ensure_dynsub_node_modules() -> None:
+    # Look for node_modules and install if we can.
+    with working_directory(
+        resources.resource_base_path() / "core" / "script" / "dynsub"
+    ):
+        # Make sure node version is at least 22.10:
+        try:
+            node_cmd = shutil.which("node")
+            if node_cmd is None:
+                log.warning(
+                    "Node.js must be installed to extract dynamic substitutions.  Please install node.js and npm."
+                )
+                raise FileNotFoundError
+            node_version = subprocess.run([node_cmd, "-v"], capture_output=True)
+            log.debug(f"Node version: {node_version.stdout.decode()}")
+            node_version_decode = node_version.stdout.decode().split(".")
+            main_version = int(node_version_decode[0][1:])
+            sub_version = int(node_version_decode[1])
+            if main_version < 22 | (main_version == 22 and sub_version < 10):
+                log.warning(
+                    "Node version must be at least 22.10 to extract dynamic substitutions.  Please update node.js and npm."
+                )
+                return
+        except Exception as e:
+            log.debug(e)
+            log.debug("", exc_info=True)
+        # Check if node_modules is already present:
+        if Path("node_modules").exists():
+            log.debug("Node modules already installed.")
+            return
+        # If not, try to install them:
+        log.debug(
+            "Attempting to install/update required node packages extract dynamic susbstitutions."
+        )
+        try:
+            npm_cmd = shutil.which("npm")
+            if npm_cmd is None:
+                log.warning("Cannot find npm. Install npm and try again.")
+                raise FileNotFoundError
+            subprocess.run([npm_cmd, "install"])
+        except Exception as e:
+            log.warning(
+                "Unable to install npm packages. Unable to extract dynamic substitutions."
+            )
+            log.warning(e)
+            log.debug("", exc_info=True)
+
+
 def playwright_install() -> None:
     """
     Run `playwright install` to ensure that its required browsers and tools are available to it.