matlab-proxy 0.16.0__py3-none-any.whl → 0.18.0__py3-none-any.whl

matlab_proxy/app.py

@@ -6,7 +6,6 @@ import mimetypes
 import pkgutil
 import secrets
 import sys
-import uuid
 
 import aiohttp
 from aiohttp import client_exceptions, web
@@ -17,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")
@@ -97,16 +95,15 @@ def marshal_error(error):
 
 
 async def create_status_response(
-    app, loadUrl=None, client_id=None, transfer_session=False, is_desktop=False
+    app, loadUrl=None, client_id=None, is_active_client=None
 ):
     """Send a generic status response about the state of server, MATLAB, MATLAB Licensing and the client session status.
 
     Args:
         app (aiohttp.web.Application): Web Server
         loadUrl (String, optional): Represents the root URL. Defaults to None.
-        client_id (String, optional): Represents the unique client_id when concurrency check is enabled. Defaults to None.
-        transfer_session (Boolean, optional): Represents whether the connection should be transfered or not when concurrency check is enabled. Defaults to False.
-        is_desktop (Boolean, optional): Represents whether the request is made by the desktop app or some other kernel. Defaults to False.
+        client_id (String, optional): Represents the generated client_id when concurrency check is enabled and client does not have a client_id. Defaults to None.
+        is_active_client (Boolean, optional): Represents whether the current client is the active_client when concurrency check is enabled. Defaults to None.
 
     Returns:
         JSONResponse: A JSONResponse object containing the generic state of the server, MATLAB, MATLAB Licensing and the client session status.
@@ -124,17 +121,30 @@ async def create_status_response(
         "wsEnv": state.settings.get("ws_env", ""),
     }
 
-    if IS_CONCURRENCY_CHECK_ENABLED and is_desktop:
-        if not client_id:
-            client_id = str(uuid.uuid4())
-            status["clientId"] = client_id
+    if client_id:
+        status["clientId"] = client_id
+    if is_active_client is not None:
+        status["isActiveClient"] = is_active_client
+
+    return web.json_response(status)
 
-        if not state.active_client or transfer_session:
-            state.active_client = client_id
 
-        status["isActiveClient"] = True if state.active_client == client_id else False
+@token_auth.authenticate_access_decorator
+async def clear_client_id(req):
+    """API endpoint to reset the active client
 
-    return web.json_response(status)
+    Args:
+        req (HTTPRequest): HTTPRequest Object
+
+    Returns:
+        Response: an empty response in JSON format
+    """
+    # Sleep for one second prior to clearing the client id to ensure that any remaining get_status responses are fully processed first.
+    await asyncio.sleep(1)
+    state = req.app["state"]
+    state.active_client = None
+    # This response is of no relevance to the front-end as the client has already exited
+    return web.json_response({})
 
 
 @token_auth.authenticate_access_decorator
@@ -201,15 +211,17 @@ async def get_status(req):
         JSONResponse: JSONResponse object containing information about the server, MATLAB and MATLAB Licensing.
     """
     # The client sends the CLIENT_ID as a query parameter if the concurrency check has been set to true.
+    state = req.app["state"]
     client_id = req.query.get("MWI_CLIENT_ID", None)
     transfer_session = json.loads(req.query.get("TRANSFER_SESSION", "false"))
     is_desktop = req.query.get("IS_DESKTOP", False)
 
+    generated_client_id, is_active_client = state.get_session_status(
+        is_desktop, client_id, transfer_session
+    )
+
     return await create_status_response(
-        req.app,
-        client_id=client_id,
-        transfer_session=transfer_session,
-        is_desktop=is_desktop,
+        req.app, client_id=generated_client_id, is_active_client=is_active_client
     )
 
 
@@ -409,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():
@@ -462,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
@@ -479,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:
@@ -773,6 +786,8 @@ async def cleanup_background_tasks(app):
     # Stop any running async tasks
     logger = mwi.logger.get()
     tasks = state.tasks
+    if state.task_detect_client_status:
+        tasks["detect_client_status"] = state.task_detect_client_status
     for task_name, task in tasks.items():
         if not task.cancelled():
             logger.debug(f"Cancelling MWI task: {task_name} : {task} ")
@@ -868,6 +883,7 @@ def create_app(config_name=matlab_proxy.get_default_config_name()):
     app.router.add_route("GET", f"{base_url}/get_auth_token", get_auth_token)
     app.router.add_route("GET", f"{base_url}/get_env_config", get_env_config)
     app.router.add_route("PUT", f"{base_url}/start_matlab", start_matlab)
+    app.router.add_route("POST", f"{base_url}/clear_client_id", clear_client_id)
     app.router.add_route("DELETE", f"{base_url}/stop_matlab", stop_matlab)
     app.router.add_route("PUT", f"{base_url}/set_licensing_info", set_licensing_info)
     app.router.add_route("PUT", f"{base_url}/update_entitlement", update_entitlement)

matlab_proxy/app_state.py

@@ -9,15 +9,18 @@ import time
 from collections import deque
 from datetime import datetime, timedelta, timezone
 from typing import Final, Optional
