rio/tests/test_url_patterns.py

"""
Matches URL patterns to URLs, verifying that they match what they should.
"""

import typing as t
import warnings

import pytest

import rio
import rio.app_server
from rio.url_pattern import UrlPattern


@pytest.mark.parametrize(
    "pattern, exception",
    [
        # Leading slash
        (
            "/foo",
            ValueError,
        ),
        # Trailing slash
        (
            "foo/",
            ValueError,
        ),
        # Just slashes
        (
            "/",
            ValueError,
        ),
        (
            "//",
            ValueError,
        ),
        # Multiple consecutive slashes
        (
            "foo//bar",
            ValueError,
        ),
        (
            "foo///bar",
            ValueError,
        ),
        # Unterminated path parameter
        (
            "foo/{param",
            ValueError,
        ),
        (
            "foo/{param:path",
            ValueError,
        ),
        (
            "foo/param}",
            ValueError,
        ),
        (
            "foo/param:path}",
            ValueError,
        ),
        # Invalid path parameter names
        (
            "{???}",
            ValueError,
        ),
        (
            "{param}/{param}",
            ValueError,
        ),
    ],
)
def test_invalid_url_pattern(
    pattern: str,
    exception: t.Type[Exception],
) -> None:
    """
    Tests that invalid patterns raise the correct exceptions.
    """
    with pytest.raises(exception):
        UrlPattern(pattern)


@pytest.mark.parametrize(
    "url, pattern_str, values_should, remaining_should",
    [
        # Empty match (as used in the home page)
        (
            "",
            "",
            {},
            "",
        ),
        # Single segment
        (
            "foo",
            "foo",
            {},
            "",
        ),
        (
            "foo/bar",
            "foo",
            {},
            "bar",
        ),
        # Multiple segments
        (
            "foo/bar/baz",
            "foo/bar",
            {},
            "baz",
        ),
        # Single path parameter
        (
            "foo",
            "{param}",
            {"param": "foo"},
            "",
        ),
        (
            "foo/bar",
            "{param}",
            {"param": "foo"},
            "bar",
        ),
        (
            "foo/bar",
            "foo/{param}",
            {"param": "bar"},
            "",
        ),
        (
            "foo/bar/baz",
            "foo/{param}",
            {"param": "bar"},
            "baz",
        ),
        (
            "foo/bar/baz/qux",
            "foo/{param}/baz",
            {"param": "bar"},
            "qux",
        ),
        # Multiple path parameters
        (
            "foo/bar/baz",
            "foo/{param1}/{param2}",
            {"param1": "bar", "param2": "baz"},
            "",
        ),
        (
            "foo/bar/baz/qux/quux",
            "foo/{param1}/baz/{param2}",
            {"param1": "bar", "param2": "qux"},
            "quux",
        ),
        # "Greedy" path parameter
        (
            "foo/bar/baz",
            "{param:path}",
            {"param": "foo/bar/baz"},
            "",
        ),
        (
            "foo/bar/baz",
            "foo/{param:path}",
            {"param": "bar/baz"},
            "",
        ),
        (
            "foo/bar/baz/qux/quux",
            "foo/{param1}/{param2:path}",
            {"param1": "bar", "param2": "baz/qux/quux"},
            "",
        ),
        (
            "foo/bar/baz/qux/quux",
            "{param:path}/qux",
            {"param": "foo/bar/baz"},
            "quux",
        ),
    ],
)
def test_url_pattern_should_match(
    url: str,
    pattern_str: str,
    values_should: dict[str, str],
    remaining_should: str,
) -> None:
    """
    Matches patterns to URLs and verifies that they match what they should. All
    provided patterns must match their URLs.
    """
    # Parse the pattern
    pattern_object = UrlPattern(pattern_str)

    # Match the URL
    did_match, values_are, remaining_are = pattern_object.match(url)

    # Verify that the URL matched
    assert did_match

    # Verify that the values are correct
    assert values_are == values_should

    # Verify that the remaining part of the URL is correct
    assert remaining_are == remaining_should


@pytest.mark.parametrize(
    "url, pattern_str",
    [
        (
            "foo",
            "",
        ),
        (
            "foo",
            "bar",
        ),
        (
            "foo",
            "foo/bar",
        ),
        (
            "users/foo",
            "user/{user_id}",
        ),
        (
            "",
            "{user_id}",
        ),
    ],
)
def test_url_pattern_should_not_match(
    url: str,
    pattern_str: str,
) -> None:
    """
    Matches patterns to URLs, verifying that they **don't** match.
    """
    # Parse the pattern
    pattern_object = UrlPattern(pattern_str)

    # Match the URL
    matched, _, _ = pattern_object.match(url)

    # Verify that the URL did not match
    assert not matched


def _build_empty() -> None:
    pass


def _build_and_verify_bool(param: rio.QueryParameter[bool] = True) -> None:
    assert isinstance(param, bool)


