Merge pull request #12 from NOAA-GSL/feat/support-updating-profile

feat: /PATCH endpoint for Support Profiles

Author: mackenzie-grimes-noaa

python/nwsc_proxy/README.md

@@ -86,6 +86,8 @@ On startup, the service creates 'existing' and 'new' subdirectories at the path
   - Get only new (never before processed) Support Profiles. After a profile is returned to any API request, it will disappear from the "new" list, only appearing in `status=existing` filter requests.
 - POST `/all-events`
   - Create a new Support Profile to be stored by the API. The body of the request will be the JSON saved--the `id` field should be unique.
+- PATCH `/all-events?uuid=<some id>`
+  - Update (complete JSON, or partial) an existing Support Profile from the API. `uuid` must match one of the saved Support Profile JSON's `id` attribute, otherwise it will return `404`.
 - DELETE `/all-events?uuid=<some id>`
   - Permanently remove an existing Support Profile from the API. `uuid` must match one of the saved Support Profile JSON's `id` attribute, otherwise it will return `404`.
 

python/nwsc_proxy/ncp_web_service.py

@@ -58,6 +58,9 @@ def handler(self):
         if request.method == "DELETE":
             return self._handle_delete()
 
+        if request.method == "PATCH":
+            return self._handle_update()
+
         # otherwise, must be 'GET' operation
         data_source = request.args.get("dataSource", None, type=str)
         profile_status = request.args.get("status", default="existing", type=str)
@@ -84,7 +87,7 @@ def handler(self):
     def _handle_delete(self) -> Response:
         """Logic for DELETE requests to /all-events. Returns Response with status_code: 204 on
         success, 404 otherwise."""
-        profile_id = request.args.get("uuid", default=None, type=str)
+        profile_id = request.args.get("uuid")
         is_deleted = self.profile_store.delete(profile_id)
         if not is_deleted:
             return jsonify({"message": f"Profile {profile_id} not found"}), 404
@@ -113,6 +116,23 @@ def _handle_create(self) -> Response:
 
         return jsonify({"message": f"Profile {profile_id} saved"}), 201
 
+    def _handle_update(self) -> Response:
+        request_body: dict = request.json
+        profile_id = request.args.get("uuid")
+
+        if not profile_id:
+            return jsonify({"message": "Missing required query parameter: uuid"}), 400
+
+        try:
+            updated_profile = self.profile_store.update(profile_id, request_body)
+        except FileNotFoundError:
+            return jsonify({"message": f"Profile {profile_id} not found"}), 404
+
+        return (
+            jsonify({"message": f"Profile {profile_id} updated", "profile": updated_profile}),
+            200,
+        )
+
 
 class AppWrapper:
     """Web server class wrapping Flask operations"""
@@ -130,7 +150,7 @@ def __init__(self, base_dir: str):
             "/all-events",
             "events",
             view_func=events_route.handler,
-            methods=["GET", "POST", "DELETE"],
+            methods=["GET", "POST", "PATCH", "DELETE"],
         )
 
     def run(self, **kwargs):

python/nwsc_proxy/src/profile_store.py

@@ -19,6 +19,8 @@
 
 from dateutil.parser import parse as dt_parse
 
+from src.utils import deep_update
+
 # constants controlling the subdirectory where new vs. existing Profiles are saved
 NEW_SUBDIR = "new"
 EXISTING_SUBDIR = "existing"
@@ -243,6 +245,43 @@ def mark_as_existing(self, profile_id: str) -> bool:
 
         return True
 
