matlab-proxy 0.17.0__tar.gz → 0.18.0__tar.gz

{matlab-proxy-0.17.0/matlab_proxy.egg-info → matlab-proxy-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.17.0
+Version: 0.18.0
 Summary: Python® package enables you to launch MATLAB® and access it from a web browser.
 Home-page: https://github.com/mathworks/matlab-proxy/
 Author: The MathWorks, Inc.

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/app.py

@@ -16,12 +16,11 @@ from cryptography import fernet
 import matlab_proxy
 from matlab_proxy import constants, settings, util
 from matlab_proxy.app_state import AppState
+from matlab_proxy.constants import IS_CONCURRENCY_CHECK_ENABLED
 from matlab_proxy.util import mwi
+from matlab_proxy.util.mwi import download, token_auth
 from matlab_proxy.util.mwi import environment_variables as mwi_env
-from matlab_proxy.util.mwi import token_auth, download
 from matlab_proxy.util.mwi.exceptions import AppError, InvalidTokenError, LicensingError
-from matlab_proxy.constants import IS_CONCURRENCY_CHECK_ENABLED
-
 
 mimetypes.add_type("font/woff", ".woff")
 mimetypes.add_type("font/woff2", ".woff2")
@@ -422,7 +421,7 @@ async def termination_integration_delete(req):
     await req.app.cleanup()
     """When testing with pytest, its not possible to catch sys.exit(0) using the construct
     'with pytest.raises()', there by causing the test : test_termination_integration_delete()
-    to fail. Inorder to avoid this, adding the below if condition to check to skip sys.exit(0) when testing
+    to fail. In order to avoid this, adding the below if condition to check to skip sys.exit(0) when testing
     """
     logger.debug("Exiting with return code 0")
     if not mwi_env.is_testing_mode_enabled():
@@ -475,7 +474,7 @@ def make_static_route_table(app):
     Returns:
         Dict: Containing information about the static files and header information.
     """
-    from pkg_resources import resource_isdir, resource_listdir
+    import importlib_resources
 
     from matlab_proxy import gui
     from matlab_proxy.gui import static
@@ -492,8 +491,9 @@ def make_static_route_table(app):
         (gui.static.js.__name__, "/static/js"),
         (gui.static.media.__name__, "/static/media"),
     ]:
-        for name in resource_listdir(mod, ""):
-            if not resource_isdir(mod, name):
+        for entry in importlib_resources.files(mod).iterdir():
+            name = entry.name
+            if not importlib_resources.files(mod).joinpath(name).is_dir():
                 if name != "__init__.py":
                     # Special case for manifest.json
                     if "manifest.json" in name:

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/app_state.py

@@ -16,10 +16,11 @@ from matlab_proxy.constants import (
     CONNECTOR_SECUREPORT_FILENAME,
     MATLAB_LOGS_FILE_NAME,
     IS_CONCURRENCY_CHECK_ENABLED,
+    USER_CODE_OUTPUT_FILE_NAME,
 )
-from matlab_proxy.settings import (
-    get_process_startup_timeout,
-)
+
+from matlab_proxy.settings import get_process_startup_timeout
+
 from matlab_proxy.util import mw, mwi, system, windows
 from matlab_proxy.util.mwi import environment_variables as mwi_env
 from matlab_proxy.util.mwi import token_auth
@@ -594,6 +595,24 @@ class AppState:
             self.matlab_session_files["matlab_ready_file"] = matlab_ready_file
 
             logger.debug(f"matlab_session_files:{self.matlab_session_files}")
+
+            # check if the user has provided any code or not
+            if self.settings.get("has_custom_code_to_execute"):
+                # Keep a reference to the user code output file in the matlab_session_files for cleanup
+                user_code_output_file = mwi_logs_dir / USER_CODE_OUTPUT_FILE_NAME
+                self.matlab_session_files["startup_code_output_file"] = (
+                    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', ' ')}",
+                        ],
+                    )
+                )
+
             return
 
     def create_server_info_file(self):
@@ -846,6 +865,10 @@ class AppState:
 
                 return matlab
 
+            except UIVisibleFatalError as e:
+                self.error = e
+                log_error(logger, e)
+
             except Exception as err:
                 self.error = err
                 log_error(logger, err)
@@ -972,7 +995,7 @@ class AppState:
             )
             await self.stop_matlab(force_quit=True)
             self.error = MatlabError(
-                "Unable to start MATLAB because of a timeout. Try again by clicking Start MATLAB."
+                "MATLAB startup has timed out. Click Start MATLAB to try again."
             )
 
     async def __read_matlab_ready_file(self, delay):

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/constants.py

@@ -7,6 +7,7 @@ CONNECTOR_SECUREPORT_FILENAME: Final[str] = "connector.securePort"
 VERSION_INFO_FILE_NAME: Final[str] = "VersionInfo.xml"
 MAX_HTTP_REQUEST_SIZE: Final[int] = 500_000_000  # 500MB
 MATLAB_LOGS_FILE_NAME: Final[str] = "matlab_logs.txt"
+USER_CODE_OUTPUT_FILE_NAME: Final[str] = "startup_code_output.txt"
 
 # Max startup duration in seconds for processes launched by matlab-proxy
 # This constant is meant for internal use within matlab-proxy

matlab-proxy-0.18.0/matlab_proxy/matlab/evaluateUserMatlabCode.m

@@ -0,0 +1,51 @@
+% Copyright 2024 The MathWorks, Inc.
+
+% Note:
+% Any extra variable we are creating begins with `mwiInternal` to prevent
+% potential conflicts with variables created by user code evaluated using evalc.
+% Since evalc("user code") is executed in the base workspace, it might create
+% variables that could overwrite our internal variables. To avoid polluting the
+% user's workspace when MATLAB starts, we ensure to clear any internal variable
+% that we create in the base workspace. We do not need to be concerned about
+% variables in the function's workspace.
+
+if ~isempty(getenv('MWI_MATLAB_STARTUP_SCRIPT')) && ~all(isspace(getenv('MWI_MATLAB_STARTUP_SCRIPT')))
+    try
+        % Evaluate the code from the environment variable and capture the output
+        mwiInternalResults = evalc(getenv('MWI_MATLAB_STARTUP_SCRIPT'));
+        % Write the results to the file
+        logOutputOrError(mwiInternalResults);
+        clear mwiInternalResults;
+    catch mwiInternalException
+        % Log the error message to the file
+        logOutputOrError(" ", mwiInternalException);
+        clear mwiInternalResults mwiInternalException;
+        error("Unable to run the startup code you specified. For details of the error, see the output file at " + fullfile(getenv('MATLAB_LOG_DIR'), "startup_code_output.txt"));
+    end
+
+end
+
+function logOutputOrError(userCodeResults, mwiInternalException)
+    %   Logs the results of the user code execution if successful, otherwise logs the
+    %   error information. It then closes the file handle.
+    %
+    %   Inputs:
+    %       userCodeResults       - String containing the output from the user code.
+    %       mwiInternalException  - (Optional) MException object containing error details.
+    filePath = fullfile(getenv('MATLAB_LOG_DIR'), "startup_code_output.txt");
+    [fileHandle, ~] = fopen(filePath, 'w');
+    if nargin < 2
+        % Log the successful output of the user code
+        fprintf(fileHandle, " ");
+        fprintf(fileHandle, userCodeResults);
+    else
+        % Log the error information
+        fprintf(fileHandle, 'An error occurred in the following code:\n');
+        fprintf(fileHandle, getenv('MWI_MATLAB_STARTUP_SCRIPT'));
+        fprintf(fileHandle, '\n\nMessage: %s\n', mwiInternalException.message);
+        fprintf(fileHandle, '\nError Identifier: %s\n', mwiInternalException.identifier);
+    end
+    % Close the file handle
+    fclose(fileHandle);
+end
+

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/matlab/startup.m

@@ -1,4 +1,4 @@
-% Copyright (c) 2020-2023 The MathWorks, Inc.
+% Copyright 2020-2024 The MathWorks, Inc.
 
 % Configure logged in user if possible
 if ~isempty(getenv('MW_LOGIN_USER_ID'))
@@ -34,4 +34,4 @@ end
 matlab_settings.matlab.addons.explorer.isExplorerSupported.TemporaryValue = false;
 
 clear
-clc
+clc

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/settings.py

@@ -366,7 +366,10 @@ def get_matlab_settings():
     flag_to_hide_desktop = ["-nodesktop"]
     if system.is_windows():
         flag_to_hide_desktop.extend(["-noDisplayDesktop", "-wait", "-log"])
-    matlab_startup_file = str(Path(__file__).resolve().parent / "matlab" / "startup.m")
+
+    matlab_code_dir = Path(__file__).resolve().parent / "matlab"
+    matlab_startup_file = str(matlab_code_dir / "startup.m")
+    matlab_code_file = str(matlab_code_dir / "evaluateUserMatlabCode.m")
 
     matlab_version = get_matlab_version(matlab_root_path)
 
@@ -388,6 +391,18 @@ def get_matlab_settings():
     profile_matlab_startup = (
         "-timing" if mwi_env.Experimental.is_matlab_startup_profiling_enabled() else ""
     )
+
+    has_custom_code_to_execute = (
+        len(os.getenv(mwi_env.get_env_name_custom_matlab_code(), "").strip()) > 0
+    )
+    mp_code_to_execute = f"try; run('{matlab_startup_file}'); catch MATLABProxyInitializationError; disp(MATLABProxyInitializationError.message); end;"
+    custom_code_to_execute = f"try; run('{matlab_code_file}'); catch MATLABCustomStartupCodeError; disp(MATLABCustomStartupCodeError.message); end;"
+    code_to_execute = (
+        mp_code_to_execute + custom_code_to_execute
+        if has_custom_code_to_execute
+        else mp_code_to_execute
+    )
+
     return {
         "matlab_path": matlab_root_path,
         "matlab_version": matlab_version,
@@ -402,13 +417,14 @@ def get_matlab_settings():
             *mpa_flags,
             profile_matlab_startup,
             "-r",
-            f"try; run('{matlab_startup_file}'); catch ME; disp(ME.message); end;",
+            code_to_execute,
         ],
         "ws_env": ws_env,
         "mwa_api_endpoint": f"https://login{ws_env_suffix}.mathworks.com/authenticationws/service/v4",
         "mhlm_api_endpoint": f"https://licensing{ws_env_suffix}.mathworks.com/mls/service/v1/entitlement/list",
         "mwa_login": f"https://login{ws_env_suffix}.mathworks.com",
         "nlm_conn_str": nlm_conn_str,
+        "has_custom_code_to_execute": has_custom_code_to_execute,
     }
 
 

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/util/__init__.py

@@ -11,6 +11,9 @@ import matlab_proxy
 from matlab_proxy.util import mwi, system
 from matlab_proxy.util.event_loop import *
 from matlab_proxy.util.mwi import environment_variables as mwi_env
+from matlab_proxy.util.mwi.exceptions import (
+    UIVisibleFatalError,
+)
 
 logger = mwi.logger.get()
 
@@ -181,7 +184,7 @@ def prettify(boundary_filler=" ", text_arr=[]):
     return result
 
 
-def get_child_processes(parent_process):
+def get_child_processes(parent_process, max_attempts=10, sleep_interval=1):
     """Get list of child processes from a parent process.
 
     Args:
@@ -199,7 +202,6 @@ def get_child_processes(parent_process):
     # to get hold child processes
     parent_process_psutil = psutil.Process(parent_process.pid)
 
-    max_attempts = 10
     child_processes = None
     for _ in range(max_attempts):
         try:
@@ -212,17 +214,24 @@ def get_child_processes(parent_process):
 
             if not child_processes:
                 logger.debug("Waiting for the child processes to be created...")
+                time.sleep(sleep_interval)
                 continue
 
+            else:
+                logger.debug(f"Found the child process: {child_processes[0]}")
+                break
+
         except AssertionError as err:
             raise err
 
-        if child_processes:
-            break
-        time.sleep(0.1)
-
     if not child_processes:
-        raise RuntimeError("No child processes found after multiple attempts.")
+        logger.debug(
+            f"MATLAB process was not found while searching for the child processes."
+        )
+
+        raise UIVisibleFatalError(
+            "Unable to create MATLAB process. Click Start MATLAB to try again."
+        )
 
     return child_processes
 

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/util/mwi/environment_variables.py

@@ -162,6 +162,11 @@ def get_env_name_process_startup_timeout():
     return "MWI_PROCESS_START_TIMEOUT"
 
 
+def get_env_name_custom_matlab_code():
+    """User specified MATLAB code that will be executed by matlab-proxy upon its start"""
+    return "MWI_MATLAB_STARTUP_SCRIPT"
+
+
 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-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/util/mwi/validators.py

@@ -1,31 +1,30 @@
 # Copyright 2020-2024 The MathWorks, Inc.
 """This file contains validators for various runtime artifacts.
-A validator is defined as a function which verifies the input and 
-returns it unchanged if validation passes. 
+A validator is defined as a function which verifies the input and
+returns it unchanged if validation passes.
 Returning inputs allows validators to be used inline with the input.
 
-Example: 
+Example:
 Original code: if( input ):
 With validator: if (valid(input)):
 
 Exceptions are thrown to signal failure.
 """
+
 import errno
 import os
-from pathlib import Path
-import pkg_resources
 import socket
+from pathlib import Path
 from typing import List
 
-
 import matlab_proxy
 from matlab_proxy import util
-from matlab_proxy.util import system
 from matlab_proxy.constants import VERSION_INFO_FILE_NAME
+from matlab_proxy.util import system
 
 from . import environment_variables as mwi_env
 from . import logger as mwi_logger
-from .exceptions import MatlabInstallError, FatalError
+from .exceptions import FatalError, MatlabInstallError
 
 logger = mwi_logger.get()
 
@@ -213,10 +212,13 @@ def __get_configs():
         Dict: Contains all the values present in 'matlab_web_desktop_configs' entry_point from all the packages
         installed in the current environment.
     """
+    import importlib_metadata
+
+    matlab_proxy_eps = importlib_metadata.entry_points(
+        group=matlab_proxy.get_entrypoint_name()
+    )
     configs = {}
-    for entry_point in pkg_resources.iter_entry_points(
-        matlab_proxy.get_entrypoint_name()
-    ):
+    for entry_point in matlab_proxy_eps:
         configs[entry_point.name.lower()] = entry_point.load()
 
     return configs

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy/util/windows.py

@@ -1,9 +1,12 @@
-# Copyright 2022-2023 The MathWorks, Inc.
+# Copyright 2022-2024 The MathWorks, Inc.
 import asyncio
 
 from matlab_proxy import util
 from matlab_proxy.util import mwi
 from matlab_proxy.util.mwi import environment_variables as mwi_env
+from matlab_proxy.util.mwi.exceptions import (
+    UIVisibleFatalError,
+)
 
 
 """ This file contains methods specific to non-posix / windows OS.
@@ -77,8 +80,9 @@ async def start_matlab(matlab_cmd, matlab_env):
             "MATLAB.exe" == matlab.name()
         ), "Expecting the child process name to be MATLAB.exe"
 
