Improve Kedro-viz experience on notebooks (kedro-org#1722)

* Add link to open in new tab * add test and lint Signed-off-by: Sajid Alam <[email protected]> * Update RELEASE.md Signed-off-by: Sajid Alam <[email protected]> --------- Signed-off-by: Sajid Alam <[email protected]> Signed-off-by: Elias Santana <[email protected]>
santana98 · Feb 19, 2024 · 5604c9d · 5604c9d
1 parent 9b67bf1
commit 5604c9d
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 5 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -6,6 +6,13 @@ Please follow the established format:
 - Include the ID number for the related PR (or PRs) in parentheses
 -->
 
+# Upcoming release
+
+## Major features and improvements
+## Bug fixes and other changes
+- Change the `%run_viz` line magic to open Kedro-viz in a new browser tab. (#1722)
+
+
 # Release 7.1.0
 
 ## Major features and improvements

diff --git a/package/kedro_viz/launchers/jupyter.py b/package/kedro_viz/launchers/jupyter.py
@@ -122,8 +122,6 @@ def run_viz(port: int = None, local_ns: Dict[str, Any] = None) -> None:
     if _is_databricks():
         _display_databricks_html(port)
     else:
-        wrapper = f"""
-                <html lang="en"><head></head><body style="width:100; height:100;">
-                <iframe src="http://{host}:{port}/" height=500 width="100%"></iframe>
-                </body></html>"""
-        display(HTML(wrapper))
+        url = f"http://{host}:{port}/"
+        link_html = f'<a href="{url}" target="_blank">Open Kedro-Viz</a>'
+        display(HTML(link_html))
diff --git a/package/tests/test_launchers/test_jupyter.py b/package/tests/test_launchers/test_jupyter.py
@@ -88,3 +88,19 @@ def test_run_viz_on_databricks(self, mocker, patched_check_viz_up, monkeypatch):
             },
         )
         databricks_display.assert_called_once()
+
+    def test_run_viz_creates_correct_link(self, mocker, patched_check_viz_up):
+        mock_process_context = mocker.patch("multiprocessing.get_context")
+        mock_context_instance = mocker.Mock()
+        mock_process_context.return_value = mock_context_instance
+        mock_process = mocker.patch.object(mock_context_instance, "Process")
+        mock_display_html = mocker.patch("kedro_viz.launchers.jupyter.display")
+
+        run_viz()
+
+        mock_process.assert_called_once()
+        mock_display_html.assert_called_once()
+
+        displayed_html = mock_display_html.call_args[0][0].data
+        assert 'target="_blank"' in displayed_html
+        assert "Open Kedro-Viz" in displayed_html