matlab-proxy 0.19.0__tar.gz → 0.20.0__tar.gz

{matlab-proxy-0.19.0/matlab_proxy.egg-info → matlab-proxy-0.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.19.0
+Version: 0.20.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.
@@ -171,7 +171,7 @@ Description: # MATLAB Proxy
         
         ### Windows Subsystem for Linux (WSL 2)
         
-        To install `matlab-proxy` in WSL 2, follow the steps mentioned in the [Installation Guide for WSL 2](./installation/wsl2/README.md).
+        To install `matlab-proxy` in WSL 2, follow the steps mentioned in the [Installation Guide for WSL 2](./install_guides/wsl2/README.md).
         
         ## Using an already activated MATLAB with matlab-proxy
         `matlab-proxy` version `v0.7.0` introduces support for using an existing MATLAB license. Use the Existing License option only if you have an activated MATLAB. This allows you to start MATLAB without authenticating every time.

{matlab-proxy-0.19.0 → matlab-proxy-0.20.0}/README.md

@@ -163,7 +163,7 @@ $ pip install --upgrade matlab-proxy>=0.5.0
 
 ### Windows Subsystem for Linux (WSL 2)
 
-To install `matlab-proxy` in WSL 2, follow the steps mentioned in the [Installation Guide for WSL 2](./installation/wsl2/README.md).
+To install `matlab-proxy` in WSL 2, follow the steps mentioned in the [Installation Guide for WSL 2](./install_guides/wsl2/README.md).
 
 ## Using an already activated MATLAB with matlab-proxy
 `matlab-proxy` version `v0.7.0` introduces support for using an existing MATLAB license. Use the Existing License option only if you have an activated MATLAB. This allows you to start MATLAB without authenticating every time.

{matlab-proxy-0.19.0 → matlab-proxy-0.20.0}/gui/src/components/App/index.js

@@ -162,7 +162,7 @@ function App () {
     const htmlToRenderMATLAB = () => {
         let theHtmlToRenderMATLAB = useMOS ? 'index-matlabonlineserver.html' : 'index-jsd-cr.html';
         if (useMRE) {
-            theHtmlToRenderMATLAB += `?mre=${fullyQualifiedUrl}`;
+            theHtmlToRenderMATLAB += `?mre=${encodeURIComponent(fullyQualifiedUrl)}`;
         }
         return theHtmlToRenderMATLAB;
     };

{matlab-proxy-0.19.0 → matlab-proxy-0.20.0}/matlab_proxy/app.py

@@ -443,7 +443,7 @@ async def shutdown_integration_delete(req):
     loop = util.get_event_loop()
     # Run the current batch of coroutines in the event loop and then exit.
     # This completes the loop.run_forever() blocking call and subsequent code
-    # in main() resumes execution.
+    # in create_and_start_app() resumes execution.
     loop.stop()
 
     return res
@@ -807,8 +807,8 @@ async def cleanup_background_tasks(app):
     await state.stop_matlab(force_quit=True)
 
     # Cleanup server tasks
-    all_tasks = state.server_tasks
-    await util.cancel_tasks(all_tasks)
+    server_tasks = state.server_tasks
+    await util.cancel_tasks(server_tasks)
 
 
 def configure_and_start(app):
@@ -936,6 +936,11 @@ def configure_no_proxy_in_env():
 
 
 def create_and_start_app(config_name):
+    """Creates and start the web server. Will block until the server is interrupted or is shut down
+
+    Args:
+        config_name (str): Name of the configuration to use with matlab-proxy.
+    """
     configure_no_proxy_in_env()
 
     # Create, configure and start the app.
@@ -947,23 +952,25 @@ def create_and_start_app(config_name):
     # Add signal handlers for the current python process
     loop = util.add_signal_handlers(loop)
     try:
+        # Further execution is stopped here until an interrupt is raised
         loop.run_forever()
+
     except SystemExit:
         pass
 
-    async def shutdown():
-        """Shuts down the app in the event of a signal interrupt."""
-        logger.info("Shutting down MATLAB proxy-app")
-
-        await app.shutdown()
-        await app.cleanup()
-
-        # Shutdown any running tasks.
-        await util.cancel_tasks(asyncio.all_tasks())
-
+    # After handling the interrupt, proceed with shutting down the server gracefully.
     try:
-        loop.run_until_complete(shutdown())
-    except:
+        running_tasks = asyncio.all_tasks(loop)
+        loop.run_until_complete(
+            asyncio.gather(
+                app.shutdown(),
+                app.cleanup(),
+                util.cancel_tasks(running_tasks),
+                return_exceptions=False,
+            )
+        )
+
+    except Exception:
         pass
 
     logger.info("Finished shutting down. Thank you for using the MATLAB proxy.")

{matlab-proxy-0.19.0 → matlab-proxy-0.20.0}/matlab_proxy/util/mwi/logger.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 """Functions to access & control the logging behavior of the app
 """
 
@@ -52,7 +52,17 @@ def __set_logging_configuration():
     # query for user specified environment variables
     log_level = os.getenv(
         mwi_env.get_env_name_logging_level(), __get_default_log_level()
-    )
+    ).upper()
+
+    valid = __is_valid_log_level(log_level)
+
+    if not valid:
+        default_log_level = __get_default_log_level()
+        logging.warn(
+            f"Unknown log level '{log_level}' set. Defaulting to log level '{default_log_level}'..."
+        )
+        log_level = default_log_level
+
     log_file = os.getenv(mwi_env.get_env_name_log_file(), None)
 
     ## Set logging object
@@ -110,3 +120,13 @@ def __get_default_log_level():
         String: The default logging level
     """
     return "INFO"
+
+
+def __is_valid_log_level(log_level):
+    """Helper to check if the log level is valid.
+
+    Returns:
+        Boolean: Whether log level  exists
+    """
+
+    return hasattr(logging, log_level)

{matlab-proxy-0.19.0 → matlab-proxy-0.20.0}/matlab_proxy/util/windows.py

@@ -49,10 +49,13 @@ async def start_matlab(matlab_cmd, matlab_env):
     """
     import psutil
 
+    # The stdout is used to suppress the MATLAB outputs from being shown in the terminal.
+    # We set it to DEVNULL instead of PIPE because PIPE has a limited buffer size and can
+    # block the process if the output exceeds the buffer limit.
     intermediate_proc = await asyncio.create_subprocess_exec(
         *matlab_cmd,
         env=matlab_env,
-        stdout=asyncio.subprocess.PIPE,
+        stdout=asyncio.subprocess.DEVNULL,
         stderr=asyncio.subprocess.STDOUT,
     )
 

{matlab-proxy-0.19.0 → matlab-proxy-0.20.0/matlab_proxy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.19.0
+Version: 0.20.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.
@@ -171,7 +171,7 @@ Description: # MATLAB Proxy
         
         ### Windows Subsystem for Linux (WSL 2)
         
-        To install `matlab-proxy` in WSL 2, follow the steps mentioned in the [Installation Guide for WSL 2](./installation/wsl2/README.md).
+        To install `matlab-proxy` in WSL 2, follow the steps mentioned in the [Installation Guide for WSL 2](./install_guides/wsl2/README.md).
         
         ## Using an already activated MATLAB with matlab-proxy
         `matlab-proxy` version `v0.7.0` introduces support for using an existing MATLAB license. Use the Existing License option only if you have an activated MATLAB. This allows you to start MATLAB without authenticating every time.

{matlab-proxy-0.19.0 → matlab-proxy-0.20.0}/setup.py

@@ -76,7 +76,7 @@ long_description = (HERE / "README.md").read_text()
 
 setuptools.setup(
     name="matlab-proxy",
-    version="0.19.0",
+    version="0.20.0",
     url=config["doc_url"],
     author="The MathWorks, Inc.",
     author_email="cloud@mathworks.com",

{matlab-proxy-0.19.0 → matlab-proxy-0.20.0}/tests/unit/util/mwi/test_logger.py

@@ -1,10 +1,10 @@
-# Copyright 2020-2022 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 """This file tests methods present in matlab_proxy/util/mwi_logger.py
 """
 
 import logging
 import os
-
+import pytest
 from matlab_proxy.util.mwi import logger as mwi_logger
 
 
@@ -22,7 +22,7 @@ def test_get_mw_logger_name():
 
 
 def test_get_with_no_environment_variables(monkeypatch):
-    """This test checks if the get method returns a logger with default settings"""
+    """This test checks if the get method returns a logger with default settings if no environment variable is set"""
     # Delete the environment variables if they do exist
     env_names_list = mwi_logger.get_environment_variable_names()
     monkeypatch.delenv(env_names_list[0], raising=False)
@@ -34,7 +34,7 @@ def test_get_with_no_environment_variables(monkeypatch):
 
 
 def test_get_with_environment_variables(monkeypatch, tmp_path):
-    """This test checks if the get method returns a logger with default settings"""
+    """This test checks if the get method returns a logger with the specified settings"""
     env_names_list = mwi_logger.get_environment_variable_names()
     monkeypatch.setenv(env_names_list[0], "CRITICAL")
     monkeypatch.setenv(env_names_list[1], str(tmp_path / "testing123.log"))
@@ -47,3 +47,37 @@ def test_get_with_environment_variables(monkeypatch, tmp_path):
     # Verify that environment variable setting the file is respected
     assert len(logger.handlers) == 1
     assert os.path.basename(logger.handlers[0].baseFilename) == "testing123.log"
+
+
+@pytest.mark.parametrize(
+    "log_level, expected_level",
+    [
+        ("DEBUG", logging.DEBUG),
+        ("INFO", logging.INFO),
+        ("WARNING", logging.WARNING),
+        ("debug", logging.DEBUG),
+        ("info", logging.INFO),
+        ("warning", logging.WARNING),
+    ],
+)
+def test_set_logging_configuration_known_logging_levels(
+    monkeypatch, log_level, expected_level
+):
+    """This test checks if the logger is set with correct level for known log levels"""
+    env_names_list = mwi_logger.get_environment_variable_names()
+    monkeypatch.setenv(env_names_list[0], log_level)
+    logger = mwi_logger.get(init=True)
+    assert (
+        logger.isEnabledFor(expected_level) == True
+    ), f"Error in initialising the logger with {log_level}"
+
+
+@pytest.mark.parametrize("log_level", ["ABC", "abc"])
+def test_set_logging_configuration_unknown_logging_levels(monkeypatch, log_level):
+    """This test checks if the logger is set with INFO level for unknown log levels"""
+    env_names_list = mwi_logger.get_environment_variable_names()
+    monkeypatch.setenv(env_names_list[0], log_level)
+    logger = mwi_logger.get(init=True)
+    assert (
+        logger.isEnabledFor(logging.INFO) == True
+    ), "Error in initialising the default logger"