matlab-proxy 0.9.1__py3-none-any.whl → 0.10.1__py3-none-any.whl

matlab_proxy/settings.py

@@ -132,8 +132,22 @@ def get_ws_env_settings():
 def get_mwi_config_folder(dev=False):
     if dev:
         return get_test_temp_dir()
+
     else:
-        return Path.home() / ".matlab" / "MWI"
+        config_folder_path = Path.home() / ".matlab" / "MWI"
+        # In multi-host environments, Path.home() can be the same for
+        # multiple hosts and can cause issues when different hosts launch
+        # matlab-proxy on the same port.
+        # Using hostname to be part of the path of the config folder would avoid collisions.
+        hostname = socket.gethostname()
+        if hostname:
+            config_folder_path = config_folder_path / "hosts" / hostname
+
+        logger.debug(
+            f"{'Hostname could not be determined. ' if not hostname else '' }Using the folder: {config_folder_path} for storing all matlab-proxy related session information"
+        )
+
+        return config_folder_path
 
 
 def get_mwi_logs_root_dir(dev=False):
@@ -269,6 +283,10 @@ def get_server_settings(config_name):
         os.getenv(mwi_env.get_env_name_ssl_key_file(), None),
         os.getenv(mwi_env.get_env_name_ssl_cert_file(), None),
     )
