[KED-3060] Create viz version graphql endpoint

RELEASE.md

@@ -10,6 +10,7 @@ Please follow the established format:
 ## Bug fixes and other changes
 - Migrate Kedro-UI buttons to Kedro-viz as Kedro-UI is now deprecated. (#716)
 - Add a Husky pre-push hook. (#723)
+- Create a `version` GraphQL query to get versions of Kedro-Viz. (#727)
 
 # Release 4.3.1
 

package/kedro_viz/api/graphql.py

@@ -24,7 +24,9 @@
 from strawberry import ID
 from strawberry.asgi import GraphQL
 
+from kedro_viz import __version__
 from kedro_viz.data_access import data_access_manager
+from kedro_viz.integrations.pypi import get_latest_version
 from kedro_viz.models.experiments_tracking import RunModel, UserRunDetailsModel
 
 logger = logging.getLogger(__name__)
@@ -69,15 +71,15 @@ def format_run(
         user_run_details.notes if user_run_details and user_run_details.notes else ""
     )
     run = Run(
-        id=ID(run_id),
         author="",
+        bookmark=bookmark,
         gitBranch=git_data.get("branch") if git_data else None,
         gitSha=git_data.get("commit_sha") if git_data else None,
-        bookmark=bookmark,
-        title=title,
+        id=ID(run_id),
         notes=notes,
-        timestamp=run_blob["session_id"],
         runCommand=run_blob["cli"]["command_path"],
+        timestamp=run_blob["session_id"],
+        title=title,
     )
     return run
 
@@ -119,6 +121,16 @@ def get_runs(run_ids: List[ID]) -> List[Run]:
     )
 
 
+def get_version() -> Version:
+    """Get the user's installed Viz version and the latest version on PyPI.
+    Returns:
+        the currently installed and most-recent released version of Viz.
+    """
+    latest_version = get_latest_version()
+    version = Version(installed=__version__, latest=latest_version)
+    return version
+
+
 def get_all_runs() -> List[Run]:
     """Get all runs from the session store.
 
@@ -247,24 +259,32 @@ def get_run_tracking_data(
 class Run:
     """Run object format"""
 
-    id: ID
-    title: str
-    timestamp: str
     author: Optional[str]
+    bookmark: Optional[bool]
     gitBranch: Optional[str]
     gitSha: Optional[str]
-    bookmark: Optional[bool]
+    id: ID
     notes: Optional[str]
     runCommand: Optional[str]
+    timestamp: str
+    title: str
 
 
 @strawberry.type
 class TrackingDataset:
     """TrackingDataset object to structure tracking data for a Run."""
 
+    data: Optional[JSONObject]
     datasetName: Optional[str]
     datasetType: Optional[str]
-    data: Optional[JSONObject]
+
+
+@strawberry.type
+class Version:
+    """The installed and latest Kedro Viz versions."""
+
+    installed: str
+    latest: str
 
 
 @strawberry.type
@@ -295,17 +315,25 @@ class Query:
 
     @strawberry.field
     def run_metadata(self, run_ids: List[ID]) -> List[Run]:
-        """Query to get data for specific runs from the session store"""
+        """Query to get data for specific run metadata from the session store"""
         return get_runs(run_ids)
 
+    @strawberry.field
+    def runs_list(self) -> List[Run]:
+        """Query to get data for all the runs from the session store"""
+        return get_all_runs()
+
     @strawberry.field
     def run_tracking_data(
         self, run_ids: List[ID], show_diff: Optional[bool] = False
     ) -> List[TrackingDataset]:
         """Query to get data for specific runs from the session store"""
         return get_run_tracking_data(run_ids, show_diff)
 
-    runs_list: List[Run] = strawberry.field(resolver=get_all_runs)
+    @strawberry.field
+    def version(self) -> Version:
+        """Query to get Kedro-Viz version"""
+        return get_version()
 
 
 schema = strawberry.Schema(query=Query, subscription=Subscription)
@@ -316,8 +344,8 @@ class RunInput:
     """Run input to update bookmark, title and notes"""
 
     bookmark: Optional[bool] = None
-    title: Optional[str] = None
     notes: Optional[str] = None
+    title: Optional[str] = None
 
 
 @strawberry.type

package/kedro_viz/launchers/cli.py

@@ -74,14 +74,14 @@ def commands():
 )
 def viz(host, port, browser, load_file, save_file, pipeline, env, autoreload):
     """Visualise a Kedro pipeline using Kedro viz."""
-    current_version = VersionInfo.parse(__version__)
+    installed_version = VersionInfo.parse(__version__)
     latest_version = get_latest_version()
 
-    if latest_version is not None and current_version < latest_version:
+    if latest_version is not None and installed_version < latest_version:
         click.echo(
             click.style(
                 "WARNING: You are using an old version of Kedro Viz. "
-                f"You are using version {current_version}; "
+                f"You are using version {installed_version}; "
                 f"however, version {latest_version} is now available.\n"
                 "You should consider upgrading via the `pip install -U kedro-viz` command.\n"
                 "You can view the complete changelog at "

package/tests/test_api/test_graphql/test_queries.py

@@ -1,5 +1,8 @@
 import pytest
 
+from kedro_viz import __version__
+from kedro_viz.integrations.pypi import get_latest_version
+
 
 class TestQueryNoSessionStore:
     def test_graphql_run_list_endpoint(self, client):
@@ -55,6 +58,17 @@ def test_graphql_runs_metadata_endpoint(self, example_run_ids, client):
             "data": {"runMetadata": [{"id": example_run_ids[0], "bookmark": True}]}
         }
 
+    def test_graphql_version_endpoint(self, client):
+        response = client.post(
+            "/graphql",
+            json={"query": "{version {installed latest}}"},
+        )
+        assert response.json() == {
+            "data": {
+                "version": {"installed": __version__, "latest": get_latest_version()}
+            }
+        }
+
     def test_run_tracking_data_query(
         self,
         example_run_ids,

package/tests/test_launchers/test_cli.py

@@ -62,8 +62,8 @@ def test_kedro_viz_command_run_server(command_options, run_server_args, mocker):
 
 
 def test_kedro_viz_command_should_log_outdated_version(mocker, mock_http_response):
-    current_version = VersionInfo.parse(__version__)
-    mock_version = f"{current_version.major + 1}.0.0"
+    installed_version = VersionInfo.parse(__version__)
+    mock_version = f"{installed_version.major + 1}.0.0"
     requests_get = mocker.patch("requests.get")
     requests_get.return_value = mock_http_response(
         data={"info": {"version": mock_version}}
@@ -77,7 +77,7 @@ def test_kedro_viz_command_should_log_outdated_version(mocker, mock_http_respons
 
     mock_click_echo.assert_called_once_with(
         "\x1b[33mWARNING: You are using an old version of Kedro Viz. "
-        f"You are using version {current_version}; "
+        f"You are using version {installed_version}; "
         f"however, version {mock_version} is now available.\n"
         "You should consider upgrading via the `pip install -U kedro-viz` command.\n"
         "You can view the complete changelog at "

src/apollo/schema.graphql

@@ -6,37 +6,38 @@ type Mutation {
 }
 
 type Query {
-  runsList: [Run!]!
   runMetadata(runIds: [ID!]!): [Run!]!
+  runsList: [Run!]!
   runTrackingData(runIds: [ID!]!, showDiff: Boolean = false): [TrackingDataset!]!
+  version: Version!
 }
 
 type Run {
-  id: ID!
-  title: String!
-  timestamp: String!
   author: String
+  bookmark: Boolean
   gitBranch: String
   gitSha: String
-  bookmark: Boolean
+  id: ID!
   notes: String
   runCommand: String
+  timestamp: String!
+  title: String!
 }
 
 input RunInput {
   bookmark: Boolean = null
-  title: String = null
   notes: String = null
+  title: String = null
 }
 
 type Subscription {
   runsAdded: [Run!]!
 }
 
 type TrackingDataset {
+  data: JSONObject
   datasetName: String
   datasetType: String
-  data: JSONObject
 }
 
 type UpdateRunDetailsFailure {
@@ -49,3 +50,8 @@ union UpdateRunDetailsResponse = UpdateRunDetailsSuccess | UpdateRunDetailsFailu
 type UpdateRunDetailsSuccess {
   run: Run!
 }
+
+type Version {
+  installed: String!
+  latest: String!
+}