matlab-proxy 0.5.3__py3-none-any.whl → 0.30.1__py3-none-any.whl

matlab_proxy/constants.py

@@ -0,0 +1,37 @@
+# Copyright 2023-2025 The MathWorks, Inc.
+from typing import Final, List
+
+"""This module defines project-level constants"""
+
+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
+MAX_WEBSOCKET_MESSAGE_SIZE_IN_MB: 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
+# Clients of this package should use settings.py::get_process_startup_timeout() function
+DEFAULT_PROCESS_START_TIMEOUT: Final[int] = 600
+
+SUPPORTED_MATLAB_VERSIONS: Final[List[str]] = [
+    "R2020b",
+    "R2021a",
+    "R2021b",
+    "R2022a",
+    "R2022b",
+    "R2023a",
+    "R2023b",
+    "R2024a",
+    "R2024b",
+    "R2025a",
+    "R2025b",
+]
+
+# This constant when set to True restricts the number of active sessions to one
+IS_CONCURRENCY_CHECK_ENABLED: Final[bool] = True
+MWI_AUTH_TOKEN_NAME_FOR_HTTP = "mwi-auth-token"
+
+# Interval in seconds to wait before querying the status of MATLAB.
+CHECK_MATLAB_STATUS_INTERVAL_SECONDS: Final[int] = 1

matlab_proxy/default_configuration.py

@@ -1,18 +1,53 @@
-# Copyright (c) 2020-2022 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
+from enum import Enum
+from typing import List
+
 import matlab_proxy
 
+
+class ConfigKeys(Enum):
+    """Enumeration for configuration keys used in the MATLAB proxy setup."""
+
+    DOC_URL = "doc_url"
+    EXT_NAME = "extension_name"
+    EXT_NAME_DESC = "extension_name_short_description"
+    SHOW_SHUTDOWN_BUTTON = "should_show_shutdown_button"
+
+
 # Configure matlab_proxy
 config = {
     # Link the documentation url here. This will show up on the website UI
     # where users can create issue's or make enhancement requests
-    "doc_url": "https://github.com/mathworks/matlab-proxy/",
+    ConfigKeys.DOC_URL.value: "https://github.com/mathworks/matlab-proxy/",
     # Use a single word for extension_name
     # It will be used as a flag when launching the integration.
     # NOTE: This name must be used when setting the entrypoint for matlab_proxy in setup.py
     # Use '-' or '_' seperated values if more than 1 word is used.
     # Ex: Hello-World, Alice_Bob.
-    "extension_name": matlab_proxy.get_default_config_name(),
+    ConfigKeys.EXT_NAME.value: matlab_proxy.get_default_config_name(),
     # This value will be used in various places on the website UI.
     # Ensure that this is not more than 3 words.
-    "extension_name_short_description": "MATLAB Desktop",
+    ConfigKeys.EXT_NAME_DESC.value: "MATLAB Desktop",
+    # Show the shutdown button in the UI for matlab-proxy
+    ConfigKeys.SHOW_SHUTDOWN_BUTTON.value: True,
 }
+
+
+def get_required_config() -> List[str]:
+    """Get the list of required configuration keys.
+
+    This function returns a list of keys that are required for
+    the MATLAB proxy configuration. These keys are used to
+    ensure that the configuration dictionary contains all the
+    necessary entries.
+
+    Returns:
+        list: A list of strings representing the required
+        configuration keys.
+    """
+    required_keys: List[ConfigKeys] = [
+        ConfigKeys.DOC_URL,
+        ConfigKeys.EXT_NAME,
+        ConfigKeys.EXT_NAME_DESC,
+    ]
+    return [key.value for key in required_keys]

matlab_proxy/devel.py

@@ -11,6 +11,8 @@ from aiohttp import web
 
 from matlab_proxy import settings
 from matlab_proxy.util.mwi import environment_variables as mwi_env
