Better raverse package export patterns

Author: codingjoe

django_esm/templatetags/esm.py

@@ -11,8 +11,19 @@
 
 
 @register.simple_tag
-@functools.lru_cache
 def importmap():
+    fn = _importmap if settings.DEBUG else _cached_importmap
+    return fn()
+
+
+functools.lru_cache()
+
+
+def _cached_importmap():
+    return _importmap()
+
+
+def _importmap():
     with (settings.BASE_DIR / "package.json").open() as f:
         package_json = json.load(f)
     return mark_safe(  # nosec

django_esm/utils.py

@@ -1,4 +1,6 @@
+import itertools
 import json
+import re
 from pathlib import Path
 
 from django.conf import settings
@@ -24,28 +26,32 @@ def parse_root_package(package_json):
         url = mod
         if mod[0] in [".", "/"]:
             # local file
-            if mod.endswith("/*"):
-                mod = mod[:-1]
-                module_name = module_name[:-1]
-            url = get_static_from_abs_path(settings.BASE_DIR / mod)
-        yield module_name, url
+            yield from get_static_from_abs_path(module_name, settings.BASE_DIR / mod)
+        else:
+            yield module_name, url
 
     for dep_name, dep_version in package_json.get("dependencies", {}).items():
         yield from parse_package_json(settings.BASE_DIR / "node_modules" / dep_name)
 
 
-def get_static_from_abs_path(path: Path):
+def get_static_from_abs_path(mod: str, path: Path):
     for finder in get_finders():
         for storage in finder.storages.values():
             try:
                 rel_path = path.relative_to(Path(storage.location).resolve())
             except ValueError:
                 pass
             else:
-                if path.is_dir():
-                    return settings.STATIC_URL + str(rel_path) + "/"
-                return staticfiles_storage.url(str(rel_path))
-    raise ValueError(f"Could not find {path} in staticfiles")
+                if "*" in mod:
+                    for match in Path(storage.location).rglob(
+                        str(rel_path).replace("*", "**/*")
+                    ):
+                        sp = str(match.relative_to(Path(storage.location).resolve()))
+                        pattern = re.escape(str(rel_path)).replace(r"\*", r"(.*)")
+                        bit = re.match(pattern, sp).group(1)
+                        yield mod.replace("*", bit), staticfiles_storage.url(sp)
+                else:
+                    yield mod, staticfiles_storage.url(str(rel_path))
 
 
 # There is a long history how ESM is supported in Node.js
@@ -71,6 +77,18 @@ def cast_exports(package_json):
     return exports
 
 
+def find_default_key(module):
+    try:
+        yield module["default"]
+    except TypeError:
+        if isinstance(module, list):
+            yield from itertools.chain(*(find_default_key(i) for i in module))
+        else:
+            yield module
+    except KeyError:
+        yield from find_default_key(module["import"])
+
+
 def parse_package_json(path: Path = None):
     """Parse a project main package.json and return a dict of importmap entries."""
     with (path / "package.json").open() as f:
@@ -80,18 +98,19 @@ def parse_package_json(path: Path = None):
     exports = cast_exports(package_json)
 
     for module_name, module in exports.items():
-        try:
-            mod = module["default"]
-        except TypeError:
-            mod = module
+        module = next(find_default_key(module))
 
         yield str(Path(name) / module_name), staticfiles_storage.url(
-            str((path / mod).resolve().relative_to(settings.BASE_DIR / "node_modules"))
+            str(
+                (path / module)
+                .resolve()
+                .relative_to(settings.BASE_DIR / "node_modules")
+            )
         )
 
-    if (path / "node_modules").exists():
-        node_modules = path / "node_modules"
-    else:
-        node_modules = path / "/".join(".." for _ in Path(name).parts)
     for dep_name, dep_version in dependencies.items():
-        yield from parse_package_json(node_modules / dep_name)
+        dep_path = path
+        while not (dep_path / "node_modules" / dep_name).exists():
+            dep_path /= ".."
+
+        yield from parse_package_json((dep_path / "node_modules" / dep_name).resolve())

tests/test_utils.py

@@ -17,7 +17,7 @@ def test_parse_root_package(package_json):
     )
     assert import_map["lit-html"] == "/static/lit-html/lit-html.js"
     assert import_map["#index"] == "/static/js/index.js"
-    assert import_map["#components/"] == "/static/js/components/"
+    assert import_map["#components/index.js"] == "/static/js/components/index.js"
     assert import_map["#htmx"] == "https://unpkg.com/htmx.org@1.9.10"
 
 
@@ -47,6 +47,4 @@ def test_cast_exports():
 
 
 def test_get_static_from_abs_path():
-    with pytest.raises(ValueError) as e:
-        utils.get_static_from_abs_path(Path("/foo/bar"))
-    assert "Could not find" in str(e.value)
+    assert not list(utils.get_static_from_abs_path("#some-module", Path("/foo/bar")))