v0.7.0 : Ability to specify to matlab-proxy that MATLAB is already licensed.

Author: diningPhilosopher64

Advanced-Usage.md

@@ -28,6 +28,7 @@ The following table describes all the environment variables that you can set to
 | **MWI_SSL_KEY_FILE** | string | `"/path/to/keyfile.key"` | The keyfile string, if present, must point to a file containing the private key. Otherwise the private key will be taken from certfile as well. |
 | **MWI_ENABLE_TOKEN_AUTH** | string | `"True"` | When set to `True`, matlab-proxy will require users to provide the security token to access the proxy. <br />The default value is `False` . See [Token-Based Authentication](./SECURITY.md#token-based-authentication) for more information.|
 | **MWI_AUTH_TOKEN** | string (optional) | `"AnyURLSafeToken"` | Optionally, provide a custom `token` for use with `MWI_ENABLE_TOKEN_AUTH`. A token can safely contain any combination of alpha numeric text along with the following permitted characters: `- .  _  ~`.<br />When absent matlab-proxy will generate a random URL safe token. |
+| **MWI_USE_EXISTING_LICENSE** | string (optional) | `"True"` | When set to True, matlab-proxy will not ask you for additional licensing information and will try to launch an already activated MATLAB on your system PATH.
 
 
 ## Custom HTTP Headers 

README.md

@@ -162,6 +162,9 @@ Install the version >=0.5.0 to use the package on MacOS.
 $ pip install --upgrade matlab-proxy>=0.5.0
 ```
 
+## 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.
+
 ## Limitations
 This package supports the same subset of MATLAB features and commands as MATLAB® Online, except there is no support for Simulink® Online.
 [Click here for a full list of Specifications and Limitations for MATLAB Online](https://www.mathworks.com/products/matlab-online/limitations.html). 

gui/src/components/Controls/index.js

@@ -1,12 +1,12 @@
-// Copyright (c) 2020-2022 The MathWorks, Inc.
+// Copyright (c) 2020-2023 The MathWorks, Inc.
 
 import React, { useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { useSelector } from 'react-redux';
 import ReactTooltip from 'react-tooltip';
 import {
     selectSubmittingServerStatus,
-    selectLicensingIsMhlm,
+    selectLicensingInfo,    
     selectLicensingProvided,
     selectMatlabUp,
     selectMatlabStarting,
@@ -36,7 +36,6 @@ function Controls({
 }) {
     const submitting = useSelector(selectSubmittingServerStatus);
     const licensed = useSelector(selectLicensingProvided);
-    const mhlmLicense = useSelector(selectLicensingIsMhlm);
     const matlabStarting = useSelector(selectMatlabStarting);
     const matlabUp = useSelector(selectMatlabUp);
     const matlabStopping = useSelector(selectMatlabStopping);
@@ -45,6 +44,7 @@ function Controls({
     const error = useSelector(selectError);
     const authEnabled = useSelector(selectAuthEnabled);
     const isAuthenticated = useSelector(selectIsAuthenticated);
+    const licensingInfo = useSelector(selectLicensingInfo);
     const canResetLicensing = licensed && !submitting;
 
     const feedbackBody = useMemo(
@@ -55,6 +55,41 @@ MATLAB version: ${matlabVersion}%0D%0A`,
         [matlabVersion]
     );
 