def _build_and_verify_int(param: rio.QueryParameter[int] = 123) -> None:
    assert isinstance(param, int) and not isinstance(param, (bool, float))


def _build_and_verify_float(param: rio.QueryParameter[float] = 123.4) -> None:
    assert isinstance(param, float) and not isinstance(param, (bool, int))


def _build_and_verify_str(
    param: rio.QueryParameter[str] = "default-value",
) -> None:
    assert isinstance(param, str)


def _build_and_verify_optional_bool(
    param: rio.QueryParameter[bool | None] = None,
) -> None:
    assert param is None or isinstance(param, bool)


def _build_and_verify_string_literal(
    param: rio.QueryParameter[t.Literal["foo", "bar"]] = "bar",
) -> None:
    assert param in ("foo", "bar")


def _build_and_verify_int_literal(
    param: rio.QueryParameter[t.Literal[1, 2, 3]] = 1,
) -> None:
    assert param in (1, 2, 3)


def _build_and_verify_float_literal(
    param: rio.QueryParameter[t.Literal[1.2, 3.4, 5.6]] = 1.2,  # type: ignore (are you kidding me, pyright?!)
) -> None:
    assert param in (1.2, 3.4, 5.6)


def _build_and_verify_bool_literal(
    param: rio.QueryParameter[t.Literal[False]] = False,
) -> None:
    assert param is False


@pytest.mark.parametrize(
    "url_str, pattern, build_function, kwargs_should",
    [
        (
            "foo/bar",
            "foo/bar",
            _build_empty,
            {},
        ),
        # Single path parameters of all types
        (
            "true",
            "{param}",
            _build_and_verify_bool,
            {"param": True},
        ),
        (
            "false",
            "{param}",
            _build_and_verify_bool,
            {"param": False},
        ),
        (
            "-1",
            "{param}",
            _build_and_verify_int,
            {"param": -1},
        ),
        (
            "0",
            "{param}",
            _build_and_verify_int,
            {"param": 0},
        ),
        (
            "1",
            "{param}",
            _build_and_verify_int,
            {"param": 1},
        ),
        (
            "-1.0",
            "{param}",
            _build_and_verify_float,
            {"param": -1.0},
        ),
        (
            "0.0",
            "{param}",
            _build_and_verify_float,
            {"param": 0.0},
        ),
        (
            "1.0",
            "{param}",
            _build_and_verify_float,
            {"param": 1.0},
        ),
        (
            "foo",
            "{param}",
            _build_and_verify_str,
            {"param": "foo"},
        ),
        (
            "false",
            "{param}",
            _build_and_verify_optional_bool,
            {"param": False},
        ),
        (
            "foo",
            "{param}",
            _build_and_verify_string_literal,
            {"param": "foo"},
        ),
        (
            "bar",
            "{param}",
            _build_and_verify_string_literal,
            {"param": "bar"},
        ),
        (
            "3",
            "{param}",
            _build_and_verify_int_literal,
            {"param": 3},
        ),
        (
            "3.4",
            "{param}",
            _build_and_verify_float_literal,
            {"param": 3.4},
        ),
        (
            "no",
            "{param}",
            _build_and_verify_bool_literal,
            {"param": False},
        ),
        # Query parameters
        (
            "foo?param=baz",
            "foo",
            _build_and_verify_str,
            {"param": "baz"},
        ),
        # Default fallback: Missing parameter
        #
        # The current implementation simply doesn't pass these values to the
        # build function, relying on Python to impute the default. Hence the
        # empty expected dictionaries.
        (
            "foo",
            "foo",
            _build_and_verify_bool,
            {},
        ),
        (
            "foo",
            "foo",
            _build_and_verify_int,
            {},
        ),
        (
            "foo",
            "foo",
            _build_and_verify_float,
            {},
        ),
        (
            "foo",
            "foo",
            _build_and_verify_str,
            {},
        ),
        (
            "foo",
            "foo",
            _build_and_verify_string_literal,
            {},
        ),
        # Default fallback: Invalid parameter value
        (
            "foo?param=bar",
            "foo",
            _build_and_verify_bool,
            {},
        ),
        (
            "foo?param=bar",
            "foo",
            _build_and_verify_int,
            {},
        ),
        (
            "foo?param=bar",
            "foo",
            _build_and_verify_float,
            {},
        ),
        (
            "foo?param=hello",
            "foo",
            _build_and_verify_string_literal,
            {},
        ),
        (
            "foo?param=yes",
            "foo",
            _build_and_verify_bool_literal,
            {},
        ),
        # TODO: Multiple parameters
    ],
)
def test_parse_url_kwargs(
    url_str: str,
    pattern: str,
    build_function: t.Callable[..., t.Any],
    kwargs_should: dict[str, object],
) -> None:
    """
    Matches URLs against patterns, ensuring the parameters are correctly
    extracted and parsed.
    """
    # Create a component page object
    page = rio.ComponentPage(
        name="Test Page",
        url_segment=pattern,
        build=build_function,
    )

    # Parse the provided URL
    url = rio.URL(url_str)
    did_match, raw_path_arguments, remaining_url = page._url_pattern.match(
        url.path,
    )

    assert did_match
    assert remaining_url == ""

    # Get the kwargs for the build function
    kwargs_are = {
        name: page._url_parameter_parsers[name].parse(value)
        for name, value in raw_path_arguments.items()
    }
    kwargs_are.update(page._parse_query_parameters(url.query))

    # Verify that the kwargs are correct
    assert kwargs_are == kwargs_should


