Bugfix: Host Interface for the server will default to 0.0.0.0 instead of localhost.

Author: diningPhilosopher64

Advanced-Usage.md

@@ -18,6 +18,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_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.py

@@ -8,7 +8,6 @@
 
 import aiohttp
 from aiohttp import web
-
 from aiohttp_session import setup as aiohttp_session_setup
 from aiohttp_session.cookie_storage import EncryptedCookieStorage
 from cryptography import fernet
@@ -17,10 +16,10 @@
 from matlab_proxy import settings, util
 from matlab_proxy.app_state import AppState
 from matlab_proxy.default_configuration import config
-from matlab_proxy.util import mwi, list_servers
+from matlab_proxy.util import list_servers, mwi
 from matlab_proxy.util.mwi import environment_variables as mwi_env
-from matlab_proxy.util.mwi.exceptions import LicensingError
 from matlab_proxy.util.mwi import token_auth
+from matlab_proxy.util.mwi.exceptions import LicensingError
 
 mimetypes.add_type("font/woff", ".woff")
 mimetypes.add_type("font/woff2", ".woff2")
@@ -589,7 +588,7 @@ def configure_and_start(app):
 
     # Update the site origin in settings.
     # The origin will be used for communicating with the Embedded connector.
-    app["settings"]["mwi_server_url"] = site.name + app["settings"]["base_url"]
+    app["settings"]["mwi_server_url"] = util.get_access_url(app)
 
     loop.run_until_complete(site.start())
 

matlab_proxy/app_state.py

@@ -1,31 +1,31 @@
 # Copyright (c) 2020-2022 The MathWorks, Inc.
 
-import aiohttp
 import asyncio
 import errno
 import json
 import logging
 import os
-import time
 import socket
 import sys
-
+import time
 from collections import deque
 from datetime import datetime, timedelta, timezone
 
+import aiohttp
+
 from matlab_proxy import util
-from matlab_proxy.util.mwi import token_auth
-from matlab_proxy.util import mw, mwi, windows, system
+from matlab_proxy.util import mw, mwi, system, windows
 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 (
     EmbeddedConnectorError,
     EntitlementError,
     InternalError,
     LicensingError,
     MatlabError,
-    XvfbError,
     MatlabInstallError,
     OnlineLicensingError,
+    XvfbError,
     log_error,
 )
 
@@ -475,13 +475,10 @@ def prepare_lock_files_for_MATLAB_launch(self):
                         )
                         return
 
-                # When testing in github workflows,  for windows container's, PermissionError is
+                # For windows container's (when testing in github workflows) PermissionError and in linux, OSError is
                 # thrown when trying to bind a used port from a previous test instead of the expected socket.error
                 except (OSError, PermissionError) as e:
-                    if system.is_windows():
-                        pass
-                    else:
-                        raise e
+                    pass
 
                 except socket.error as e:
                     if e.errno != errno.EADDRINUSE:
@@ -788,7 +785,7 @@ async def matlab_stderr_reader():
 
                 # The maximum amount of time in seconds the Embedded Connector can take
                 # for lauching, before the matlab-proxy server concludes that something is wrong.
-                self.embedded_connector_max_starting_duration = 15
+                self.embedded_connector_max_starting_duration = 120
 
                 # In Windows systems, errors are raised as UI windows and cannot be captured programmatically.
                 # So, check for how long the Embedded Connector is not up and then raise a generic error.

matlab_proxy/settings.py

@@ -165,8 +165,9 @@ def get(config_name=matlab_proxy.get_default_config_name(), dev=False):
             "app_port": mwi.validators.validate_app_port_is_free(
                 os.getenv(mwi_env.get_env_name_app_port())
             ),
+            # Set default to host interface to 0.0.0.0
             "host_interface": os.environ.get(
-                mwi_env.get_env_name_app_host(), "localhost"
+                mwi_env.get_env_name_app_host(), "0.0.0.0"
             ),
             "mwapikey": str(uuid.uuid4()),
             "matlab_protocol": "https",

matlab_proxy/util/__init__.py

@@ -12,26 +12,6 @@
 logger = mwi.logger.get()
 
 
