add tests for export resolution

Author: rmorshea

src/idom/web/utils.py

@@ -18,43 +18,50 @@ def web_module_path(name: str) -> Path:
 
 
 def resolve_module_exports_from_file(file: Path, max_depth: int) -> Set[str]:
-    export_names, references = resolve_module_exports_from_source(file.read_text())
     if max_depth == 0:
-        logger.warning(f"Unable to resolve all exports for {file}")
-    else:
-        for ref in references:
-            if urlparse(ref).scheme:  # is an absolute URL
-                export_names.update(resolve_module_exports_from_url(ref, max_depth - 1))
-            elif ref.startswith("."):
-                path = _resolve_relative_file_path(file, ref)
-                export_names.update(
-                    resolve_module_exports_from_file(path, max_depth - 1)
-                )
-            else:
-                logger.warning(f"Did not resolve exports for unknown location {ref}")
+        logger.warning(f"Did not resolve all exports for {file} - max depth reached")
+        return set()
+    elif not file.exists():
+        logger.warning(f"Did not resolve exports for unknown file {file}")
+        return set()
+
+    export_names, references = resolve_module_exports_from_source(file.read_text())
+
+    for ref in references:
+        if urlparse(ref).scheme:  # is an absolute URL
+            export_names.update(resolve_module_exports_from_url(ref, max_depth - 1))
+        else:
+            path = _resolve_relative_file_path(file, ref)
+            export_names.update(resolve_module_exports_from_file(path, max_depth - 1))
+
     return export_names
 
 
 def resolve_module_exports_from_url(url: str, max_depth: int) -> Set[str]:
-    export_names, references = resolve_module_exports_from_source(
-        requests.get(url).text
-    )
     if max_depth == 0:
-        logger.warning(f"Unable to fully resolve all exports for {url}")
-    else:
-        for ref in references:
-            url = _resolve_relative_url(url, ref)
-            export_names.update(resolve_module_exports_from_url(url, max_depth - 1))
+        logger.warning(f"Did not resolve all exports for {url} - max depth reached")
+        return set()
+
+    try:
+        text = requests.get(url).text
+    except requests.exceptions.ConnectionError as error:
+        reason = "" if error is None else " - {error.errno}"
+        logger.warning("Did not resolve exports for url " + url + reason)
+        return set()
+
+    export_names, references = resolve_module_exports_from_source(text)
+
+    for ref in references:
+        url = _resolve_relative_url(url, ref)
+        export_names.update(resolve_module_exports_from_url(url, max_depth - 1))
+
     return export_names
 
 
 def resolve_module_exports_from_source(content: str) -> Tuple[Set[str], Set[str]]:
     names: Set[str] = set()
     references: Set[str] = set()
-    for export in _JS_EXPORT_PATTERN.findall(
-        # strip comments
-        _JS_LINE_COMMENT.sub("", content)
-    ):
+    for export in _JS_EXPORT_PATTERN.findall(content):
         export = export.rstrip(";").strip()
         # Exporting individual features
         if export.startswith("let "):
@@ -112,5 +119,4 @@ def _resolve_relative_url(base_url: str, rel_url: str) -> str:
     return f"{base_url}/{rel_url}"
 
 
-_JS_LINE_COMMENT = re.compile(r"//.*$")
 _JS_EXPORT_PATTERN = re.compile(r";?\s*export(?=\s+|{)(.*?(?:;|}\s*))", re.MULTILINE)

tests/test_web/js_fixtures/export-resolution/index.js

@@ -0,0 +1,2 @@
+export {index as Index};
+export * from "./one.js";

tests/test_web/js_fixtures/export-resolution/one.js

@@ -0,0 +1,2 @@
+export {one as One};
+export * from "./two.js";

tests/test_web/js_fixtures/export-resolution/two.js

@@ -0,0 +1,2 @@
+export {two as Two};
+export * from "https://some.external.url";

tests/test_web/js_fixtures/exports-syntax.js