def test_layout_parameters_arent_url_parameters() -> None:
    # When a Component is used as the `build` function, layout properties like
    # `grow_x` must not be controllable via the URL.
    class MyComponent(rio.Component):
        foo: rio.QueryParameter[int] = 0

        def build(self) -> rio.Component:
            return rio.Text(str(self.foo))

    page = rio.ComponentPage(
        name="Test Page",
        url_segment="foobar",
        build=MyComponent,
    )

    kwargs = page._parse_query_parameters(
        {
            "foo": "7",
            "key": "0",
            "grow_x": "true",
            "grow_y": "1",
            "min_width": "5",
            "min_height": "5",
            "margin": "5",
            "_id_": "5",
        },
    )

    assert kwargs == {"foo": 7}


def test_annotations_dont_have_to_be_resolvable():
    # The type annotation is invalid, but it's quite clearly not supposed to be
    # a query parameter, so it should be silently ignored.
    def build(foo: "oops" = 0):  # type: ignore
        return rio.Text(str(foo))

    with warnings.catch_warnings(record=True) as warnings_list:
        rio.ComponentPage(
            name="Test Page",
            url_segment="foobar",
            build=build,
        )

    assert not warnings_list


def test_unresolvable_annotation_warning():
    # The type annotation is invalid, but it's likely meant to be a query
    # parameter, so rio should emit a warning.
    def build(foo: "QueryParameter[int]" = 0):  # type: ignore
        return rio.Text(str(foo))

    with warnings.catch_warnings(record=True) as warnings_list:
        rio.ComponentPage(
            name="Test Page",
            url_segment="foobar",
            build=build,
        )

    assert len(warnings_list) == 1


def test_valid_urls_list():
    def build_search(query: rio.QueryParameter[str] = ""):
        return rio.Text(query)

    def build_user_profile_page(user_id: int):
        return rio.Text(str(user_id))

    def build_switch_page(switch: bool):
        return rio.Switch(switch)

    def build_docs(
        version: t.Literal[1, 2, 3],
        section: t.Literal["tutorial", "api"],
    ):
        return rio.Text(f"{section} v{version}")

    def build_docs_subpage(param: t.Literal["foo", "bar"]):
        return rio.Text(param)

    app = rio.App(
        name="Test App",
        pages=[
            # Static URL
            rio.ComponentPage(
                name="Home",
                url_segment="",
                build=rio.Spacer,
            ),
            # Static URL + query parameter
            rio.ComponentPage(
                name="Search",
                url_segment="search",
                build=build_search,
            ),
            # Dynamic URL with `int` parameter
            rio.ComponentPage(
                name="Users",
                url_segment="user/{user_id}",
                build=build_user_profile_page,
            ),
            # Dynamic URL with `bool` parameter
            rio.ComponentPage(
                name="Switch",
                url_segment="switch/{switch}",
                build=build_switch_page,
            ),
            # Dynamic URL with literal parameters *and* subpages
            rio.ComponentPage(
                name="Docs",
                url_segment="docs/{version}/{section}",
                build=build_docs,
                children=[
                    rio.ComponentPage(
                        name="Docs Subpage",
                        url_segment="{param}",
                        build=build_docs_subpage,
                    ),
                ],
            ),
        ],
    )

    urls = set[str]()
    for url in app._iter_page_urls(include_redirects=False):
        assert url not in urls, f"Duplicate URL: {url}"
        urls.add(url)

    assert urls == {
        "",
        "search",
        # No `user/` url because its parameter is an int, and there are infinite
        # ints
        "switch/true",
        "switch/false",
        # No bare `docs/x/y` because there is no subpage with `url_segment=""`
        "docs/1/tutorial/foo",
        "docs/1/tutorial/bar",
        "docs/1/api/foo",
        "docs/1/api/bar",
        "docs/2/tutorial/foo",
        "docs/2/tutorial/bar",
        "docs/2/api/foo",
        "docs/2/api/bar",
        "docs/3/tutorial/foo",
        "docs/3/tutorial/bar",
        "docs/3/api/foo",
        "docs/3/api/bar",
    }