Use MWI_APP_HOST to update URL to be displayed in the matlab-proxy startup message.

fixes #69

Author: krisctl

Advanced-Usage.md

@@ -17,7 +17,7 @@ The following table describes all the environment variables that you can set to
 | **MLM_LICENSE_FILE** | string | `"1234@111.22.333.444"` | When you want to use either a license file or a network license manager to license MATLAB, specify this variable.</br> For example, specify the location of the network license manager to be `123@hostname`.|                                                                         
 | **MWI_BASE_URL** | string | `"/matlab"` | Set to control the base URL of the app. MWI_BASE_URL should start with `/` or be `empty`. |
 | **MWI_APP_PORT** | integer | `8080` | Specify the port for the HTTP server to listen on. |
-| **MWI_APP_HOST** | string | `127.0.0.1` | Specify the host interface for the HTTP server to launch on. Defaults to `0.0.0.0` on POSIX and Windows systems.<br />With the default value, the server will be accessible remotely at the fully qualified domain name of the system. |
+| **MWI_APP_HOST** | string | `127.0.0.1` | Specify the host address to display the connection URL in the startup message.|
 | **MWI_LOG_LEVEL** | string | `"CRITICAL"` | Specify the Python log level to be one of the following `NOTSET`, `DEBUG`, `INFO`, `WARN`, `ERROR`, or `CRITICAL`. For more information on Python log levels, see [Logging Levels](https://docs.python.org/3/library/logging.html#logging-levels) .<br />The default value is `INFO`. |
 | **MWI_LOG_FILE** | string | `"/tmp/logs.txt"` | Specify the full path to the file where you want debug logs from this integration to be written. |
 | **MWI_ENABLE_WEB_LOGGING** | string | `"True"` | Set this value to `"True"` to see additional web server logs. |

matlab_proxy/app_state.py

@@ -33,14 +33,29 @@
     MatlabInstallError,
     OnlineLicensingError,
     UIVisibleFatalError,
-    XvfbError,
     WindowManagerError,
+    XvfbError,
     log_error,
 )
 
 logger = mwi.logger.get()
 
 
+def _get_server_urls(server_url: str, mwi_auth_token_str: str) -> list[str]:
+    """Returns list of server URLs including user supplied hostname, if any."""
+    # By default mwi_server_url usually points to 0.0.0.0 as the hostname, but this does not work well
+    # on some browsers. Specifically on Safari (MacOS), hence the replace op with localhost.
+    server_urls_with_auth_token = [
+        f'{server_url.replace("0.0.0.0", "localhost")}{mwi_auth_token_str}'
+    ]
+    if user_supplied_hostname := os.getenv(mwi_env.get_env_name_app_host(), "").strip():
+        server_urls_with_auth_token.append(
+            f'{server_urls_with_auth_token[0].replace("localhost", user_supplied_hostname)}'
+        )
+
+    return server_urls_with_auth_token
+
+
 class AppState:
     """A Class which represents the state of the App.
     This class handles state of MATLAB, MATLAB Licensing and Xvfb.
@@ -219,15 +234,15 @@ def __get_cached_config_file(self):
     def __delete_cached_config_file(self):
         """Deletes the cached config file"""
         try:
-            logger.debug(f"Deleting any cached config files!")
+            logger.debug("Deleting any cached config files!")
             os.remove(self.__get_cached_config_file())
         except FileNotFoundError:
             # The file being absent is acceptable.
             pass
 
     def __reset_and_delete_cached_config(self):
         """Reset licensing variable of the class and removes the cached config file."""
-        logger.debug(f"Resetting cached config information...")
+        logger.debug("Resetting cached config information...")
         self.licensing = None
         self.__delete_cached_config_file()
 
@@ -263,7 +278,7 @@ async def init_licensing(self):
                 f"{mwi_env.get_env_name_mwi_use_existing_license()} variable set in environment"
             )
             logger.info(
-                f"!!! Starting MATLAB without providing any additional licensing information. This requires MATLAB to have been activated on the machine from which its being started !!!"
+                "!!! Starting MATLAB without providing any additional licensing information. This requires MATLAB to have been activated on the machine from which its being started !!!"
             )
 
             # Delete old config info from cache to ensure its wiped out first before persisting new info.
@@ -342,7 +357,7 @@ async def init_licensing(self):
                     else:
                         # Somethings wrong, licensing is neither NLM or MHLM
                         self.__reset_and_delete_cached_config()
-                except Exception as e:
+                except Exception:
                     self.__reset_and_delete_cached_config()
 
     async def __update_matlab_state_based_on_connector_state(self):
@@ -900,16 +915,11 @@ def create_server_info_file(self):
         self.mwi_server_session_files["mwi_server_info_file"] = mwi_server_info_file
         logger.debug(f"Server info stored into: {mwi_server_info_file}")
 
-        # By default mwi_server_url usually points to 0.0.0.0 as the hostname, but this does not work well
-        # on some browsers. Specifically on Safari (MacOS)
-        server_url = (
-            self.settings["mwi_server_url"].replace("0.0.0.0", "localhost")
-            + mwi_auth_token_str
-        )
-
         mwi.logger.log_startup_info(
             title=f"matlab-proxy-app running on {self.settings['app_port']}",
-            matlab_url=server_url,
+            matlab_urls=_get_server_urls(
+                self.settings["mwi_server_url"], mwi_auth_token_str
+            ),
         )
         logger.info(f"MATLAB Root: {self.settings['matlab_path']}")
 
@@ -1103,7 +1113,7 @@ async def __start_xvfb_process(self):
 
         # FileNotFoundError: is thrown if Xvfb is not found on System Path.
         # XvfbError: is thrown if something went wrong when starting Xvfb process.
-        except (FileNotFoundError, XvfbError) as err:
+        except (FileNotFoundError, XvfbError):
             self.error = XvfbError(
                 """Unable to start the Xvfb process. Ensure Xvfb is installed and is available on the System Path. See https://github.com/mathworks/matlab-proxy#requirements for information on Xvfb"""
             )
