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

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/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/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/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/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/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/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.16.0.dist-info → matlab_proxy-0.18.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.16.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.
@@ -18,8 +18,10 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Python: ~=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: aiohttp >=3.7.4
-Requires-Dist: psutil
 Requires-Dist: aiohttp-session[secure]
+Requires-Dist: importlib-metadata
+Requires-Dist: importlib-resources
+Requires-Dist: psutil
 Provides-Extra: dev
 Requires-Dist: aiohttp-devtools ; extra == 'dev'
 Requires-Dist: black ; extra == 'dev'

{matlab_proxy-0.16.0.dist-info → matlab_proxy-0.18.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
 matlab_proxy/__init__.py,sha256=6cwi8buKCMtw9OeWaOYUHEoqwl5MyJ_s6GxgNuqPuNg,1673
-matlab_proxy/app.py,sha256=-QcfNOCyXAQu58Gq-bSU4iHtJrVglxgD0c-n6nTzumo,33819
-matlab_proxy/app_state.py,sha256=tHZpv2pEk_zb55FKDvnIIcIg-S3i-r52h5WHot-wITI,55450
-matlab_proxy/constants.py,sha256=gHL6bYgRDyzufMx1XF9tbtC9vsS_yQlfYPNommti8tA,972
+matlab_proxy/app.py,sha256=fcZGlpW8Ox1ahHIhDBnL_iBkF-tFejTRr61L8WgGFgM,34429
+matlab_proxy/app_state.py,sha256=i5AVaNroFSld4Y36BNil5lwS0PNrHnceYq7swXY5AI4,60502
+matlab_proxy/constants.py,sha256=CrbIA098b5LMsqxY7nbap0_tqA2tIrIckGAffTgIkrA,1039
 matlab_proxy/default_configuration.py,sha256=DxQaHzAivzstiPl_nDfxs8SOyP9oaK9v3RP4LtroJl4,843
 matlab_proxy/devel.py,sha256=nR6XPVBUEdQ-RZGtYvX1YHTp8gj9cuw5Hp8ahasMBc8,14310
-matlab_proxy/settings.py,sha256=Q901JN7zwcySVOs7EQ69m4Ngishmo9ihFzqbPxXajh4,24915
+matlab_proxy/settings.py,sha256=I4nvFZzACKx-JBlAFCFWHA60gg66bR4hrXj1f5awfbA,25616
 matlab_proxy/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/asset-manifest.json,sha256=Y0bASwFy_ZO21iJjvOmN9Rf4pgvKRqpVMxVQ5g0eU2Q,3516
+matlab_proxy/gui/asset-manifest.json,sha256=XqmLvi3DDOGSbBxNZwjuaNJXoYjZiG2HasxvZnEzPEo,3516
 matlab_proxy/gui/favicon.ico,sha256=7w7Ki1uQP2Rgwc64dOV4-NrTu97I3WsZw8OvRSoY1A0,130876
-matlab_proxy/gui/index.html,sha256=R6bC4lxj_0V0mmXr4Rqf9mHQoDWkNY0CpKBGNvxWaWs,637
+matlab_proxy/gui/index.html,sha256=lWKKMXjAyOc-vk6t4rasj49sa2UgXAAlMdWYCd5V8N8,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.47712126.css,sha256=OT5ccyC0a6fVg956C-8b6uDVbZZVgcpXbHjdO6v4ZBI,274313
 matlab_proxy/gui/static/css/main.47712126.css.map,sha256=RdfmXfQvzvvh4XZuDWShm8CD8pA2Gb2K6MtMzrgJyKM,350495
 matlab_proxy/gui/static/js/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/static/js/main.522d83ba.js,sha256=6Mr6KC2dNysr7aA1VUObaA-2XZDPeZbA7FWl3W3GH68,294192
-matlab_proxy/gui/static/js/main.522d83ba.js.LICENSE.txt,sha256=3cj3DrwM51esz1ogL9VVU1ZyXyXJ6u-Ec2CI9CCcI_A,1689
-matlab_proxy/gui/static/js/main.522d83ba.js.map,sha256=dJifP1EbrR0Dli2vzs_uRFhJ10MG_6Zwaw2GtWWEkq0,937322
+matlab_proxy/gui/static/js/main.5b5ca2f2.js,sha256=XvoCZpW63pLcHvS9meZxIId_yQPC3w5SuGIij5VwOEc,294436
+matlab_proxy/gui/static/js/main.5b5ca2f2.js.LICENSE.txt,sha256=3cj3DrwM51esz1ogL9VVU1ZyXyXJ6u-Ec2CI9CCcI_A,1689
+matlab_proxy/gui/static/js/main.5b5ca2f2.js.map,sha256=mCDweY7BuQ4Ld5c6Z521rjPGrIlIzG2b_DjxsW_eo6M,938339
 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
@@ -52,21 +52,22 @@ matlab_proxy/gui/static/media/terminate.7ea1363ee0fa72344ef6.svg,sha256=LDLYNWk_
 matlab_proxy/gui/static/media/trigger-error.3f1c4ef23ab8f3e60b0e.svg,sha256=3zzT0uTrl4M_HlAjjVy_9F6fJDY9TifdQCFYX36LCOY,5017
 matlab_proxy/gui/static/media/trigger-ok.7b9c238be42f685c4fa7.svg,sha256=mD-7N9cc4ARdMBFcplnogJv6nA4Yh3jQuYbZDUi18LU,4997
 matlab_proxy/icons/matlab.svg,sha256=xh5uYebQd8I-ISvenjU9A-PkClzW_lU9wvm3doXOFKM,13366
-matlab_proxy/matlab/startup.m,sha256=YRtI8P2flDJSDcPxJ2008B2l1T9JpqiUbzhQxA0frbc,1558
-matlab_proxy/util/__init__.py,sha256=ikj07VxQdIThUWzWLOrdIsO-R1VtEhunB0mjrfnD5jE,8114
+matlab_proxy/matlab/evaluateUserMatlabCode.m,sha256=R8w6nPdGtadR4UUFJaspcrGQL7cJwUItdrfc531w3bM,2420
+matlab_proxy/matlab/startup.m,sha256=1hIvfWgBDcvM3wW__X2yaQ6cBwKjdh5eO0zycbJB78k,1555
+matlab_proxy/util/__init__.py,sha256=rhBsXJT-5v67FuJ9Rz23yDT7afYfwrS5y_oMQSTbCwg,8456
 matlab_proxy/util/event_loop.py,sha256=Zqd282jlvPHHyc4kg8IjIzlzh9zLM_SAc5xjqUOrm04,1144
 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=R9-VA7f0snVanSR7IgbHz3kvSnthZuUYe2UhBd5QWMQ,3440
+matlab_proxy/util/windows.py,sha256=J5O-wihOxEex43_AzwvFylNlN4hcZdO6KD5cpLv1FX8,3538
 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=bIz0QFWo0pgyvSeJ_kAobUCS17V05CSmFWm3zYIOIsA,7139
+matlab_proxy/util/mwi/environment_variables.py,sha256=SC5pMCs2EVWd9NrvA8yYbCOm998SXDhQCIG1h8Ilysc,7309
 matlab_proxy/util/mwi/exceptions.py,sha256=93HrHbOq24KI4Md2el23XN01wIqVShEK29Pbt2V0Jr8,4628
 matlab_proxy/util/mwi/logger.py,sha256=e7wTPclrtJ-aX5mPk_pUJMX7-1QD_snGBW1P2ks-ETE,3311
 matlab_proxy/util/mwi/token_auth.py,sha256=UbIWqo7qADaZdijFvorLYsZbxzaB8TycGP8nk305ru0,9997
-matlab_proxy/util/mwi/validators.py,sha256=BMMOD-0tdjGIALm1MmG4yXVRoD2ZUXkrJXLWP_D5FGo,11712
+matlab_proxy/util/mwi/validators.py,sha256=QEaP0N6U8BF4MglxrkM1phK0lWNiWBK7JdJbcfFRACY,11765
 matlab_proxy/util/mwi/embedded_connector/__init__.py,sha256=SVSckEJ4zQQ2KkNPT_un8ndMAImcMOTrai7ShAbmFY4,114
 matlab_proxy/util/mwi/embedded_connector/helpers.py,sha256=p6TedefbvhlZT64IMwFjrb0panWCXf-T3XPoztDbxM0,3391
 matlab_proxy/util/mwi/embedded_connector/request.py,sha256=-6DL9K8JWjX5u5XVOEGaqBUIwQ-oCVW30-VP3qk_rzw,3730
@@ -82,16 +83,16 @@ 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=8hR0pWEIWrXU2UTZLLug9spaadp5Hb33960RE3jy4mw,37300
-tests/unit/test_app_state.py,sha256=wuEAYCXT262Ew01tRVP_SwRDa_M6MlzkkKuGTlcbGaY,18790
+tests/unit/test_app.py,sha256=xiiEQu1iNK0h3Yuwn3c-hgvNhC1EXKFgTbE_7U3mSrs,37731
+tests/unit/test_app_state.py,sha256=qD2I7qfUwME_M8lCMsg62Kmky5xdCBav3r3em39Zkt0,22906
 tests/unit/test_constants.py,sha256=ieDKc7bL8zWsd_D4dv2n8iftXr2h-bkS5p6zVan0BtQ,125
 tests/unit/test_ddux.py,sha256=a2J2iM8j_nnfJVuMI38p5AjwrRdoMj3N88gFgS2I4hg,713
 tests/unit/test_devel.py,sha256=A-1iVhSSwmywaW65QIRcUS2Fk7nJxceCcCm7CJtNdEc,7982
 tests/unit/test_non_dev_mode.py,sha256=0v27y27SLOWvw6jf_GhLLNg-RMsZS_OyGAnqoQYPpSA,5515
-tests/unit/test_settings.py,sha256=6KuYcOIqilR5RmaYxHw5mr_4CqDS3iMsouS-IrT9wGk,16644
+tests/unit/test_settings.py,sha256=eBlV-ME_O8oLoOjJqqYTDTXJs-0smnM0oIMwHZEjUbo,17727
 tests/unit/util/__init__.py,sha256=GInSQBb2SoVD5LZfmSCQa9-UZJT_UP-jNfrojkgCybU,87
 tests/unit/util/test_mw.py,sha256=YC4mjn6G6_XuHELt8uW9F6g2K0_fWtQl1R0kWFvWbAo,18565
-tests/unit/util/test_util.py,sha256=jhZOgErpD6b3JeusLBOPVvu6iZ3_ttwlEVV8uKLUvrw,5060
+tests/unit/util/test_util.py,sha256=vqTPgmaKDWhVBRnCKtCNg-OtyR5bP8jeH9DnpcbfVTk,5141
 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_logger.py,sha256=zWImNitMYKPJunXWJjEDEtCEKwBz615PC844ZLwoxIg,1845
@@ -102,9 +103,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.16.0.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
-matlab_proxy-0.16.0.dist-info/METADATA,sha256=OhfB2b3xNfmm_1jHPjgpc2wOXa_te8IO4xxjmLNi0Q4,10108
-matlab_proxy-0.16.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-matlab_proxy-0.16.0.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
-matlab_proxy-0.16.0.dist-info/top_level.txt,sha256=9uVTjsUCAS4TwsxueTBxrBg3PdBiTSsYowAkHPv9VY0,19
-matlab_proxy-0.16.0.dist-info/RECORD,,
+matlab_proxy-0.18.0.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
+matlab_proxy-0.18.0.dist-info/METADATA,sha256=9FmzMjPlFh73Jyg-jwhxTDMu_HIfVJJgfAeaMt02lH4,10177
+matlab_proxy-0.18.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+matlab_proxy-0.18.0.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
+matlab_proxy-0.18.0.dist-info/top_level.txt,sha256=9uVTjsUCAS4TwsxueTBxrBg3PdBiTSsYowAkHPv9VY0,19
+matlab_proxy-0.18.0.dist-info/RECORD,,

tests/unit/test_app.py

@@ -284,6 +284,20 @@ async def test_get_status_route(test_server):
     assert resp.status == HTTPStatus.OK
 
 
+async def test_clear_client_id_route(test_server):
+    """Test to check endpoint: "/clear_client_id"
+
+    Args:
+        test_server (aiohttp_client): A aiohttp_client server for sending POST request.
+    """
+
+    state = test_server.server.app["state"]
+    state.active_client = "mock_client_id"
+    resp = await test_server.post("/clear_client_id")
+    assert resp.status == HTTPStatus.OK
+    assert state.active_client is None
+
+
 async def test_get_env_config(test_server):
     """Test to check endpoint : "/get_env_config"
 

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,
     }
 
 
@@ -584,3 +591,108 @@ async def test_start_matlab_without_xvfb(app_state_fixture, mocker):
     assert app_state_fixture.processes["xvfb"] is None
     # Check if Matlab started
     assert app_state_fixture.processes["matlab"] is mock_matlab
+
+
+@pytest.mark.parametrize(
+    "is_desktop, client_id, is_client_id_present, expected_is_active_client",
+    [
+        (False, None, False, None),
+        (False, "mock_id", False, None),
+        (True, None, True, True),
+        (True, "mock_id", False, True),
+    ],
+    ids=[
+        "request_from_non-desktop_client",
+        "request_from_non-desktop_client_having_mock_id",
+        "request_from_desktop_client",
+        "request_from_desktop_client_having_mock_id",
+    ],
+)
+async def test_get_session_status(
+    app_state_fixture,
+    is_desktop,
+    client_id,
+    is_client_id_present,
+    expected_is_active_client,
+):
+    """Test to check if correnct session response is returned based on various conditions.
+
+    Args:
+        app_state_fixture (AppState): Object of AppState class with defaults set
+        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.
+        is_client_id_present (bool): Indicates whether the expected value of client_id is string or not.
+        expected_is_active_client (bool): Indicates the expected value of is_active_client
+
+    """
+    # The value of transfer_session is a Don't Care condition as initially the value of client_id is always None.
+    output_client_id, output_is_active_client = app_state_fixture.get_session_status(
+        is_desktop, client_id, transfer_session=False
+    )
+    assert isinstance(output_client_id, str) == is_client_id_present, (
+        "Expected client_id to be a string got None"
+        if is_client_id_present
+        else "Expected client_id to be None got a string value"
+    )
+    assert (
+        output_is_active_client == expected_is_active_client
+    ), f"Expected is_active_client to be {expected_is_active_client} got {output_is_active_client}"
+    # For clean up of task_detect_client_status
+    app_state_fixture.active_client = None
+
+
+async def test_get_session_status_can_transfer_session(app_state_fixture):
+    """Test to check whether transer session changes client id to the new id
+
+    Args:
+        app_state_fixture (AppState): Object of AppState class with defaults set
+    """
+    app_state_fixture.active_client = "mock_id"
+    app_state_fixture.get_session_status(
+        is_desktop=True, client_id="new_id", transfer_session=True
+    )
+    assert app_state_fixture.active_client == "new_id"
+    # For clean up of task_detect_client_status
+    app_state_fixture.active_client = None
+
+
+async def test_detect_active_client_status_can_reset_active_client(app_state_fixture):
+    """Test to check whether the value of active client is being reset due to the client inactivity.
+
+    Args:
+        app_state_fixture (AppState): Object of AppState class with defaults set
+    """
+    app_state_fixture.active_client = "mock_id"
+    await app_state_fixture.detect_active_client_status(
+        sleep_time=0, max_inactive_count=0
+    )
+    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

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

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)