+    def update(self, profile_id: str, data: dict) -> dict:
+        """Update a Support Profile in storage based on its UUID.
+
+        Args:
+            profile_id (str): The UUID of the Support Profile to update
+            data (dict): The JSON attributes to apply. Can be partial Support Profile
+
+        Returns:
+            dict: the latest version of the Profile, with all attribute changes applied
+
+        Raises:
+            FileNotFoundError: if no Support Profile exists with the provided uuid
+        """
+        logger.info("Updating profile_id %s with new attributes: %s", profile_id, data)
+
+        # find the profile data from the new_profiles cache, then apply updates and save over it
+        cached_profile = next(
+            (profile for profile in self.profile_cache if profile.id == profile_id), None
+        )
+        if not cached_profile:
+            raise FileNotFoundError  # Profile with this ID does not exist in cache
+
+        # Apply dict of edits on top of existing cached profile (combining any nested attributes)
+        new_profile_data = deep_update(cached_profile.data, data)
+        is_new_profile = cached_profile.is_new
+
+        # a bit hacky, but the fastest and least duplicative way to update a Profile
+        # in cache + disk is to delete the existing profile and re-save with modified JSON data
+        self.delete(profile_id)
+        update_success = self.save(new_profile_data, is_new_profile)
+
+        if not update_success:
+            logger.warning("Unable to update Profile ID %s for some reason", profile_id)
+            return None
+
+        return new_profile_data
+
     def delete(self, profile_id: str) -> bool:
         """Delete a Support Profile profile from storage, based on its UUID.
 

python/nwsc_proxy/src/utils.py

@@ -0,0 +1,36 @@
+"""Misc Python utilities"""
+
+# ----------------------------------------------------------------------------------
+# Created on Wed Jun 18 2025
+#
+# Copyright (c) 2025 Colorado State University. All rights reserved.             (1)
+#
+# Contributors:
+#     Mackenzie Grimes (1)
+#
+# ----------------------------------------------------------------------------------
+
+from copy import deepcopy
+
+
+def deep_update(original: dict, updates: dict) -> dict:
+    """Recursively combine two dictionaries such that attributes in `changes` only
+    overwrite the original dict's values at the deepest level (a.k.a. leaf node). Returns
+    the original dictionary with changes updated (dictionaries not changed in place).
+
+    E.g.
+    ```
+    deepupdate({'foo': {'bar': 'x', 'baz': 'x'}}, {'foo': {'bar': 'y'}})
+    ```
+    Will result in a combined dictionary where only foo.bar was overwritten, not foo.baz:
+    ```
+    {'foo': {'bar': 'y', 'baz': 'x'}}
+    ```
+    """
+    updated_dict = deepcopy(original)
+    for key, value in updates.items():
+        if isinstance(original.get(key), dict) and isinstance(value, dict):
+            updated_dict[key] = deep_update(original.get(key), value)  # recurse down one level
+        else:
+            updated_dict[key] = value
+    return updated_dict

python/nwsc_proxy/test/test_ncp_web_service.py

@@ -224,9 +224,31 @@ def test_delete_profile_success(wrapper: AppWrapper, mock_request: Mock, mock_pr
 def test_delete_profile_failure(wrapper: AppWrapper, mock_request: Mock, mock_profile_store: Mock):
     mock_request.method = "DELETE"
     mock_request.args = MultiDict({"uuid": EXAMPLE_UUID})
-    mock_profile_store.return_value.delete.return_value = (
-        False  # delete() rejected, profile must exist
-    )
+    # delete() was rejected, profile must exist
+    mock_profile_store.return_value.delete.return_value = False
+
+    result: tuple[Response, int] = wrapper.app.view_functions["events"]()
+
+    assert result[1] == 404
+
+
+def test_update_profile_success(wrapper: AppWrapper, mock_request: Mock, mock_profile_store: Mock):
+    mock_request.method = "PATCH"
+    mock_request.args = MultiDict({"uuid": EXAMPLE_UUID})
+    mock_request.json = {"name": "Some new name"}
+    updated_profile = {"id": EXAMPLE_UUID, "name": "Some new name"}
+
+    mock_profile_store.return_value.update.return_value = updated_profile
+    result: tuple[Response, int] = wrapper.app.view_functions["events"]()
+
+    assert result[1] == 200
+    assert result[0].json["profile"] == updated_profile
+
+
+def test_update_profile_missing(wrapper: AppWrapper, mock_request: Mock, mock_profile_store: Mock):
+    mock_request.method = "PATCH"
+    mock_request.args = MultiDict({"uuid": EXAMPLE_UUID})
+    mock_profile_store.return_value.update.side_effect = FileNotFoundError
 
     result: tuple[Response, int] = wrapper.app.view_functions["events"]()
 

python/nwsc_proxy/test/test_profile_store.py

@@ -14,11 +14,12 @@
 import os
 import shutil
 from copy import deepcopy
+from datetime import datetime, UTC
 from glob import glob
 
-from pytest import fixture
+from pytest import fixture, raises
 
-from python.nwsc_proxy.src.profile_store import ProfileStore, NEW_SUBDIR, EXISTING_SUBDIR
+from python.nwsc_proxy.src.profile_store import ProfileStore, NEW_SUBDIR, EXISTING_SUBDIR, dt_parse
 
 # constants
 STORE_BASE_DIR = os.path.join(os.path.dirname(__file__), "temp")
@@ -179,3 +180,35 @@ def test_delete_profile_failure(store: ProfileStore):
 
     success = store.delete(profile_id)
     assert not success
+
+
+def test_update_profile_success(store: ProfileStore):
+    profile_id = EXAMPLE_SUPPORT_PROFILE["id"]
+    new_start_dt = "2026-01-01T12:00:00Z"
+    new_name = "A different name"
+    new_profile_data = {"name": new_name, "setting": {"timing": {"start": new_start_dt}}}
+
+    updated_profile = store.update(profile_id, new_profile_data)
+
+    # data returned should have updated attributes
+    assert updated_profile["name"] == new_name
+    assert updated_profile["setting"]["timing"]["start"] == new_start_dt
+    # attributes at same level as any nested updated ones should not have changed
+    assert (
+        updated_profile["setting"]["timing"].get("durationInMinutes")
+        == EXAMPLE_SUPPORT_PROFILE["setting"]["timing"]["durationInMinutes"]
+    )
+    # profile in cache should have indeed been changed
+    refetched_profile = next((p for p in store.profile_cache if p.id == profile_id), None)
+    assert refetched_profile.name == new_name
+    assert datetime.fromtimestamp(refetched_profile.start_timestamp, UTC) == dt_parse(new_start_dt)
+
+
+def test_update_profile_not_found(store: ProfileStore):
+    profile_id = "11111111-2222-3333-444444444444"  # fake ID does not exist in ProfileStore
+    new_profile_data = {"name": "A different name"}
+
+    with raises(FileNotFoundError) as exc:
+        _ = store.update(profile_id, new_profile_data)
+
+    assert exc is not None