+import uuid
 
 from matlab_proxy import util
 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
@@ -103,6 +106,12 @@ class AppState:
         # connected to the backend
         self.active_client = None
 
+        # Used to detect whether the active client is actively sending out request or is inactive
+        self.active_client_request_detected = False
+
+        # An event loop task to handle the detection of client activity
+        self.task_detect_client_status = None
+
     def __get_cached_config_file(self):
         """Get the cached config file
 
@@ -586,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):
@@ -838,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)
@@ -964,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):
@@ -1304,3 +1335,76 @@ class AppState:
             if err is not None:
                 self.error = err
                 log_error(logger, err)
+
+    def get_session_status(self, is_desktop, client_id, transfer_session):
+        """
+        Determines the session status for a client, potentially generating a new client ID.
+
+        This function is responsible for managing and tracking the session status of a client.
+        It can generate a new client ID if one is not provided and the conditions are met.
+        It also manages the active client status within the session, especially in scenarios
+        involving desktop clients and when concurrency checks are enabled.
+
+        Args:
+            is_desktop (bool): A flag indicating whether the client is a desktop client.
+            client_id (str or None): The client ID. If None, a new client ID may be generated.
+            transfer_session (bool): Indicates whether the session should be transferred to this client.
+
+        Returns:
+            tuple:
+                - A 2-tuple containing the generated client ID (or None if not generated) and
+                a boolean indicating whether the client is considered the active client.
+                - If concurrency checks are not enabled or the client is not a desktop client, it returns None for both
+                the generated client ID and the active client status.
+        """
+        if IS_CONCURRENCY_CHECK_ENABLED and is_desktop:
+            generated_client_id = None
+            if not client_id:
+                generated_client_id = str(uuid.uuid4())
+                client_id = generated_client_id
+
+            if not self.active_client or transfer_session:
+                self.active_client = client_id
+
+                if not self.task_detect_client_status:
+                    # Create the loop to detect the active status of the client
+                    loop = util.get_event_loop()
+                    self.task_detect_client_status = loop.create_task(
+                        self.detect_active_client_status()
+                    )
+
+            if self.active_client == client_id:
+                is_active_client = True
+                self.active_client_request_detected = True
+            else:
+                is_active_client = False
+            return generated_client_id, is_active_client
+        return None, None
+
+    async def detect_active_client_status(self, sleep_time=1, max_inactive_count=10):
+        """Detects whether the client is online or not by continuously checking if the active client is making requests
+
+        Args:
+            sleep_time (int): The time in seconds for which the process waits before checking for the next get_status request from the active client.
+            max_inactive_count (int): The maximum number of times the check for the request from the active_client fails before reseting the active client id.
+        """
+        inactive_count = 0
+        while self.active_client:
+            # Check if the get_status request from the active client is received or not
+            await asyncio.sleep(sleep_time)
+            if self.active_client_request_detected:
+                self.active_client_request_detected = False
+                inactive_count = 0
+            else:
+                inactive_count = inactive_count + 1
+            if inactive_count > max_inactive_count:
+                # If no request is received from the active_client for more than 10 seconds then clear the active client id
+                inactive_count = 0
+                self.active_client = None
+        if self.task_detect_client_status:
+            try:
+                # Self cleanup of the task
+                self.task_detect_client_status.cancel()
+                self.task_detect_client_status = None
+            except Exception as e:
+                logger.error("Cleaning of task: 'detect_client_status' failed.")

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/gui/asset-manifest.json

@@ -1,7 +1,7 @@
 {
   "files": {
     "main.css": "./static/css/main.47712126.css",
-    "main.js": "./static/js/main.522d83ba.js",
+    "main.js": "./static/js/main.5b5ca2f2.js",
     "static/media/mathworks-pictograms.svg?20181009": "./static/media/mathworks-pictograms.f6f087b008b5a9435f26.svg",
     "static/media/MATLAB-env-blur.png": "./static/media/MATLAB-env-blur.4fc94edbc82d3184e5cb.png",
     "static/media/mathworks.svg?20181004": "./static/media/mathworks.80a3218e1ba29f0573fb.svg",
@@ -35,10 +35,10 @@
     "static/media/gripper.svg": "./static/media/gripper.9defbc5e76d0de8bb6e0.svg",
     "static/media/arrow.svg": "./static/media/arrow.0c2968b90bd9a64c8c3f.svg",
     "main.47712126.css.map": "./static/css/main.47712126.css.map",
-    "main.522d83ba.js.map": "./static/js/main.522d83ba.js.map"
+    "main.5b5ca2f2.js.map": "./static/js/main.5b5ca2f2.js.map"
   },
   "entrypoints": [
     "static/css/main.47712126.css",
-    "static/js/main.522d83ba.js"
+    "static/js/main.5b5ca2f2.js"
   ]
 }

matlab_proxy/gui/index.html

@@ -1 +1 @@
-<!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.522d83ba.js"></script><link href="./static/css/main.47712126.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!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.5b5ca2f2.js"></script><link href="./static/css/main.47712126.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>