-    except AssertionError as err:
+    except (AssertionError, UIVisibleFatalError) as err:
         raise err
+
     except psutil.NoSuchProcess:
         # We reach here when the intermediate process launched by matlab-proxy died
         # before we can query for its child processes. Hence, to find the actual MATLAB

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0/matlab_proxy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.17.0
+Version: 0.18.0
 Summary: Python® package enables you to launch MATLAB® and access it from a web browser.
 Home-page: https://github.com/mathworks/matlab-proxy/
 Author: The MathWorks, Inc.

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy.egg-info/SOURCES.txt

@@ -113,6 +113,7 @@ matlab_proxy.egg-info/not-zip-safe
 matlab_proxy.egg-info/requires.txt
 matlab_proxy.egg-info/top_level.txt
 matlab_proxy/icons/matlab.svg
+matlab_proxy/matlab/evaluateUserMatlabCode.m
 matlab_proxy/matlab/startup.m
 matlab_proxy/util/__init__.py
 matlab_proxy/util/event_loop.py

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/matlab_proxy.egg-info/requires.txt

@@ -1,6 +1,8 @@
 aiohttp>=3.7.4
-psutil
 aiohttp_session[secure]
+importlib-metadata
+importlib-resources
+psutil
 
 [dev]
 aiohttp-devtools

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/setup.py

