[KED-2997] Create rename run and edit notes UI behavior

.circleci/config.yml

@@ -43,7 +43,7 @@ commands:
     steps:
       - run:
           name: Install Node dependencies
-          command: npm install 
+          command: npm install
 
   test_lib_transpilation:
     steps:
@@ -125,8 +125,8 @@ commands:
       - checkout
       - restore_cache:
           keys:
-            - v${CACHE_VERSION}-dependencies-{{ checksum "package.json" }}
-            - v${CACHE_VERSION}-dependencies-
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-{{ checksum "package.json" }}
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-
       - install_node_dependencies
       - build_npm_package
       - run:
@@ -146,9 +146,9 @@ commands:
       - checkout
       - restore_cache:
           keys:
-            - v${CACHE_VERSION}-dependencies-{{ checksum "package.json" }}
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-{{ checksum "package.json" }}
             # fallback to using the latest cache if no exact match is found
-            - v${CACHE_VERSION}-dependencies-
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-
       - install_node_dependencies
       - build_npm_package
       - add_ssh_keys:
@@ -166,24 +166,24 @@ commands:
             git commit -m 'Demo build [ci skip]'
             git remote add origin https://github.com/quantumblacklabs/kedro-viz.git
             git push origin gh-pages --force
-  
+
   build:
     description: Run build
     steps:
       - checkout
       - restore_cache:
           keys:
-            - v${CACHE_VERSION}-dependencies-{{ checksum "package.json" }}-{{ checksum "package/requirements.txt" }}-{{ checksum "package/test_requirements.txt" }}
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-{{ checksum "package.json" }}-{{ checksum "package/requirements.txt" }}-{{ checksum "package/test_requirements.txt" }}
             # fallback to using the latest cache if no exact match is found
-            - v${CACHE_VERSION}-dependencies-
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-
       - setup_python_env
       - install_node_dependencies
       - save_cache:
           paths:
             - node_modules
             - /home/circleci/.venvs/kedro-viz
             - /home/circleci/.cache/pip/
-          key: v${CACHE_VERSION}-dependencies-{{ checksum "package.json" }}-{{ checksum "package/requirements.txt" }}-{{ checksum "package/test_requirements.txt" }}
+          key: v${CACHE_VERSION}-{{ arch }}-dependencies-{{ checksum "package.json" }}-{{ checksum "package/requirements.txt" }}-{{ checksum "package/test_requirements.txt" }}
       - test_lib_transpilation
       - test_lib_import
       - run_eslint
@@ -236,9 +236,9 @@ commands:
       - checkout
       - restore_cache:
           keys:
-            - v${CACHE_VERSION}-dependencies-{{ checksum "package.json" }}-{{ checksum "package/requirements.txt" }}-{{ checksum "package/test_requirements.txt" }}
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-{{ checksum "package.json" }}-{{ checksum "package/requirements.txt" }}-{{ checksum "package/test_requirements.txt" }}
             # fallback to using the latest cache if no exact match is found
-            - v${CACHE_VERSION}-dependencies-
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-
       - win_setup_conda
       - win_setup_requirements
       - install_node_dependencies
@@ -247,7 +247,7 @@ commands:
             - node_modules
             - c:\tools\miniconda3\envs\kedro-viz\
             - c:\users\circleci\appdata\local\pip\cache\
-          key: v${CACHE_VERSION}-dependencies-{{ checksum "package.json" }}-{{ checksum "package/requirements.txt" }}-{{ checksum "package/test_requirements.txt" }}
+          key: v${CACHE_VERSION}-{{ arch }}-dependencies-{{ checksum "package.json" }}-{{ checksum "package/requirements.txt" }}-{{ checksum "package/test_requirements.txt" }}
       - run:
           name: Run Python unit tests
           command: |
@@ -264,7 +264,6 @@ commands:
             behave
 
 jobs:
-
   build_37:
     executor: circleci_machine
     environment:
@@ -308,8 +307,8 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - v${CACHE_VERSION}-dependencies-{{ checksum "package.json" }}
-            - v${CACHE_VERSION}-dependencies-
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-{{ checksum "package.json" }}
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-
       - install_node_dependencies
       - build_npm_package
       - run:
