Enable/disable preview for all the datasets when publishing Kedro-Viz from UI

RELEASE.md

@@ -9,6 +9,9 @@ Please follow the established format:
 
 ## Major features and improvements
 
+- Enable/disable preview for all the datasets when publishing Kedro-Viz from CLI. (#1894)
+- Enable/disable preview for all the datasets when publishing Kedro-Viz from UI. (#1895)
+
 ## Bug fixes and other changes
 
 - Upgrade the gitpod workspace-full to a newer version which includes both Node 18 and Python 3.11.5. (#1862)

package/kedro_viz/api/rest/requests.py

@@ -7,5 +7,6 @@ class DeployerConfiguration(BaseModel):
     """Credentials for Deployers."""
 
     platform: str
+    is_all_previews_enabled: bool = False
     endpoint: str
     bucket_name: str

package/kedro_viz/api/rest/responses.py

@@ -420,8 +420,13 @@ def save_api_main_response_to_fs(main_path: str, remote_fs: Any):
         raise exc
 
 
-def save_api_node_response_to_fs(nodes_path: str, remote_fs: Any):
+def save_api_node_response_to_fs(
+    nodes_path: str, remote_fs: Any, is_all_previews_enabled: bool
+):
     """Saves API /nodes/{node} response to a directory."""
+    # Set if preview is enabled/disabled for all data nodes
+    DataNodeMetadata.set_is_all_previews_enabled(is_all_previews_enabled)
+
     for nodeId in data_access_manager.nodes.get_node_ids():
         try:
             write_api_response_to_fs(
@@ -452,7 +457,7 @@ def save_api_pipeline_response_to_fs(pipelines_path: str, remote_fs: Any):
             raise exc
 
 
-def save_api_responses_to_fs(path: str, remote_fs: Any):
+def save_api_responses_to_fs(path: str, remote_fs: Any, is_all_previews_enabled: bool):
     """Saves all Kedro Viz API responses to a directory."""
     try:
         logger.debug(
@@ -470,7 +475,7 @@ def save_api_responses_to_fs(path: str, remote_fs: Any):
             remote_fs.makedirs(pipelines_path, exist_ok=True)
 
         save_api_main_response_to_fs(main_path, remote_fs)
-        save_api_node_response_to_fs(nodes_path, remote_fs)
+        save_api_node_response_to_fs(nodes_path, remote_fs, is_all_previews_enabled)
         save_api_pipeline_response_to_fs(pipelines_path, remote_fs)
 
     except Exception as exc:  # pragma: no cover

package/kedro_viz/api/rest/router.py

@@ -63,7 +63,7 @@ async def deploy_kedro_viz(input_values: DeployerConfiguration):
         deployer = DeployerFactory.create_deployer(
             input_values.platform, input_values.endpoint, input_values.bucket_name
         )
-        deployer.deploy()
+        deployer.deploy(input_values.is_all_previews_enabled)
         response = {
             "message": "Website deployed on "
             f"{input_values.platform and input_values.platform.upper()}",

package/kedro_viz/data_access/repositories/catalog.py

@@ -12,7 +12,7 @@
     from kedro.pipeline._transcoding import TRANSCODING_SEPARATOR, _strip_transcoding
 except ImportError:  # pragma: no cover
     # older versions
-    from kedro.pipeline.pipeline import TRANSCODING_SEPARATOR, _strip_transcoding
+    from kedro.pipeline.pipeline import TRANSCODING_SEPARATOR, _strip_transcoding  # type: ignore
 
 from packaging.version import parse
 

package/kedro_viz/integrations/deployment/base_deployer.py

@@ -33,9 +33,9 @@ def __init__(self):
         self._path = None
         self._fs = None
 
-    def _upload_api_responses(self):
+    def _upload_api_responses(self, is_all_previews_enabled: bool):
         """Write API responses to the build."""
-        save_api_responses_to_fs(self._path, self._fs)
+        save_api_responses_to_fs(self._path, self._fs, is_all_previews_enabled)
 
     def _ingest_heap_analytics(self):
         """Ingest heap analytics to index file in the build."""
@@ -98,9 +98,9 @@ def _upload_deploy_viz_metadata_file(self):
             logger.exception("Upload failed: %s ", exc)
             raise exc
 
-    def deploy(self):
+    def deploy(self, is_all_previews_enabled: bool = False):
         """Create and deploy all static files to local/remote file system"""
 
-        self._upload_api_responses()
+        self._upload_api_responses(is_all_previews_enabled)
         self._upload_static_files(_HTML_DIR)
         self._upload_deploy_viz_metadata_file()

package/kedro_viz/integrations/kedro/hooks.py

@@ -17,7 +17,10 @@
     from kedro.pipeline._transcoding import TRANSCODING_SEPARATOR, _strip_transcoding
 except ImportError:  # pragma: no cover
     # older versions
-    from kedro.pipeline.pipeline import TRANSCODING_SEPARATOR, _strip_transcoding
+    from kedro.pipeline.pipeline import (  # type: ignore
+        TRANSCODING_SEPARATOR,
+        _strip_transcoding,
+    )
 
 logger = logging.getLogger(__name__)
 

package/kedro_viz/launchers/cli.py

@@ -234,7 +234,12 @@ def run(
     is_flag=True,
     help="A flag to include all registered hooks in your Kedro Project",
 )
-def deploy(platform, endpoint, bucket_name, include_hooks):
+@click.option(
+    "--include-preview",
+    is_flag=True,
+    help="Enable/disable preview for all the datasets.",
+)
+def deploy(platform, endpoint, bucket_name, include_hooks, include_preview):
     """Deploy and host Kedro Viz on provided platform"""
     if not platform or platform.lower() not in SHAREABLEVIZ_SUPPORTED_PLATFORMS:
         display_cli_message(
@@ -252,7 +257,13 @@ def deploy(platform, endpoint, bucket_name, include_hooks):
         )
         return
 
-    create_shareableviz_process(platform, endpoint, bucket_name, include_hooks)
+    create_shareableviz_process(
+        platform,
+        include_preview,
+        endpoint,
+        bucket_name,
+        include_hooks,
+    )
 
 
 @viz.command(context_settings={"help_option_names": ["-h", "--help"]})
@@ -261,14 +272,23 @@ def deploy(platform, endpoint, bucket_name, include_hooks):
     is_flag=True,
     help="A flag to include all registered hooks in your Kedro Project",
 )
-def build(include_hooks):
+@click.option(
+    "--include-preview",
+    is_flag=True,
+    help="Enable/disable preview for all the datasets.",
+)
+def build(include_hooks, include_preview):
     """Create build directory of local Kedro Viz instance with Kedro project data"""
 
-    create_shareableviz_process("local", include_hooks=include_hooks)
+    create_shareableviz_process("local", include_preview, include_hooks=include_hooks)
 
 
 def create_shareableviz_process(
-    platform, endpoint=None, bucket_name=None, include_hooks=False
+    platform,
+    is_all_previews_enabled,
+    endpoint=None,
+    bucket_name=None,
+    include_hooks=False,
 ):
     """Creates platform specific deployer process"""
     try:
@@ -279,6 +299,7 @@ def create_shareableviz_process(
             target=load_and_deploy_viz,
             args=(
                 platform,
+                is_all_previews_enabled,
                 endpoint,
                 bucket_name,
                 include_hooks,
@@ -354,6 +375,7 @@ def create_shareableviz_process(
 
 def load_and_deploy_viz(
     platform,
+    is_all_previews_enabled,
     endpoint,
     bucket_name,
     include_hooks,
@@ -369,7 +391,7 @@ def load_and_deploy_viz(
 
         # Start the deployment
         deployer = DeployerFactory.create_deployer(platform, endpoint, bucket_name)
-        deployer.deploy()
+        deployer.deploy(is_all_previews_enabled)
 
     except (
         # pylint: disable=catching-non-exception

package/kedro_viz/models/flowchart.py

@@ -8,7 +8,7 @@
 from enum import Enum
 from pathlib import Path
 from types import FunctionType
-from typing import Any, Dict, List, Optional, Set, Union, cast
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union, cast
 
 from kedro.pipeline.node import Node as KedroNode
 
@@ -17,7 +17,7 @@
     from kedro.pipeline._transcoding import TRANSCODING_SEPARATOR, _strip_transcoding
 except ImportError:  # pragma: no cover
     # older versions
-    from kedro.pipeline.pipeline import TRANSCODING_SEPARATOR, _strip_transcoding
+    from kedro.pipeline.pipeline import TRANSCODING_SEPARATOR, _strip_transcoding  # type: ignore
 
 from pydantic import (
     BaseModel,
@@ -646,7 +646,10 @@ def get_preview_args(self):
         return self.viz_metadata.get("preview_args", None)
 
     def is_preview_disabled(self):
-        """Checks if the dataset has a preview disabled"""
+        """Checks if the dataset has a preview disabled at the node level.
+        This happens when the user specifies 'preview=false' in the DataCatalog.
+        """
+
         return (
             self.viz_metadata is not None and self.viz_metadata.get("preview") is False
         )
@@ -729,12 +732,19 @@ class DataNodeMetadata(GraphNodeMetadata):
     Args:
         data_node (DataNode): Data node to which this metadata belongs to.
 
+    Attributes:
+        is_all_previews_enabled (bool): Class-level attribute to determine if
+            previews are enabled for all nodes. This can be configured via CLI
+            or UI to manage the preview settings.
+
     Raises:
         AssertionError: If data_node is not supplied during instantiation
     """
 
     data_node: DataNode = Field(..., exclude=True)
 
+    is_all_previews_enabled: ClassVar[bool] = True
+
     type: Optional[str] = Field(
         default=None, validate_default=True, description="The type of the data node"
     )
@@ -776,6 +786,10 @@ def check_data_node_exists(cls, values):
         cls.set_data_node_and_dataset(values["data_node"])
         return values
 
+    @classmethod
+    def set_is_all_previews_enabled(cls, value: bool):
+        cls.is_all_previews_enabled = value
+
     @classmethod
     def set_data_node_and_dataset(cls, data_node):
         cls.data_node = data_node
@@ -806,7 +820,11 @@ def set_run_command(cls, _):
     @field_validator("preview")
     @classmethod
     def set_preview(cls, _):
-        if cls.data_node.is_preview_disabled() or not hasattr(cls.dataset, "preview"):
+        if (
+            cls.data_node.is_preview_disabled()
+            or not hasattr(cls.dataset, "preview")
+            or not cls.is_all_previews_enabled
+        ):
             return None
 
         try:
@@ -829,7 +847,11 @@ def set_preview(cls, _):
     @field_validator("preview_type")
     @classmethod
     def set_preview_type(cls, _):
-        if cls.data_node.is_preview_disabled() or not hasattr(cls.dataset, "preview"):
+        if (
+            cls.data_node.is_preview_disabled()
+            or not hasattr(cls.dataset, "preview")
+            or not cls.is_all_previews_enabled
+        ):
             return None
 
         try:

package/kedro_viz/server.py

@@ -125,9 +125,10 @@ def run_server(
             pipeline_name,
             extra_params,
         )
-
+        # [TODO: As we can do this with `kedro viz build`,
+        # we need to shift this feature outside of kedro viz run]
         if save_file:
-            save_api_responses_to_fs(save_file, fsspec.filesystem("file"))
+            save_api_responses_to_fs(save_file, fsspec.filesystem("file"), True)
 
         app = apps.create_api_app_from_project(path, autoreload)
     else:

package/tests/conftest.py

@@ -17,7 +17,7 @@
 from kedro_viz.data_access import DataAccessManager
 from kedro_viz.integrations.kedro.hooks import DatasetStatsHook
 from kedro_viz.integrations.kedro.sqlite_store import SQLiteStore
-from kedro_viz.models.flowchart import GraphNode
+from kedro_viz.models.flowchart import DataNodeMetadata, GraphNode
 from kedro_viz.server import populate_data
 
 
@@ -350,3 +350,8 @@ def pipeline_with_data_sets_mock():
     pipeline = mock.MagicMock()
     pipeline.data_sets.return_value = ["model_inputs#csv"]
     return pipeline
+
+
+@pytest.fixture(autouse=True)
+def reset_is_all_previews_enabled():
+    DataNodeMetadata.is_all_previews_enabled = True

package/tests/test_api/test_rest/test_responses.py

@@ -979,7 +979,7 @@ def test_save_api_node_response_to_fs(self, mocker):
         )
         remote_fs = Mock()
 
-        save_api_node_response_to_fs(nodes_path, remote_fs)
+        save_api_node_response_to_fs(nodes_path, remote_fs, False)
 
         assert mock_write_api_response_to_fs.call_count == len(nodeIds)
         assert mock_get_node_metadata_response.call_count == len(nodeIds)
@@ -1031,14 +1031,16 @@ def test_save_api_pipeline_response_to_fs(self, mocker):
         mock_write_api_response_to_fs.assert_has_calls(expected_calls, any_order=True)
 
     @pytest.mark.parametrize(
-        "file_path, protocol",
+        "file_path, protocol, is_all_previews_enabled",
         [
-            ("s3://shareableviz", "s3"),
-            ("abfs://shareableviz", "abfs"),
-            ("shareableviz", "file"),
+            ("s3://shareableviz", "s3", True),
+            ("abfs://shareableviz", "abfs", False),
+            ("shareableviz", "file", True),
         ],
     )
-    def test_save_api_responses_to_fs(self, file_path, protocol, mocker):
+    def test_save_api_responses_to_fs(
+        self, file_path, protocol, is_all_previews_enabled, mocker
+    ):
         mock_api_main_response_to_fs = mocker.patch(
             "kedro_viz.api.rest.responses.save_api_main_response_to_fs"
         )
@@ -1052,13 +1054,17 @@ def test_save_api_responses_to_fs(self, file_path, protocol, mocker):
         mock_filesystem = mocker.patch("fsspec.filesystem")
         mock_filesystem.return_value.protocol = protocol
 
-        save_api_responses_to_fs(file_path, mock_filesystem.return_value)
+        save_api_responses_to_fs(
+            file_path, mock_filesystem.return_value, is_all_previews_enabled
+        )
 
         mock_api_main_response_to_fs.assert_called_once_with(
             f"{file_path}/api/main", mock_filesystem.return_value
         )
         mock_api_node_response_to_fs.assert_called_once_with(
-            f"{file_path}/api/nodes", mock_filesystem.return_value
+            f"{file_path}/api/nodes",
+            mock_filesystem.return_value,
+            is_all_previews_enabled,
         )
         mock_api_pipeline_response_to_fs.assert_called_once_with(
             f"{file_path}/api/pipelines", mock_filesystem.return_value

package/tests/test_api/test_rest/test_router.py

@@ -6,25 +6,32 @@ class MockDeployer:
     def __init__(self, platform, endpoint, bucket_name):
         pass
 
-    def deploy(self):
+    def deploy(self, is_all_previews_enabled):
         pass
 
 
 @pytest.mark.parametrize(
-    "platform, endpoint, bucket_name",
+    "platform, endpoint, bucket_name, is_all_previews_enabled",
     [
-        ("aws", "http://mocked-url.com", "s3://shareableviz"),
-        ("azure", "http://mocked-url.com", "abfs://shareableviz"),
+        ("aws", "http://mocked-url.com", "s3://shareableviz", True),
+        ("azure", "http://mocked-url.com", "abfs://shareableviz", False),
     ],
 )
-def test_deploy_kedro_viz(client, platform, endpoint, bucket_name, mocker):
+def test_deploy_kedro_viz(
+    client, platform, endpoint, bucket_name, is_all_previews_enabled, mocker
+):
     mocker.patch(
         "kedro_viz.api.rest.router.DeployerFactory.create_deployer",
         return_value=MockDeployer(platform, endpoint, bucket_name),
     )
     response = client.post(
         "/api/deploy",
-        json={"platform": platform, "endpoint": endpoint, "bucket_name": bucket_name},
+        json={
+            "platform": platform,
+            "endpoint": endpoint,
+            "bucket_name": bucket_name,
+            "is_all_previews_enabled": is_all_previews_enabled,
+        },
     )
 
     assert response.status_code == 200