@@ -63,14 +63,20 @@ TESTS_REQUIRES = [
     "pytest-playwright",
 ]
 
-INSTALL_REQUIRES = ["aiohttp>=3.7.4", "psutil", "aiohttp_session[secure]"]
+INSTALL_REQUIRES = [
+    "aiohttp>=3.7.4",
+    "aiohttp_session[secure]",
+    "importlib-metadata",
+    "importlib-resources",
+    "psutil",
+]
 
 HERE = Path(__file__).parent.resolve()
 long_description = (HERE / "README.md").read_text()
 
 setuptools.setup(
     name="matlab-proxy",
-    version="0.17.0",
+    version="0.18.0",
     url=config["doc_url"],
     author="The MathWorks, Inc.",
     author_email="cloud@mathworks.com",

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/tests/unit/test_app_state.py

@@ -7,6 +7,7 @@ from pathlib import Path
 from typing import Optional
 
 import pytest
+from matlab_proxy import settings
 
 from matlab_proxy import settings
 from matlab_proxy.app_state import AppState
@@ -14,6 +15,11 @@ from matlab_proxy.constants import MWI_AUTH_TOKEN_NAME_FOR_HTTP
 from matlab_proxy.util.mwi.exceptions import LicensingError, MatlabError
 from tests.unit.util import MockResponse
 
+from matlab_proxy.constants import (
+    CONNECTOR_SECUREPORT_FILENAME,
+    USER_CODE_OUTPUT_FILE_NAME,
+)
+
 
 @pytest.fixture
 def sample_settings_fixture(tmp_path):
@@ -35,6 +41,7 @@ def sample_settings_fixture(tmp_path):
         "mwi_logs_root_dir": Path(settings.get_mwi_config_folder(dev=True)),
         "app_port": 12345,
         "mwapikey": "asdf",
+        "has_custom_code_to_execute": False,
     }
 
 
