✨(backend) add settings to configure drive external service

We want to add ability to Messages to interop with our Drive application.
First, we want to be able to set the Drive base url through environment
variable then pass down Drive configuration to frontend through the config
api endpoint.

https://github.com/suitenumerique/drive

Author: jbpenrath

docs/env.md

@@ -268,6 +268,16 @@ The application uses a new environment file structure with `.defaults` and `.loc
 | `AI_MODEL` | None | Default model used for AI features | Optional |
 | `AI_FEATURE_SUMMARY_ENABLED` | `False` | Default enabled mode for summary AI features | Required |
 
+### External Services
+
+#### Drive
+
+| Variable | Default | Description | Required |
+|----------|---------|-------------|----------|
+| `DRIVE_BASE_URL` | None | Base URL to access Drive endpoints | Optional |
+
+
+
 ## Legend
 
 - **Required**: Must be set for the application to function

env.d/development/backend.defaults

@@ -73,9 +73,13 @@ MTA_OUT_SMTP_PASSWORD=pass
 MDA_API_SECRET=my-shared-secret-mda
 SALT_KEY=ThisIsAnExampleSaltForDevPurposeOnly
 
-# AI 
+# AI
 AI_BASE_URL=
 AI_API_KEY=
 AI_MODEL=
 
-AI_FEATURE_SUMMARY_ENABLED=False
+AI_FEATURE_SUMMARY_ENABLED=False
+
+# Interoperability
+# Drive - https://github.com/suitenumerique/drive
+DRIVE_BASE_URL=

src/backend/core/api/openapi.json

@@ -181,6 +181,25 @@
                                         "AI_FEATURE_SUMMARY_ENABLED": {
                                             "type": "boolean",
                                             "readOnly": true
+                                        },
+                                        "DRIVE": {
+                                            "type": "object",
+                                            "description": "The URLs of the Drive external service.",
+                                            "properties": {
+                                                "sdk_url": {
+                                                    "type": "string",
+                                                    "readOnly": true
+                                                },
+                                                "api_url": {
+                                                    "type": "string",
+                                                    "readOnly": true
+                                                }
+                                            },
+                                            "readOnly": true,
+                                            "required": [
+                                                "sdk_url",
+                                                "api_url"
+                                            ]
                                         }
                                     },
                                     "required": [

src/backend/core/api/viewsets/config.py

@@ -49,6 +49,22 @@ class ConfigView(drf.views.APIView):
                             "type": "boolean",
                             "readOnly": True,
                         },
+                        "DRIVE": {
+                            "type": "object",
+                            "description": "The URLs of the Drive external service.",
+                            "properties": {
+                                "sdk_url": {
+                                    "type": "string",
+                                    "readOnly": True,
+                                },
+                                "api_url": {
+                                    "type": "string",
+                                    "readOnly": True,
+                                },
+                            },
+                            "readOnly": True,
+                            "required": ["sdk_url", "api_url"],
+                        },
                     },
                     "required": [
                         "ENVIRONMENT",
@@ -83,7 +99,19 @@ def get(self, request):
             if hasattr(settings, setting):
                 dict_settings[setting] = getattr(settings, setting)
 
+        # AI Features
         dict_settings["AI_ENABLED"] = is_ai_enabled()
         dict_settings["AI_FEATURE_SUMMARY_ENABLED"] = is_ai_summary_enabled()
 
+        # Drive service
+        if base_url := settings.DRIVE_CONFIG.get("base_url"):
+            dict_settings.update(
+                {
+                    "DRIVE": {
+                        "sdk_url": f"{base_url}{settings.DRIVE_CONFIG.get('sdk_url')}",
+                        "api_url": f"{base_url}{settings.DRIVE_CONFIG.get('api_url')}",
+                    }
+                }
+            )
+
         return drf.response.Response(dict_settings)

src/backend/core/tests/api/test_config.py

@@ -25,6 +25,7 @@
     AI_BASE_URL=None,
     AI_MODEL=None,
     AI_FEATURE_SUMMARY_ENABLED=False,
+    DRIVE_CONFIG={"base_url": None},
 )
 @pytest.mark.parametrize("is_authenticated", [False, True])
 def test_api_config(is_authenticated):
@@ -47,3 +48,22 @@ def test_api_config(is_authenticated):
         "AI_ENABLED": False,
         "AI_FEATURE_SUMMARY_ENABLED": False,
     }
+
+
+@override_settings(
+    DRIVE_CONFIG={
+        "base_url": "http://localhost:8902",
+        "sdk_url": "/sdk",
+        "api_url": "/api/v1.0",
+    }
+)
+def test_api_config_with_external_services():
+    """If Drive external service is configured, it should be included in the configuration."""
+    client = APIClient()
+
+    response = client.get("/api/v1.0/config/")
+    assert response.status_code == HTTP_200_OK
+    assert response.json().get("DRIVE") == {
+        "sdk_url": "http://localhost:8902/sdk",
+        "api_url": "http://localhost:8902/api/v1.0",
+    }

src/backend/messages/settings.py

@@ -592,6 +592,18 @@ class Base(Configuration):
         environ_prefix=None,
     )
 
+    # External services
+    # Settings related to the interoperability with external services
+    # that messges is able to use
+    # 1. Drive - https://github.com/suitenumerique/drive
+    DRIVE_CONFIG = {
+        "base_url": values.Value(
+            default=None, environ_name="DRIVE_BASE_URL", environ_prefix=None
+        ),
+        "sdk_url": "/sdk",
+        "api_url": "/api/v1.0",
+    }
+
     # pylint: disable=invalid-name
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)

src/frontend/src/features/api/gen/models/config_retrieve200.ts

@@ -5,6 +5,7 @@
  * This is the messages API schema.
  * OpenAPI spec version: 1.0.0 (v1.0)
  */
+import type { ConfigRetrieve200DRIVE } from "./config_retrieve200_driv_e";
 
 export type ConfigRetrieve200 = {
   readonly ENVIRONMENT: string;
@@ -18,4 +19,6 @@ export type ConfigRetrieve200 = {
   readonly LANGUAGE_CODE: string;
   readonly AI_ENABLED: boolean;
   readonly AI_FEATURE_SUMMARY_ENABLED: boolean;
+  /** The URLs of the Drive external service. */
+  readonly DRIVE?: ConfigRetrieve200DRIVE;
 };

src/frontend/src/features/api/gen/models/config_retrieve200_driv_e.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * messages API
+ * This is the messages API schema.
+ * OpenAPI spec version: 1.0.0 (v1.0)
+ */
+
+/**
+ * The URLs of the Drive external service.
+ */
+export type ConfigRetrieve200DRIVE = {
+  readonly sdk_url: string;
+  readonly api_url: string;
+};

src/frontend/src/features/api/gen/models/index.ts

@@ -11,6 +11,7 @@ export * from "./blob_upload_create201";
 export * from "./blob_upload_create_body";
 export * from "./change_flag_request_request";
 export * from "./config_retrieve200";
+export * from "./config_retrieve200_driv_e";
 export * from "./contact";
 export * from "./contacts_list_params";
 export * from "./dnscheck_response";