matlab-proxy 0.19.0__py3-none-any.whl → 0.21.0__py3-none-any.whl

matlab_proxy/settings.py

@@ -493,7 +493,7 @@ def create_xvfb_cmd():
         str(dpipe[1]),
         "-screen",
         "0",
-        "1600x1200x24",
+        "3840x2160x24",
         "-dpi",
         "100",
         # "-ac",

matlab_proxy/util/mwi/logger.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 """Functions to access & control the logging behavior of the app
 """
 
@@ -52,7 +52,17 @@ def __set_logging_configuration():
     # query for user specified environment variables
     log_level = os.getenv(
         mwi_env.get_env_name_logging_level(), __get_default_log_level()
-    )
+    ).upper()
+
+    valid = __is_valid_log_level(log_level)
+
+    if not valid:
+        default_log_level = __get_default_log_level()
+        logging.warn(
+            f"Unknown log level '{log_level}' set. Defaulting to log level '{default_log_level}'..."
+        )
+        log_level = default_log_level
+
     log_file = os.getenv(mwi_env.get_env_name_log_file(), None)
 
     ## Set logging object
@@ -110,3 +120,13 @@ def __get_default_log_level():
         String: The default logging level
     """
     return "INFO"
+
+
+def __is_valid_log_level(log_level):
+    """Helper to check if the log level is valid.
+
+    Returns:
+        Boolean: Whether log level  exists
+    """
+
+    return hasattr(logging, log_level)

matlab_proxy/util/windows.py

@@ -49,10 +49,13 @@ async def start_matlab(matlab_cmd, matlab_env):
     """
     import psutil
 
+    # The stdout is used to suppress the MATLAB outputs from being shown in the terminal.
+    # We set it to DEVNULL instead of PIPE because PIPE has a limited buffer size and can
+    # block the process if the output exceeds the buffer limit.
     intermediate_proc = await asyncio.create_subprocess_exec(
         *matlab_cmd,
         env=matlab_env,
-        stdout=asyncio.subprocess.PIPE,
+        stdout=asyncio.subprocess.DEVNULL,
         stderr=asyncio.subprocess.STDOUT,
     )
 

{matlab_proxy-0.19.0.dist-info → matlab_proxy-0.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.19.0
+Version: 0.21.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.
@@ -17,24 +17,25 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Python: ~=3.8
 Description-Content-Type: text/markdown
-Requires-Dist: aiohttp >=3.7.4
+Requires-Dist: aiohttp>=3.7.4
 Requires-Dist: aiohttp-session[secure]
 Requires-Dist: importlib-metadata
 Requires-Dist: importlib-resources
 Requires-Dist: psutil
+Requires-Dist: watchdog
 Provides-Extra: dev
-Requires-Dist: aiohttp-devtools ; extra == 'dev'
-Requires-Dist: black ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: pytest-env ; extra == 'dev'
-Requires-Dist: pytest-cov ; extra == 'dev'
-Requires-Dist: pytest-timeout ; 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'
+Requires-Dist: aiohttp-devtools; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-env; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-timeout; 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)
@@ -201,7 +202,7 @@ $ pip install --upgrade matlab-proxy>=0.5.0
 
 ### Windows Subsystem for Linux (WSL 2)
 
-To install `matlab-proxy` in WSL 2, follow the steps mentioned in the [Installation Guide for WSL 2](./installation/wsl2/README.md).
+To install `matlab-proxy` in WSL 2, follow the steps mentioned in the [Installation Guide for WSL 2](./install_guides/wsl2/README.md).
 
 ## Using an already activated MATLAB with matlab-proxy
 `matlab-proxy` version `v0.7.0` introduces support for using an existing MATLAB license. Use the Existing License option only if you have an activated MATLAB. This allows you to start MATLAB without authenticating every time.

{matlab_proxy-0.19.0.dist-info → matlab_proxy-0.21.0.dist-info}/RECORD

