Adds MWI_SESSION_NAME environment variable for custom browser tab titles.

Author: prabhakk-mw

Advanced-Usage.md

@@ -33,6 +33,7 @@ The following table describes all the environment variables that you can set to
 | **MWI_PROCESS_START_TIMEOUT** | integer (optional) | `1234` |  This field controls the time (in seconds) for which `matlab-proxy` waits for the processes it spins up, viz: MATLAB & Xvfb, to respond. By default, this value is `600 seconds`. A timeout could either indicate an issue with the spawned processes or be a symptom of a resource-constrained environment. Increase this value if your environment needs more time for the spawned processes to start.|
 | **MWI_MATLAB_STARTUP_SCRIPT** | string (optional) | `"addpath('/path/to/a/folder'), c=12"` | Executes string provided at MATLAB startup. For details, see [Run Custom MATLAB Startup Code](#run-custom-matlab-startup-code) |
 | **MWI_SHUTDOWN_ON_IDLE_TIMEOUT** | integer (optional) | 60 | Defines the duration in minutes, that `matlab-proxy` remains idle before shutting down. When you do not set the variable, `matlab-proxy` will not shut down when idle. For details, [see Shutdown on Idle](#shutdown-on-idle). |
+| **MWI_SESSION_NAME** | string (optional) | "My MATLAB" | Specifies the title of the browser tab, displayed as `{MWI_SESSION_NAME} - MATLAB R20xxy`. Default value is `MATLAB R20XXy`. |
 
 ## Shutdown on Idle
 

gui/src/components/App/index.jsx

@@ -40,6 +40,7 @@ import {
     selectMatlabStarting,
     selectIsIdleTimeoutEnabled,
     selectMatlabStopping,
+    selectBrowserTitle,
     selectIntegrationName
 } from '../../selectors';
 
@@ -54,7 +55,7 @@ import blurredBackground from './MATLAB-env-blur.png';
 import EntitlementSelector from '../EntitlementSelector';
 import { BUFFER_TIMEOUT_DURATION, MWI_AUTH_TOKEN_NAME_FOR_HTTP } from '../../constants';
 
-function App () {   
+function App() {
     const dispatch = useDispatch();
 
     const overlayVisible = useSelector(selectOverlayVisible);
@@ -76,6 +77,7 @@ function App () {
     const isConcurrencyEnabled = useSelector(selectIsConcurrencyEnabled);
     const wasEverActive = useSelector(selectWasEverActive);
     const integrationName = useSelector(selectIntegrationName);
+    const browserTitle = useSelector(selectBrowserTitle);
 
     // Timeout duration is specified in seconds, but useTimeoutFn accepts timeout values in ms.
     const idleTimeoutDurationInMS = useSelector(selectIdleTimeoutDurationInMS);
@@ -93,7 +95,7 @@ function App () {
 
 
     // callback that will fire once the IDLE timer expires
-    function terminationFn () {
+    function terminationFn() {
         // Reset the timer if MATLAB is either starting or stopping or is busy
         if (isMatlabStarting || isMatlabStopping || isMatlabBusy) {
             idleTimerReset();
@@ -303,7 +305,7 @@ function App () {
         if (hasFetchedEnvConfig) {
             const queryParams = parseQueryParams(window.location);
             const token = queryParams.get(MWI_AUTH_TOKEN_NAME_FOR_HTTP);
-
+            document.title = `${browserTitle}`;
             if (token) {
                 dispatch(updateAuthStatus(token));
             }
@@ -331,7 +333,7 @@ function App () {
             overlayContent = <ShutdownWarning
                 bufferTimeout={BUFFER_TIMEOUT_DURATION}
                 resumeCallback={() => {
-                // Restart IDLE timer
+                    // Restart IDLE timer
                     idleTimerReset();
                     setIdleTimerHasExpired(false);
 
@@ -386,7 +388,7 @@ function App () {
     if (matlabUp) {
         matlabJsd = (!authEnabled || isAuthenticated)
             ? (<MatlabJsd handleUserInteraction={handleUserInteraction} url={matlabUrl} iFrameRef={MatlabJsdIframeRef} shouldListenForEvents={shouldListenForEvents} />)
-            : <img style={{ objectFit: 'fill' }}src={blurredBackground} alt='Blurred MATLAB environment'/>;
+            : <img style={{ objectFit: 'fill' }} src={blurredBackground} alt='Blurred MATLAB environment' />;
     }
 
     const overlayTrigger = overlayVisible

gui/src/selectors/index.js

@@ -260,9 +260,23 @@ export const selectIsIdleTimeoutEnabled = createSelector(
 export const selectIdleTimeoutDurationInMS = createSelector(
     selectIsIdleTimeoutEnabled,
     selectIdleTimeoutDuration,
-    (isTimeoutEnabled, idleTimeoutDuration) => { return isTimeoutEnabled
-        ? idleTimeoutDuration * 1000
-        : undefined; }
+    (isTimeoutEnabled, idleTimeoutDuration) => {
+        return isTimeoutEnabled
+            ? idleTimeoutDuration * 1000
+            : undefined;
+    }
+);
+
+export const selectBrowserTitle = createSelector(
+    selectHasFetchedEnvConfig,
+    selectEnvConfig,
+    (hasFetchedEnvConfig, envConfig) => {
+        if (hasFetchedEnvConfig) {
+            return envConfig.browserTitle;
+        } else {
+            return 'MATLAB';
+        }
+    }
 );
 
 export const selectIntegrationName = createSelector(

matlab_proxy/app.py

@@ -209,6 +209,8 @@ async def get_env_config(req):
         "supportedVersions": constants.SUPPORTED_MATLAB_VERSIONS,
     }
 
+    config["browserTitle"] = state.settings["browser_title"]
+
     # Send timeout duration for the idle timer as part of the response
     config["idleTimeoutDuration"] = state.settings["mwi_idle_timeout"]
 

matlab_proxy/app_state.py

@@ -896,8 +896,8 @@ def create_server_info_file(self):
 
         mwi_server_info_file = mwi_logs_dir / "mwi_server.info"
         mwi_auth_token_str = token_auth.get_mwi_auth_token_access_str(self.settings)
-        with open(mwi_server_info_file, "w") as fh:
-            fh.write(self.settings["mwi_server_url"] + mwi_auth_token_str + "\n")
+        with open(mwi_server_info_file, "w", encoding="utf-8") as fh:
+            fh.write(self.settings["mwi_server_url"] + mwi_auth_token_str + "\n" + self.settings["browser_title"] + "\n")
         self.mwi_server_session_files["mwi_server_info_file"] = mwi_server_info_file
         logger.debug(f"Server info stored into: {mwi_server_info_file}")
 

matlab_proxy/settings.py

@@ -21,7 +21,7 @@
 from matlab_proxy.util import mwi, system
 from matlab_proxy.util.cookie_jar import HttpOnlyCookieJar
 from matlab_proxy.util.mwi import environment_variables as mwi_env
-from matlab_proxy.util.mwi import token_auth
+from matlab_proxy.util.mwi import token_auth, session_name
 from matlab_proxy.util.mwi.exceptions import (
     FatalError,
     MatlabInstallError,
@@ -222,6 +222,7 @@ def get_dev_settings(config):
         "is_windowmanager_available": False,
         "mwi_idle_timeout": None,
         "cookie_jar": _get_cookie_jar(),
+        "browser_title": session_name.get_browser_title("R2020b"),
     }
 
 
@@ -324,7 +325,6 @@ def get_server_settings(config_name):
     )
 
     cookie_jar = _get_cookie_jar()
-
     return {
         "create_xvfb_cmd": create_xvfb_cmd,
         "base_url": mwi.validators.validate_base_url(
@@ -406,6 +406,7 @@ def get_matlab_settings():
         **mw_licensing_urls,
         "nlm_conn_str": nlm_conn_str,
         "has_custom_code_to_execute": has_custom_code_to_execute,
+        "browser_title": session_name.get_browser_title(matlab_version),
     }
 
 

matlab_proxy/util/list_servers.py

@@ -31,8 +31,8 @@ def print_server_info():
         for server in search_results:
             server_number += 1
             with open(server) as f:
-                server_info = f.read()
-                print_output += str(server_number) + ".  " + str(server_info)
+                server_info = f.readline().strip()
+                print_output += str(server_number) + ".  " + str(server_info) + "\n"
 
     print_output += str(
         mwi_util.prettify(

matlab_proxy/util/mwi/environment_variables.py

@@ -172,6 +172,11 @@ def get_env_name_shutdown_on_idle_timeout():
     return "MWI_SHUTDOWN_ON_IDLE_TIMEOUT"
 
 
+def get_env_name_session_name():
+    """User specified session name for the MATLAB Proxy instance, used to set the browser title."""
+    return "MWI_SESSION_NAME"
+
+
 class Experimental:
     """This class houses functions which are undocumented APIs and Environment variables.
     Note: Never add any state to this class. Its only intended for use as an abstraction layer

matlab_proxy/util/mwi/session_name.py

@@ -0,0 +1,27 @@
+# Copyright 2025 The MathWorks, Inc.
+"""This file provides functions to set a session name for the MATLAB Proxy instance."""
+
+import os
+from matlab_proxy.util.mwi import environment_variables as mwi_env
+from matlab_proxy.util.mwi import logger as mwi_logger
+
+logger = mwi_logger.get()
+
+def _get_session_name():
+    """Get the session name for the MATLAB Proxy instance.
+
+    Returns:
+        str: returns the user-defined session name if set, otherwise returns None.
+    """
+    return os.getenv(mwi_env.get_env_name_session_name(), None)
+
+
+def get_browser_title(matlab_version) -> str:
+    """Get the browser title for the MATLAB Proxy instance."""
+
+    browser_title = "MATLAB " + (matlab_version or "")
+    session_name = _get_session_name()
+    if session_name:
+        browser_title = session_name + " - " + browser_title
+        logger.info("Session Name set to : %s", session_name)
+    return browser_title

tests/unit/test_app.py

@@ -360,6 +360,7 @@ async def test_get_env_config(test_server):
         "should_show_shutdown_button": True,
         "isConcurrencyEnabled": "foobar",
         "idleTimeoutDuration": 100,
+        "browserTitle": "MATLAB R2020b",
     }
     resp = await test_server.get("/get_env_config")
     assert resp.status == HTTPStatus.OK