Adds FogBugz case creation for support requests

Integrates automatic case creation in FogBugz when a user submits
the first message in a support conversation, if configured.

Falls back to email-based support request if FogBugz is not set up,
and logs actions for clarity.

Updates data types and test coverage to reflect new workflow.

Author: matusdrobuliak66

services/web/server/src/simcore_service_webserver/conversations/_controller/_conversations_messages_rest.py

@@ -1,4 +1,5 @@
 import functools
+import json
 import logging
 from typing import Any
 
@@ -22,20 +23,24 @@
 from models_library.utils.fastapi_encoders import jsonable_encoder
 from pydantic import BaseModel, ConfigDict
 from servicelib.aiohttp import status
+from servicelib.aiohttp.application_keys import APP_SETTINGS_KEY
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
     parse_request_path_parameters_as,
     parse_request_query_parameters_as,
 )
 from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from servicelib.rest_constants import RESPONSE_MODEL_POLICY
-from simcore_service_webserver.users import users_service
 
 from ..._meta import API_VTAG as VTAG
 from ...email import email_service
+from ...fogbugz import get_fogbugz_rest_client
+from ...fogbugz._client import FogbugzCaseCreate
+from ...fogbugz.settings import FogbugzSettings
 from ...login.decorators import login_required
 from ...models import AuthenticatedRequestContext
 from ...products import products_web
+from ...users import users_service
 from ...utils_aiohttp import envelope_json_response
 from .. import _conversation_message_service, _conversation_service
 from ._common import ConversationPathParams, raise_unsupported_type
@@ -107,10 +112,60 @@ async def create_conversation_message(request: web.Request):
     )
 
     # NOTE: This is done here in the Controller layer, as the interface around email currently needs request
-    if is_first_message:
+    product = products_web.get_current_product(request)
+    fogbugz_settings_or_none: FogbugzSettings | None = request.app[
+        APP_SETTINGS_KEY
+    ].WEBSERVER_FOGBUGZ
+    if (
+        product.support_standard_group_id
+        and fogbugz_settings_or_none is not None
+        and is_first_message
+    ):
+        _logger.debug(
+            "Support settings available and FogBugz client configured, creating FogBugz case."
+        )
+        assert product.support_assigned_fogbugz_project_id  # nosec
+
+        try:
+            user = await users_service.get_user(request.app, req_ctx.user_id)
+            _url = request.url
+            _conversation_url = f"{_url.scheme}://{_url.host}/#/conversation/{path_params.conversation_id}"
+
+            _description = f"""
+            Dear Support Team,
+
+            We have received a support request from {user["first_name"]} {user["last_name"]} ({user["email"]}) on {request.host}.
+
+            All communication should take place in the Platform Support Center at the following link: {_conversation_url}
+
+            First message content: {message.content}
+
+            Extra content: {json.dumps(_conversation.extra_context)}
+            """
+
+            _fogbugz_client = get_fogbugz_rest_client(request.app)
+            _fogbugz_case_data = FogbugzCaseCreate(
+                fogbugz_project_id=product.support_assigned_fogbugz_project_id,
+                title=f"Request for Support on {request.host}",
+                description=_description,
+            )
+            await _fogbugz_client.create_case(_fogbugz_case_data)
+        except Exception:  # pylint: disable=broad-except
+            _logger.exception(
+                "Failed to create support request FogBugz case for conversation %s.",
+                _conversation.conversation_id,
+            )
+
+    elif (
+        product.support_standard_group_id
+        and fogbugz_settings_or_none is None
+        and is_first_message
+    ):
+        _logger.debug(
+            "Support settings available, but no FogBugz client configured, sending email instead to create FogBugz case."
+        )
         try:
             user = await users_service.get_user(request.app, req_ctx.user_id)
-            product = products_web.get_current_product(request)
             template_name = "request_support.jinja2"
             destination_email = product.support_email
             email_template_path = await products_web.get_product_template_path(
@@ -141,6 +196,8 @@ async def create_conversation_message(request: web.Request):
                 template_name,
                 destination_email,
             )
+    else:
+        _logger.debug("No support settings available, skipping FogBugz case creation.")
 
     data = ConversationMessageRestGet.from_domain_model(message)
     return envelope_json_response(data, web.HTTPCreated)

services/web/server/src/simcore_service_webserver/fogbugz/__init__.py

@@ -0,0 +1,11 @@
+from ._client import FogbugzCaseCreate, FogbugzRestClient, get_fogbugz_rest_client
+
+assert get_fogbugz_rest_client  # nosec
+assert FogbugzCaseCreate  # nosec
+assert FogbugzRestClient  # nosec
+
+__all__ = [
+    "get_fogbugz_rest_client",
+    "FogbugzCaseCreate",
+    "FogbugzRestClient",
+]

services/web/server/src/simcore_service_webserver/fogbugz/_client.py

@@ -21,13 +21,9 @@
 _JSON_CONTENT_TYPE = "application/json"
 _UNKNOWN_ERROR_MESSAGE = "Unknown error occurred"
 
-_FOGBUGZ_TIMEOUT: float = Field(
-    default=45.0, description="API request timeout in seconds"
-)
-
 
 class FogbugzCaseCreate(BaseModel):
-    fogbugz_project_id: str = Field(description="Project ID in Fogbugz")
+    fogbugz_project_id: int = Field(description="Project ID in Fogbugz")
     title: str = Field(description="Case title")
     description: str = Field(description="Case description/first comment")
 
@@ -36,7 +32,7 @@ class FogbugzRestClient:
     """REST client for Fogbugz API"""
 
     def __init__(self, api_token: SecretStr, base_url: AnyUrl) -> None:
-        self._client = httpx.AsyncClient(timeout=_FOGBUGZ_TIMEOUT)
+        self._client = httpx.AsyncClient()
         self._api_token = api_token
         self._base_url = base_url
 
@@ -57,7 +53,7 @@ async def create_case(self, data: FogbugzCaseCreate) -> str:
         json_payload = {
             "cmd": "new",
             "token": self._api_token.get_secret_value(),
-            "ixProject": data.fogbugz_project_id,
+            "ixProject": f"{data.fogbugz_project_id}",
             "sTitle": data.title,
             "sEvent": data.description,
         }

services/web/server/tests/unit/with_dbs/04/test_fogbugz_client.py

@@ -4,6 +4,7 @@
 # pylint: disable=too-many-arguments
 # pylint: disable=too-many-statements
 
+import json
 from collections.abc import Iterator
 
 import httpx
@@ -94,11 +95,20 @@ async def test_fogubugz_client(
     fogbugz_client = get_fogbugz_rest_client(client.app)
     assert fogbugz_client
 
+    _json = {"first_key": "test", "second_key": "test2"}
+    _description = f"""
+    Dear Support Team,
+
+    We have received a support request.
+
+    Extra content: {json.dumps(_json)}
+    """
+
     case_id = await fogbugz_client.create_case(
         data=FogbugzCaseCreate(
-            fogbugz_project_id="45",
+            fogbugz_project_id=45,
             title="Matus Test Automatic Creation of Fogbugz Case",
-            description="This is a test case",
+            description=_description,
         )
     )
     assert case_id == _IXBUG_DUMMY