@@ -1,24 +1,24 @@
 matlab_proxy/__init__.py,sha256=6cwi8buKCMtw9OeWaOYUHEoqwl5MyJ_s6GxgNuqPuNg,1673
-matlab_proxy/app.py,sha256=6_zql3Uv0gT1pSBDdesZ_FSFqtPWt--YIVyh3cj4d_g,34379
+matlab_proxy/app.py,sha256=0conSbbVwaYdWtbA_ZTUk2lLDZYsLIBQiBqNKYj0rho,34713
 matlab_proxy/app_state.py,sha256=pt6s3Yy6NV6LB-GxT1Y4cOpeDaTFMm_ItN_qPstDTwE,71296
 matlab_proxy/constants.py,sha256=-gEUNjBATe3_4Cd7CN-VhkEn-iMRfiZ-zdDDD6fM_II,1161
 matlab_proxy/default_configuration.py,sha256=DxQaHzAivzstiPl_nDfxs8SOyP9oaK9v3RP4LtroJl4,843
 matlab_proxy/devel.py,sha256=nR6XPVBUEdQ-RZGtYvX1YHTp8gj9cuw5Hp8ahasMBc8,14310
-matlab_proxy/settings.py,sha256=Jrk6vkYCKt-cFogkkNpfMcEzZcrDgzfeHqSl6ndgkUA,26722
+matlab_proxy/settings.py,sha256=63pyCUvT7WLBRUpUr3F4r4nL13pQ2Hn6-oZODAhuGLo,26722
 matlab_proxy/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/asset-manifest.json,sha256=DvwTnv61wL1g9_YFg4tttJTsaU4QS9atCESSS1tXSAg,3516
+matlab_proxy/gui/asset-manifest.json,sha256=IarJ9XmKoHJovFfsx1gHk1frgKLGgyCzzYmZNz1DT3A,3516
 matlab_proxy/gui/favicon.ico,sha256=7w7Ki1uQP2Rgwc64dOV4-NrTu97I3WsZw8OvRSoY1A0,130876
-matlab_proxy/gui/index.html,sha256=QfpshVMgl83FzcW82qdNIaGRp-KJ0oIIErk0wDK_Gps,637
+matlab_proxy/gui/index.html,sha256=BvGtBVGQxdCjSKGhUFEXZPK3SaFXB7TF3gbFxyx7miQ,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
 matlab_proxy/gui/static/css/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/static/css/main.da9c4eb8.css,sha256=etg2mMerqvNiYKBJgve5vBUc-X8ZnnCVnf5gc-DMaPA,274453
-matlab_proxy/gui/static/css/main.da9c4eb8.css.map,sha256=favITMsubUPvF7E0vWcdc2RXJ9Pj5ljIWdPuhSBfDVU,351326
+matlab_proxy/gui/static/css/main.6cd0caba.css,sha256=Ks90yx_8kQC9UQXlkvh5ecz2vk2jEN2FKkMCLn0hTb8,269168
+matlab_proxy/gui/static/css/main.6cd0caba.css.map,sha256=-pczDWw0U0T9Yd7pVYDklDlsc6OJqxCYlGmS6qtAhqU,350517
 matlab_proxy/gui/static/js/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/static/js/main.e07799e7.js,sha256=rtgmv7rYVVOVheycw3zNBjIyKv63qeTRgZ4zmO4HxCs,298414
