matlab-proxy 0.15.1__py3-none-any.whl → 0.17.0__py3-none-any.whl

matlab_proxy/settings.py

@@ -17,6 +17,7 @@ from cryptography.x509.oid import NameOID
 
 import matlab_proxy
 from matlab_proxy import constants
+from matlab_proxy.constants import MWI_AUTH_TOKEN_NAME_FOR_HTTP
 from matlab_proxy.util import mwi, system
 from matlab_proxy.util.mwi import environment_variables as mwi_env
 from matlab_proxy.util.mwi import token_auth
@@ -197,11 +198,12 @@ def get_dev_settings(config):
         "mwi_logs_root_dir": get_mwi_logs_root_dir(dev=True),
         "mw_context_tags": get_mw_context_tags(matlab_proxy.get_default_config_name()),
         "mwi_server_url": None,
-        "mwi_is_token_auth_enabled": mwi_auth_token != None,
+        "mwi_is_token_auth_enabled": mwi_auth_token is not None,
         "mwi_auth_status": False,
         "mwi_auth_token": mwi_auth_token,
         "mwi_auth_token_hash": mwi_auth_token_hash,
-        "mwi_auth_token_name": mwi_env.get_env_name_mwi_auth_token().lower(),
+        "mwi_auth_token_name_for_http": MWI_AUTH_TOKEN_NAME_FOR_HTTP,
+        "mwi_auth_token_name_for_env": mwi_env.get_env_name_mwi_auth_token().lower(),
         "mwi_use_existing_license": mwi.validators.validate_use_existing_licensing(
             os.getenv(mwi_env.get_env_name_mwi_use_existing_license(), "")
         ),
@@ -322,11 +324,12 @@ def get_server_settings(config_name):
         "mw_context_tags": get_mw_context_tags(config_name),
         # The url where the matlab-proxy server is accessible at
         "mwi_server_url": None,
-        "mwi_is_token_auth_enabled": mwi_auth_token != None,
+        "mwi_is_token_auth_enabled": mwi_auth_token is not None,
         "mwi_auth_status": False,
         "mwi_auth_token": mwi_auth_token,
         "mwi_auth_token_hash": mwi_auth_token_hash,
-        "mwi_auth_token_name": mwi_env.get_env_name_mwi_auth_token().lower(),
+        "mwi_auth_token_name_for_http": MWI_AUTH_TOKEN_NAME_FOR_HTTP,
+        "mwi_auth_token_name_for_env": mwi_env.get_env_name_mwi_auth_token().lower(),
         "mwi_use_existing_license": mwi.validators.validate_use_existing_licensing(
             os.getenv(mwi_env.get_env_name_mwi_use_existing_license(), "")
         ),

matlab_proxy/util/mwi/token_auth.py

@@ -59,7 +59,7 @@ def generate_mwi_auth_token_and_hash():
 def get_mwi_auth_token_access_str(app_settings):
     """Returns formatted string with mwi token for use with server URL"""
     if app_settings["mwi_is_token_auth_enabled"]:
-        mwi_auth_token_name = app_settings["mwi_auth_token_name"]
+        mwi_auth_token_name = app_settings["mwi_auth_token_name_for_http"]
         mwi_auth_token = app_settings["mwi_auth_token"]
         return f"?{mwi_auth_token_name}={mwi_auth_token}"
 
@@ -134,7 +134,20 @@ async def _get_token_name(request):
         str : token name
     """
     app_settings = request.app["settings"]
-    return app_settings["mwi_auth_token_name"]
+    return app_settings["mwi_auth_token_name_for_env"]
+
+
+def _get_token_name_for_http(request):
+    """Gets the name of the token from settings.
+
+    Args:
+        request (HTTPRequest) : Used to get to app settings
+
+    Returns:
+        str : token name
+    """
+    app_settings = request.app["settings"]
+    return app_settings["mwi_auth_token_name_for_http"]
 
 
 async def _get_token(request):
@@ -238,11 +251,11 @@ async def _is_valid_token_in_url_query(request):
     query_string = request.query_string
     logger.debug(f"url query parameters found:{query_string}")
     if query_string:
-        token_name = await _get_token_name(request)
+        token_name = _get_token_name_for_http(request)
         parsed_token = parse_qs(request.query_string).get(token_name)
         if parsed_token:
             parsed_token = parsed_token[0]
-            logger.debug(f"parsed_token from url query string.")
+            logger.debug("parsed_token from url query string.")
             return await _is_valid_token(parsed_token, request)
 
     logger.debug("Token not found in url query.")
@@ -262,8 +275,9 @@ async def _is_valid_token_in_headers(request):
     """
     logger.debug("Checking for token in request headers...")
     headers = request.headers
