matlab-proxy 0.27.0__tar.gz → 0.27.3__tar.gz

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matlab-proxy
-Version: 0.27.0
+Version: 0.27.3
 Summary: Python® package enables you to launch MATLAB® and access it from a web browser.
 Project-URL: Homepage, https://github.com/mathworks/matlab-proxy/
 Project-URL: Documentation, https://github.com/mathworks/matlab-proxy/blob/main/README.md
@@ -23,6 +23,7 @@ Requires-Dist: importlib-metadata
 Requires-Dist: importlib-resources
 Requires-Dist: psutil
 Requires-Dist: requests
+Requires-Dist: rich
 Requires-Dist: watchdog
 Provides-Extra: dev
 Requires-Dist: aiohttp-devtools; extra == 'dev'

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/gui/src/components/App/index.jsx

@@ -4,8 +4,6 @@ import React, { useState, useCallback, useEffect, useMemo, useRef } from 'react'
 import { useSelector, useDispatch } from 'react-redux';
 import { useInterval, useTimeoutFn } from 'react-use';
 import './App.css';
-import './3p/css/bootstrap.min.css';
-import './3p/css/site7.min.css';
 import Confirmation from '../Confirmation';
 import OverlayTrigger from '../OverlayTrigger';
 import Overlay from '../Overlay';

matlab_proxy-0.27.3/gui/src/components/LicensingGatherer/MHLM.css

@@ -0,0 +1,7 @@
+/* Copyright 2025 The MathWorks, Inc. */
+
+iframe {
+    border: 0px;
+    height: 380px;                
+    width: 100%;
+}

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/gui/src/components/LicensingGatherer/MHLM.jsx

@@ -13,6 +13,8 @@ import {
     fetchSetLicensing
 } from '../../actionCreators';
 