-matlab_proxy/gui/static/js/main.e07799e7.js.LICENSE.txt,sha256=3cj3DrwM51esz1ogL9VVU1ZyXyXJ6u-Ec2CI9CCcI_A,1689
-matlab_proxy/gui/static/js/main.e07799e7.js.map,sha256=nCto0v-cMAs0t2YmSz2UqwJ3PlWgoW6aLRNYo67Nie0,955674
+matlab_proxy/gui/static/js/main.61c661b8.js,sha256=w44nS4qbZOF7mS5ASEhmhDPLk1KPDP4f4qF3eNZRzBg,283166
+matlab_proxy/gui/static/js/main.61c661b8.js.LICENSE.txt,sha256=uJRPpXtA1Wzfw2dMAUGOPgwqYk2GvDcIafoGMMNLECQ,1539
+matlab_proxy/gui/static/js/main.61c661b8.js.map,sha256=02MznaDjhNTG_3yo4quVaeyxtnsJVacK_LbN4pTXJdA,911172
 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
@@ -59,18 +59,35 @@ matlab_proxy/util/event_loop.py,sha256=sX_0tKlirCY5ImLxkss_XO4Ksj65u6JHtwMj25oGL
 matlab_proxy/util/list_servers.py,sha256=M93coVZjyQCdIvCCxsNOU_XDWNjBSysOJ5tWXaTjP8Y,1369
 matlab_proxy/util/mw.py,sha256=dLGSdfcTZiwKR1MMZA-39o-8na13IEPZOGBqcaHmKVI,11086
 matlab_proxy/util/system.py,sha256=XoT3Rv5MwPkdfhk2oMvUwxxlzZmADMlxzi9IRQyGgbA,1692
-matlab_proxy/util/windows.py,sha256=J5O-wihOxEex43_AzwvFylNlN4hcZdO6KD5cpLv1FX8,3538
+matlab_proxy/util/windows.py,sha256=_5gl2IyHIfw8-D3_G5uHkycZVGGFVXtjkd6_aP3g2Ts,3785
 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/download.py,sha256=-GJj3yOsL4vF_9baqRXkgBI-vu_OwjZMQVkJXFS8GMc,4965
 matlab_proxy/util/mwi/environment_variables.py,sha256=sOfmL8PjQONgkJdegdotLbsqHsWJDsjS7kak0TJtVKU,7441
 matlab_proxy/util/mwi/exceptions.py,sha256=3jklFU6br2_pSSsATCRDY3A5fTzk6ekJ4M69sunwxBk,5114
-matlab_proxy/util/mwi/logger.py,sha256=e7wTPclrtJ-aX5mPk_pUJMX7-1QD_snGBW1P2ks-ETE,3311
+matlab_proxy/util/mwi/logger.py,sha256=EHHr6OWlXe6yVX0RPh57HSE7lz6MhWmwLQIpe_SlsC0,3803
 matlab_proxy/util/mwi/token_auth.py,sha256=UbIWqo7qADaZdijFvorLYsZbxzaB8TycGP8nk305ru0,9997
 matlab_proxy/util/mwi/validators.py,sha256=br-22Gyef_vxVSSH2Qkb97Nfph9sfl7fyhQ8-LWkBP4,12600
 matlab_proxy/util/mwi/embedded_connector/__init__.py,sha256=Vfl2hNC7V1IwoK9_wrwfENs4BC8P-Mvvqh4BNGi2n48,119
 matlab_proxy/util/mwi/embedded_connector/helpers.py,sha256=aOn-AvcDy6jBQJIffiv_agIa4UVldAIl3--QnDpXWDM,3656
 matlab_proxy/util/mwi/embedded_connector/request.py,sha256=-IzTDjy3qViHfLJpK3OnFtEyV7dgwJKPQAfav9lqILc,4317