-    token_name = await _get_token_name(request)
+    token_name = _get_token_name_for_http(request)
     if token_name in headers:
+        logger.debug(f"Token found in headers: {token_name}")
         is_valid_token = await _is_valid_token(headers[token_name], request)
         if is_valid_token:
             await _store_token_hash_into_session(request)

{matlab_proxy-0.15.1.dist-info → matlab_proxy-0.17.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.15.1
+Version: 0.17.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.

{matlab_proxy-0.15.1.dist-info → matlab_proxy-0.17.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=HV4_igTkUVf-CQWPKc7s3z4Ea_MkSBbV7k3I-AG-m28,55374
-matlab_proxy/constants.py,sha256=k9vESSF1HSrr2-tCgIEomJ47Q7UR4wbrMCWzZnLLoPc,924
+matlab_proxy/app.py,sha256=aoKkhw_E71uCJeMzqr9VE4mrIRd_4Aqt3Uw4nrYiZZY,34386
+matlab_proxy/app_state.py,sha256=-8gduqMymI7U_NwNRtL26skrjOlnDRiM2vXqBTfMnKo,59525
+matlab_proxy/constants.py,sha256=gHL6bYgRDyzufMx1XF9tbtC9vsS_yQlfYPNommti8tA,972
 matlab_proxy/default_configuration.py,sha256=DxQaHzAivzstiPl_nDfxs8SOyP9oaK9v3RP4LtroJl4,843
 matlab_proxy/devel.py,sha256=nR6XPVBUEdQ-RZGtYvX1YHTp8gj9cuw5Hp8ahasMBc8,14310
-matlab_proxy/settings.py,sha256=YjchyZAzvLfl-CiwxAPtSaTTo7aRgD6inS4-jZmsuNY,24687
+matlab_proxy/settings.py,sha256=Q901JN7zwcySVOs7EQ69m4Ngishmo9ihFzqbPxXajh4,24915
 matlab_proxy/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/asset-manifest.json,sha256=2i4oSd9fAzwDgW_jBPUrOvvrelhiEh0iUIXge7tpVZ4,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=iSRij24ekBNqZqWd0urs_FUmEs9lrbf9mIBMpLXNlB0,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.ff1bfd69.js,sha256=hu8hJKKivhC7JHB7mRjzRf1bz503WR5fX7FiIPhdPJ4,294194
-matlab_proxy/gui/static/js/main.ff1bfd69.js.LICENSE.txt,sha256=3cj3DrwM51esz1ogL9VVU1ZyXyXJ6u-Ec2CI9CCcI_A,1689
-matlab_proxy/gui/static/js/main.ff1bfd69.js.map,sha256=y7nJxSw1bPSVkRLkIoFB6WxvoTGwbUR26MlqSz8mQ5U,937068
+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
@@ -65,7 +65,7 @@ matlab_proxy/util/mwi/download.py,sha256=-GJj3yOsL4vF_9baqRXkgBI-vu_OwjZMQVkJXFS
 matlab_proxy/util/mwi/environment_variables.py,sha256=bIz0QFWo0pgyvSeJ_kAobUCS17V05CSmFWm3zYIOIsA,7139
 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=25uQE2cul6MZNTj1HQqukiBS014dj7URZfMOFPKcS3Y,9606
+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/embedded_connector/__init__.py,sha256=SVSckEJ4zQQ2KkNPT_un8ndMAImcMOTrai7ShAbmFY4,114
 matlab_proxy/util/mwi/embedded_connector/helpers.py,sha256=p6TedefbvhlZT64IMwFjrb0panWCXf-T3XPoztDbxM0,3391
@@ -73,18 +73,18 @@ matlab_proxy/util/mwi/embedded_connector/request.py,sha256=-6DL9K8JWjX5u5XVOEGaq
 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
-tests/integration/integration_tests_with_license/test_http_end_points.py,sha256=fDA2VyauxM8x0Gw9ArZLI4YFOVduX6Wg-UiHdr5tmHk,7411
+tests/integration/integration_tests_with_license/test_http_end_points.py,sha256=SDJIoyo-hh2Ns9uWaDeO87N0jY3svhKOn29HFFyx_jM,7485
 tests/integration/integration_tests_without_license/__init__.py,sha256=vVYZCur-QhmIGCxUmn-WZjIywtDQidaLDmlmrRHRlgY,37
-tests/integration/integration_tests_without_license/conftest.py,sha256=z5r_hALWo7Lh0kyN-h1N2oCj1jIug3-0RXQm92XTtPI,3426
+tests/integration/integration_tests_without_license/conftest.py,sha256=n-oppKWxavyy1O0J6DywO3DnOHuYc7yUZRXm3Bt4szU,3526
 tests/integration/integration_tests_without_license/test_matlab_is_down_if_unlicensed.py,sha256=tkdyhfZBpfJpbnEzjURyV-GE0p43YxOa9xooJf-JoM4,1653
 tests/integration/utils/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
 tests/integration/utils/integration_tests_utils.py,sha256=IbJ9CedFHiz3k85FBY-8GwotTnjPF3jF4AHdKio7jqk,10321
 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=0JK5xak31wIC_of5fNAtoCgi6E-z4JR-AAqtIlNAZ0k,37313
-tests/unit/test_app_state.py,sha256=M1jsEVfg4XnseQ_PSJjcCm40extosayRaA7NzdJ9FkY,18596
-tests/unit/test_constants.py,sha256=ZSsj1-xHrlqxhnjv2x2een6E_U2vSCONoQVWO_QpbYI,124
+tests/unit/test_app.py,sha256=xiiEQu1iNK0h3Yuwn3c-hgvNhC1EXKFgTbE_7U3mSrs,37731
+tests/unit/test_app_state.py,sha256=xwXOmyzamL89eg4q2s4IpFKWDN4r2lZwsHBafqDkins,21854
+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
@@ -95,16 +95,16 @@ tests/unit/util/test_util.py,sha256=jhZOgErpD6b3JeusLBOPVvu6iZ3_ttwlEVV8uKLUvrw,
 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
-tests/unit/util/mwi/test_token_auth.py,sha256=-G5u4tFYefhzb-W4tTS-F4HxNYxNNrPa0FOLncHjMN8,10173
+tests/unit/util/mwi/test_token_auth.py,sha256=-eBsaQ5JC7pyd9PXt48Rqs4cWjg6I-eOkp_gFVEwYhk,10538
 tests/unit/util/mwi/test_validators.py,sha256=YeOP0-T7SFNeiC7JIQj7cV4ja3d6PhswsTz27IEgJHQ,10852
 tests/unit/util/mwi/embedded_connector/__init__.py,sha256=pl5jqyCHEwZEviiL8OC-SHulb1rBecstQCFF6qVjL9Y,37
 tests/unit/util/mwi/embedded_connector/test_helpers.py,sha256=vYTWNUTuDeaygo16JGMTvWeI_CLOnvPkwNJmLndvJhE,890
 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.15.1.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
-matlab_proxy-0.15.1.dist-info/METADATA,sha256=P95V-BiQ49UlFBPIFIEwMm_gpjfFmutEHKBW3VMPH-Q,10108
-matlab_proxy-0.15.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-matlab_proxy-0.15.1.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
-matlab_proxy-0.15.1.dist-info/top_level.txt,sha256=9uVTjsUCAS4TwsxueTBxrBg3PdBiTSsYowAkHPv9VY0,19
-matlab_proxy-0.15.1.dist-info/RECORD,,
+matlab_proxy-0.17.0.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
+matlab_proxy-0.17.0.dist-info/METADATA,sha256=_UnbcVVZElb72b3PjnP85kmOmqYdzoXv1tcsEGkVD5s,10108
+matlab_proxy-0.17.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+matlab_proxy-0.17.0.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
+matlab_proxy-0.17.0.dist-info/top_level.txt,sha256=9uVTjsUCAS4TwsxueTBxrBg3PdBiTSsYowAkHPv9VY0,19
+matlab_proxy-0.17.0.dist-info/RECORD,,

tests/integration/integration_tests_with_license/test_http_end_points.py

@@ -12,7 +12,7 @@ import re
 from requests.adapters import HTTPAdapter, Retry
 from urllib.parse import urlparse, parse_qs
 from tests.utils.logging_util import create_integ_test_logger
-from logging import DEBUG
+from matlab_proxy.constants import MWI_AUTH_TOKEN_NAME_FOR_HTTP
 
 _logger = create_integ_test_logger(__name__)
 
@@ -64,9 +64,9 @@ class RealMATLABServer:
         parsed_url = urlparse(utils.get_connection_string(self.mwi_app_port))
 
         self.headers = {
-            "mwi_auth_token": (
-                parse_qs(parsed_url.query)["mwi_auth_token"][0]
-                if "mwi_auth_token" in parse_qs(parsed_url.query)
+            MWI_AUTH_TOKEN_NAME_FOR_HTTP: (
+                parse_qs(parsed_url.query)[MWI_AUTH_TOKEN_NAME_FOR_HTTP][0]
+                if MWI_AUTH_TOKEN_NAME_FOR_HTTP in parse_qs(parsed_url.query)
                 else ""
             )
         }

tests/integration/integration_tests_without_license/conftest.py

@@ -6,6 +6,7 @@ import requests
 from tests.utils.logging_util import create_integ_test_logger
 import os
 from urllib.parse import urlparse, parse_qs
+from matlab_proxy.constants import MWI_AUTH_TOKEN_NAME_FOR_HTTP
 
 _logger = create_integ_test_logger(__name__)
 
@@ -34,9 +35,9 @@ def parse_matlab_proxy_url():
     parsed_url = urlparse(utils.get_connection_string(mwi_app_port))
 
     headers = {
-        "mwi_auth_token": (
-            parse_qs(parsed_url.query)["mwi_auth_token"][0]
-            if "mwi_auth_token" in parse_qs(parsed_url.query)
+        MWI_AUTH_TOKEN_NAME_FOR_HTTP: (
+            parse_qs(parsed_url.query)[MWI_AUTH_TOKEN_NAME_FOR_HTTP][0]
+            if MWI_AUTH_TOKEN_NAME_FOR_HTTP in parse_qs(parsed_url.query)
             else ""
         )
     }

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"
 
@@ -1031,7 +1045,7 @@ async def test_update_entitlement_with_correct_entitlement(set_licensing_info):
     assert resp.status == HTTPStatus.OK
 
 
-async def test_get_auth_token_route(test_server, monkeypatch):
+async def test_get_auth_token_route(test_server):
     """Test to check endpoint : "/get_auth_token"
 
     Args:

tests/unit/test_app_state.py

@@ -1,4 +1,4 @@
-# Copyright 2023 The MathWorks, Inc.
+# Copyright 2023-2024 The MathWorks, Inc.
 
 import json
 import os
@@ -7,9 +7,10 @@ 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
+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
 
@@ -55,7 +56,7 @@ def app_state_fixture(sample_settings_fixture):
 
 @pytest.fixture
 def sample_token_headers_fixture():
-    return {"mwi_auth_token_name": "asdf"}
+    return {MWI_AUTH_TOKEN_NAME_FOR_HTTP: "asdf"}
 
 
 @pytest.fixture
@@ -76,7 +77,10 @@ def app_state_with_token_auth_fixture(
     ((mwi_auth_token_name, mwi_auth_token_hash),) = sample_token_headers_fixture.items()
     app_state_fixture.matlab_session_files["matlab_ready_file"] = tmp_matlab_ready_file
     app_state_fixture.settings["mwi_is_token_auth_enabled"] = True
-    app_state_fixture.settings["mwi_auth_token_name"] = mwi_auth_token_name
+    app_state_fixture.settings["mwi_auth_token_name_for_env"] = mwi_auth_token_name
+    app_state_fixture.settings["mwi_auth_token_name_for_http"] = (
+        MWI_AUTH_TOKEN_NAME_FOR_HTTP
+    )
     app_state_fixture.settings["mwi_auth_token_hash"] = mwi_auth_token_hash
     app_state_fixture.settings["mwi_server_url"] = "http://localhost:8888"
 
@@ -580,3 +584,81 @@ 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"

tests/unit/test_constants.py

@@ -1,4 +1,5 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2023-2024 The MathWorks, Inc.
+
 TWO_MAX_TRIES = 2
 FIVE_MAX_TRIES = 5
 HALF_SECOND_DELAY = 0.5

tests/unit/util/mwi/test_token_auth.py

@@ -6,6 +6,7 @@ from aiohttp_session import setup as aiohttp_session_setup
 from aiohttp_session.cookie_storage import EncryptedCookieStorage
 from cryptography import fernet
 
+from matlab_proxy.constants import MWI_AUTH_TOKEN_NAME_FOR_HTTP
 from matlab_proxy.util.mwi import environment_variables as mwi_env
 from matlab_proxy.util.mwi import token_auth
 
@@ -105,10 +106,11 @@ def fake_server_with_auth_enabled(
 
     app = web.Application()
     app["settings"] = {
-        "mwi_is_token_auth_enabled": mwi_auth_token != None,
+        "mwi_is_token_auth_enabled": mwi_auth_token is not None,
         "mwi_auth_token": mwi_auth_token,
         "mwi_auth_token_hash": mwi_auth_token_hash,
-        "mwi_auth_token_name": mwi_env.get_env_name_mwi_auth_token().lower(),
+        "mwi_auth_token_name_for_http": MWI_AUTH_TOKEN_NAME_FOR_HTTP,
+        "mwi_auth_token_name_for_env": mwi_env.get_env_name_mwi_auth_token().lower(),
     }
     app.router.add_get("/", fake_endpoint)
     app.router.add_post("/", fake_endpoint)
@@ -127,7 +129,7 @@ async def test_set_value_with_token(
     resp = await fake_server_with_auth_enabled.post(
         "/",
         data={"value": "foo"},
-        headers={"mwi_auth_token": get_custom_auth_token_str},
+        headers={MWI_AUTH_TOKEN_NAME_FOR_HTTP: get_custom_auth_token_str},
     )
     assert resp.status == web.HTTPOk.status_code
     assert await resp.text() == "thanks for the data"
@@ -158,7 +160,9 @@ async def test_set_value_with_token_hash(
         "/",
         data={"value": "foo"},
         headers={
-            "mwi_auth_token": token_auth._generate_hash(get_custom_auth_token_str)
+            MWI_AUTH_TOKEN_NAME_FOR_HTTP: token_auth._generate_hash(
+                get_custom_auth_token_str
+            )
         },
     )
     assert resp.status == web.HTTPOk.status_code
@@ -193,7 +197,9 @@ async def test_set_value_without_token(fake_server_with_auth_enabled):
 
 async def test_set_value_with_invalid_token(fake_server_with_auth_enabled):
     resp2 = await fake_server_with_auth_enabled.post(
-        "/", data={"value": "foobar"}, headers={"mwi_auth_token": "invalid-token"}
+        "/",
+        data={"value": "foobar"},
+        headers={MWI_AUTH_TOKEN_NAME_FOR_HTTP: "invalid-token"},
     )
     assert resp2.status == web.HTTPForbidden.status_code
 
@@ -205,7 +211,11 @@ async def test_set_value_with_token_in_params(
     resp = await fake_server_with_auth_enabled.post(
         "/",
         data={"value": "foofoo"},
-        params={"mwi_auth_token": token_auth._generate_hash(get_custom_auth_token_str)},
+        params={
+            MWI_AUTH_TOKEN_NAME_FOR_HTTP: token_auth._generate_hash(
+                get_custom_auth_token_str
+            )
+        },
     )
     assert resp.status == web.HTTPOk.status_code
     assert await resp.text() == "thanks for the data"
@@ -232,7 +242,11 @@ async def test_get_value_with_token_in_query_params(
     fake_server_with_auth_enabled.server.app["value"] = "bar"
     resp = await fake_server_with_auth_enabled.get(
         "/",
-        params={"mwi_auth_token": token_auth._generate_hash(get_custom_auth_token_str)},
+        params={
+            MWI_AUTH_TOKEN_NAME_FOR_HTTP: token_auth._generate_hash(
+                get_custom_auth_token_str
+            )
+        },
     )
     assert resp.status == web.HTTPOk.status_code
     assert await resp.text() == "value: bar"
@@ -257,7 +271,7 @@ def fake_server_without_auth_enabled(loop, aiohttp_client, monkeypatch):
         "mwi_is_token_auth_enabled": mwi_auth_token != None,
         "mwi_auth_token": mwi_auth_token,
         "mwi_auth_token_hash": mwi_auth_token_hash,
-        "mwi_auth_token_name": mwi_env.get_env_name_mwi_auth_token().lower(),
+        "mwi_auth_token_name_for_env": mwi_env.get_env_name_mwi_auth_token().lower(),
     }
     app.router.add_get("/", fake_endpoint)
     app.router.add_post("/", fake_endpoint)
@@ -283,7 +297,7 @@ async def test_get_value_in_query_params(
     # Server should respond even if token is provided when not needed.
     fake_server_without_auth_enabled.server.app["value"] = "bar2"
     resp = await fake_server_without_auth_enabled.get(
-        "/", params={"mwi_auth_token": get_custom_auth_token_str}
+        "/", params={"mwi-auth-token": get_custom_auth_token_str}
     )
     assert resp.status == web.HTTPOk.status_code
     assert await resp.text() == "value: bar2"