Adds support for notebook magic %matlab [OPTIONS] in jupyter-matlab-proxy.

Author: krisctl

matlab_proxy/app.py

@@ -207,6 +207,7 @@ async def get_env_config(req):
     config["matlab"] = {
         "version": state.settings["matlab_version"],
         "supportedVersions": constants.SUPPORTED_MATLAB_VERSIONS,
+        "rootPath": str(state.settings.get("matlab_path", "")),
     }
 
     config["browserTitle"] = state.settings["browser_title"]
@@ -432,8 +433,12 @@ async def shutdown_integration_delete(req):
         req (HTTPRequest): HTTPRequest Object
     """
     state = req.app["state"]
-    logger.info(f"Shutting down {state.settings['integration_name']}...")
+    if state.is_shutting_down:
+        logger.debug("Shutdown already in progress")
+        return create_status_response(req.app, "../")
 
+    logger.info(f"Shutting down {state.settings['integration_name']}...")
+    state.is_shutting_down = True
     res = create_status_response(req.app, "../")
 
     # Schedule the shutdown to happen after the response is sent

matlab_proxy/app_state.py

@@ -154,6 +154,9 @@ def __init__(self, settings):
                 self.__decrement_idle_timer()
             )
 
+        # Flag to track if matlab-proxy is in the process of shutting down
+        self.is_shutting_down: bool = False
+
     def set_remaining_idle_timeout(self, new_timeout):
         """Sets the remaining IDLE timeout after the validating checks.
 

matlab_proxy_manager/lib/api.py

@@ -21,19 +21,37 @@
 
 
 async def start_matlab_proxy_for_kernel(
-    caller_id: str, parent_id: str, is_shared_matlab: bool, base_url_prefix: str = ""
+    caller_id: str,
+    parent_id: str,
+    is_shared_matlab: bool,
+    base_url_prefix: str = "",
+    **kwargs,
 ):
     """
     Starts a MATLAB proxy server specifically for MATLAB Kernel.
 
     This function is a wrapper around the `start_matlab_proxy` function, with mpm_auth_token
     set to None, for starting the MATLAB proxy server via proxy manager.
+
+    Args:
+        caller_id (str): The identifier for the caller (kernel id).
+        parent_id (str): The context in which the server is being started (parent pid).
+        is_shared_matlab (bool): Flag indicating if the MATLAB proxy is shared.
+        base_url_prefix (str, optional): Custom URL path which gets added to mwi_base_url. Defaults to "".
+        **kwargs: Additional keyword arguments:
+            env (Dict[str, str], optional): Dictionary of environment variables to set for the
+                MATLAB proxy process. These variables can control various aspects of the MATLAB proxy
+                behavior. Defaults to None.
+
+    Returns:
+        dict: A dictionary representation of the server process, including any errors encountered.
     """
     return await _start_matlab_proxy(
         caller_id=caller_id,
         ctx=parent_id,
         is_shared_matlab=is_shared_matlab,
         base_url_prefix=base_url_prefix,
+        **kwargs,
     )
 
 
@@ -42,19 +60,34 @@ async def start_matlab_proxy_for_jsp(
     is_shared_matlab: bool,
     mpm_auth_token: str,
     base_url_prefix: str = "",
+    **kwargs,
 ):
     """
     Starts a MATLAB proxy server specifically for Jupyter Server Proxy (JSP) - Open MATLAB launcher.
 
     This function is a wrapper around the `start_matlab_proxy` function, providing
     a more specific context (mpm_auth_token) for starting the MATLAB proxy server via proxy manager.
+
+    Args:
+        caller_id (str): The identifier for the caller (kernel id).
+        parent_id (str): The context in which the server is being started (parent pid).
+        is_shared_matlab (bool): Flag indicating if the MATLAB proxy is shared.
+        base_url_prefix (str, optional): Custom URL path which gets added to mwi_base_url. Defaults to "".
+        **kwargs: Additional keyword arguments:
+            env (Dict[str, str], optional): Dictionary of environment variables to set for the
+                MATLAB proxy process. These variables can control various aspects of the MATLAB proxy
+                behavior. Defaults to None.
+
+    Returns:
+        dict: A dictionary representation of the server process, including any errors encountered.
     """
     return await _start_matlab_proxy(
         caller_id="jsp",
         ctx=parent_id,
         is_shared_matlab=is_shared_matlab,
         mpm_auth_token=mpm_auth_token,
         base_url_prefix=base_url_prefix,
+        **kwargs,
     )
 
 