+matlab_proxy_manager/__init__.py,sha256=CMqm2aSYUWo5sxV3vyqWudrQU31muouSqZRDesJNJSA,178
+matlab_proxy_manager/lib/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
+matlab_proxy_manager/lib/api.py,sha256=X-VSbZ41TPosqGODve8PSG6G9dZfqi0kmY_iGWFW3EA,10615
+matlab_proxy_manager/storage/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
+matlab_proxy_manager/storage/file_repository.py,sha256=U4FAw0zFN9z7YNlaMsYZXWm5ccs3rp3bzZL-W2BNhxA,5187
+matlab_proxy_manager/storage/interface.py,sha256=pnRRD0Ku3gzbruAOM3J3NI2Kk8do3-_yRw9Pag1IqnE,1883
+matlab_proxy_manager/storage/server.py,sha256=kQ4jtG2xqCa8c7zqDBFYxOhxMxwZwqTIITBxcJRDcvE,4848
+matlab_proxy_manager/utils/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
+matlab_proxy_manager/utils/auth.py,sha256=60vi16eQ7LWp3I4CNv2easTjObw50irEm518fiMA5YI,2526
+matlab_proxy_manager/utils/constants.py,sha256=pyg-bkk6wWfmy60nvhroZDMZt__FcbZbuvU-b9m2Fkg,163
+matlab_proxy_manager/utils/environment_variables.py,sha256=rbDeWnyJp77Yr6btK3eXKZQ5thwiwhOGZcvDetGPOH8,1436
+matlab_proxy_manager/utils/helpers.py,sha256=5yTRM0NjGUC6lcQ6O8ilDrG2AnICGfvJYdIPho41Egw,9193
+matlab_proxy_manager/utils/logger.py,sha256=GSRGD-yf518o-2b1BxEeJYuNiEz2eEqpl0Solqbwpb4,1869
+matlab_proxy_manager/web/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
+matlab_proxy_manager/web/app.py,sha256=Lu6sl3Mft98oL-Z1NwBdmmG1OvnwYEN31pU2bOdzFi0,16572
+matlab_proxy_manager/web/monitor.py,sha256=Gj0DxwX0c1PEAly5jWmuIGqNJYGDDjTkQIzbVXu4zCQ,1589
+matlab_proxy_manager/web/watcher.py,sha256=aNa_UDwvzaZrIdHyvWGX7dILH199uc6xVH4odrKU5-E,1817
 tests/integration/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
 tests/integration/integration_tests_with_license/__init__.py,sha256=vVYZCur-QhmIGCxUmn-WZjIywtDQidaLDmlmrRHRlgY,37
 tests/integration/integration_tests_with_license/conftest.py,sha256=sCaIXB8d4vf05C7JWSVA7g5gnPjbpRq3dftuBpWyp1s,1599
@@ -83,7 +100,7 @@ tests/integration/utils/integration_tests_utils.py,sha256=IbJ9CedFHiz3k85FBY-8Gw
 tests/integration/utils/licensing.py,sha256=rEBjvMXO8R3mL6KnePu2lojmOsjD4GXl9frf9N0Wacs,4842
 tests/unit/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
 tests/unit/conftest.py,sha256=Hfxq3h8IZuLJkRMh5jdEFiq78CIAdKvm-6KryRDZ0FY,1918
-tests/unit/test_app.py,sha256=LkIqION-F_4dDpbT0VXzdL_ue-1HGXhPRP9-AprcRKY,38443
+tests/unit/test_app.py,sha256=15kSWsfIEQpGzr6QoDoFpV501SYA5XkszrwDp8pJi74,38442
 tests/unit/test_app_state.py,sha256=ZtM79HAe5W6pVVWV-NICjDJBlmuxJ4NnZn-urGGtH-E,33429
 tests/unit/test_constants.py,sha256=2nXxTmDP8utr8krsfZ4c_Bh4_mWPcDO5uI8MXeq4Usg,158
 tests/unit/test_ddux.py,sha256=a2J2iM8j_nnfJVuMI38p5AjwrRdoMj3N88gFgS2I4hg,713
