matlab-proxy 0.23.4__py3-none-any.whl → 0.24.2__py3-none-any.whl

matlab_proxy/app_state.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2024 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 
 import asyncio
 import contextlib
@@ -10,15 +10,15 @@ import time
 import uuid
 from collections import deque
 from datetime import datetime, timedelta, timezone
-from typing import Final, Optional, Callable
+from typing import Callable, Final, Optional
 
 from matlab_proxy import util
 from matlab_proxy.constants import (
+    CHECK_MATLAB_STATUS_INTERVAL_SECONDS,
     CONNECTOR_SECUREPORT_FILENAME,
     IS_CONCURRENCY_CHECK_ENABLED,
     MATLAB_LOGS_FILE_NAME,
     USER_CODE_OUTPUT_FILE_NAME,
-    CHECK_MATLAB_STATUS_INTERVAL_SECONDS,
 )
 from matlab_proxy.settings import get_process_startup_timeout
 from matlab_proxy.util import mw, mwi, system, windows
@@ -30,10 +30,10 @@ from matlab_proxy.util.mwi.exceptions import (
     FatalError,
     LicensingError,
     MatlabError,
+    MatlabInstallError,
     OnlineLicensingError,
     UIVisibleFatalError,
     XvfbError,
-    LockAcquisitionError,
     log_error,
 )
 
@@ -90,10 +90,6 @@ class AppState:
         self.error = settings["error"]
         self.warnings = settings["warnings"]
 
-        if self.error is not None:
-            self.logs["matlab"].clear()
-            return
-
         # Keep track of when the Embedded connector starts.
         # Would be initialized appropriately by get_embedded_connector_state() task.
         self.embedded_connector_start_time = None
@@ -436,8 +432,10 @@ class AppState:
 
             else:
                 await self.matlab_state_updater_lock.release()
-                await self._update_matlab_state_based_on_ready_file_and_connector_status(
-                    matlab_endpoint_to_use
+                await (
+                    self._update_matlab_state_based_on_ready_file_and_connector_status(
+                        matlab_endpoint_to_use
+                    )
                 )
                 logger.debug(
                     f"{this_task}: Required processes are ready, Embedded Connector status is '{self.get_matlab_state()}'"
@@ -1107,6 +1105,12 @@ class AppState:
         Returns:
             (asyncio.subprocess.Process | psutil.Process): If process creation is successful, else return None.
         """
+        # If there's no matlab_cmd available, it means that MATLAB is not available on system PATH.
+        if not self.settings["matlab_cmd"]:
+            raise MatlabInstallError(
+                "Unable to find MATLAB on the system PATH. Add MATLAB to the system PATH, and restart matlab-proxy."
+            )
+
         if system.is_posix():
             import pty
 
@@ -1243,7 +1247,7 @@ class AppState:
             delay (int): time delay in seconds before retrying the file read operation
         """
         logger.debug(
-            f'updating matlab_port information from {self.matlab_session_files["matlab_ready_file"]}'
+            f"updating matlab_port information from {self.matlab_session_files['matlab_ready_file']}"
         )
         try:
             await asyncio.wait_for(
@@ -1326,7 +1330,14 @@ class AppState:
         # Start MATLAB Process
         logger.debug("Starting MATLAB")
 
-        matlab = await self.__start_matlab_process(matlab_env)
+        try:
+            matlab = await self.__start_matlab_process(matlab_env)
+
+        # If there's an error with starting MATLAB, set the error to the state and matlab to None
+        except MatlabInstallError as err:
+            log_error(logger, err)
+            self.error = err
+            matlab = None
 
         # Release the lock after MATLAB process has started.
         await self.matlab_state_updater_lock.release()
@@ -1415,6 +1426,10 @@ class AppState:
         waiters = []
         if matlab is not None:
             if system.is_posix() and matlab.returncode is None:
+                # Close the stderr stream to prevent indefinite hanging on it due to a child
+                # process inheriting it, fixes https://github.com/mathworks/matlab-proxy/issues/44
+                self._close_matlab_stderr_stream(matlab)
+
                 # Sending an exit request to the embedded connector takes time.
                 # When MATLAB is in a "starting" state (implies the Embedded connector is not up)
                 # OR
@@ -1427,23 +1442,9 @@ class AppState:
                 else:
                     logger.debug("Sending HTTP request to stop the MATLAB process...")
                     try:
-                        import sys
-
                         # Send HTTP request
                         await self.__send_stop_request_to_matlab()
 
-                        # Close the stderr stream to prevent indefinite hanging on it due to a child
-                        # process inheriting it, fixes https://github.com/mathworks/matlab-proxy/issues/44
-                        stderr_stream = matlab._transport.get_pipe_transport(
-                            sys.stderr.fileno()
-                        )
-                        if stderr_stream:
-                            logger.debug(
-                                "Closing matlab process stderr stream: %s",
-                                stderr_stream,
-                            )
-                            stderr_stream.close()
-
                         # Wait for matlab to shutdown gracefully
                         await matlab.wait()
 
@@ -1461,9 +1462,10 @@ class AppState:
                         try:
                             matlab.terminate()
                             await matlab.wait()
-                        except:
-                            pass
-
+                        except Exception as ex:
+                            logger.debug(
+                                "Received an exception while terminating matlab: %s", ex
+                            )
             else:
                 # In a windows system
                 if system.is_windows() and matlab.is_running():
@@ -1533,6 +1535,23 @@ class AppState:
         self.matlab_port = None
         logger.debug("Completed Shutdown!!!")
 
+    def _close_matlab_stderr_stream(self, matlab):
+        """
+        This method attempts to close the stderr stream associated with the MATLAB process
+        to prevent potential resource leaks. It logs a debug message if the stream is
+        successfully closed.
+
+        Args:
+            matlab: The MATLAB process reference.
+        """
+        stderr_stream = matlab._transport.get_pipe_transport(sys.stderr.fileno())
+        if stderr_stream:
+            logger.debug(
+                "Closing matlab process stderr stream: %s",
+                stderr_stream,
+            )
+            stderr_stream.close()
+
     async def handle_matlab_output(self):
         """Parse MATLAB output from stdout and raise errors if any."""
         matlab = self.processes["matlab"]

matlab_proxy/gui/index.html

@@ -1 +1,20 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="MATLAB"/><meta name="internal_mw_identifier" content="MWI_MATLAB_PROXY_IDENTIFIER"/><link rel="manifest" href="./manifest.json"/><title>MATLAB</title><script defer="defer" src="./static/js/main.ce0f5505.js"></script><link href="./static/css/main.efa05ff9.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+ <!-- Copyright 2025 The MathWorks, Inc. -->
+
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href="./favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="MATLAB" />
+    <meta name="internal_mw_identifier" content="MWI_MATLAB_PROXY_IDENTIFIER" />
+    <link rel="manifest" href="./manifest.json" />
+    <title>MATLAB</title>
+    <script type="module" crossorigin src="./static/js/index.c3NLxnRM.js"></script>
+    <link rel="stylesheet" crossorigin href="./static/css/index.BSVLACuY.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>