@@ -16,8 +16,8 @@ export { variable1 as name10, variable2 as name11, name12 };
 export const { name13, name14: bar } = o;
 
 // Aggregating modules
-export * from "source1"; // does not set the default export
-export * from "source2"; // does not set the default export
-export * as name15 from "source3"; // Draft ECMAScript® 2O21
-export { name16, name17 } from "source4";
-export { import1 as name18, import2 as name19, name20 } from "source5";
+export * from "https://source1.com"; // does not set the default export
+export * from "https://source2.com"; // does not set the default export
+export * as name15 from "https://source3.com"; // Draft ECMAScript® 2O21
+export { name16, name17 } from "https://source4.com";
+export { import1 as name18, import2 as name19, name20 } from "https://source5.com";

tests/test_web/test_utils.py

@@ -1,13 +1,90 @@
 from pathlib import Path
 
 import pytest
+import responses
 
-from idom.web.utils import resolve_module_exports_from_source
+from idom.web.utils import (
+    resolve_module_exports_from_file,
+    resolve_module_exports_from_source,
+    resolve_module_exports_from_url,
+)
 
 
 JS_FIXTURES_DIR = Path(__file__).parent / "js_fixtures"
 
 
+@responses.activate
+def test_resolve_module_exports_from_file(caplog):
+    responses.add(
+        responses.GET,
+        "https://some.external.url",
+        body="export {something as ExternalUrl}",
+    )
+    path = JS_FIXTURES_DIR / "export-resolution" / "index.js"
+    assert resolve_module_exports_from_file(path, 4) == {
+        "Index",
+        "One",
+        "Two",
+        "ExternalUrl",
+    }
+
+
+def test_resolve_module_exports_from_file_log_on_max_depth(caplog):
+    path = JS_FIXTURES_DIR / "export-resolution" / "index.js"
+    assert resolve_module_exports_from_file(path, 0) == set()
+    assert len(caplog.records) == 1
+    assert caplog.records[0].message.endswith("max depth reached")
+
+    caplog.records.clear()
+
+    assert resolve_module_exports_from_file(path, 2) == {"Index", "One"}
+    assert len(caplog.records) == 1
+    assert caplog.records[0].message.endswith("max depth reached")
+
+
+def test_resolve_module_exports_from_file_log_on_unknown_file_location(
+    caplog, tmp_path
+):
+    file = tmp_path / "some.js"
+    file.write_text("export * from './does-not-exist.js';")
+    resolve_module_exports_from_file(file, 2)
+    assert len(caplog.records) == 1
+    assert caplog.records[0].message.startswith(
+        "Did not resolve exports for unknown file"
+    )
+
+
+@responses.activate
+def test_resolve_module_exports_from_url():
+    responses.add(
+        responses.GET,
+        "https://first.url",
+        body="export const First = 1; export * from 'https://second.url';",
+    )
+    responses.add(
+        responses.GET,
+        "https://second.url",
+        body="export const Second = 2;",
+    )
+
+    assert resolve_module_exports_from_url("https://first.url", 2) == {
+        "First",
+        "Second",
+    }
+
+
+def test_resolve_module_exports_from_url_log_on_max_depth(caplog):
+    assert resolve_module_exports_from_url("https://some.url", 0) == set()
+    assert len(caplog.records) == 1
+    assert caplog.records[0].message.endswith("max depth reached")
+
+
+def test_resolve_module_exports_from_url_log_on_bad_response(caplog):
+    assert resolve_module_exports_from_url("https://some.url", 1) == set()
+    assert len(caplog.records) == 1
+    assert caplog.records[0].message.startswith("Did not resolve exports for url")
+
+
 @pytest.mark.parametrize(
     "text",
     [
@@ -36,5 +113,5 @@ def test_resolve_module_exports_from_source():
                 "ClassName",
             }
         )
-        and references == {"source1", "source2"}
+        and references == {"https://source1.com", "https://source2.com"}
     )