matlab-proxy 0.11.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

matlab_proxy/app.py

@@ -1,10 +1,11 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 
 import asyncio
 import json
 import mimetypes
 import pkgutil
 import sys
+import uuid
 
 import aiohttp
 from aiohttp import client_exceptions, web
@@ -19,6 +20,7 @@ from matlab_proxy.util import mwi
 from matlab_proxy.util.mwi import environment_variables as mwi_env
 from matlab_proxy.util.mwi import token_auth
 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")
@@ -93,30 +95,45 @@ def marshal_error(error):
         return {"message": error.__str__, "logs": "", "type": error.__class__.__name__}
 
 
-async def create_status_response(app, loadUrl=None):
-    """Send a generic status response about the state of server,MATLAB and MATLAB Licensing
+async def create_status_response(
+    app, loadUrl=None, client_id=None, transfer_session=False, is_desktop=False
+):
+    """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.
 
     Returns:
-        JSONResponse: A JSONResponse object containing the generic state of the server, MATLAB and MATLAB Licensing.
+        JSONResponse: A JSONResponse object containing the generic state of the server, MATLAB, MATLAB Licensing and the client session status.
     """
     state = app["state"]
-    return web.json_response(
-        {
-            "matlab": {
-                "status": await state.get_matlab_state(),
-                "version": state.settings["matlab_version"],
-            },
-            "licensing": marshal_licensing_info(state.licensing),
-            "loadUrl": loadUrl,
-            "error": marshal_error(state.error),
-            "warnings": state.warnings,
-            "wsEnv": state.settings.get("ws_env", ""),
-        }
-    )
+    status = {
+        "matlab": {
+            "status": await state.get_matlab_state(),
+            "version": state.settings["matlab_version"],
+        },
+        "licensing": marshal_licensing_info(state.licensing),
+        "loadUrl": loadUrl,
+        "error": marshal_error(state.error),
+        "warnings": state.warnings,
+        "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 not state.active_client or transfer_session:
+            state.active_client = client_id
+
+        status["isActiveClient"] = True if state.active_client == client_id else False
+
+    return web.json_response(status)
 
 
 @token_auth.authenticate_access_decorator
@@ -155,7 +172,7 @@ async def get_env_config(req):
 
     config["useMOS"] = mwi_env.Experimental.should_use_mos_html()
     config["useMRE"] = mwi_env.Experimental.should_use_mre_html()
-
+    config["isConcurrencyEnabled"] = IS_CONCURRENCY_CHECK_ENABLED
     # In a previously authenticated session, if the url is accessed without the token(using session cookie), send the token as well.
     config["authentication"] = {
         "enabled": state.settings["mwi_is_token_auth_enabled"],
@@ -182,7 +199,17 @@ async def get_status(req):
     Returns:
         JSONResponse: JSONResponse object containing information about the server, MATLAB and MATLAB Licensing.
     """
-    return await create_status_response(req.app)
+    # The client sends the CLIENT_ID as a query parameter if the concurrency check has been set to true.
+    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)
+
+    return await create_status_response(
+        req.app,
+        client_id=client_id,
+        transfer_session=transfer_session,
+        is_desktop=is_desktop,
+    )
 
 
 # @token_auth.authenticate_access_decorator

matlab_proxy/app_state.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 
 import asyncio
 import contextlib
@@ -100,6 +100,10 @@ class AppState:
         # This variable can be either "up" or "down"
         self.embedded_connector_state = "down"
 
+        # Specific to concurrent session and is used to track the active client/s that are currently
+        # connected to the backend
+        self.active_client = None
+
     def __get_cached_config_file(self):
         """Get the cached config file
 

matlab_proxy/constants.py

@@ -1,4 +1,4 @@
-# Copyright 2023 The MathWorks, Inc.
+# Copyright 2023-2024 The MathWorks, Inc.
 from typing import Final, List
 
 """This module defines project-level constants"""
@@ -22,3 +22,6 @@ SUPPORTED_MATLAB_VERSIONS: Final[List[str]] = [
     "R2023a",
     "R2023b",
 ]
+
+# This constant when set to True restricts the number of active sessions to one
+IS_CONCURRENCY_CHECK_ENABLED: Final[bool] = True

matlab_proxy/gui/asset-manifest.json

@@ -1,7 +1,7 @@
 {
   "files": {
     "main.css": "./static/css/main.47712126.css",
-    "main.js": "./static/js/main.152b02bc.js",
+    "main.js": "./static/js/main.ea1ebdce.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.152b02bc.js.map": "./static/js/main.152b02bc.js.map"
+    "main.ea1ebdce.js.map": "./static/js/main.ea1ebdce.js.map"
   },
   "entrypoints": [
     "static/css/main.47712126.css",
-    "static/js/main.152b02bc.js"
+    "static/js/main.ea1ebdce.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.152b02bc.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.ea1ebdce.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>