@@ -96,7 +113,7 @@ tests/unit/util/test_util.py,sha256=gecUFSVIg4a9s3Ljl0A7eSSY5jN4vH668CbjnTpi198,
 tests/unit/util/mwi/__init__.py,sha256=pl5jqyCHEwZEviiL8OC-SHulb1rBecstQCFF6qVjL9Y,37
 tests/unit/util/mwi/test_custom_http_headers.py,sha256=UfrhclS0j6WhShtg1ki2oF1kK8JqRC29uevH4tuDqF4,11182
 tests/unit/util/mwi/test_download.py,sha256=jYwPJFYGrPKqnkIJW42XYSe1fowmzChAkOx0k0xVldo,4779
-tests/unit/util/mwi/test_logger.py,sha256=zWImNitMYKPJunXWJjEDEtCEKwBz615PC844ZLwoxIg,1845
+tests/unit/util/mwi/test_logger.py,sha256=2VFoVlMLgsSWtDn0iVxHNArGBfN-IgWehuoaLvWlS6U,3151
 tests/unit/util/mwi/test_token_auth.py,sha256=-eBsaQ5JC7pyd9PXt48Rqs4cWjg6I-eOkp_gFVEwYhk,10538
 tests/unit/util/mwi/test_validators.py,sha256=rzSmifQdPWZ5ZjecShBpC_RYL55_smCsG248h2JzUDU,11467
 tests/unit/util/mwi/embedded_connector/__init__.py,sha256=pl5jqyCHEwZEviiL8OC-SHulb1rBecstQCFF6qVjL9Y,37
@@ -104,9 +121,9 @@ tests/unit/util/mwi/embedded_connector/test_helpers.py,sha256=vYTWNUTuDeaygo16JG
 tests/unit/util/mwi/embedded_connector/test_request.py,sha256=PR-jddnXDEiip-lD7A_QSvRwEkwo3eQ8owZlk-r9vnk,1867
 tests/utils/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
 tests/utils/logging_util.py,sha256=VBy_NRvwau3C_CVTBjK5RMROrQimnJYHO2U0aKSZiRw,2234
-matlab_proxy-0.19.0.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
-matlab_proxy-0.19.0.dist-info/METADATA,sha256=UPcQ8G3Z3NGsFcIrXpEhDj-RVJMAIDYQSNZxCFWf4HY,10177
-matlab_proxy-0.19.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-matlab_proxy-0.19.0.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
-matlab_proxy-0.19.0.dist-info/top_level.txt,sha256=9uVTjsUCAS4TwsxueTBxrBg3PdBiTSsYowAkHPv9VY0,19
-matlab_proxy-0.19.0.dist-info/RECORD,,
+matlab_proxy-0.21.0.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
+matlab_proxy-0.21.0.dist-info/METADATA,sha256=gnssXFWPF13KwXQjNiEuEaaE1IN-zOHHslCQ8TnnpGU,10190
+matlab_proxy-0.21.0.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+matlab_proxy-0.21.0.dist-info/entry_points.txt,sha256=ZAlCUsgKzGcAeQaMZOq31FrTB5tQ8Ypq8Op_8U600-A,305
+matlab_proxy-0.21.0.dist-info/top_level.txt,sha256=KF-347aoRGsfHTpiSqfIPUZ95bzK5-oMIu8S_TUcu-w,40
+matlab_proxy-0.21.0.dist-info/RECORD,,

{matlab_proxy-0.19.0.dist-info → matlab_proxy-0.21.0.dist-info}/WHEEL

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

{matlab_proxy-0.19.0.dist-info → matlab_proxy-0.21.0.dist-info}/entry_points.txt

@@ -1,6 +1,7 @@
 [console_scripts]
 matlab-proxy-app = matlab_proxy.app:main
 matlab-proxy-app-list-servers = matlab_proxy.util.list_servers:print_server_info
+matlab-proxy-manager-app = matlab_proxy_manager.web.app:main
 
 [matlab_proxy_configs]
 default_configuration_matlab_proxy = matlab_proxy.default_configuration:config

matlab_proxy-0.21.0.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+matlab_proxy
+matlab_proxy_manager
+tests

matlab_proxy_manager/__init__.py