+
+    # log file validation check is already done in logger.py
+    mwi_log_file = os.getenv(mwi_env.get_env_name_log_file(), None)
+
     return {
         "create_xvfb_cmd": create_xvfb_cmd,
         "base_url": mwi.validators.validate_base_url(
@@ -288,6 +306,7 @@ def get_server_settings(config_name):
         # This directory will be used to store connector.securePort(matlab_ready_file) and its corresponding files. This will be
         # a central place to store logs of all the running instances of MATLAB launched by matlab-proxy
         "mwi_logs_root_dir": get_mwi_logs_root_dir(),
+        "mwi_log_file": mwi_log_file,
         "mw_context_tags": get_mw_context_tags(config_name),
         # The url where the matlab-proxy server is accessible at
         "mwi_server_url": None,
@@ -350,6 +369,14 @@ def get_matlab_settings():
             f"Set {mwi_env.get_env_name_custom_matlab_root()} to a valid MATLAB root path"
         )
 
+    mpa_flags = (
+        mwi_env.Experimental.get_mpa_flags()
+        if mwi_env.Experimental.is_mpa_enabled()
+        else ""
+    )
+    profile_matlab_startup = (
+        "-timing" if mwi_env.Experimental.is_matlab_startup_profiling_enabled() else ""
+    )
     return {
         "matlab_path": matlab_root_path,
         "matlab_version": matlab_version,
@@ -358,7 +385,10 @@ def get_matlab_settings():
             "-nosplash",
             *flag_to_hide_desktop,
             "-softwareopengl",
+            # " v=mvm ",
             *matlab_lic_mode,
+            *mpa_flags,
+            profile_matlab_startup,
             "-r",
             f"try; run('{matlab_startup_file}'); catch ME; disp(ME.message); end;",
         ],

matlab_proxy/util/mwi/embedded_connector/request.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2022 The MathWorks, Inc.
+# Copyright 2020-2023 The MathWorks, Inc.
 
 """ 
 This file contains the methods to communicate with the embedded connector.

matlab_proxy/util/mwi/environment_variables.py

@@ -1,9 +1,21 @@
-# Copyright (c) 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2023 The MathWorks, Inc.
 """This file lists and exposes the environment variables which are used by the integration."""
 
 import os
 
 
+def _is_env_set_to_true(env_name: str) -> bool:
+    """Helper function that returns True if the environment variable specified is set to True.
+
+    Args:
+        env_name (str): Name of the environment variable to check the state for.
+
+    Returns:
+        bool: True if the value of the environment variable is a case insensitive match to the string "True"
+    """
+    return os.environ.get(env_name, "false").lower() == "true"
+
+
 def get_env_name_network_license_manager():
     """Specifies the path to valid license file or address of a network license server"""
     return "MLM_LICENSE_FILE"
@@ -20,19 +32,10 @@ def get_env_name_logging_level():
 
 
 def get_env_name_enable_web_logging():
-    """wef > v0.2.10 Enable the logging of asyncio web traffic by setting to true"""
+    """Enable the logging of asyncio web traffic by setting to true"""
     return "MWI_ENABLE_WEB_LOGGING"
 
 
-def get_old_env_name_enable_web_logging():
-    """
-    Enable the logging of asyncio web traffic by setting to true
-    This name is deprecated and was last published in version v0.2.10 of matlab-proxy.
-    """
-
-    return "MWI_WEB_LOGGING_ENABLED"
-
-
 def get_env_name_log_file():
     """Specifies a file into which logging content is directed"""
     return "MWI_LOG_FILE"
@@ -89,32 +92,17 @@ def get_env_name_matlab_tempdir():
 
 def is_development_mode_enabled():
     """Returns true if the app is in development mode."""
-    return os.environ.get(get_env_name_development(), "false").lower() == "true"
+    return _is_env_set_to_true(get_env_name_development())
 
 
 def is_testing_mode_enabled():
     """Returns true if the app is in testing mode."""
-    return (
-        is_development_mode_enabled()
-        and os.environ.get(get_env_name_testing(), "false").lower() == "true"
-    )
+    return is_development_mode_enabled() and _is_env_set_to_true(get_env_name_testing())
 
 
 def is_web_logging_enabled():
     """Returns true if the web logging is required to be enabled"""
-
-    if os.environ.get(get_old_env_name_enable_web_logging(), None) is not None:
-        from matlab_proxy.util import mwi
-
-        logger = mwi.logger.get()
-        logger.warning(
-            f"Usage of {get_old_env_name_enable_web_logging()} is being deprecated from v0.2.10 and will be removed in a future release.\n Use {get_env_name_enable_web_logging()} instead. "
-        )
-        return (
-            os.environ.get(get_old_env_name_enable_web_logging(), "false").lower()
-            == "true"
-        )
-    return os.environ.get(get_env_name_enable_web_logging(), "false").lower() == "true"
+    return _is_env_set_to_true(get_env_name_enable_web_logging())
 
 
 def get_env_name_ssl_cert_file():
@@ -155,3 +143,56 @@ def get_env_name_custom_matlab_root():
 def get_env_name_process_startup_timeout():
     """User specified timeout in seconds for processes launched by matlab-proxy"""
     return "MWI_PROCESS_START_TIMEOUT"
+
+
+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
+    for functions which are not ready for prime time.
+    """
+
+    @staticmethod
+    def get_env_name_enable_simulink():
+        """Returns the environment variable name used to enable simulink support"""
+        ##NOTE: Simulink Online is unavailable for general use as of R2023b.
+        return "MWI_ENABLE_SIMULINK"
+
+    @staticmethod
+    def is_simulink_enabled():
+        """Returns true if the simulink online is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_enable_simulink())
+
+    @staticmethod
+    def should_use_mos_html():
+        """Returns true if matlab-proxy should use MOS htmls to load MATLAB"""
+        return _is_env_set_to_true("MWI_USE_MOS") or Experimental.is_simulink_enabled()
+
+    @staticmethod
+    def should_use_mre_html():
+        """Returns true if matlab-proxy should provide MRE parameter to the htmls used to load MATLAB"""
+        return _is_env_set_to_true("MWI_USE_MRE")
+
+    @staticmethod
+    def get_env_name_enable_mpa():
+        """Returns the environment variable name used to enable MPA support"""
+        return "MWI_ENABLE_MPA"
+
+    @staticmethod
+    def is_mpa_enabled():
+        """Returns true if the simulink online is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_enable_mpa())
+
+    @staticmethod
+    def get_env_name_profile_matlab_startup():
+        """Returns the environment variable name used to enable MPA support"""
+        return "MWI_PROFILE_MATLAB_STARTUP"
+
+    @staticmethod
+    def is_matlab_startup_profiling_enabled():
+        """Returns true if the simulink online is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_profile_matlab_startup())
+
+    @staticmethod
+    def get_mpa_flags():
+        """Returns list of flags required to enable MPA"""
+        return ["-webui", "-externalUI"]

matlab_proxy/util/mwi/logger.py

@@ -1,12 +1,15 @@
-# Copyright (c) 2020-2022 The MathWorks, Inc.
+# Copyright 2020-2023 The MathWorks, Inc.
 """Functions to access & control the logging behavior of the app
 """
 
 import logging
 import os
+import sys
+from pathlib import Path
 
 from . import environment_variables as mwi_env
 
+
 logging.getLogger("aiohttp_session").setLevel(logging.ERROR)
 
 
@@ -47,19 +50,35 @@ def __set_logging_configuration():
         Logger: Logger object with the set configuration.
     """
     # query for user specified environment variables