@@ -1309,7 +1319,7 @@ async def start_matlab(self, restart_matlab=False):
         # to MATLAB state by other functions/tasks until the lock is released, ensuring consistency. It's released early only in case of exceptions.
         await self.matlab_state_updater_lock.acquire()
         self.set_matlab_state("starting")
-        logger.info(f"Starting MATLAB...")
+        logger.info("Starting MATLAB...")
 
         # Clear MATLAB errors and logging
         self.error = None

matlab_proxy/settings.py

@@ -21,7 +21,7 @@
 from matlab_proxy.util import mwi, system
 from matlab_proxy.util.cookie_jar import HttpOnlyCookieJar
 from matlab_proxy.util.mwi import environment_variables as mwi_env
-from matlab_proxy.util.mwi import token_auth, session_name
+from matlab_proxy.util.mwi import session_name, token_auth
 from matlab_proxy.util.mwi.exceptions import (
     FatalError,
     MatlabInstallError,
@@ -191,7 +191,7 @@ def get_dev_settings(config):
         "create_xvfb_cmd": create_xvfb_cmd,
         "base_url": os.environ.get(mwi_env.get_env_name_base_url(), ""),
         "app_port": os.environ.get(mwi_env.get_env_name_app_port(), 8000),
-        "host_interface": os.environ.get(mwi_env.get_env_name_app_host(), "127.0.0.1"),
+        "host_interface": "127.0.0.1",
         "mwapikey": str(uuid.uuid4()),
         "matlab_protocol": "http",
         "matlab_display": ":1",
@@ -329,8 +329,8 @@ def get_server_settings(config_name):
         "base_url": mwi.validators.validate_base_url(
             os.getenv(mwi_env.get_env_name_base_url(), "")
         ),
-        # Set default to host interface to 0.0.0.0
-        "host_interface": os.environ.get(mwi_env.get_env_name_app_host(), "0.0.0.0"),
+        # Set host interface to 0.0.0.0 to bind on all interfaces
+        "host_interface": "0.0.0.0",
         # not_exception_safe, can_terminate_process by throwing FatalError
         "app_port": mwi.validators.validate_app_port_is_free(
             os.getenv(mwi_env.get_env_name_app_port())

matlab_proxy/util/mwi/logger.py

@@ -1,15 +1,16 @@
 # Copyright 2020-2025 The MathWorks, Inc.
 """Functions to access & control the logging behavior of the app"""
 
-from . import environment_variables as mwi_env
-
-from pathlib import Path
-from rich.console import Console
-from rich.table import Table
 import logging
 import os
 import sys
 import time
+from pathlib import Path
+
+from rich.console import Console
+from rich.table import Table
+
+from . import environment_variables as mwi_env
 
 logging.getLogger("aiohttp_session").setLevel(logging.ERROR)
 
@@ -144,7 +145,7 @@ def __is_invalid_log_level(log_level):
     return not hasattr(logging, log_level)
 
 
-def log_startup_info(title=None, matlab_url=None):
+def log_startup_info(title=None, matlab_urls=[]):
     """Logs the startup information to the console and log file if specified."""
     logger = __get_mw_logger()
     print_as_table = False
@@ -155,7 +156,7 @@ def log_startup_info(title=None, matlab_url=None):
         console = Console()
         # Number of additional characters used by the table
         padding = 4
-        print_as_table = len(matlab_url) + padding <= console.width
+        print_as_table = all(len(url) + padding <= console.width for url in matlab_urls)
 
     if print_as_table:
         table = Table(
@@ -168,11 +169,13 @@ def log_startup_info(title=None, matlab_url=None):
         )
         table.add_column(overflow="fold", style="bold green", justify="center")
         table.add_row(header_info)
-        table.add_row(matlab_url)
+        for url in matlab_urls:
+            table.add_row(url)
         console.print(table)
 
     if os.getenv(mwi_env.get_env_name_log_file(), None) or not print_as_table:
-        logger.critical(f"{header_info} {matlab_url}")
+        urls = "\n\t".join(matlab_urls)
+        logger.critical(f"{header_info}\n\t{urls}")
 
 
 class _ColoredFormatter(logging.Formatter):

tests/unit/test_app.py

@@ -924,16 +924,6 @@ def test_get_access_url_non_dev_windows(
     assert "127.0.0.1" in util.get_access_url(test_server.app)
 
 
-@pytest.mark.skipif(
-    platform.system() == "Windows", reason="Testing the non-Windows access URL"
-)
-def test_get_access_url_non_dev_posix(
-    non_default_host_interface, non_test_env, test_server
-):
-    """Test to check access url to be 0.0.0.0 in non-dev mode on Linux/Darwin"""
-    assert "0.0.0.0" in util.get_access_url(test_server.app)
-
-
 @pytest.fixture(name="set_licensing_info_mock_fetch_single_entitlement")
 def set_licensing_info_mock_fetch_single_entitlement_fixture():
     """Fixture that returns a single entitlement