@@ -328,9 +327,9 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - v${CACHE_VERSION}-dependencies-{{ checksum "package.json" }}
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-{{ checksum "package.json" }}
             # fallback to using the latest cache if no exact match is found
-            - v${CACHE_VERSION}-dependencies-
+            - v${CACHE_VERSION}-{{ arch }}-dependencies-
       - setup_python_env
       - run:
           name: Install twine

package.json

@@ -39,7 +39,7 @@
     "snyk-test": "snyk test -prune-repeated-subdependencies"
   },
   "dependencies": {
-    "@apollo/client": "^3.5.5",
+    "@apollo/client": "^3.5.6",
     "@graphql-tools/schema": "7.1.5",
     "@material-ui/core": "^4.11.4",
     "@material-ui/icons": "^4.11.2",
@@ -138,4 +138,4 @@
     "not op_mini all"
   ],
   "snyk": true
-}
+}

package/kedro_viz/api/graphql.py

@@ -27,6 +27,7 @@ class JSONObject(dict):
         https://github.com/python/mypy/issues/2477
         """
 
+
 else:
     JSONObject = strawberry.scalar(
         NewType("JSONObject", dict),
@@ -46,7 +47,11 @@ def format_run(run_id: str, run_blob: Dict) -> Run:
     """
     session = data_access_manager.db_session
     git_data = run_blob.get("git")
-    user_details = session.query(UserRunDetailsModel).filter(UserRunDetailsModel.run_id == run_id).scalar()
+    user_details = (
+        session.query(UserRunDetailsModel)
+        .filter(UserRunDetailsModel.run_id == run_id)
+        .scalar()
+    )
     run = Run(
         id=ID(run_id),
         author="",
@@ -95,7 +100,9 @@ def get_all_runs() -> List[Run]:
     return runs
 
 
-def format_run_tracking_data(tracking_data: Dict, show_diff: Optional[bool] = False) -> JSONObject:
+def format_run_tracking_data(
+    tracking_data: Dict, show_diff: Optional[bool] = False
+) -> JSONObject:
     """Convert tracking data in the front-end format.
 
     Args:
@@ -140,7 +147,9 @@ def format_run_tracking_data(tracking_data: Dict, show_diff: Optional[bool] = Fa
 
     for run_id, run_tracking_data in tracking_data.items():
         for tracking_name, data in run_tracking_data.items():
-            formatted_tracking_data[tracking_name].append({"runId": run_id, "value": data})
+            formatted_tracking_data[tracking_name].append(
+                {"runId": run_id, "value": data}
+            )
     if not show_diff:
         for tracking_key, run_tracking_data in list(formatted_tracking_data.items()):
             if len(run_tracking_data) != len(tracking_data):
@@ -149,7 +158,9 @@ def format_run_tracking_data(tracking_data: Dict, show_diff: Optional[bool] = Fa
     return JSONObject(formatted_tracking_data)
 
 
-def get_run_tracking_data(run_ids: List[ID], show_diff: Optional[bool] = False) -> List[TrackingDataset]:
+def get_run_tracking_data(
+    run_ids: List[ID], show_diff: Optional[bool] = False
+) -> List[TrackingDataset]:
     # pylint: disable=protected-access,import-outside-toplevel
     """Get all tracking data for a list of runs. Tracking data contains the data from the
     tracking MetricsDataSet and JSONDataSet instances that have been logged
@@ -179,7 +190,9 @@ def get_run_tracking_data(run_ids: List[ID], show_diff: Optional[bool] = False)
             run_id = ID(run_id)
             file_path = dataset._get_versioned_path(str(run_id))
             if Path(file_path).is_file():
-                with dataset._fs.open(file_path, **dataset._fs_open_args_load) as fs_file:
+                with dataset._fs.open(
+                    file_path, **dataset._fs_open_args_load
+                ) as fs_file:
                     json_data = json.load(fs_file)
                     all_runs[run_id] = json_data
             else:
@@ -238,7 +251,9 @@ def run_metadata(self, run_ids: List[ID]) -> List[Run]:
         return get_runs(run_ids)
 
     @strawberry.field
-    def run_tracking_data(self, run_ids: List[ID], show_diff: Optional[bool] = False) -> List[TrackingDataset]:
+    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)
 
