Provides the ability to choose the license for use with MATLAB when multiple active licenses are associated with the MathWorks Account.

Author: krisctl

gui/package-lock.json

@@ -46,7 +46,7 @@
     "@testing-library/jest-dom": "^4.2.4",
     "@testing-library/react": "^11.2.6",
     "@testing-library/react-hooks": "^3.4.1",
-    "@testing-library/user-event": "^7.2.1",
+    "@testing-library/user-event": "^14.4.3",
     "fetch-mock": "^9.10.7",
     "react-test-renderer": "^16.13.1",
     "redux-mock-store": "^1.5.4"

gui/package.json

@@ -1,4 +1,4 @@
-// Copyright (c) 2020-2022 The MathWorks, Inc.
+// Copyright (c) 2020-2023 The MathWorks, Inc.
 
 import {
     SET_TRIGGER_POSITION,
@@ -7,11 +7,13 @@ import {
     REQUEST_SERVER_STATUS,
     RECEIVE_SERVER_STATUS,
     REQUEST_SET_LICENSING,
+    REQUEST_UPDATE_LICENSING,
     REQUEST_TERMINATE_INTEGRATION,
     REQUEST_STOP_MATLAB,
     REQUEST_START_MATLAB,
     REQUEST_ENV_CONFIG,
     RECEIVE_SET_LICENSING,
+    RECEIVE_UPDATE_LICENSING,
     RECEIVE_TERMINATE_INTEGRATION,
     RECEIVE_STOP_MATLAB,
     RECEIVE_START_MATLAB,
@@ -100,6 +102,20 @@ export function receiveSetLicensing(status) {
     };
 }
 
+export function requestUpdateLicensing() {
+    return {
+        type: REQUEST_UPDATE_LICENSING,
+    };
+}
+
+export function receiveUpdateLicensing(status) {
+    return {
+        type: RECEIVE_UPDATE_LICENSING,
+        status
+    };
+}
+
+
 export function requestTerminateIntegration() {
     return {
         type: REQUEST_TERMINATE_INTEGRATION,
@@ -239,6 +255,27 @@ export function fetchSetLicensing(info) {
     }
 }
 
+export function fetchUpdateLicensing(info) {
+    return async function (dispatch, getState) {
+
+        const options = {
+            method: 'PUT',
+            mode: 'same-origin',
+            cache: 'no-cache',
+            credentials: 'same-origin',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(info),
+        }
+
+        dispatch(requestUpdateLicensing());
+        const response = await fetchWithTimeout(dispatch, './update_entitlement', options, 1500);
+        const data = await response.json();
+        dispatch(receiveUpdateLicensing(data));
+    }
+}
+
 export function fetchUnsetLicensing() {
     return async function (dispatch, getState) {
 

gui/src/actionCreators/index.js

@@ -1,15 +1,17 @@
-// Copyright (c) 2020-2022 The MathWorks, Inc.
+// Copyright (c) 2020-2023 The MathWorks, Inc.
 
 export const SET_TRIGGER_POSITION = 'SET_TRIGGER_POSITION';
 export const SET_TUTORIAL_HIDDEN = 'SET_TUTORIAL_HIDDEN';
 export const SET_OVERLAY_VISIBILITY = 'SET_OVERLAY_VISIBILITY';
 export const REQUEST_SERVER_STATUS = 'REQUEST_SERVER_STATUS';
 export const RECEIVE_SERVER_STATUS = 'RECEIVE_SERVER_STATUS';
 export const REQUEST_SET_LICENSING = 'REQUEST_SET_LICENSING';
+export const REQUEST_UPDATE_LICENSING = 'REQUEST_UPDATE_LICENSING';
 export const REQUEST_TERMINATE_INTEGRATION = 'REQUEST_TERMINATE_INTEGRATION';
 export const REQUEST_STOP_MATLAB = 'REQUEST_STOP_MATLAB';
 export const REQUEST_START_MATLAB = 'REQUEST_START_MATLAB';
 export const RECEIVE_SET_LICENSING = 'RECEIVE_SET_LICENSING';
+export const RECEIVE_UPDATE_LICENSING = 'RECEIVE_UPDATE_LICENSING';
 export const RECEIVE_TERMINATE_INTEGRATION = 'RECEIVE_TERMINATE_INTEGRATION';
 export const RECEIVE_STOP_MATLAB = 'RECEIVE_STOP_MATLAB';
 export const RECEIVE_START_MATLAB = 'RECEIVE_START_MATLAB';

gui/src/actions/index.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2020-2022 The MathWorks, Inc.
+// Copyright (c) 2020-2023 The MathWorks, Inc.
 
 import React from 'react';
 import { render, fireEvent } from '../../test/utils/react-test';

gui/src/components/App/App.spec.js

@@ -14,25 +14,30 @@ import Information from '../Information';
 import Help from '../Help';
 import Error from '../Error';
 import {
-    selectOverlayVisible,
-    selectFetchStatusPeriod,
-    selectHasFetchedServerStatus,
-    selectLicensingProvided,
-    selectMatlabUp,
-    selectError,
-    selectLoadUrl,
-    selectIsConnectionError,
-    selectHasFetchedEnvConfig,
-    selectAuthEnabled,
-    selectIsAuthenticated,
-} from '../../selectors';
+  selectOverlayVisible,
+  selectFetchStatusPeriod,
+  selectHasFetchedServerStatus,
+  selectLicensingProvided,
+  selectMatlabUp,
+  selectError,
+  selectLoadUrl,
+  selectIsConnectionError,
+  selectHasFetchedEnvConfig,
+  selectAuthEnabled,
+  selectIsAuthenticated,
+  selectLicensingMhlmHasEntitlements,
+  selectIsEntitled,
+  selectLicensingInfo,
+} from "../../selectors";
+
 import {
     setOverlayVisibility,
     fetchServerStatus,
     fetchEnvConfig,
     updateAuthStatus,
 } from '../../actionCreators';
 import blurredBackground from './MATLAB-env-blur.png';
+import EntitlementSelector from "../EntitlementSelector";
 
 function App() {
     const dispatch = useDispatch();
@@ -42,12 +47,15 @@ function App() {
     const hasFetchedServerStatus = useSelector(selectHasFetchedServerStatus);
     const hasFetchedEnvConfig = useSelector(selectHasFetchedEnvConfig);
     const licensingProvided = useSelector(selectLicensingProvided);
+    const hasEntitlements = useSelector(selectLicensingMhlmHasEntitlements);
+    const isEntitled = useSelector(selectIsEntitled);
     const matlabUp = useSelector(selectMatlabUp);
     const error = useSelector(selectError);
     const loadUrl = useSelector(selectLoadUrl);
     const isConnectionError = useSelector(selectIsConnectionError);
     const isAuthenticated = useSelector(selectIsAuthenticated)
     const authEnabled = useSelector(selectAuthEnabled);
+    const licensingInfo = useSelector(selectLicensingInfo);
 
     const baseUrl = useMemo(() => {
         const url = document.URL        
@@ -152,6 +160,7 @@ function App() {
     // * Help
     // * Error
     // * License gatherer
+    // * License selector
     // * Status Information
     let overlayContent;   
 
@@ -163,6 +172,14 @@ function App() {
     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) {
+        const options = licensingInfo.entitlements.map((entitlement) => ({
+            label: entitlement.license_number,
+            value: entitlement.id,
+          }));
+        overlayContent = <EntitlementSelector options={options} />;
+  }
     // in all other cases, we will either ask for the token, 
     else if (!dialog) {
         overlayContent = (
@@ -204,4 +221,4 @@ function App() {
     );
 }
 
-export default App;
+export default App;

gui/src/components/App/index.js

@@ -0,0 +1,104 @@
+// Copyright (c) 2020-2023 The MathWorks, Inc.
+
+import React from "react";
+import EntitlementSelector from "./index";
+import App from "../App";
+import { render, fireEvent } from "../../test/utils/react-test";
+import userEvent from "@testing-library/user-event";
+
+describe("EntitlementSelector Component", () => {
+  let initialState;
+
+  beforeEach(() => {
+    initialState = {
+      triggerPosition: { x: 539, y: 0 },
+      tutorialHidden: false,
+      overlayVisibility: false,
+      serverStatus: {
+        licensingInfo: {
+          type: "mhlm",
+          emailAddress: "[email protected]",
+          entitlements: [
+            { id: "1234567", label: null, license_number: "7654321" },
+            {
+              id: "2345678",
+              label: "MATLAB - Staff Use",
+              license_number: "87654432",
+            },
+          ],
+          entitlementId: null,
+        },
+        matlabStatus: "down",
+        matlabVersion: "R2023a",
+        isFetching: false,
+        hasFetched: true,
+        isSubmitting: false,
+        fetchFailCount: 0,
+        wsEnv: "mw",
+      },
+      loadUrl: null,
+      error: null,
+      authInfo: {
+        authEnabled: false,
+        authStatus: false,
+        authToken: null,
+      },
+    };
+  });
+
+  const options = [
+    { value: "license1", label: "Entitlement1" },
+    { value: "license2", label: "Entitlement2" },
+    { value: "license3", label: "Entitlement3" },
+  ];
+
+  function setup(jsx) {
+    return {
+      user: userEvent.setup(),
+      ...render(jsx),
+    };
+  }
+
+  it("should render correctly", () => {
+    render(<EntitlementSelector options={options} />);
+  });
+
+  it("should render with default value selected and all options present", () => {
+    const { getByRole } = render(<EntitlementSelector options={options} />);
+
+    let comboBox = getByRole("combobox");
+    expect(comboBox.length).toBe(3);
+    expect(comboBox).toHaveValue("license1");
+    expect(getByRole("option", { name: "Entitlement1" }).selected).toBe(true);
+  });
+
+  it("should select correct value on change", async () => {
+    const { user, getByRole } = setup(
+      <EntitlementSelector options={options} />
+    );
+    let comboBox = getByRole("combobox");
+    await user.selectOptions(comboBox, "license2");
+    expect(comboBox).toHaveValue("license2");
+  });
+
+  it("should fire onClick Event for submit button without crashing", () => {
+    const { getByTestId, container, unmount } = render(<App />, {
+      initialState: initialState,
+    });
+
+    // Expecting the license selector dialog since entitlementId is not set
+    expect(
+      container.querySelector("#entitlement-selection")
+    ).toBeInTheDocument();
+    const submitButton = getByTestId("submitButton");
+    fireEvent.click(submitButton);
+
+    // re-rendering (via unmount and rendering again similar to real app) so 
+    // that the redux state (entitlementId) is updated for test App component
+    unmount();
+    render(<App />);
+    expect(
+      container.querySelector("#entitlement-selection")
+    ).not.toBeInTheDocument();
+  });
+});