Warn when http URLs are configured (#14233)

* add a warning

* add test

* add test

* add changelog

* remove todo

* clarify http won't work in cloud

* Apply suggestions from code review

Co-authored-by: Sherin Thomas <sherin@grid.ai>

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Sherin Thomas <sherin@grid.ai>

Author: 3 people

src/lightning_app/CHANGELOG.md

@@ -21,11 +21,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 
 - Adds `LightningTrainingComponent`. `LightningTrainingComponent` orchestrates multi-node training in the cloud ([#13830](https://github.com/Lightning-AI/lightning/pull/13830))
-- Add support for printing application logs using CLI `lightning show logs <app_name> [components]` ([#13634](https://github.com/Lightning-AI/lightning/pull/13634))
 
 
+- Add support for printing application logs using CLI `lightning show logs <app_name> [components]` ([#13634](https://github.com/Lightning-AI/lightning/pull/13634))
+
 
 - Add support for `Lightning API` through the `configure_api` hook on the Lightning Flow and the `Post`, `Get`, `Delete`, `Put` HttpMethods ([#13945](https://github.com/Lightning-AI/lightning/pull/13945))
+
+
+- Added a warning when `configure_layout` returns URLs configured with http instead of https ([#14233](https://github.com/Lightning-AI/lightning/pull/14233))
+
+
 ### Changed
 
 - Default values and parameter names for Lightning AI BYOC cluster management ([#14132](https://github.com/Lightning-AI/lightning/pull/14132))

src/lightning_app/utilities/cloud.py

@@ -1,3 +1,4 @@
+import os
 import warnings
 
 from lightning_cloud.openapi import V1Membership
@@ -34,3 +35,8 @@ def _get_project(client: LightningClient, project_id: str = LIGHTNING_CLOUD_PROJ
 
 def _sigterm_flow_handler(*_, app: "lightning_app.LightningApp"):
     app.stage = AppStage.STOPPING
+
+
+def is_running_in_cloud() -> bool:
+    """Returns True if the Lightning App is running in the cloud."""
+    return "LIGHTNING_APP_STATE_URL" in os.environ

src/lightning_app/utilities/layout.py

@@ -1,8 +1,10 @@
 import inspect
+import warnings
 from typing import Dict, List, Union
 
 import lightning_app
 from lightning_app.frontend.frontend import Frontend
+from lightning_app.utilities.cloud import is_running_in_cloud
 
 
 def _add_comment_to_literal_code(method, contains, comment):
@@ -79,11 +81,17 @@ def _collect_content_layout(layout: List[Dict], flow: "lightning_app.LightningFl
                 f" For the value, choose either a reference to a child flow or a URla."
             )
         if isinstance(entry["content"], str):  # assume this is a URL
-            # The URL isn't fully defined yet. Looks something like ``self.work.url + /something``.
-            if entry["content"].startswith("/"):
+            url = entry["content"]
+            if url.startswith("/"):
+                # The URL isn't fully defined yet. Looks something like ``self.work.url + /something``.
                 entry["target"] = ""
             else:
-                entry["target"] = entry["content"]
+                entry["target"] = url
+            if url.startswith("http://") and is_running_in_cloud():
+                warnings.warn(
+                    f"You configured an http link {url[:32]}... but it won't be accessible in the cloud."
+                    f" Consider replacing 'http' with 'https' in the link above."
+                )
         elif isinstance(entry["content"], lightning_app.LightningFlow):
             entry["content"] = entry["content"].name
         elif isinstance(entry["content"], lightning_app.LightningWork):

tests/tests_app/core/lightning_app/test_configure_layout.py

@@ -218,3 +218,21 @@ def test_dynamic_content_layout_update():
     app = LightningApp(flow)
     MultiProcessRuntime(app).dispatch()
     assert flow.configure_layout_called == 5
+
+
+@mock.patch("lightning_app.utilities.layout.is_running_in_cloud", return_value=True)
+def test_http_url_warning(*_):
+    class Root(EmptyFlow):
+        def configure_layout(self):
+            return [
+                dict(name="warning expected", content="http://github.com/very/long/link/to/display"),
+                dict(name="no warning expected", content="https://github.com"),
+            ]
+
+    root = Root()
+
+    with pytest.warns(
+        UserWarning,
+        match=escape("You configured an http link http://github.com/very/long/link... but it won't be accessible"),
+    ):
+        LightningApp(root)

tests/tests_app/utilities/test_cloud.py

@@ -0,0 +1,14 @@
+import os
+from unittest import mock
+
+from lightning_app.utilities.cloud import is_running_in_cloud
+
+
+@mock.patch.dict(os.environ, clear=True)
+def test_is_running_locally():
+    assert not is_running_in_cloud()
+
+
+@mock.patch.dict(os.environ, {"LIGHTNING_APP_STATE_URL": "127.0.0.1"})
+def test_is_running_cloud():
+    assert is_running_in_cloud()