Restructuring and adding tests

Author: elnelson575

shiny/_main.py

@@ -333,9 +333,6 @@ def run_app(
 
     log_config: dict[str, Any] = copy.deepcopy(uvicorn.config.LOGGING_CONFIG)
 
-    # Workaround for nginx/uvicorn issue within Workbench
-    # https://github.com/rstudio/rstudio-pro/issues/7368#issuecomment-2918016088
-
     if reload_dirs is None:
         reload_dirs = []
         if app_dir is not None:
@@ -404,16 +401,7 @@ def run_app(
 
     maybe_setup_rsw_proxying(log_config)
 
-    if is_workbench() and kwargs.get("ws_per_message_deflate"):
-        # Workaround for nginx/uvicorn issue within Workbench
-        # https://github.com/rstudio/rstudio-pro/issues/7368#issuecomment-2918016088
-        warnings.warn(
-            "Overwriting kwarg 'ws_per_message_deflate'=True to False to avoid breaking issue in Workbench",
-            stacklevel=2,
-        )
-        kwargs["ws_per_message_deflate"] = False
-    elif is_workbench():
-        kwargs["ws_per_message_deflate"] = False
+    _set_workbench_kwargs(kwargs)
 
     uvicorn.run(  # pyright: ignore[reportUnknownMemberType]
         app,
@@ -729,6 +717,21 @@ class ReloadArgs(TypedDict):
     reload_dirs: NotRequired[list[str]]
 
 
+def _set_workbench_kwargs(kwargs: dict[str, object]) -> None:
+    print(kwargs)
+    if is_workbench():
+        print("hit")
+        if kwargs.get("ws_per_message_deflate"):
+            # Workaround for nginx/uvicorn issue within Workbench
+            # https://github.com/rstudio/rstudio-pro/issues/7368#issuecomment-2918016088
+            warnings.warn(
+                "Overwriting kwarg `ws_per_message_deflate=True` to `False` to avoid breaking issue in Workbench",
+                stacklevel=2,
+            )
+        kwargs["ws_per_message_deflate"] = False
+    print(kwargs)
+
+
 # Check that the version of rsconnect supports Shiny Express; can be removed in the
 # future once this version of rsconnect is widely used. The dependency on "packaging"
 # can also be removed then, because it is only used here. (Added 2024-03)

tests/pytest/test_main.py

@@ -0,0 +1,53 @@
+import os
+import warnings
+
+import pytest
+
+from shiny._main import _set_workbench_kwargs
+
+
+def test_workbench_kwargs_if_url_set():
+    """
+    Test that the `ws_per_message_deflate` kwarg is set to False when
+    RS_SERVER_URL and RS_SESSION_URL are set in the environment.
+    This is to avoid breaking issues in Workbench.
+    If the kwargs are set to True, a warning is raised and the value is set to False.
+    """
+    # Workbench URL is set, kwargs are not
+    os.environ["RS_SERVER_URL"] = "any_string"
+    os.environ["RS_SESSION_URL"] = "any_string"
+
+    kwargs = {}
+    _set_workbench_kwargs(kwargs)
+    assert kwargs.get("ws_per_message_deflate") is False
+
+    # kwarg have been set to True
+    kwargs = {
+        "ws_per_message_deflate": True,
+    }
+    with pytest.warns(UserWarning):
+        warnings.warn(
+            "Overwriting kwarg `ws_per_message_deflate=True` to `False` to avoid breaking issue in Workbench",
+            UserWarning,
+        )
+        _set_workbench_kwargs(kwargs)
+        assert kwargs.get("ws_per_message_deflate") is False
+
+    # Teardown
+    del os.environ["RS_SERVER_URL"]
+    del os.environ["RS_SESSION_URL"]
+
+
+def test_workbench_kwargs_if_url_not_set():
+    """
+    Test that the `ws_per_message_deflate` kwarg is not changed if the RS_SERVER_URL and RS_SESSION_URL environment variables are not set are set.
+    """
+    kwargs = {
+        "ws_per_message_deflate": True,
+    }
+    _set_workbench_kwargs(kwargs)
+    assert kwargs.get("ws_per_message_deflate") is True
+
+    kwargs = {}
+    _set_workbench_kwargs(kwargs)
+    assert kwargs.get("ws_per_message_deflate") is None