renamed reserved endpoints of Reflex (#1542)

This commit is contained in:
Thomas Brandého 2023-08-30 18:33:54 +02:00 committed by GitHub
parent 689f078aa3
commit bb44fcdaa1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 11 deletions

View File

@ -255,8 +255,8 @@ class Endpoint(Enum):
"""Endpoints for the reflex backend API."""
PING = "ping"
EVENT = "event"
UPLOAD = "upload"
EVENT = "_event"
UPLOAD = "_upload"
def __str__(self) -> str:
"""Get the string representation of the endpoint.

View File

@ -361,7 +361,7 @@ class AppHarness:
raise RuntimeError("App is not running.")
event_ns: EventNamespace = cast(
EventNamespace,
self.app_instance.sio.namespace_handlers["/event"],
self.app_instance.event_namespace,
)
pending: list[Coroutine[Any, Any, Any]] = []
for state in self.app_instance.state_manager.states.values():

View File

@ -3,7 +3,8 @@ import os
import pytest
import reflex as rx
from reflex.config import get_config
import reflex.config
from reflex.constants import Endpoint
def test_requires_app_name():
@ -64,7 +65,7 @@ def test_update_from_env(base_config_values, monkeypatch, env_var, value):
env_var: The environment variable name.
value: The environment variable value.
"""
monkeypatch.setenv(env_var, value)
monkeypatch.setenv(env_var, str(value))
assert os.environ.get(env_var) == str(value)
config = rx.Config(**base_config_values)
assert getattr(config, env_var.lower()) == value
@ -73,11 +74,20 @@ def test_update_from_env(base_config_values, monkeypatch, env_var, value):
@pytest.mark.parametrize(
"kwargs, expected",
[
({"app_name": "test_app", "api_url": "http://example.com"}, "/event"),
({"app_name": "test_app", "api_url": "http://example.com/api"}, "/api/event"),
({"app_name": "test_app", "event_namespace": "/event"}, "/event"),
({"app_name": "test_app", "event_namespace": "event"}, "/event"),
({"app_name": "test_app", "event_namespace": "event/"}, "/event"),
(
{"app_name": "test_app", "api_url": "http://example.com"},
f"{Endpoint.EVENT}",
),
(
{"app_name": "test_app", "api_url": "http://example.com/api"},
f"/api{Endpoint.EVENT}",
),
({"app_name": "test_app", "event_namespace": "/event"}, f"/event"),
({"app_name": "test_app", "event_namespace": "event"}, f"/event"),
({"app_name": "test_app", "event_namespace": "event/"}, f"/event"),
({"app_name": "test_app", "event_namespace": "/_event"}, f"{Endpoint.EVENT}"),
({"app_name": "test_app", "event_namespace": "_event"}, f"{Endpoint.EVENT}"),
({"app_name": "test_app", "event_namespace": "_event/"}, f"{Endpoint.EVENT}"),
],
)
def test_event_namespace(mocker, kwargs, expected):
@ -91,5 +101,6 @@ def test_event_namespace(mocker, kwargs, expected):
conf = rx.Config(**kwargs)
mocker.patch("reflex.config.get_config", return_value=conf)
config = get_config()
config = reflex.config.get_config()
assert conf == config
assert config.get_event_namespace() == expected