@@ -662,3 +669,30 @@ async def test_detect_active_client_status_can_reset_active_client(app_state_fix
     assert (
         app_state_fixture.active_client == None
     ), f"Expected the active_client to be None"
+
+
+@pytest.mark.parametrize(
+    "session_file_count, has_custom_code_to_execute", [(2, True), (1, False)]
+)
+def test_create_logs_dir_for_MATLAB(
+    app_state_fixture, session_file_count, has_custom_code_to_execute
+):
+    """Test to check create_logs_dir_for_MATLAB()
+
+    Args:
+        app_state_fixture (AppState): Object of AppState class with defaults set
+    """
+    # Arrange
+    app_state_fixture.settings["has_custom_code_to_execute"] = (
+        has_custom_code_to_execute
+    )
+
+    # Act
+    app_state_fixture.create_logs_dir_for_MATLAB()
+
+    # Assert
+    for _, session_file_path in app_state_fixture.matlab_session_files.items():
+        # Check session files are present in mwi logs directory
+        assert app_state_fixture.mwi_logs_dir == Path(session_file_path).parent
+
+    assert len(app_state_fixture.matlab_session_files) == session_file_count

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/tests/unit/test_settings.py

@@ -458,3 +458,38 @@ def test_get_ssl_context_with_invalid_custom_ssl_files_raises_exception(
 
     with pytest.raises(Exception, match=exception_msg):
         settings._validate_ssl_files_and_get_ssl_context(mwi_certs_dir)
+
+
+@pytest.mark.parametrize(
+    "expected_value_for_has_custom_code, custom_code, has_custom_code_exception_matlab_cmd",
+    [(False, "", False), (True, "run(disp('MATLAB'))", True)],
+    ids=["No custom code to execute", "Has custom code to execute"],
+)
+def test_get_matlab_settings_custom_code(
+    monkeypatch,
+    mocker,
+    expected_value_for_has_custom_code,
+    custom_code,
+    has_custom_code_exception_matlab_cmd,
+):
+    # Arrange
+    monkeypatch.setenv(mwi_env.get_env_name_custom_matlab_code(), custom_code)
+    mocker.patch(
+        "matlab_proxy.settings.get_matlab_executable_and_root_path",
+        return_value=("matlab", None),
+    )
+
+    # Act
+    matlab_settings = settings.get_matlab_settings()
+    exception_present_in_matlab_cmd = (
+        "MATLABCustomStartupCodeError" in matlab_settings["matlab_cmd"][-1]
+    )
+    print(matlab_settings)
+
+    # Assert
+    assert (
+        matlab_settings["has_custom_code_to_execute"]
+        == expected_value_for_has_custom_code
+    )
+
+    assert exception_present_in_matlab_cmd == has_custom_code_exception_matlab_cmd

{matlab-proxy-0.17.0 → matlab-proxy-0.18.0}/tests/unit/util/test_util.py

@@ -6,6 +6,9 @@ import psutil
 
 from matlab_proxy.util import get_child_processes, system, add_signal_handlers, prettify
 from matlab_proxy.util import system
+from matlab_proxy.util.mwi.exceptions import (
+    UIVisibleFatalError,
+)
 
 
 def test_get_supported_termination_signals():
@@ -90,7 +93,7 @@ def test_get_child_processes_no_children(mocker):
     mock_parent_process_psutil.children.return_value = []
 
     # Call the function with the mocked parent process
-    with pytest.raises(RuntimeError):
+    with pytest.raises(UIVisibleFatalError):
         get_child_processes(parent_process)