matlab-proxy 0.10.0__tar.gz → 0.10.1__tar.gz

{matlab-proxy-0.10.0/matlab_proxy.egg-info → matlab-proxy-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.10.0
+Version: 0.10.1
 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.10.0 → matlab-proxy-0.10.1}/gui/src/components/App/index.js

@@ -1,4 +1,4 @@
-// Copyright 2020-2022 The MathWorks, Inc.
+// Copyright 2020-2023 The MathWorks, Inc.
 
 import React, { useState, useCallback, useEffect, useMemo } from 'react';
 import { useSelector, useDispatch } from 'react-redux';
@@ -14,20 +14,22 @@ import Information from '../Information';
 import Help from '../Help';
 import Error from '../Error';
 import {
-  selectOverlayVisible,
-  selectFetchStatusPeriod,
-  selectHasFetchedServerStatus,
-  selectLicensingProvided,
-  selectMatlabUp,
-  selectError,
-  selectLoadUrl,
-  selectIsConnectionError,
-  selectHasFetchedEnvConfig,
-  selectAuthEnabled,
-  selectIsAuthenticated,
-  selectLicensingMhlmHasEntitlements,
-  selectIsEntitled,
-  selectLicensingInfo,
+    selectOverlayVisible,
+    selectFetchStatusPeriod,
+    selectHasFetchedServerStatus,
+    selectLicensingProvided,
+    selectMatlabUp,
+    selectError,
+    selectLoadUrl,
+    selectIsConnectionError,
+    selectHasFetchedEnvConfig,
+    selectAuthEnabled,
+    selectIsAuthenticated,
+    selectLicensingMhlmHasEntitlements,
+    selectIsEntitled,
+    selectLicensingInfo,
+    selectUseMOS,
+    selectUseMRE,
 } from "../../selectors";
 
 import {
@@ -56,17 +58,34 @@ function App() {
     const isAuthenticated = useSelector(selectIsAuthenticated)
     const authEnabled = useSelector(selectAuthEnabled);
     const licensingInfo = useSelector(selectLicensingInfo);
+    const useMOS = useSelector(selectUseMOS);
+    const useMRE = useSelector(selectUseMRE);
 
     const baseUrl = useMemo(() => {
-        const url = document.URL        
+        const url = document.URL
         return url.split(window.location.origin)[1].split('index.html')[0]
     }, [])
-    
-    const parseQueryParams = (url)  => {
+
+    const parseQueryParams = (url) => {
         const queryParams = new URLSearchParams(url.search);
         return queryParams;
     }
 
+    const fullyQualifiedUrl = useMemo(() => {
+        // Returns the Fully Qualified URL used to load the page.
+        const url = document.URL
+        let baseUrlStr = url.split('/index.html')[0]
+        return baseUrlStr;
+    }, [])
+
+    const htmlToRenderMATLAB = () => {
+        let theHtmlToRenderMATLAB = useMOS ? "index-matlabonlineserver.html" : 'index-jsd-cr.html'
+        if (useMRE) {
+            theHtmlToRenderMATLAB += `?mre=${fullyQualifiedUrl}`
+        }
+        return theHtmlToRenderMATLAB
+    }
+
     const toggleOverlayVisible = useCallback(
         () => dispatch(setOverlayVisibility(!overlayVisible)),
         [overlayVisible, dispatch]
@@ -137,10 +156,10 @@ function App() {
     // Periodic fetch server status
     useInterval(() => {
         dispatch(fetchServerStatus());
-    },  fetchStatusPeriod);
+    }, fetchStatusPeriod);
 
     // Load URL
-    useEffect(() => {      
+    useEffect(() => {
         if (loadUrl !== null) {
             window.location.href = loadUrl;
         }
@@ -148,14 +167,14 @@ function App() {
 
     useEffect(() => {
         const queryParams = parseQueryParams(window.location);
-        const token = queryParams.get("mwi_auth_token");      
+        const token = queryParams.get("mwi_auth_token");
 
-        if(token){
-            dispatch(updateAuthStatus(token));              
+        if (token) {
+            dispatch(updateAuthStatus(token));
         }
-        window.history.replaceState(null, '', `${baseUrl}index.html`); 
+        window.history.replaceState(null, '', `${baseUrl}index.html`);
     }, [dispatch, baseUrl]);
-    
+
     // Display one of:
     // * Confirmation
     // * Help
@@ -163,16 +182,16 @@ function App() {
     // * License gatherer
     // * License selector
     // * Status Information
-    let overlayContent;   
+    let overlayContent;
 
     if (dialog) {
         // TODO Inline confirmation component build
         overlayContent = dialog;
-    }    
+    }
     // Give precedence to token auth over licensing info ie. once after token auth is done, show licensing if not provided.
-    else if((!licensingProvided) && hasFetchedServerStatus && (!authEnabled || isAuthenticated)) {    
+    else if ((!licensingProvided) && hasFetchedServerStatus && (!authEnabled || isAuthenticated)) {
         overlayContent = <LicensingGatherer role="licensing" aria-describedby="license-window" />;
-    } 
+    }
     // Show license selector if the user has entitlements and is not currently entitled
     else if (hasEntitlements && !isEntitled) {
         overlayContent = <EntitlementSelector options={licensingInfo.entitlements} />;
@@ -192,19 +211,23 @@ function App() {
         </Overlay>
     ) : null;
 
+
     // FIXME Until https://github.com/http-party/node-http-proxy/issues/1342
     // is addressed, use a direct URL in development mode. Once that is
     // fixed, the request will be served by the fake MATLAB Embedded Connector
     // process in development mode
+
+    // MW Internal Comment: See g2992889 for a discussion on why a FQDN is required in the MRE parameter.
+    // MW Internal Comment: Using websocket on breaks some UI components : `./index-matlabonlineserver.html?websocket=on&mre=${fullyQualifiedUrl}`;
     const matlabUrl = process.env.NODE_ENV === 'development'
         ? 'http://localhost:31515/index-jsd-cr.html'
-        : './index-jsd-cr.html';
+        : `./${htmlToRenderMATLAB()}`;
 
     let matlabJsd = null;
-    if(matlabUp){
-        matlabJsd = (!authEnabled || isAuthenticated) 
-        ? ( <MatlabJsd url={matlabUrl} /> ) 
-        : <img style={{objectFit: 'fill'}}src={blurredBackground} alt='Blurred MATLAB environment'/> 
+    if (matlabUp) {
+        matlabJsd = (!authEnabled || isAuthenticated)
+            ? (<MatlabJsd url={matlabUrl} />)
+            : <img style={{ objectFit: 'fill' }} src={blurredBackground} alt='Blurred MATLAB environment' />
     }
 
     const overlayTrigger = overlayVisible ? null : <OverlayTrigger />;

{matlab-proxy-0.10.0 → matlab-proxy-0.10.1}/gui/src/reducers/index.js

@@ -35,6 +35,26 @@ export function authEnabled(state = false, action) {
     }
 }
 
+// Stores information on whether to use MOS HTML while rendering MATLAB.
+export function useMOS(state = false, action) {
+    switch (action.type) {
+        case RECEIVE_ENV_CONFIG:
+            return action.config.useMOS;
+        default:
+            return state;
+    }
+}
+
+// Stores information on whether to provide MRE parameter to HTML while rendering MATLAB.
+export function useMRE(state = false, action) {
+    switch (action.type) {
+        case RECEIVE_ENV_CONFIG:
+            return action.config.useMRE;
+        default:
+            return state;
+    }
+}
+
 // Stores status of token authentication.
 export function authStatus(state = false, action) {
     switch (action.type) {
@@ -251,7 +271,7 @@ export function envConfig(state = null, action) {
         case RECEIVE_ENV_CONFIG:
             // Token authentication info is also sent as a response to /get_env_config endpoint.
             // As its already stored in 'authStatus', 'authEnabled' and 'authToken', ignoring it in envConfig.
-            const { authStatus, authEnabled, ...envConfig } = action.config
+            const { authStatus, authEnabled, useMOS, useMRE, ...envConfig } = action.config
             return envConfig
         default:
             return state;
@@ -284,4 +304,6 @@ export default combineReducers({
     error,
     envConfig,
     authInfo,
+    useMOS,
+    useMRE,
 });

{matlab-proxy-0.10.0 → matlab-proxy-0.10.1}/gui/src/selectors/index.js

@@ -15,6 +15,8 @@ export const selectError = state => state.error;
 export const selectAuthEnabled = state => state.authInfo.authEnabled;
 export const selectAuthToken = state => state.authInfo.authToken;
 export const selectIsAuthenticated = state => state.authInfo.authStatus === true;
+export const selectUseMOS = state => state.useMOS === true;
+export const selectUseMRE = state => state.useMRE === true;
 
 export const selectTriggerPosition = createSelector(
     state => state.triggerPosition,

{matlab-proxy-0.10.0 → matlab-proxy-0.10.1}/matlab_proxy/app.py

@@ -152,6 +152,9 @@ async def get_env_config(req):
     config = state.settings["env_config"]
     config["authEnabled"] = state.settings["mwi_is_token_auth_enabled"]
 
+    config["useMOS"] = mwi_env.Experimental.should_use_mos_html()
+    config["useMRE"] = mwi_env.Experimental.should_use_mre_html()
+
     # In a previously authenticated session, if the url is accessed without the token(using session cookie), send the token as well.
     config["authStatus"] = True if await token_auth.authenticate_request(req) else False
     return web.json_response(config)

{matlab-proxy-0.10.0 → matlab-proxy-0.10.1}/matlab_proxy/app_state.py

@@ -679,6 +679,18 @@ class AppState:
         # The mwi_logs_dir is where MATLAB will write any subsequent logs
         matlab_env["MATLAB_LOG_DIR"] = str(self.mwi_logs_dir)
 
+        # Set MW_CONNECTOR_CONTEXT_ROOT for MPA
+        if mwi_env.Experimental.is_mpa_enabled():
+            matlab_env["MW_CONNECTOR_CONTEXT_ROOT"] = self.settings.get("base_url", "/")
+            logger.info(
+                f"MW_CONNECTOR_CONTEXT_ROOT is set to: {matlab_env['MW_CONNECTOR_CONTEXT_ROOT']}"
+            )
+
+        # Setup Simulink Online which requires a pre-warm stage
+        if mwi_env.Experimental.is_simulink_enabled():
+            logger.info("Enabling usage of Simulink Online...")
+            matlab_env["PREWARM_SIMULINK"] = "true"
+
         # Env setup related to logging
         # Very verbose logging in debug mode
         if logger.isEnabledFor(logging.getLevelName("DEBUG")):

{matlab-proxy-0.10.0 → matlab-proxy-0.10.1}/matlab_proxy/settings.py

@@ -369,6 +369,14 @@ def get_matlab_settings():
             f"Set {mwi_env.get_env_name_custom_matlab_root()} to a valid MATLAB root path"
         )
 
+    mpa_flags = (
+        mwi_env.Experimental.get_mpa_flags()
+        if mwi_env.Experimental.is_mpa_enabled()
+        else ""
+    )
+    profile_matlab_startup = (
+        "-timing" if mwi_env.Experimental.is_matlab_startup_profiling_enabled() else ""
+    )
     return {
         "matlab_path": matlab_root_path,
         "matlab_version": matlab_version,
@@ -377,7 +385,10 @@ def get_matlab_settings():
             "-nosplash",
             *flag_to_hide_desktop,
             "-softwareopengl",
+            # " v=mvm ",
             *matlab_lic_mode,
+            *mpa_flags,
+            profile_matlab_startup,
             "-r",
             f"try; run('{matlab_startup_file}'); catch ME; disp(ME.message); end;",
         ],

{matlab-proxy-0.10.0 → matlab-proxy-0.10.1}/matlab_proxy/util/mwi/environment_variables.py

@@ -1,9 +1,21 @@
-# Copyright (c) 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2023 The MathWorks, Inc.
 """This file lists and exposes the environment variables which are used by the integration."""
 
 import os
 
 
+def _is_env_set_to_true(env_name: str) -> bool:
+    """Helper function that returns True if the environment variable specified is set to True.
+
+    Args:
+        env_name (str): Name of the environment variable to check the state for.
+
+    Returns:
+        bool: True if the value of the environment variable is a case insensitive match to the string "True"
+    """
+    return os.environ.get(env_name, "false").lower() == "true"
+
+
 def get_env_name_network_license_manager():
     """Specifies the path to valid license file or address of a network license server"""
     return "MLM_LICENSE_FILE"
@@ -20,19 +32,10 @@ def get_env_name_logging_level():
 
 
 def get_env_name_enable_web_logging():
-    """wef > v0.2.10 Enable the logging of asyncio web traffic by setting to true"""
+    """Enable the logging of asyncio web traffic by setting to true"""
     return "MWI_ENABLE_WEB_LOGGING"
 
 
-def get_old_env_name_enable_web_logging():
-    """
-    Enable the logging of asyncio web traffic by setting to true
-    This name is deprecated and was last published in version v0.2.10 of matlab-proxy.
-    """
-
-    return "MWI_WEB_LOGGING_ENABLED"
-
-
 def get_env_name_log_file():
     """Specifies a file into which logging content is directed"""
     return "MWI_LOG_FILE"
@@ -89,32 +92,17 @@ def get_env_name_matlab_tempdir():
 
 def is_development_mode_enabled():
     """Returns true if the app is in development mode."""
-    return os.environ.get(get_env_name_development(), "false").lower() == "true"
+    return _is_env_set_to_true(get_env_name_development())
 
 
 def is_testing_mode_enabled():
     """Returns true if the app is in testing mode."""
-    return (
-        is_development_mode_enabled()
-        and os.environ.get(get_env_name_testing(), "false").lower() == "true"
-    )
+    return is_development_mode_enabled() and _is_env_set_to_true(get_env_name_testing())
 
 
 def is_web_logging_enabled():
     """Returns true if the web logging is required to be enabled"""
-
-    if os.environ.get(get_old_env_name_enable_web_logging(), None) is not None:
-        from matlab_proxy.util import mwi
-
-        logger = mwi.logger.get()
-        logger.warning(
-            f"Usage of {get_old_env_name_enable_web_logging()} is being deprecated from v0.2.10 and will be removed in a future release.\n Use {get_env_name_enable_web_logging()} instead. "
-        )
-        return (
-            os.environ.get(get_old_env_name_enable_web_logging(), "false").lower()
-            == "true"
-        )
-    return os.environ.get(get_env_name_enable_web_logging(), "false").lower() == "true"
+    return _is_env_set_to_true(get_env_name_enable_web_logging())
 
 
 def get_env_name_ssl_cert_file():
@@ -155,3 +143,56 @@ def get_env_name_custom_matlab_root():
 def get_env_name_process_startup_timeout():
     """User specified timeout in seconds for processes launched by matlab-proxy"""
     return "MWI_PROCESS_START_TIMEOUT"
+
+
+class Experimental:
+    """This class houses functions which are undocumented APIs and Environment variables.
+    Note: Never add any state to this class. Its only intended for use as an abstraction layer
+    for functions which are not ready for prime time.
+    """
+
+    @staticmethod
+    def get_env_name_enable_simulink():
+        """Returns the environment variable name used to enable simulink support"""
+        ##NOTE: Simulink Online is unavailable for general use as of R2023b.
+        return "MWI_ENABLE_SIMULINK"
+
+    @staticmethod
+    def is_simulink_enabled():
+        """Returns true if the simulink online is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_enable_simulink())
+
+    @staticmethod
+    def should_use_mos_html():
+        """Returns true if matlab-proxy should use MOS htmls to load MATLAB"""
+        return _is_env_set_to_true("MWI_USE_MOS") or Experimental.is_simulink_enabled()
+
+    @staticmethod
+    def should_use_mre_html():
+        """Returns true if matlab-proxy should provide MRE parameter to the htmls used to load MATLAB"""
+        return _is_env_set_to_true("MWI_USE_MRE")
+
+    @staticmethod
+    def get_env_name_enable_mpa():
+        """Returns the environment variable name used to enable MPA support"""
+        return "MWI_ENABLE_MPA"
+
+    @staticmethod
+    def is_mpa_enabled():
+        """Returns true if the simulink online is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_enable_mpa())
+
+    @staticmethod
+    def get_env_name_profile_matlab_startup():
+        """Returns the environment variable name used to enable MPA support"""
+        return "MWI_PROFILE_MATLAB_STARTUP"
+
+    @staticmethod
+    def is_matlab_startup_profiling_enabled():
+        """Returns true if the simulink online is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_profile_matlab_startup())
+
+    @staticmethod
+    def get_mpa_flags():
+        """Returns list of flags required to enable MPA"""
+        return ["-webui", "-externalUI"]

{matlab-proxy-0.10.0 → matlab-proxy-0.10.1/matlab_proxy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.10.0
+Version: 0.10.1
 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.10.0 → matlab-proxy-0.10.1}/setup.py

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