+    let licensingData, licensingConfirmationMessage;
+    switch (licensingInfo?.type) {
+        case "mhlm":
+            licensingData =  {
+                label: 'Sign Out',
+                dataTip : 'Sign out of MATLAB',
+            };
+            licensingConfirmationMessage = `Are you sure you want to sign out of MATLAB?`
+            break;
+        case "nlm":
+            licensingData =  {
+                label: 'Remove License Server Address',
+                dataTip : 'Remove the network license manager server address',
+            };  
+            licensingConfirmationMessage = `Are you sure you want to remove the network license manager server address?`
+            break;
+
+        case "existing_license":
+            licensingData =  {
+                label: 'Stop using Existing License',
+                dataTip : 'Stop using existing license',
+            };
+            licensingConfirmationMessage = `Are you sure you want to stop using an Existing License?`
+            break;
+        
+        default:
+            licensingData =  {
+                label: 'None',
+                dataTip : 'None',
+            }; 
+            licensingConfirmationMessage = null  
+        }
+
+
+
     const Confirmations = {
         START: {
             type: 'confirmation',
@@ -73,7 +108,7 @@ MATLAB version: ${matlabVersion}%0D%0A`,
         },
         SIGN_OUT: {
             type: 'confirmation',
-            message: `Are you sure you want to ${mhlmLicense ? 'sign out of MATLAB' : 'unset the connection string'}?`,
+            message: licensingConfirmationMessage,
             callback: fetchUnsetLicensing
         },
         HELP: {
@@ -92,7 +127,7 @@ MATLAB version: ${matlabVersion}%0D%0A`,
             return cls + 'btn_color_blue';
         }
         return cls + 'btn_color_mediumgray';
-    };
+    };    
 
     return (
         <div id="controls" className="labels-on-top">
@@ -127,10 +162,10 @@ MATLAB version: ${matlabVersion}%0D%0A`,
                 onClick={() => callback(Confirmations.SIGN_OUT)}
                 disabled={!canResetLicensing || (authEnabled && !isAuthenticated)}
                 data-for="control-button-tooltip"
-                data-tip={mhlmLicense ? 'Sign out' : 'Unset the network license manager server address'}
+                data-tip= {licensingData.dataTip}
             >
                 <span className='icon-custom-sign-out'></span>
-                <span className='btn-label'>{mhlmLicense ? 'Sign Out' : 'Unset License Server Address'}</span>
+                <span className='btn-label'>{licensingData.label}</span>
             </button>
             {/* <button
                 id="terminateIntegration"

gui/src/components/Information/Information.spec.js

@@ -20,7 +20,7 @@ describe('Information Component', () => {
       tutorialHidden: false,
       overlayVisibility: false,
       serverStatus: {
-        licensingInfo: { type: 'MHLM', emailAddress: 'abc@mathworks.com' },
+        licensingInfo: { type: 'mhlm', emailAddress: 'abc@mathworks.com' },
         matlabStatus: 'up',
         matlabVersion: 'R2020b',
         isFetching: false,
@@ -71,7 +71,7 @@ describe('Information Component', () => {
   });
 
   it('should render Online Licensing info with licensing type MHLM', () => {
-    const { container, debug, getByText } = render(
+    const {  getByText } = render(
       <Information closeHandler={closeHandler} children={children} />,
       { initialState: initialState }
     );
@@ -85,10 +85,10 @@ describe('Information Component', () => {
 
   it('should render Online Licensing info with licensing type NLM', () => {
     initialState.serverStatus.licensingInfo = {
-      type: 'NLM',
+      type: 'nlm',
       connectionString: 'abc@nlm',
     };
-    const { container, debug, getByText } = render(
+    const { getByText } = render(
       <Information closeHandler={closeHandler} children={children} />,
       { initialState: initialState }
     );
@@ -100,6 +100,19 @@ describe('Information Component', () => {
     );
   });
 
+  it('should render Existing License with licensing type existing_license', () => {
+    initialState.serverStatus.licensingInfo = {
+      type: 'existing_license',
+    };
+    const { getByText } = render(
+      <Information closeHandler={closeHandler} children={children} />,
+      { initialState: initialState }
+    );
+
+    const licensingInfo = getByText('Licensing:');
+    expect(licensingInfo.nextSibling.textContent).toEqual("Existing License");
+  });
+
   it('should display errors', () => {
     initialState.error = {
       message: 'Exited with exit code -9',

gui/src/components/Information/index.js

@@ -11,7 +11,7 @@ import {
     selectInformationDetails,
     selectAuthEnabled,
     selectIsAuthenticated,
-    selectAuthToken
+    selectAuthToken,
 } from '../../selectors';
 import { updateAuthStatus } from '../../actionCreators';
 import './Information.css';
@@ -39,16 +39,21 @@ function Information({
 
     let info;
     switch (licensingInfo?.type) {
-        case "MHLM":
+        case "mhlm":
             info = {
                 label: `Online License Manager (${licensingInfo.emailAddress})`
             };
             break;
-        case "NLM":
+        case "nlm":
             info = {
                 label: `Network License Manager (${licensingInfo.connectionString})`
             };
             break;
+        case "existing_license":            
+            info = {
+                label : 'Existing License'
+            };
+            break;
         default:
             info = {
                 label: 'None'

gui/src/components/LicensingGatherer/ExistingLicense.css

@@ -0,0 +1,3 @@
+label {
+    padding-left: 5px;
+}

gui/src/components/LicensingGatherer/ExistingLicense.js

@@ -0,0 +1,35 @@
+import React from 'react';
+import { useDispatch } from 'react-redux';
+import {
+    fetchSetLicensing
+} from '../../actionCreators';
+import "./ExistingLicense.css"
+
+
+
+function ExistingLicense() {
+    const dispatch = useDispatch();
+
+    function submitForm(event) {
+        event.preventDefault();
+        dispatch(fetchSetLicensing({
+            'type': 'existing_license',
+        }));
+    }
+
+return (
+        <div id="ExistingLicense">
+            <form onSubmit={submitForm}>
+                <div className='form-group'>                     
+                    <p>
+                        <b>Note</b>: Choose this option if you already have an activated MATLAB license. This option allows you to run MATLAB on your host machine without providing additional licensing information.
+                    </p>
+                    <br/>
+                <input type="submit" id="submit" value="Start MATLAB" className="btn btn_color_blue" />
+                </div>
+            </form>
+        </div>
+    )
+}
+
+export default ExistingLicense;

gui/src/components/LicensingGatherer/LicenseGatherer.spec.js

@@ -15,7 +15,7 @@ describe('LicenseGatherer component', () => {
       overlayVisibility: false,
 
       serverStatus: {
-        licensingInfo: { type: 'MHLM', emailAddress: 'abc@mathworks.com' },
+        licensingInfo: { type: 'mhlm', emailAddress: 'abc@mathworks.com' },
         matlabStatus: 'up',
         matlabVersion: 'R2020b',
         isFetching: false,
@@ -63,7 +63,7 @@ describe('LicenseGatherer component', () => {
 
     initialState.serverStatus.wsEnv = 'mw-integ'
 
-    const { container, debug } = render(<LicenseGatherer />, { initialState: initialState });
+    const { container } = render(<LicenseGatherer />, { initialState: initialState });
 
     const mhlmTab = container.querySelector('#mhlm-tab');
 
@@ -99,11 +99,24 @@ describe('LicenseGatherer component', () => {
     // Click on nlm Tab
     fireEvent.click(nlmTab);
 
-    // Check if nlm iframe is rendered.
+    // Check if nlm tab is rendered.
     const nlmTabContent = container.querySelector('#NLM');
     expect(nlmTabContent).toBeInTheDocument();
   }); 
 
+  it('should have rendered existing license tab content without crashing', () => {
+    const { container } = render(<LicenseGatherer />, { initialState: initialState });
+
+    const existingLicenseTab = container.querySelector('#existingLicense-tab');
+    expect(existingLicenseTab).toBeInTheDocument();
+
+    // Click on existingLicense Tab
+    fireEvent.click(existingLicenseTab);
+
+    // Check if existingLicense tab is rendered.
+    const existingLicenseTabContent = container.querySelector('#existingLicense');
+    expect(existingLicenseTabContent).toBeInTheDocument();
+  }); 
 
   test.each([
     ['1234', true], ['hostname', true], ['1234hostname', true], ['1234,', true], ['hostname,', true], 

gui/src/components/LicensingGatherer/MHLM.js

@@ -102,7 +102,7 @@ function MHLM() {
                 } else if (data.event === 'login') {
                     // Persist credentials to serverside
                     dispatch(fetchSetLicensing({
-                        type: 'MHLM',
+                        type: 'mhlm',
                         token: data.token,
                         profileId: data.profileId,
                         emailAddress: data.emailAddress,

gui/src/components/LicensingGatherer/NLM.js

@@ -50,7 +50,7 @@ function NLM() {
     function submitForm(event) {
         event.preventDefault();
         dispatch(fetchSetLicensing({
-            'type': 'NLM',
+            'type': 'nlm',
             'connectionString': connStr
         }));
     }