Ensures MATLAB proxy manager correctly forwards client request headers.

Author: krisctl

matlab_proxy_manager/web/app.py

@@ -232,7 +232,7 @@ async def proxy(req):
 
     # Set content length in case of modification
     req_headers["Content-Length"] = str(len(req_body))
-    req_headers["x-forwarded-proto"] = "http"
+    req_headers["X-Forwarded-Proto"] = "http"
     req_path = req.rel_url
 
     # Redirect block to move /*/matlab to /*/matlab/default/
@@ -272,9 +272,11 @@ async def proxy(req):
         and req_headers.get(upgrade, "").lower() == "websocket"
         and req.method == "GET"
     ):
-        return await _handle_websocket_request(req, proxy_url)
+        return await _forward_websocket_request(req, proxy_url)
     try:
-        return await _handle_http_request(req, req_body, proxy_url, backend_server)
+        return await _forward_http_request(
+            req, req_body, proxy_url, _collate_headers(req_headers, backend_server)
+        )
     except web.HTTPFound:
         log.debug("Redirection to path with /default")
         raise
@@ -295,7 +297,20 @@ async def proxy(req):
 # Helper private functions
 
 
-async def _handle_websocket_request(
+def _collate_headers(req_headers: dict, backend_server: dict) -> dict:
+    """Combines request headers with backend server (matlab-proxy) headers.
+
+    Args:
+        req_headers (dict): The headers from the incoming request.
+        backend_server (dict): The backend server configuration.
+
+    Returns:
+        dict: A new dictionary containing all headers from both sources.
+    """
+    return {**req_headers, **backend_server.get("headers")}
+
+
+async def _forward_websocket_request(
     req: web.Request, proxy_url: str
 ) -> web.WebSocketResponse:
     """Handles a websocket request to the backend matlab proxy server
@@ -381,8 +396,11 @@ async def ws_forward(ws_src, ws_dest):
             raise aiohttp.WebSocketError(code=code, message=message)
 
 
-async def _handle_http_request(
-    req: web.Request, req_body: Optional[bytes], proxy_url: str, backend_server: dict
+async def _forward_http_request(
+    req: web.Request,
+    req_body: Optional[bytes],
+    proxy_url: str,
+    headers: dict,
 ) -> web.Response:
     """
     Forwards an incoming HTTP request to a specified backend server.
@@ -396,7 +414,7 @@ async def _handle_http_request(
         proxy_url,
         allow_redirects=True,
         data=req_body,
-        headers=backend_server.get("headers"),
+        headers=headers,
     ) as res:
         headers = res.headers.copy()
         body = await res.read()

tests/unit/proxy-manager/web/test_app.py

@@ -259,14 +259,14 @@ async def test_proxy_websocket_request(self, mocker):
             "matlab_proxy_manager.web.app._get_backend_server",
             return_value={"absolute_url": "http://server1"},
         )
-        mock_handle_websocket = mocker.patch(
-            "matlab_proxy_manager.web.app._handle_websocket_request",
+        mock_forward_websocket = mocker.patch(
+            "matlab_proxy_manager.web.app._forward_websocket_request",
             return_value=web.WebSocketResponse(),
         )
 
         await app.proxy(mock_req)
 
-        mock_handle_websocket.assert_called_once()
+        mock_forward_websocket.assert_called_once()
 
     async def test_proxy_http_request(self, mocker):
         """
@@ -284,16 +284,16 @@ async def test_proxy_http_request(self, mocker):
 
         mocker.patch(
             "matlab_proxy_manager.web.app._get_backend_server",
-            return_value={"absolute_url": "http://server"},
+            return_value={"absolute_url": "http://server", "headers": {}},
         )
-        mock_handle_http = mocker.patch(
-            "matlab_proxy_manager.web.app._handle_http_request",
+        mock_forward_http = mocker.patch(
+            "matlab_proxy_manager.web.app._forward_http_request",
             return_value=web.Response(),
         )
 
         await app.proxy(mock_req)
 
-        mock_handle_http.assert_called_once()
+        mock_forward_http.assert_called_once()
 
     async def test_proxy_server_disconnected(self, mocker):
         """
@@ -310,10 +310,10 @@ async def test_proxy_server_disconnected(self, mocker):
 
         mocker.patch(
             "matlab_proxy_manager.web.app._get_backend_server",
-            return_value={"absolute_url": "http://backend"},
+            return_value={"absolute_url": "http://backend", "headers": {}},
         )
         mocker.patch(
-            "matlab_proxy_manager.web.app._handle_http_request",
+            "matlab_proxy_manager.web.app._forward_http_request",
             side_effect=client_exceptions.ServerDisconnectedError,
         )
 
@@ -339,13 +339,55 @@ async def test_proxy_unexpected_exception(self, mocker):
             return_value={"absolute_url": "http://backend"},
         )
         mocker.patch(
-            "matlab_proxy_manager.web.app._handle_http_request",
+            "matlab_proxy_manager.web.app._forward_http_request",
             side_effect=Exception("Unexpected error"),
         )
 
         with pytest.raises(web.HTTPNotFound):
             await app.proxy(mock_req)
 
+    async def test_proxy_correct_req_headers_are_forwarded(self, mocker):
+        """
+        Test that the correct request headers are forwarded to the backend server.
+
+        This test ensures that the proxy function correctly forwards the necessary
+        headers to the backend server, including the MWI-MPM-CONTEXT header.
+        """
+        mock_req = mocker.AsyncMock()
+        mock_req.read = mocker.AsyncMock(return_value=b"request_body")
+        mock_req.rel_url = "/matlab/default/some/path"
+        mock_req.headers = {
+            "JSESSION-ID": "123456789",
+            "MWI-MPM-CONTEXT": "test_context",
+        }
+        mock_req.method = "GET"
+
+        mocker.patch(
+            "matlab_proxy_manager.web.app._get_backend_server",
+            return_value={
+                "absolute_url": "http://server1",
+                "headers": {"MWI-AUTH-TOKEN": "token"},
+            },
+        )
+        mock_forward_http = mocker.patch(
+            "matlab_proxy_manager.web.app._forward_http_request",
+            return_value=web.Response(),
+        )
+        await app.proxy(mock_req)
+        mock_forward_http.assert_called_once_with(
+            mock_req,
+            b"request_body",
+            "http://server1/some/path",
+            {
+                **mock_req.headers,
+                **{
+                    "MWI-AUTH-TOKEN": "token",
+                    "Content-Length": "12",
+                    "X-Forwarded-Proto": "http",
+                },
+            },
+        )
+
 
 @pytest.fixture
 def patch_env_vars(monkeypatch):