@@ -261,18 +276,20 @@ class RunInput:
 class UpdateRunDetailsSuccess:
     """Response type for sucessful update of runs"""
 
-    run_details: JSONObject
+    run: Run
 
 
 @strawberry.type
 class UpdateRunDetailsFailure:
     """Response type for failed update of runs"""
 
-    run_id: ID
+    id: ID
     error_message: str
 
 
-Response = strawberry.union("UpdateRunDetailsResponse", (UpdateRunDetailsSuccess, UpdateRunDetailsFailure))
+Response = strawberry.union(
+    "UpdateRunDetailsResponse", (UpdateRunDetailsSuccess, UpdateRunDetailsFailure)
+)
 
 
 @strawberry.type
@@ -284,34 +301,50 @@ def update_run_details(self, run_id: ID, run_input: RunInput) -> Response:
         """Updates run details based on run inputs provided by user"""
         runs = get_runs([run_id])
         if not runs:
-            return UpdateRunDetailsFailure(run_id=run_id, error_message=f"Given run_id: {run_id} doesn't exist")
+            return UpdateRunDetailsFailure(
+                id=run_id, error_message=f"Given run_id: {run_id} doesn't exist"
+            )
         existing_run = runs[0]
-        updated_user_run_details = {
-            "run_id": run_id,
-            "bookmark": run_input.bookmark if run_input.bookmark is not None else existing_run.bookmark,
-            "notes": run_input.notes if run_input.notes is not None else existing_run.notes,
-        }
-
+        new_run = existing_run
         # if user doesn't provide a new title, use the old title.
         if run_input.title is None:
-            updated_user_run_details["title"] = existing_run.title
+            new_run.title = existing_run.title
         # if user provides an empty title, we assume they want to revert to the old timestamp title
         elif run_input.title.strip() == "":
-            updated_user_run_details["title"] = existing_run.timestamp
+            new_run.title = existing_run.timestamp
         else:
-            updated_user_run_details["title"] = run_input.title
+            new_run.title = run_input.title
+
+        new_run.bookmark = (
+            run_input.bookmark
+            if run_input.bookmark is not None
+            else existing_run.bookmark
+        )
+
+        new_run.notes = (
+            run_input.notes if run_input.notes is not None else existing_run.notes
+        )
+
+        updated_user_run_details = {
+            "run_id": run_id,
+            "title": new_run.title,
+            "bookmark": new_run.bookmark,
+            "notes": new_run.notes,
+        }
 
         session = data_access_manager.db_session
-        user_run_details = session.query(UserRunDetailsModel).filter(UserRunDetailsModel.run_id == run_id).first()
+        user_run_details = (
+            session.query(UserRunDetailsModel)
+            .filter(UserRunDetailsModel.run_id == run_id)
+            .first()
+        )
         if not user_run_details:
-            session.add(UserRunDetailsModel(**updated_user_run_details)) # type: ignore
+            session.add(UserRunDetailsModel(**updated_user_run_details))  # type: ignore
         else:
             for key, value in updated_user_run_details.items():
                 setattr(user_run_details, key, value)
         session.commit()
-        return UpdateRunDetailsSuccess(
-            run_details=JSONObject(updated_user_run_details)
-        )
+        return UpdateRunDetailsSuccess(new_run)
 
 
 schema = strawberry.Schema(query=Query, mutation=Mutation)

package/kedro_viz/integrations/kedro/sqlite_store.py

@@ -51,7 +51,7 @@ def to_json(self) -> str:
 
                     branch = git.Repo(search_parent_directories=True).active_branch
                     value["branch"] = branch.name
-                except ImportError as exc: # pragma: no cover
+                except ImportError as exc:  # pragma: no cover
                     logger.warning("%s:%s", exc.__class__.__name__, exc.msg)
 
             if _is_json_serializable(value):