+from matlab_proxy.constants import CONNECTOR_SECUREPORT_FILENAME
+from matlab_proxy.util.event_loop import *
 
 desktop_html = b"""
 <h1>Fake MATLAB Web Desktop</h1>
@@ -27,23 +29,13 @@ desktop_html = b"""
 """
 
 
-def wait_for_port(port):
-    """Waits for the given port to become available
-
-    Args:
-        port (Integer): Port number to start fake matlab server.
-    """
-    while True:
-        print(f"Waiting for port {port} to be available")
-        try:
-            s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-            s.bind(("", port))
-        except OSError:
-            time.sleep(5)
-            continue
-        # Once successful, close the port and stop waiting
-        s.close()
-        break
+def assign_free_port():
+    """Finds an available free port"""
+    s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    s.bind(("", 0))
+    port = s.getsockname()[1]
+    s.close()
+    return port
 
 
 async def web_handler(request):
@@ -176,10 +168,11 @@ async def fake_matlab_started(app):
 
     # Real MATLAB always uses  $MATLAB_LOG_DIR/connection.securePort as the ready file
     # We mock reading from the environment variable by calling the helper functions
-    mwi_logs_dir = settings.get(dev=True)["mwi_logs_root_dir"] / str(app["port"])
-    mwi_logs_dir.mkdir(parents=True, exist_ok=True)
+    matlab_logs_dir = os.getenv(mwi_env.get_env_name_matlab_log_dir())
 
-    app["matlab_ready_file"] = mwi_logs_dir / "connector.securePort"
+    app["matlab_ready_file"] = Path(
+        f"{matlab_logs_dir}/{CONNECTOR_SECUREPORT_FILENAME}"
+    )
 
     ready_delay = app["ready_delay"]
     try:
@@ -188,6 +181,10 @@ async def fake_matlab_started(app):
             f"Creating fake MATLAB Embedded Connector ready file at {app['matlab_ready_file']}"
         )
         app["matlab_ready_file"].touch()
+
+        # Populate ready file with the embedded connector port information
+        with open(app["matlab_ready_file"], "w") as f:
+            f.write(str(app["port"]))
     except asyncio.CancelledError:
         pass
 
@@ -223,8 +220,7 @@ def matlab(args):
     Args:
         args (Dict): Contains data on how to start web server.
     """
-    port = int(os.environ["MW_CONNECTOR_SECURE_PORT"])
-    wait_for_port(port)
+    port = assign_free_port()
     print(f"Serving fake MATLAB Embedded Connector at port {port}")
     app = web.Application()
     app["ready_delay"] = args.ready_delay

matlab_proxy/gui/index.html

@@ -1 +1,20 @@
-<!doctype html><html lang="en"><script>function isServerAuthenticated(){var e=document.URL,o=e.split("index.html")[0],t=new URL(e).searchParams.get("mwi_auth_token"),n=o+"authenticate_request";t&&(n+="?mwi_auth_token="+t),console.log("auth_endpoint: "+n),fetch(n).then((function(e){e.ok?console.log("This page is authorized!"):(console.log("This page is NOT authorized!"),console.log("Redirecting to :"+o),window.location.replace(o))})).catch((function(e){console.log(e)}))}</script><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"/><link rel="manifest" href="./manifest.json"/><title>MATLAB</title><link href="./static/css/main.d890078a.chunk.css" rel="stylesheet"></head><body onload="isServerAuthenticated()"><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script>!function(e){function r(r){for(var n,l,a=r[0],p=r[1],f=r[2],c=0,s=[];c<a.length;c++)l=a[c],Object.prototype.hasOwnProperty.call(o,l)&&o[l]&&s.push(o[l][0]),o[l]=0;for(n in p)Object.prototype.hasOwnProperty.call(p,n)&&(e[n]=p[n]);for(i&&i(r);s.length;)s.shift()();return u.push.apply(u,f||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,a=1;a<t.length;a++){var p=t[a];0!==o[p]&&(n=!1)}n&&(u.splice(r--,1),e=l(l.s=t[0]))}return e}var n={},o={1:0},u=[];function l(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,l),t.l=!0,t.exports}l.m=e,l.c=n,l.d=function(e,r,t){l.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},l.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},l.t=function(e,r){if(1&r&&(e=l(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(l.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)l.d(t,n,function(r){return e[r]}.bind(null,n));return t},l.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return l.d(r,"a",r),r},l.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},l.p="./";var a=this["webpackJsonpmatlab-proxy"]=this["webpackJsonpmatlab-proxy"]||[],p=a.push.bind(a);a.push=r,a=a.slice();for(var f=0;f<a.length;f++)r(a[f]);var i=p;t()}([])</script><script src="./static/js/2.13be6544.chunk.js"></script><script src="./static/js/main.c311d854.chunk.js"></script></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.pQwV1obF.js"></script>
+    <link rel="stylesheet" crossorigin href="./static/css/index.BedVwcEg.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>