-def get_event_loop():
-    """Returns an asyncio event loop by checking the current python version and uses the appropriate
-    asyncio API
-
-    Returns:
-        asyncio.loop: asyncio event loop.
-    """
-    # get_running_loop() api is available for python >= 3.7
-    try:
-        # Try to get an existing event loop.
-        # If there's no running event loop, raise RuntimeError.
-        loop = asyncio.get_running_loop()
-    except RuntimeError:
-        # If execution reached this except block, it implies that there
-        # was no running event loop. So, create one.
-        loop = asyncio.get_event_loop()
-
-    return loop
-
-
 def parse_cli_args():
     """Parses CLI arguments passed to the main() function.
 
@@ -214,3 +194,37 @@ def get_child_processes(parent_process):
             break
 
     return child_processes
+
+
+def get_access_url(app):
+    """Returns the url at which the server will be accessible at
+
+    Args:
+        app (aiohttp.web.Application): The web application from aiottp package
+
+    Returns:
+        str: complete url at which the server will be accessible.
+    """
+    base_url = app["settings"]["base_url"]
+    port = app["settings"]["app_port"]
+
+    ssl_context = app["settings"]["ssl_context"]
+    host_interface = app["settings"]["host_interface"]
+
+    access_protocol = "https" if ssl_context else "http"
+
+    # When host interface is set to 0.0.0.0, in a windows system, the server will not be accessible.
+    # Setting the value to fqdn, will allow it be remotely and locally accessible.
+
+    # NOTE: When windows container support is introduced this will need to be tweaked accordingly.
+    if host_interface == "0.0.0.0" and system.is_windows():
+        import socket
+
+        hostname = socket.gethostname()
+        fqdn = socket.getfqdn(hostname)
+
+        url = f"{access_protocol}://{fqdn}:{port}{base_url}"
+    else:
+        url = f"{access_protocol}://{host_interface}:{port}{base_url}"
+
+    return url

matlab_proxy/util/list_servers.py

@@ -3,8 +3,9 @@
 
 import glob
 import os
-import matlab_proxy.util as mwi_util
+
 import matlab_proxy.settings as mwi_settings
+import matlab_proxy.util as mwi_util
 
 
 def print_server_info():

matlab_proxy/util/mwi/token_auth.py

@@ -2,12 +2,14 @@
 
 # This file contains functions required to enable token based authentication in the server.
 
+import os
+import secrets
+
 from aiohttp import web
-from aiohttp_session import setup, get_session, new_session
+from aiohttp_session import get_session, new_session, setup
 from aiohttp_session.cookie_storage import EncryptedCookieStorage
 from matlab_proxy.util.mwi import environment_variables as mwi_env
-import os
-import secrets
+
 from . import logger as mwi_logger
 
 logger = mwi_logger.get()

matlab_proxy/util/system.py

@@ -1,7 +1,7 @@
 # Copyright 2022 The MathWorks, Inc.
 import os
-import signal
 import platform
+import signal
 
 """Contains methods and helpers which return OS specific information 
 """

setup.py

@@ -66,7 +66,7 @@ def run(self):
 
 setuptools.setup(
     name="matlab-proxy",
-    version="0.4.0",
+    version="0.4.1",
     url=config["doc_url"],
     author="The MathWorks, Inc.",
     author_email="cloud@mathworks.com",

tests/test_app.py

@@ -8,6 +8,7 @@
 import pytest
 from aiohttp import web
 from matlab_proxy import app, util
+from matlab_proxy.util.mwi import environment_variables as mwi_env
 from matlab_proxy.util.mwi.exceptions import MatlabInstallError
 
 
@@ -540,3 +541,41 @@ async def test_set_termination_integration_delete(test_server):
         assert resp.status == 200 and resp_json["loadUrl"] == "../"
     except ProcessLookupError:
         pass
+
+
+def test_get_access_url(test_server):
+    """Should return a url with 127.0.0.1 in test mode
+
+    Args:
+        test_server (aiohttp.web.Application): Application Server
+    """
+    assert "127.0.0.1" in util.get_access_url(test_server.app)
+
+
+@pytest.fixture(name="non_test_env")
+def non_test_env_fixture(monkeypatch):
+    """Monkeypatches MWI_TEST env var to false
+
+    Args:
+        monkeypatch (_pytest.monkeypatch.MonkeyPatch): To monkeypatch env vars
+    """
+    monkeypatch.setenv(mwi_env.get_env_name_testing(), "false")
+
+
+@pytest.fixture(name="non_default_host_interface")
+def non_default_host_interface_fixture(monkeypatch):
+    """Monkeypatches MWI_TEST env var to false
+
+    Args:
+        monkeypatch (_pytest.monkeypatch.MonkeyPatch): To monkeypatch env vars
+    """
+    monkeypatch.setenv(mwi_env.get_env_name_app_host(), "0.0.0.0")
+
+
+# For pytest fixtures, order of arguments matter.
+# First set the default host interface to a non-default value
+# Then set MWI_TEST to false and then create an instance of the test_server
+# This order will set the test_server with appropriate values.
+def test_get_access_url_non_dev(non_default_host_interface, non_test_env, test_server):
+    """Test to check access url to not be 127.0.0.1 in non-dev mode"""
+    assert "127.0.0.1" not in util.get_access_url(test_server.app)