@@ -0,0 +1,6 @@
+# Copyright 2024 The MathWorks, Inc.
+
+
+def get_executable_name() -> str:
+    """Fetches and returns matlab proxy manager executable name"""
+    return "matlab-proxy-manager-app"

matlab_proxy_manager/lib/__init__.py

@@ -0,0 +1 @@
+# Copyright 2024 The MathWorks, Inc.

matlab_proxy_manager/lib/api.py

@@ -0,0 +1,295 @@
+# Copyright 2024 The MathWorks, Inc.
+import asyncio
+import os
+import secrets
+import subprocess
+from typing import Optional
+
+import matlab_proxy
+import matlab_proxy.util.system as mwi_sys
+from matlab_proxy_manager.storage.file_repository import FileRepository
+from matlab_proxy_manager.storage.server import ServerProcess
+from matlab_proxy_manager.utils import constants, helpers, logger
+
+# Used to list all the public-facing APIs exported by this module.
+__all__ = ["shutdown", "start_matlab_proxy_for_kernel", "start_matlab_proxy_for_jsp"]
+
+log = logger.get()
+shutdown_lock = asyncio.Lock()
+log = logger.get(init=True)
+
+
+async def start_matlab_proxy_for_kernel(
+    caller_id: str, parent_id: str, is_isolated_matlab: bool
+):
+    """
+    Starts a MATLAB proxy server specifically for MATLAB Kernel.
+
+    This function is a wrapper around the `start_matlab_proxy` function, with mpm_auth_token
+    set to None, for starting the MATLAB proxy server via proxy manager.
+    """
+    return await _start_matlab_proxy(
+        caller_id=caller_id, ctx=parent_id, is_isolated_matlab=is_isolated_matlab
+    )
+
+
+async def start_matlab_proxy_for_jsp(
+    parent_id: str, is_isolated_matlab: bool, mpm_auth_token: str
+):
+    """
+    Starts a MATLAB proxy server specifically for Jupyter Server Proxy (JSP) - Open MATLAB launcher.
+
+    This function is a wrapper around the `start_matlab_proxy` function, providing
+    a more specific context (mpm_auth_token) for starting the MATLAB proxy server via proxy manager.
+    """
+    return await _start_matlab_proxy(
+        caller_id="jsp",
+        ctx=parent_id,
+        is_isolated_matlab=is_isolated_matlab,
+        mpm_auth_token=mpm_auth_token,
+    )
+
+
+async def _start_matlab_proxy(**options) -> Optional[dict]:
+    """
+    Start a MATLAB proxy server.
+
+    This function starts a MATLAB proxy server based on the provided context and caller ID.
+    It handles the creation of new servers and the reuse of existing ones.
+
+    Args (keyword arguments):
+        - caller_id (str): The identifier for the caller (kernel id for kernels, "jsp" for JSP).
+        - ctx (str): The context in which the server is being started (parent pid).
+        - is_isolated_matlab (bool, optional): Whether to start an isolated MATLAB proxy instance.
+        Defaults to False.
+        - mpm_auth_token (str, optional): The MATLAB proxy manager token. If not provided,
+        a new token is generated. Defaults to None.
+
+    Returns:
+        ServerProcess: The process representing the MATLAB proxy server.
+
+    Raises:
+        ValueError: If `caller_id` is "default" and `is_isolated_matlab` is True.
+    """
+    caller_id: str = options.get("caller_id")
+    ctx: str = options.get("ctx")
+    is_isolated_matlab: bool = options.get("is_isolated_matlab", False)
+    mpm_auth_token: Optional[str] = options.get("mpm_auth_token", None)
+
+    if is_isolated_matlab and caller_id == "default":
+        raise ValueError(
+            "Caller id cannot be default when isolated_matlab is set to true"
+        )
+
+    mpm_auth_token = mpm_auth_token or secrets.token_hex(32)
+
+    # Cleanup stale entries before starting new instance of matlab proxy server
+    helpers._are_orphaned_servers_deleted(ctx)
+
+    ident = caller_id if is_isolated_matlab else "default"
+    key = f"{ctx}_{ident}"
+    log.debug("Starting matlab proxy using %s, %s, %s", ctx, ident, is_isolated_matlab)
+
+    data_dir = helpers.create_and_get_proxy_manager_data_dir()
+    server_process = ServerProcess.find_existing_server(data_dir, key)
+
+    if server_process:
+        log.debug("Found existing server for aliasing")
+
+        # Create a backend file for this caller for reference tracking
+        helpers.create_state_file(data_dir, server_process, f"{ctx}_{caller_id}")
+
+    # Create a new matlab proxy server
+    else:
+        server_process: ServerProcess | None = (
+            await _start_subprocess_and_check_for_readiness(
+                ident, ctx, key, is_isolated_matlab, mpm_auth_token
+            )
+        )
+
+        # Store the newly created server into filesystem
+        if server_process:
+            helpers.create_state_file(data_dir, server_process, f"{ctx}_{caller_id}")
+
+    return server_process.as_dict() if server_process else None
+
+
+async def _start_subprocess_and_check_for_readiness(
+    server_id: str, ctx: str, key: str, isolated: bool, mpm_auth_token: str
+) -> Optional[ServerProcess]:
+    """
+    Starts a MATLAB proxy server.
+
+    This function performs the following steps:
+    1. Prepares the command and environment variables required to start the MATLAB proxy server.
+    2. Initializes the MATLAB proxy process.
+    3. Checks if the MATLAB proxy server is ready.
+    4. Creates and returns a ServerProcess instance if the server is ready.
+
+    Returns:
+        Optional[ServerProcess]: An instance of ServerProcess if the server is successfully started,
+        otherwise None.
+    """
+    log.debug("Starting new matlab proxy server")
+
+    # Prepare matlab proxy command and required environment variables
+    matlab_proxy_cmd, matlab_proxy_env = _prepare_cmd_and_env_for_matlab_proxy()
+
+    # Start the matlab proxy process
+    process_id, url, mwi_base_url = await _start_subprocess(
+        matlab_proxy_cmd, matlab_proxy_env, server_id
+    )
+
+    server_process = None
+
+    # Check for the matlab proxy server readiness
+    if helpers.is_server_ready(f"{url}{mwi_base_url}"):
+        log.debug("Matlab proxy process info: %s, %s", url, mwi_base_url)
+        server_process = ServerProcess(
+            server_url=url,
+            mwi_base_url=mwi_base_url,
+            headers=helpers.convert_mwi_env_vars_to_header_format(
+                matlab_proxy_env, "MWI"
+            ),
+            pid=process_id,
+            parent_pid=ctx,
+            id=key,
+            type="named" if isolated else "shared",
+            mpm_auth_token=mpm_auth_token,
+        )
+    else:
+        log.error("Could not start matlab proxy")
+
+    return server_process
+
+
+def _prepare_cmd_and_env_for_matlab_proxy():
+    """
+    Prepare the command and environment variables for starting the MATLAB proxy.
+
+    Returns:
+        Tuple: A tuple containing the MATLAB proxy command and environment variables.
+    """
+    from jupyter_matlab_proxy import config
+
+    # Get the command to start matlab-proxy
+    matlab_proxy_cmd: list = [
+        matlab_proxy.get_executable_name(),
+        "--config",
+        config.get("extension_name"),
+    ]
+
+    input_env: dict = {
+        "MWI_AUTH_TOKEN": secrets.token_urlsafe(32),
+    }
+
+    matlab_proxy_env: dict = os.environ.copy()
+    matlab_proxy_env.update(input_env)
+
+    return matlab_proxy_cmd, matlab_proxy_env
+
+
+async def _start_subprocess(cmd, env, server_id) -> Optional[int]:
+    """
+    Initializes and starts a subprocess using the specified command and provided environment.
+
+    Returns:
+        Optional[int]: The process ID if the process is successfully created, otherwise None.
+    """
+    process = None
+    mwi_base_url: str = f"{constants.MWI_BASE_URL_PREFIX}{server_id}"
+
+    # Get a free port, closer to starting the matlab proxy appx
+    port: str = helpers.find_free_port()
+    env.update(
+        {
+            "MWI_APP_PORT": port,
+            "MWI_BASE_URL": mwi_base_url,
+        }
+    )
+
+    # Using loopback address so that DNS resolution doesn't add latency in Windows
+    url: str = f"http://127.0.0.1:{port}"
+
+    if mwi_sys.is_posix():
+        process = await asyncio.create_subprocess_exec(
+            *cmd,
+            env=env,
+        )
+        log.debug("Started matlab proxy subprocess for posix")
+    else:
+        process = subprocess.Popen(
+            cmd,
+            env=env,
+        )
+        log.debug("Started matlab proxy subprocess for windows")
+
+    if not process:
+        log.error("Matlab proxy process not created %d", process.returncode)
+        return None
+
+    process_pid = process.pid
+    log.debug("MATLAB proxy info: pid = %s, rc = %s", process_pid, process.returncode)
+    return process_pid, url, mwi_base_url
+
+
+async def shutdown(parent_pid: str, caller_id: str, mpm_auth_token: str):
+    """
+    Shutdown the MATLAB proxy server if the provided authentication token is valid.
+
+    This function attempts to shut down the MATLAB proxy server identified by the
+    given context and ID, provided the correct authentication token is supplied.
+    It ensures that the shutdown process is thread-safe using an asyncio lock.
+
+    Args:
+        parent_pid (str): The context identifier for the server.
+        caller_id (str): The unique identifier for the server.
+        mpm_auth_token (str): The authentication token for proxy manager and client communication.
+
+    Returns:
+        Optional[None]: Returns None if the shutdown process is successful or if
+                        required arguments are missing.
+
+    Raises:
+        FileNotFoundError: If the state file for the server does not exist.
+        ValueError: If the authentication token is invalid.
+        Exception: If any other error occurs during the shutdown process.
+    """
+    if not parent_pid or not caller_id or not mpm_auth_token:
+        log.debug(
+            "Required arguments (parent_pid | caller_id | mpm_auth_token) for shutdown missing"
+        )
+        return
+
+    try:
+        data_dir = helpers.create_and_get_proxy_manager_data_dir()
+        storage = FileRepository(data_dir)
+        filename = f"{parent_pid}_{caller_id}"
+        full_file_path, server = storage.get(filename)
+
+        if not server:
+            log.debug("State file for this server not found, filename: %s", filename)
+            return
+
+        if mpm_auth_token != server.mpm_auth_token:
+            raise ValueError("Invalid authentication token")
+
+        # Using asyncio lock to ensure thread-safe shutdown: clicking shutdown
+        # all on Kernel UI sends shutdown request in parallel which could lead
+        # to a scenario where the kernels' shutdown just cleans the files from
+        # filesystem and doesn't shut down the backend matlab proxy server.
+        async with shutdown_lock:
+            if helpers.is_only_reference(full_file_path):
+                server.shutdown()
+
+            # Delete the file for this server
+            storage.delete(f"{filename}.info")
+    except FileNotFoundError as e:
+        log.error("State file for server %s not found: %s", filename, e)
+        return
+    except ValueError as e:
+        log.error("Authentication error for server %s: %s", filename, e)
+        return
+    except Exception as e:
+        log.error("Error during shutdown of server %s: %s", filename, e)
+        raise

matlab_proxy_manager/storage/__init__.py

@@ -0,0 +1 @@
+# Copyright 2024 The MathWorks, Inc.