@@ -123,6 +156,11 @@ async def _start_matlab_proxy(**options) -> dict:
             client_id, base_url_prefix
         )
 
+        # Use client-provided environment variables, if available
+        client_env_variables = options.get("env")
+        if client_env_variables and isinstance(client_env_variables, dict):
+            matlab_proxy_env.update(client_env_variables)
+
         log.debug(
             "Starting new matlab proxy server using ctx=%s, client_id=%s, is_shared_matlab=%s",
             ctx,

matlab_proxy_manager/utils/constants.py

@@ -1,6 +1,8 @@
 # Copyright 2024-2025 The MathWorks, Inc.
+import re
 
 MWI_BASE_URL_PREFIX = "/matlab/"
 MWI_DEFAULT_MATLAB_PATH = MWI_BASE_URL_PREFIX + "default"
 HEADER_MWI_MPM_CONTEXT = "MWI-MPM-CONTEXT"
 HEADER_MWI_MPM_AUTH_TOKEN = "MWI-MPM-AUTH-TOKEN"
+MATLAB_IN_REQ_PATH_PATTERN = re.compile(r".*?/matlab/([^/]+)/(.*)")

matlab_proxy_manager/utils/decorators.py

@@ -0,0 +1,37 @@
+# Copyright 2025 The MathWorks, Inc.
+
+import functools
+from typing import Callable
+
+from matlab_proxy_manager.utils.constants import (
+    HEADER_MWI_MPM_CONTEXT,
+)
+from matlab_proxy_manager.utils.helpers import render_error_page
+
+
+def validate_incoming_request_decorator(endpoint: Callable):
+    """Decorator to validate incoming requests.
+
+    This decorator checks if the request contains the required MWI_MPM_CONTEXT header.
+    If the header is not found, it returns an error page. Otherwise, it adds the context
+    to the request object and proceeds with the endpoint execution.
+
+    Args:
+        endpoint (Callable): The endpoint function to be decorated.
+
+    Returns:
+        Callable: The wrapped function that validates the request before calling the endpoint.
+    """
+
+    @functools.wraps(endpoint)
+    async def wrapper(req):
+        ctx = req.headers.get(HEADER_MWI_MPM_CONTEXT)
+        if not ctx:
+            return render_error_page(
+                f"Required header: ${HEADER_MWI_MPM_CONTEXT} not found in the request"
+            )
+        # Add ctx to the request object
+        req.ctx = ctx
+        return await endpoint(req)
+
+    return wrapper

matlab_proxy_manager/utils/helpers.py

@@ -1,4 +1,5 @@
 # Copyright 2024-2025 The MathWorks, Inc.
+import asyncio
 import http
 import os
 import socket
@@ -194,7 +195,7 @@ def _delete_server_and_file(storage, servers) -> bool:
     return is_server_deleted
 
 
-def poll_for_server_deletion() -> None:
+async def poll_for_server_deletion(app: web.Application) -> None:
     """
     Poll for server deletion for a specified timeout period.
 
@@ -207,14 +208,17 @@ def poll_for_server_deletion() -> None:
     log.debug("Interrupt/termination signal caught, cleaning up resources")
     start_time = time.time()
 
-    while time.time() - start_time < timeout_in_seconds:
-        is_server_deleted = _are_orphaned_servers_deleted()
-        if is_server_deleted:
-            log.debug("Servers deleted, breaking out of loop")
-            break
-        log.debug("Servers not deleted, waiting")
-        # Sleep for a short interval before polling again
-        time.sleep(0.5)
+    try:
+        while time.time() - start_time < timeout_in_seconds:
+            is_server_deleted = _are_orphaned_servers_deleted()
+            if is_server_deleted:
+                log.debug("Servers deleted, breaking out of loop")
+                break
+            log.debug("Servers not deleted, waiting")
+            # Sleep for a short interval before polling again
+            await asyncio.sleep(0.5)
+    except Exception as ex:
+        log.debug("Error while polling for server deletion: %s", ex)
 
 
 @contextmanager
@@ -301,3 +305,10 @@ def create_state_file(data_dir, server_process, filename: str):
         raise IOError(
             f"Failed to create state file {filename} in {data_dir}, error: {e}"
         ) from e
+
+
+def render_error_page(error_msg: str) -> web.Response:
+    """Returns 503 with error text"""
+    return web.HTTPServiceUnavailable(
+        text=f'<p style="color: red;">{error_msg}</p>', content_type="text/html"
+    )