Output the preview url in case of drafts (#681)

* return preview_url from deploy

Author: amol-

rsconnect/api.py

@@ -46,9 +46,9 @@
 # they should both come from the same typing module.
 # https://peps.python.org/pep-0655/#usage-in-python-3-11
 if sys.version_info >= (3, 11):
-    from typing import NotRequired, TypedDict
+    from typing import TypedDict
 else:
-    from typing_extensions import NotRequired, TypedDict
+    from typing_extensions import TypedDict
 
 from . import validation
 from .bundle import _default_title
@@ -331,10 +331,11 @@ def __init__(self, url: str):
 
 
 class RSConnectClientDeployResult(TypedDict):
-    task_id: NotRequired[str]
+    task_id: str | None
     app_id: str
-    app_guid: str
+    app_guid: str | None
     app_url: str
+    preview_url: str | None
     title: str | None
 
 
@@ -569,11 +570,17 @@ def deploy(
 
         task = self.content_deploy(app_guid, app_bundle["id"], activate=activate)
 
+        # http://ADDRESS/preview/APP_GUID/BUNDLE_ID
+        # Using replace makes this a bit more robust to changes in the URL structure
+        # like connect being served on a subpath.
+        preview_url = app["url"].replace("/content/", "/preview/") + f"/{app_bundle['id']}"
+
         return {
             "task_id": task["task_id"],
             "app_id": app_id,
             "app_guid": app["guid"],
             "app_url": app["url"],
+            "preview_url": preview_url if not activate else None,
             "title": app["title"],
         }
 
@@ -1079,12 +1086,14 @@ def deploy_bundle(self, activate: bool = True):
             print("Application successfully deployed to {}".format(prepare_deploy_result.app_url))
             webbrowser.open_new(prepare_deploy_result.app_url)
 
-            self.deployed_info = {
-                "app_url": prepare_deploy_result.app_url,
-                "app_id": prepare_deploy_result.app_id,
-                "app_guid": None,
-                "title": self.title,
-            }
+            self.deployed_info = RSConnectClientDeployResult(
+                app_url=prepare_deploy_result.app_url,
+                app_id=str(prepare_deploy_result.app_id),
+                app_guid=None,
+                task_id=None,
+                preview_url=None,
+                title=self.title,
+            )
             return self
 
     def emit_task_log(
@@ -1127,7 +1136,9 @@ def emit_task_log(
             app_dashboard_url = app_config.get("config_url")
             log_callback.info("Deployment completed successfully.")
             log_callback.info("\t Dashboard content URL: %s", app_dashboard_url)
-            log_callback.info("\t Direct content URL: %s", self.deployed_info["app_url"])
+            log_callback.info(
+                "\t Direct content URL: %s", self.deployed_info["preview_url"] or self.deployed_info["app_url"]
+            )
 
         return self
 

rsconnect/http_support.py

@@ -405,7 +405,15 @@ def _do_request(
                     for key, value in response.getheaders():
                         logger.debug("--> %s: %s" % (key, value))
                     logger.debug("Body:")
-                    logger.debug("--> %s" % response_body)
+                    if response.getheader("Content-Type", "").startswith("application/json"):
+                        # Only print JSON responses.
+                        # Otherwise we end up dumping entire web pages to the log.
+                        try:
+                            logger.debug("--> %s" % response_body)
+                        except json.JSONDecodeError:
+                            logger.debug("--> <invalid JSON>")
+                    else:
+                        logger.debug("--> <non-json-response>")
             finally:
                 if local_connection:
                     self.__exit__()

tests/test_main.py

@@ -113,7 +113,7 @@ def test_deploy(self):
         ],
     )
     @httpretty.activate(verbose=True, allow_net_connect=False)
-    def test_deploy_draft(self, command, target, expected_activate):
+    def test_deploy_draft(self, command, target, expected_activate, caplog):
         original_api_key_value = os.environ.pop("CONNECT_API_KEY", None)
         original_server_value = os.environ.pop("CONNECT_SERVER", None)
 
@@ -146,7 +146,7 @@ def test_deploy_draft(self, command, target, expected_activate):
                     "id": "1234-5678-9012-3456",
                     "guid": "1234-5678-9012-3456",
                     "title": "app5",
-                    "url": "http://fake_server/apps/1234-5678-9012-3456",
+                    "url": "http://fake_server/content/1234-5678-9012-3456",
                 }
             ),
             adding_headers={"Content-Type": "application/json"},
@@ -241,10 +241,19 @@ def post_application_deploy_callback(request, uri, response_headers):
                 # Do not validate app mode, so that the "target" content doesn't matter.
                 "rsconnect.api.RSConnectExecutor.validate_app_mode",
                 new=lambda self_, *args, **kwargs: self_,
+            ), caplog.at_level(
+                "INFO"
             ):
                 result = runner.invoke(cli, args)
             assert result.exit_code == 0, result.output
             assert deploy_api_invoked == [True]
+            assert "Deployment completed successfully." in caplog.text
+            if expected_activate:
+                assert "Direct content URL: http://fake_server/content/1234-5678-9012-3456" in caplog.text
+            else:
+                assert (
+                    "Direct content URL: http://fake_server/preview/1234-5678-9012-3456/FAKE_BUNDLE_ID" in caplog.text
+                )
         finally:
             if original_api_key_value:
                 os.environ["CONNECT_API_KEY"] = original_api_key_value