+import './MHLM.css';
+
 // Send a generated nonce to the login iframe
 function setLoginNonce (username) {
     const clientNonce = (Math.random() + '').substr(2);
@@ -150,9 +152,6 @@ function MHLM ({ mhlmLicensingInfo = null }) {
                 id="loginframe"
                 title="MathWorks Embedded Login"
                 type="text/html"
-                height="380"
-                width="100%"
-                frameBorder="0"
                 src={embeddedLoginUrl}
                 onLoad={handleIFrameLoaded}
             >

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/gui/src/components/MatlabJsd/index.jsx

@@ -39,7 +39,6 @@ function MatlabJsd ({ url, iFrameRef, shouldListenForEvents, handleUserInteracti
                 ref={iFrameRef}
                 title="MATLAB JSD"
                 src={url}
-                frameBorder="0"
                 allowFullScreen />
         </div>
     );

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/hatch_build.py

@@ -3,7 +3,7 @@
 import os
 import subprocess
 from pathlib import Path
-from shutil import which, copytree
+from shutil import copytree, which
 from typing import Any, Dict
 
 from hatchling.builders.hooks.plugin.interface import BuildHookInterface
@@ -23,7 +23,8 @@ class CustomBuildHook(BuildHookInterface):
                 "npm must be installed and on the path during package build!"
             )
 
-        npm_install = [npm_path, "install"]
+        # Adding retries to npm install to avoid transient rate limiting issues
+        npm_install = [npm_path, "install", "--fetch-retries", "10"]
         npm_build = [npm_path, "run", "build"]
 
         pwd = Path.cwd()

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/matlab_proxy/app.py

@@ -432,25 +432,38 @@ async def shutdown_integration_delete(req):
         req (HTTPRequest): HTTPRequest Object
     """
     state = req.app["state"]
-
     logger.info(f"Shutting down {state.settings['integration_name']}...")
 
-    # Send response manually because this has to happen before the application exits
     res = create_status_response(req.app, "../")
-    await res.prepare(req)
-    await res.write_eof()
 
-    # Gracefully shutdown the server
-    await req.app.shutdown()
-    await req.app.cleanup()
+    # Schedule the shutdown to happen after the response is sent
+    asyncio.create_task(_shutdown_after_response(req.app))
+
+    return res
+
+
+async def _shutdown_after_response(app):
+    # Shutdown the application after a short delay to allow the response to be fully sent
+    # back to the client before the server is stopped
+    await asyncio.sleep(0.1)
+
+    # aiohttp shutdown to be invoked before cleanup -
+    # https://docs.aiohttp.org/en/stable/web_reference.html#aiohttp.web.Application.shutdown
+    await app.shutdown()
+    await app.cleanup()
 
     loop = util.get_event_loop()
-    # Run the current batch of coroutines in the event loop and then exit.
-    # This completes the loop.run_forever() blocking call and subsequent code
-    # in create_and_start_app() resumes execution.
-    loop.stop()
 
-    return res
+    # Cancel remaining tasks (except this one: _shutdown_after_response)
+    running_tasks = asyncio.all_tasks(loop)
+    current_task = asyncio.current_task()
+    if current_task:
+        running_tasks.discard(current_task)
+
+    await util.cancel_tasks(running_tasks)
+
+    # Stop the event loop from this task
+    loop.call_soon_threadsafe(loop.stop)
 
 
 # @token_auth.authenticate_access_decorator
@@ -873,8 +886,6 @@ def configure_and_start(app):
     """
     loop = util.get_event_loop()
 
-    web_logger = None if not mwi_env.is_web_logging_enabled() else logger
-
     # Setup the session storage,
     # Uniqified per session to prevent multiple proxy servers on the same FQDN from interfering with each other.
     uniqify_session_cookie = secrets.token_hex()
@@ -888,7 +899,9 @@ def configure_and_start(app):
     )
 
     # Setup runner
-    runner = web.AppRunner(app, logger=web_logger, access_log=web_logger)
+    runner = web.AppRunner(
+        app, access_log=logger if mwi_env.is_web_logging_enabled() else None
+    )
     loop.run_until_complete(runner.setup())
 
     # Prepare site to start, then set port of the app.
@@ -961,7 +974,7 @@ def create_app(config_name=matlab_proxy.get_default_config_name()):
     app.router.add_route("*", f"{base_url}", root_redirect)
 
     app.router.add_route("*", f"{base_url}/{{proxyPath:.*}}", matlab_view)
-    app.on_cleanup.append(cleanup_background_tasks)
+    app.on_shutdown.append(cleanup_background_tasks)
 
     return app
 
@@ -983,7 +996,7 @@ def configure_no_proxy_in_env():
         os.environ["no_proxy"] = ",".join(
             set(existing_no_proxy_env + no_proxy_whitelist)
         )
-    logger.info(f"Setting no_proxy to: {os.environ.get('no_proxy')}")
+    logger.debug(f"Setting no_proxy to: {os.environ.get('no_proxy')}")
 
 
 def create_and_start_app(config_name):
@@ -1011,15 +1024,15 @@ def create_and_start_app(config_name):
 
     # After handling the interrupt, proceed with shutting down the server gracefully.
     try:
+        # aiohttp shutdown to be invoked before cleanup -
+        # https://docs.aiohttp.org/en/stable/web_reference.html#aiohttp.web.Application.shutdown
+        loop.run_until_complete(app.shutdown())
+        loop.run_until_complete(app.cleanup())
+
         running_tasks = asyncio.all_tasks(loop)
-        loop.run_until_complete(
-            asyncio.gather(
-                app.shutdown(),
-                app.cleanup(),
-                util.cancel_tasks(running_tasks),
-                return_exceptions=False,
-            )
-        )
+
+        # Gracefully cancel all running background tasks
+        loop.run_until_complete(util.cancel_tasks(running_tasks))
 
     except Exception:
         pass
@@ -1040,12 +1053,12 @@ def print_version_and_exit():
 
 def main():
     """Starting point of the integration. Creates the web app and runs indefinitely."""
-    if util.parse_cli_args()["version"]:
+    if util.parse_main_cli_args()["version"]:
         print_version_and_exit()
 
     # The integration needs to be called with --config flag.
     # Parse the passed cli arguments.
-    desired_configuration_name = util.parse_cli_args()["config"]
+    desired_configuration_name = util.parse_main_cli_args()["config"]
 
     create_and_start_app(config_name=desired_configuration_name)
 

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/matlab_proxy/app_state.py

@@ -484,7 +484,7 @@ class AppState:
                         "'busy' status endpoint returned an invalid response, falling back to using 'ping' endpoint to determine MATLAB state"
                     )
                     warning = f"{mwi_env.get_env_name_shutdown_on_idle_timeout()} environment variable is supported only for MATLAB versions R2021a or later"
-                    logger.warn(warning)
+                    logger.warning(warning)
                     self.warnings.append(warning)
 
                 else:
@@ -875,15 +875,8 @@ class AppState:
                     user_code_output_file
                 )
                 logger.info(
-                    util.prettify(
-                        boundary_filler="*",
-                        text_arr=[
-                            f"When MATLAB starts, you can see the output for your startup code at:",
-                            f"{self.matlab_session_files.get('startup_code_output_file', ' ')}",
-                        ],
-                    )
+                    f"The results of executing MWI_MATLAB_STARTUP_SCRIPT are stored at: {user_code_output_file} "
                 )
-
             return
 
     def create_server_info_file(self):
@@ -909,16 +902,16 @@ class AppState:
 
         # By default mwi_server_url usually points to 0.0.0.0 as the hostname, but this does not work well
         # on some browsers. Specifically on Safari (MacOS)
-        logger.info(
-            util.prettify(
-                boundary_filler="=",
-                text_arr=[
-                    f"Access MATLAB at:",
-                    self.settings["mwi_server_url"].replace("0.0.0.0", "localhost")
-                    + mwi_auth_token_str,
-                ],
-            )
+        server_url = (
+            self.settings["mwi_server_url"].replace("0.0.0.0", "localhost")
+            + mwi_auth_token_str
+        )
+
+        mwi.logger.log_startup_info(
+            title=f"matlab-proxy-app running on {self.settings['app_port']}",
+            matlab_url=server_url,
         )
+        logger.info(f"MATLAB Root: {self.settings['matlab_path']}")
 
     def clean_up_mwi_server_session(self):
         # Clean up mwi_server_session_files
@@ -965,10 +958,11 @@ class AppState:
             matlab_env["MLM_LICENSE_FILE"] = self.licensing["conn_str"]
 
         # Env setup related to MATLAB
-        matlab_env["MW_CRASH_MODE"] = "native"
-        matlab_env["MATLAB_WORKER_CONFIG_ENABLE_LOCAL_PARCLUSTER"] = "true"
-        matlab_env["PCT_ENABLED"] = "true"
-        matlab_env["HTTP_MATLAB_CLIENT_GATEWAY_PUBLIC_PORT"] = "1"
+        ## Update the values only if it does not already exist in the environment
+        matlab_env["MW_CRASH_MODE"] = matlab_env.get("MW_CRASH_MODE", "native")
+        matlab_env["MATLAB_WORKER_CONFIG_ENABLE_LOCAL_PARCLUSTER"] = matlab_env.get(
+            "MATLAB_WORKER_CONFIG_ENABLE_LOCAL_PARCLUSTER", "true"
+        )
         matlab_env["MW_DOCROOT"] = os.path.join("ui", "webgui", "src")
         matlab_env["MWAPIKEY"] = self.settings["mwapikey"]
 
@@ -1003,7 +997,7 @@ class AppState:
 
         # Set MW_CONNECTOR_CONTEXT_ROOT
         matlab_env["MW_CONNECTOR_CONTEXT_ROOT"] = self.settings.get("base_url", "/")
-        logger.info(
+        logger.debug(
             f"MW_CONNECTOR_CONTEXT_ROOT is set to: {matlab_env['MW_CONNECTOR_CONTEXT_ROOT']}"
         )
 
@@ -1315,6 +1309,8 @@ class AppState:
         # to MATLAB state by other functions/tasks until the lock is released, ensuring consistency. It's released early only in case of exceptions.
         await self.matlab_state_updater_lock.acquire()
         self.set_matlab_state("starting")
+        logger.info(f"Starting MATLAB...")
+
         # Clear MATLAB errors and logging
         self.error = None
         self.logs["matlab"].clear()
@@ -1534,7 +1530,7 @@ class AppState:
                             except:
                                 pass
 
-        logger.info("Stopped (any running) MATLAB process.")
+        logger.debug("Stopped (any running) MATLAB process.")
 
         # Terminating Xvfb
         if system.is_posix():

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/matlab_proxy/settings.py

@@ -53,7 +53,7 @@ def get_process_startup_timeout():
             )
             return constants.DEFAULT_PROCESS_START_TIMEOUT
 
-    logger.info(
+    logger.debug(
         f"Using {constants.DEFAULT_PROCESS_START_TIMEOUT} seconds as the default timeout value"
     )
 
@@ -94,7 +94,7 @@ def get_matlab_executable_and_root_path():
 
     if matlab_executable_path:
         matlab_root_path = Path(matlab_executable_path).resolve().parent.parent
-        logger.info(f"Found MATLAB executable at: {matlab_executable_path}")
+        logger.debug(f"MATLAB root folder: {matlab_root_path}")
         matlab_root_path = mwi.validators.validate_matlab_root_path(
             matlab_root_path, is_custom_matlab_root=False
         )
@@ -289,7 +289,6 @@ def get(config_name=matlab_proxy.get_default_config_name(), dev=False):
             if not settings["is_windowmanager_available"]:
                 warning = " Unable to find fluxbox on the system PATH. To use Simulink Online, add Fluxbox to the system PATH and restart matlab-proxy. For details, see https://github.com/mathworks/matlab-proxy#requirements."
                 logger.warning(warning)
-                settings["warnings"].append(warning)
 
         settings.update(get_matlab_settings())
 
@@ -500,7 +499,7 @@ def _validate_ssl_files_and_get_ssl_context(mwi_config_folder):
     # Don't use SSL if the user has explicitly disabled SSL communication or not set the respective env var
     if not is_ssl_enabled:
         if ssl_cert_file:
-            logger.warn(
+            logger.warning(
                 f"Ignoring provided SSL files, as {env_name_enable_ssl} is either unset or set to false"
             )
         return None
@@ -597,7 +596,7 @@ def generate_new_self_signed_certs(mwi_certs_dir):
             f.write(cert.public_bytes(serialization.Encoding.PEM))
 
     except Exception as ex:
-        logger.warn(
+        logger.warning(
             f"Failed to generate self-signed certificates, proceeding with non-secure mode! Error: {ex}"
         )
         cert_file = priv_key_file = None
@@ -699,7 +698,6 @@ def _get_matlab_cmd(matlab_executable_path, code_to_execute, nlm_conn_str):
         "-nosplash",
         *flag_to_hide_desktop,
         "-softwareopengl",
-        # " v=mvm ",
         *matlab_lic_mode,
         "-externalUI",
         profile_matlab_startup,

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/matlab_proxy/util/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2024 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 import argparse
 import inspect
 import os
@@ -26,7 +26,7 @@ logger = mwi.logger.get()
 interrupt_signal_caught = False
 
 
-def parse_cli_args():
+def parse_main_cli_args():
     """Parses CLI arguments passed to the main() function.
 
     Returns:
@@ -56,6 +56,28 @@ def parse_cli_args():
     return parsed_args
 
 
+def parse_list_cli_args():
+    """Parses CLI arguments passed to the matlab-proxy-app-list-servers entrypoint.
+
+    Returns:
+        dict: Containing the parsed arguments
+    """
+    # Parse the --config flag provided to the console script executable.
+    parsed_args = {}
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-q",
+        "--quiet",
+        help="Return the server list without any additional text.",
+        action="store_true",
+    )
+    args = parser.parse_args()
+
+    parsed_args["quiet"] = args.quiet
+
+    return parsed_args
+
+
 def prepare_site(app, runner):
     """Prepares to launch a TCPSite. If MWI_APP_PORT env variable is set,
     it will setup a site to launch on that port, else will launch on a random available port.
@@ -148,47 +170,6 @@ def add_signal_handlers(loop):
     return loop
 
 
-def prettify(boundary_filler=" ", text_arr=[]):
-    """Prettify array of strings with borders for stdout
-
-    Args:
-        boundary_filler (str, optional): Upper and lower border filler for text. Defaults to " ".
-        text_arr (list, optional):The text array to prettify. Each element will be added to a newline. Defaults to [].
-
-    Returns:
-        [str]: Prettified String
-    """
-
-    import sys
-
-    if not sys.stdout.isatty():
-        return (
-            "\n============================\n"
-            + "\n".join(text_arr)
-            + "\n============================\n"
-        )
-
-    size = os.get_terminal_size()
-    cols, _ = size.columns, size.lines
-
-    if any(len(text) > cols for text in text_arr):
-        result = ""
-        for text in text_arr:
-            result += text + "\n"
-        return result
-
-    upper = "\n" + "".ljust(cols, boundary_filler) + "\n" if len(text_arr) > 0 else ""
-    lower = "".ljust(cols, boundary_filler) if len(text_arr) > 0 else ""
-
-    content = ""
-    for text in text_arr:
-        content += text.center(cols) + "\n"
-
-    result = upper + content + lower
-
-    return result
-
-
 def get_child_processes(parent_process, max_attempts=10, sleep_interval=1):
     """Get list of child processes from a parent process.
 
@@ -312,7 +293,7 @@ class TrackingLock:
         self._acquired_by = None
         self._lock = asyncio.Lock()
         if not purpose:
-            logger.warn("Provide a purpose for this instance of TrackingLock")
+            logger.warning("Provide a purpose for this instance of TrackingLock")
         self._purpose = purpose
 
     @property

matlab_proxy-0.27.3/matlab_proxy/util/list_servers.py

@@ -0,0 +1,89 @@
+# Copyright (c) 2020-2025 The MathWorks, Inc.
+# Script to print information about all running matlab-proxy servers for current user on current machine.
+
+import glob
+import os
+
+import matlab_proxy.settings as mwi_settings
+import matlab_proxy.util as mwi_util
+
+from datetime import datetime
+from rich.console import Console
+from rich.table import Table
+
+__NO_SERVERS_MSG = "No MATLAB-PROXY Servers are currently running."
+
+
+def _extract_version_and_session(title):
+    """Extracts session name and MATLAB version from the title."""
+    parts = title.split("-")
+    if len(parts) < 2:
+        return title.replace("MATLAB ", ""), ""
+    session_name = parts[0].strip()
+    matlab_version = parts[1].strip().replace("MATLAB ", "")
+    return matlab_version, session_name
+
+
+def _get_server_info(server):
+    """Helper function to parse info from server file."""
+    with open(server) as f:
+        # Assumes that the server file contains the address on the first line,
+        # the browser_title on the second line, and the timestamp is derived from the file's last modified time.
+        address = f.readline().strip()
+        browser_title = f.readline().strip()
+        matlab_version, session_name = _extract_version_and_session(browser_title)
+        timestamp = _get_timestamp(server)
+        return timestamp, matlab_version, session_name, address
+
+
+def _print_server_info_as_table(servers):
+    console = Console()
+    table = Table(
+        title="MATLAB Proxy Servers",
+        title_style="cyan",
+        title_justify="center",
+        caption="No servers found." if not servers else "",
+        caption_style="bold red",
+        show_header=True,
+        header_style="yellow",
+        show_lines=True,
+        show_edge=True,
+    )
+    table.add_column("Created On")
+    table.add_column("MATLAB\nVersion")
+    table.add_column("Session Name")
+    table.add_column("Server URL", overflow="fold")
+
+    # Build server information
+    for server in servers:
+        table.add_row(*_get_server_info(server))
+
+    console.print(table)
+
+
+def _get_timestamp(filename):
+    """Get the last modified timestamp of the file in a human-readable format."""
+    timestamp = os.path.getmtime(filename)
+    readable_time = datetime.fromtimestamp(timestamp).strftime("%d/%m/%y %H:%M:%S")
+    return readable_time
+
+
+def print_server_info():
+    """Print information about all matlab-proxy servers (with version > 0.4.0) running on this machine"""
+    home_folder = mwi_settings.get_mwi_config_folder()
+
+    # Look for files in port folders
+    ports_folder = home_folder / "ports"
+    search_string = str(ports_folder) + "/**/mwi_server.info"
+    servers = sorted(glob.glob(search_string), key=os.path.getmtime)
+
+    args = mwi_util.parse_list_cli_args()
+
+    if args["quiet"]:
+        for server in servers:
+            with open(server) as f:
+                server_info = f.readline().strip()
+                print(f"{server_info}", end="\n")
+    else:
+        _print_server_info_as_table(servers)
+    return

{matlab_proxy-0.27.0 → matlab_proxy-0.27.3}/matlab_proxy/util/mwi/environment_variables.py

@@ -213,3 +213,13 @@ class Experimental:
     def should_use_cookie_cache():
         """Returns true if the cookie jar support is enabled."""
         return _is_env_set_to_true(Experimental.get_env_name_use_cookie_cache())
+
+    @staticmethod
+    def get_env_name_use_rich_logging():
+        """Set to True to enable rich logging to console."""
+        return "MWI_USE_RICH_LOGGING"
+
+    @staticmethod
+    def use_rich_logger():
+        """Returns true if the cookie jar support is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_use_rich_logging())