-    log_level, log_file = __query_environment()
+    log_level = os.getenv(
+        mwi_env.get_env_name_logging_level(), __get_default_log_level()
+    )
+    log_file = os.getenv(mwi_env.get_env_name_log_file(), None)
 
     ## Set logging object
     logger = __get_mw_logger()
-    if log_file is not None:
-        logger.info(f"Initializing logger with log_file:{log_file}")
-        file_handler = logging.FileHandler(filename=log_file)
-        formatter = logging.Formatter(
-            fmt="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
-        )
-        file_handler.setFormatter(formatter)
-        file_handler.setLevel(log_level)
-        logger.addHandler(file_handler)
+    try:
+        if log_file:
+            log_file = Path(log_file)
+            # Need to create the file if it doesn't exist or else logging.FileHandler
+            # would open it in 'write' mode instead of 'append' mode.
+            log_file.touch(exist_ok=True)
+            logger.info(f"Initializing logger with log file:{log_file}")
+            file_handler = logging.FileHandler(filename=log_file, mode="a")
+            formatter = logging.Formatter(
+                fmt="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+            )
+            file_handler.setFormatter(formatter)
+            file_handler.setLevel(log_level)
+            logger.addHandler(file_handler)
+
+    except PermissionError:
+        print(f"PermissionError: Permission denied to create log file at: {log_file}")
+        sys.exit(1)
+
+    except Exception as err:
+        print(f"Failed to use log file: {log_file} with error: {err}")
+        sys.exit(1)
 
     # log_level is either set by environment or is the default value.
     logger.info(f"Initializing logger with log_level: {log_level}")
@@ -91,16 +110,3 @@ def __get_default_log_level():
         String: The default logging level
     """
     return "INFO"
-
-
-def __query_environment():
-    """Private function to query environment variables
-        to control logging
-
-    Returns:
-        tuple: Log level & Log file as found in the environment
-    """
-    env_var_log_level, env_var_log_file = get_environment_variable_names()
-    log_level = os.environ.get(env_var_log_level, __get_default_log_level())
-    log_file = os.environ.get(env_var_log_file)
-    return log_level, log_file

matlab_proxy/util/mwi/token_auth.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2023 The MathWorks, Inc.
 
 # This file contains functions required to enable token based authentication in the server.
 
@@ -135,6 +135,8 @@ def authenticate_access_decorator(endpoint):
 
 
 ## Module Private Methods:
+
+
 async def _get_token_name(request):
     """Gets the name of the token from settings.
 

{matlab_proxy-0.9.1.dist-info → matlab_proxy-0.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.9.1
+Version: 0.10.1
 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.
@@ -29,6 +29,9 @@ Requires-Dist: pytest-cov ; extra == 'dev'
 Requires-Dist: pytest-mock ; extra == 'dev'
 Requires-Dist: pytest-aiohttp ; extra == 'dev'
 Requires-Dist: psutil ; extra == 'dev'
+Requires-Dist: urllib3 ; extra == 'dev'
+Requires-Dist: requests ; extra == 'dev'
+Requires-Dist: pytest-playwright ; extra == 'dev'
 
 # MATLAB Proxy
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mathworks/matlab-proxy/run-tests.yml?branch=main&logo=github)](https://github.com/mathworks/matlab-proxy/actions)   [![PyPI badge](https://img.shields.io/pypi/v/matlab-proxy.svg?logo=pypi)](https://pypi.python.org/pypi/matlab-proxy)    [![codecov](https://codecov.io/gh/mathworks/matlab-proxy/branch/main/graph/badge.svg?token=ZW3SESKCSS)](https://codecov.io/gh/mathworks/matlab-proxy)   [![Downloads](https://static.pepy.tech/personalized-badge/matlab-proxy?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads/month)](https://pepy.tech/project/matlab-proxy)

{matlab_proxy-0.9.1.dist-info → matlab_proxy-0.10.1.dist-info}/RECORD

@@ -1,14 +1,14 @@
 matlab_proxy/__init__.py,sha256=6cwi8buKCMtw9OeWaOYUHEoqwl5MyJ_s6GxgNuqPuNg,1673
-matlab_proxy/app.py,sha256=RXb45AniSi-6iZTKEZzjjLin1IaIqKeLAgfelsw2WHU,28548
-matlab_proxy/app_state.py,sha256=s8HNzmbCPmhVkop-rshlrs1X46RLLe5e75TGPcOJZ5o,52053
-matlab_proxy/constants.py,sha256=IPGbrmhtvaWUhiV-vdEshKLQ62EkKl3K93bWf7Ec8dA,497
+matlab_proxy/app.py,sha256=pMLiSfUbes04boTqjmmV2OZrzTmIJA5wtn5mK8jQAnY,28681
+matlab_proxy/app_state.py,sha256=OXk7-SR83CSn-BlZflu679TwuPDjviA6Vta5FvZqEF0,54552
+matlab_proxy/constants.py,sha256=mtIZmO8MVbKoHqu0jTDB0R3c8tNw_2csm4dM0vNRDIE,620
 matlab_proxy/default_configuration.py,sha256=DxQaHzAivzstiPl_nDfxs8SOyP9oaK9v3RP4LtroJl4,843
 matlab_proxy/devel.py,sha256=nR6XPVBUEdQ-RZGtYvX1YHTp8gj9cuw5Hp8ahasMBc8,14310
-matlab_proxy/settings.py,sha256=KLaQO_xjsj5dm51lxevtfbmLhTuf0E8k6Dkq1QKoeU4,18556
+matlab_proxy/settings.py,sha256=FyctpBa9SaQEnItfFi6gF4SZ_d2Qm1ojonGug4bwRt4,19738
 matlab_proxy/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/asset-manifest.json,sha256=VH6xUEv0Fy6ULD8Ov5BmUtYMwK_LzTxNiB6CD3oQYko,3516
+matlab_proxy/gui/asset-manifest.json,sha256=ULnp89obzlSF90igCa2cFhgmBTKJwe4WOeBhrlydUjs,3516
 matlab_proxy/gui/favicon.ico,sha256=7w7Ki1uQP2Rgwc64dOV4-NrTu97I3WsZw8OvRSoY1A0,130876
-matlab_proxy/gui/index.html,sha256=N6vbd0aZL4jEvqGduPB3MxGyjcapXx7MBqp2lK2jX-M,637
+matlab_proxy/gui/index.html,sha256=PGUXqpG-bX2JI35hPaOsauUR6y1z84AQJPQTkRwI-ik,637
 matlab_proxy/gui/manifest.json,sha256=NwDbrALM5auYyj2bbEf4aGwAUDqNl1FzMFQpPiG2Ty4,286
 matlab_proxy/gui/robots.txt,sha256=kNJLw79pisHhc3OVAimMzKcq3x9WT6sF9IS4xI0crdI,67
 matlab_proxy/gui/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -16,9 +16,9 @@ matlab_proxy/gui/static/css/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 matlab_proxy/gui/static/css/main.aa888962.css,sha256=pIXlQZlx2Xn0N5a7Wvh9UBBrKOZr0DOr9eEzmEAbAeM,274104
 matlab_proxy/gui/static/css/main.aa888962.css.map,sha256=8he7DI95fPkvfLbdbx77QEcqFjuNBz4YpX3HDzFNNGw,350274
 matlab_proxy/gui/static/js/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/static/js/main.daea642c.js,sha256=5T2DwlpYAIwAWwzwAqR2lagRAZVqugzxUjdsy_pUebI,288122
-matlab_proxy/gui/static/js/main.daea642c.js.LICENSE.txt,sha256=3cj3DrwM51esz1ogL9VVU1ZyXyXJ6u-Ec2CI9CCcI_A,1689
-matlab_proxy/gui/static/js/main.daea642c.js.map,sha256=4HJYZWdYNREKiJKy5AqAwHbgZm00VFKdwSxqqPes2_s,911354
+matlab_proxy/gui/static/js/main.fbc5c728.js,sha256=CTUnx095f0hFy9BKYU_IokVIRoIrNwu3BFVfWNzpmLo,288746
+matlab_proxy/gui/static/js/main.fbc5c728.js.LICENSE.txt,sha256=3cj3DrwM51esz1ogL9VVU1ZyXyXJ6u-Ec2CI9CCcI_A,1689
+matlab_proxy/gui/static/js/main.fbc5c728.js.map,sha256=6JF-lxxluIkr1Cc8Teyf9SUzFfKBup1IV13KFuuxGac,913905
 matlab_proxy/gui/static/media/MATLAB-env-blur.4fc94edbc82d3184e5cb.png,sha256=QpmQTLDvBu2-b7ev83Rvpt0Q72R6wdQGkuJMPPpjv7M,220290
 matlab_proxy/gui/static/media/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 matlab_proxy/gui/static/media/arrow.0c2968b90bd9a64c8c3f.svg,sha256=XtmvDWzGZnwCZm08TKBnqt5hc1wphJnNupG0Fx_faAY,327
@@ -61,17 +61,17 @@ matlab_proxy/util/system.py,sha256=XoT3Rv5MwPkdfhk2oMvUwxxlzZmADMlxzi9IRQyGgbA,1
 matlab_proxy/util/windows.py,sha256=R9-VA7f0snVanSR7IgbHz3kvSnthZuUYe2UhBd5QWMQ,3440
 matlab_proxy/util/mwi/__init__.py,sha256=zI-X1lafr8H3j17PyA0oSZ0q5nINfK-WDA7VmJKmSAQ,158
 matlab_proxy/util/mwi/custom_http_headers.py,sha256=kfDjSnEXEVzoF2pZuEn76LKayeD2WKoQEDu2Y9EMOAo,7154
-matlab_proxy/util/mwi/environment_variables.py,sha256=tb1aoqxbI8BjGg9pqc0XTY-6NCVXOih_2GHAc2tmrqM,4961
+matlab_proxy/util/mwi/environment_variables.py,sha256=BrG7FeXZ3nTE7BGFmItdNXRYpcfRMdIBaJCvj8llle0,6554
 matlab_proxy/util/mwi/exceptions.py,sha256=93HrHbOq24KI4Md2el23XN01wIqVShEK29Pbt2V0Jr8,4628
-matlab_proxy/util/mwi/logger.py,sha256=uOqsJJmrHNwUNKI2tFmfmV6-8L3NH2Ua5sNJESpnqrQ,3049
-matlab_proxy/util/mwi/token_auth.py,sha256=yXf9mkwoPe9LJh0O7LJgWmv7Nq8fXs3fx0nqvnXqflc,9846
+matlab_proxy/util/mwi/logger.py,sha256=e7wTPclrtJ-aX5mPk_pUJMX7-1QD_snGBW1P2ks-ETE,3311
+matlab_proxy/util/mwi/token_auth.py,sha256=2HiLmfvi_ejTJAEyV0_Unt-CK_osZTwfROp6yQ6SGfY,9844
 matlab_proxy/util/mwi/validators.py,sha256=Do0w8pjzCpYg9EiWqUtDojnBw8iwqkMR7K3ZQ8cBK8U,11745
 matlab_proxy/util/mwi/embedded_connector/__init__.py,sha256=SVSckEJ4zQQ2KkNPT_un8ndMAImcMOTrai7ShAbmFY4,114
 matlab_proxy/util/mwi/embedded_connector/helpers.py,sha256=SfrwpCnZ6QGJBko-sR2bIG4-_qZOn29zCZV9qwVBnkM,3395
-matlab_proxy/util/mwi/embedded_connector/request.py,sha256=Lc7ATrHOrXCa6EY8v_CzNH5I8rM7s6NZZP8vXtTnwTE,3720
-matlab_proxy-0.9.1.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
-matlab_proxy-0.9.1.dist-info/METADATA,sha256=udUZhm84n6myWUmgBucMiOFxfPsKj25dEjw7embargk,9648
-matlab_proxy-0.9.1.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-matlab_proxy-0.9.1.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
-matlab_proxy-0.9.1.dist-info/top_level.txt,sha256=3-Lxje1LZvSfK__TVoRksU4th_PCj6cMMJwhH8P0_3I,13
-matlab_proxy-0.9.1.dist-info/RECORD,,
+matlab_proxy/util/mwi/embedded_connector/request.py,sha256=0NyfnE7-0g3BBPTPmjbkDrTOGiTNqFDrqKDObcRc2Jw,3716
+matlab_proxy-0.10.1.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
+matlab_proxy-0.10.1.dist-info/METADATA,sha256=cgDn7iW9yn-jCdRhfdspK5Ne7Xj1NM3aZIMBFJNXs-k,9780
+matlab_proxy-0.10.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+matlab_proxy-0.10.1.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
+matlab_proxy-0.10.1.dist-info/top_level.txt,sha256=3-Lxje1LZvSfK__TVoRksU4th_PCj6cMMJwhH8P0_3I,13
+matlab_proxy-0.10.1.dist-info/RECORD,,

{matlab_proxy-0.9.1.dist-info → matlab_proxy-0.10.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: true
 Tag: py3-none-any