review comments: move to true toggle logic

Signed-off-by: Jordan Dubrick <[email protected]>

Author: Jdubrick

docs/openapi.json

@@ -394,18 +394,8 @@
                     "feedback"
                 ],
                 "summary": "Feedback Toggle",
-                "description": "Handle feedback toggle requests.\n\nReturns the current enbaled status of the feedback functionality after it has been\nupdated to the desired value from the request.\n\nReturns:\n    StatusResponse: Indicates whether feedback is enabled.",
+                "description": "Handle feedback toggle requests.\n\nReturns the current enabled status of the feedback functionality after it has been\nupdated to the opposite value from the previously set value.\n\nReturns:\n    StatusResponse: Indicates whether feedback is enabled.",
                 "operationId": "feedback_toggle_v1_feedback_toggle_post",
-                "requestBody": {
-                    "content": {
-                        "application/json": {
-                            "schema": {
-                                "$ref": "#/components/schemas/FeedbackToggleRequest"
-                            }
-                        }
-                    },
-                    "required": true
-                },
                 "responses": {
                     "200": {
                         "description": "Successful Response",
@@ -416,16 +406,6 @@
                                 }
                             }
                         }
-                    },
-                    "422": {
-                        "description": "Validation Error",
-                        "content": {
-                            "application/json": {
-                                "schema": {
-                                    "$ref": "#/components/schemas/HTTPValidationError"
-                                }
-                            }
-                        }
                     }
                 }
             }
@@ -1488,23 +1468,6 @@
                     }
                 ]
             },
-            "FeedbackToggleRequest": {
-                "properties": {
-                    "status": {
-                        "type": "boolean",
-                        "title": "Status",
-                        "description": "Desired state of feedback enablement, must be False or True",
-                        "default": false,
-                        "examples": [
-                            true,
-                            false
-                        ]
-                    }
-                },
-                "type": "object",
-                "title": "FeedbackToggleRequest",
-                "description": "Model representing a feedback toggle request.\n\nAttributes:\n    status: Boolean controlling what the Feedback status should be.\n\nExample:\n    ```python\n    feedback_request = FeedbackRequest(\n        status=false\n    )\n    ```"
-            },
             "ForbiddenResponse": {
                 "properties": {
                     "detail": {

src/app/endpoints/feedback.py

@@ -20,7 +20,6 @@
     UnauthorizedResponse,
     ForbiddenResponse,
 )
-from models.requests import FeedbackToggleRequest
 from utils.suid import get_suid
 
 logger = logging.getLogger(__name__)
@@ -178,32 +177,20 @@ def feedback_status() -> StatusResponse:
 
 
 @router.post("/toggle")
-def feedback_toggle(feedback_toggle_request: FeedbackToggleRequest) -> StatusResponse:
+def feedback_toggle() -> StatusResponse:
     """
     Handle feedback toggle requests.
 
-    Returns the current enbaled status of the feedback functionality after it has been
-    updated to the desired value from the request.
+    Returns the current enabled status of the feedback functionality after it has been
+    updated to the opposite value from the previously set value.
 
     Returns:
         StatusResponse: Indicates whether feedback is enabled.
     """
-    fetched_status = toggle_feedback_status(feedback_toggle_request)
-    return StatusResponse(functionality="feedback", status={"enabled": fetched_status})
-
-
-def toggle_feedback_status(req: FeedbackToggleRequest) -> bool:
-    """
-    Toggles the feedback boolean stored in the configuration.
-
-    This toggling is temporary until the service is interrupted as it will not edit
-    any configuration files.
-
-    Parameters:
-        req (FeedbackToggleRequest): The request received with a boolean for the new value.
-
-    Returns:
-        bool: The current enabled status of feedback.
-    """
-    configuration.user_data_collection_configuration.feedback_enabled = req.get_value()
-    return is_feedback_enabled()
+    flipped_feedback_status = not is_feedback_enabled()
+    configuration.user_data_collection_configuration.feedback_enabled = (
+        flipped_feedback_status
+    )
+    return StatusResponse(
+        functionality="feedback", status={"enabled": flipped_feedback_status}
+    )

src/models/requests.py

@@ -380,28 +380,3 @@ def check_feedback_provided(self) -> Self:
                 "'sentiment', 'user_feedback', or 'categories'"
             )
         return self
-
-
-class FeedbackToggleRequest(BaseModel):
-    """Model representing a feedback toggle request.
-
-    Attributes:
-        status: Boolean controlling what the Feedback status should be.
-
-    Example:
-        ```python
-        feedback_request = FeedbackRequest(
-            status=false
-        )
-        ```
-    """
-
-    status: bool = Field(
-        False,
-        description="Desired state of feedback enablement, must be False or True",
-        examples=[True, False],
-    )
-
-    def get_value(self) -> bool:
-        """Return the value of the status attribute."""
-        return self.status

tests/unit/app/endpoints/test_feedback.py

@@ -12,7 +12,6 @@
     feedback_status,
     feedback_toggle,
 )
-from models.requests import FeedbackToggleRequest
 from tests.unit.utils.auth_helpers import mock_authorization_resolvers
 
 
@@ -207,43 +206,12 @@ def test_feedback_status():
     assert response.status == {"enabled": True}
 
 
-def test_feedback_toggle_enabled():
-    """Test that feedback_toggle processes feedback toggle for disabled status payloads."""
+def test_feedback_toggle():
+    """Test that feedback_toggle correctly toggles the feedback enabled bool."""
 
     configuration.user_data_collection_configuration.feedback_enabled = True
 
-    feedback_toggle_request = FeedbackToggleRequest(status=False)
-
-    response = feedback_toggle(feedback_toggle_request=feedback_toggle_request)
+    response = feedback_toggle()
 
     assert response.functionality == "feedback"
     assert response.status == {"enabled": False}
-
-
-def test_feedback_toggle_disabled():
-    """Test that feedback_toggle processes feedback toggle for enabled status payloads."""
-
-    configuration.user_data_collection_configuration.feedback_enabled = False
-
-    feedback_toggle_request = FeedbackToggleRequest(status=True)
-
-    response = feedback_toggle(feedback_toggle_request=feedback_toggle_request)
-
-    assert response.functionality == "feedback"
-    assert response.status == {"enabled": True}
-
-
-def test_feedback_toggle_equivalent():
-    """
-    Test that feedback_toggle processes feedback toggle for status payloads with the same value
-    as what is presently set.
-    """
-
-    configuration.user_data_collection_configuration.feedback_enabled = True
-
-    feedback_toggle_request = FeedbackToggleRequest(status=True)
-
-    response = feedback_toggle(feedback_toggle_request=feedback_toggle_request)
-
-    assert response.functionality == "feedback"
-    assert response.status == {"enabled": True}