Introduces environment variable MWI_SHUTDOWN_ON_IDLE_TIMEOUT to specify the idle time after which matlab-proxy will shutdown. See [Advanced-Usage.md](https://github.com/mathworks/matlab-proxy/blob/main/Advanced-Usage.md) for more information.

fixes #10

Author: diningPhilosopher64

Advanced-Usage.md

@@ -32,6 +32,22 @@ The following table describes all the environment variables that you can set to
 | **MWI_CUSTOM_MATLAB_ROOT** | string (optional) | `"/path/to/matlab/root/"` | Optionally, provide a custom path to MATLAB root. For more information see [Adding MATLAB to System Path](#adding-matlab-to-system-path) |
 | **MWI_PROCESS_START_TIMEOUT** | integer (optional) | `1234` |  This field controls the time (in seconds) for which `matlab-proxy` waits for the processes it spins up, viz: MATLAB & Xvfb, to respond. By default, this value is `600 seconds`. A timeout could either indicate an issue with the spawned processes or be a symptom of a resource-constrained environment. Increase this value if your environment needs more time for the spawned processes to start.|
 | **MWI_MATLAB_STARTUP_SCRIPT** | string (optional) | `"addpath('/path/to/a/folder'), c=12"` | Executes string provided at MATLAB startup. For details, see [Run Custom MATLAB Startup Code](#run-custom-matlab-startup-code) |
+| **MWI_SHUTDOWN_ON_IDLE_TIMEOUT** | integer (optional) | 60 | Defines the duration in minutes, that `matlab-proxy` remains idle before shutting down. When you do not set the variable, `matlab-proxy` will not shutdown when idle. For details, [see Shutdown on Idle](#shutdown-on-idle).
+
+## Shutdown on Idle
+
+Set the environment variable `MWI_SHUTDOWN_ON_IDLE_TIMEOUT` to the number of minutes with no user activity after which matlab-proxy will shutdown.
+
+This timer resets when we detect:
+* Usage of MATLAB from the Desktop
+* Execution of MATLAB code
+* Execution of MATLAB code from jupyter notebooks
+
+<p align="center">
+  <img width="800" src="./img/shutdown_warning.png">
+</p>
+
+Use this environment variable to clean up idle system resources.
 
 ## Adding MATLAB to System Path
 

bla.py

@@ -0,0 +1,16 @@
+def example_function():
+    try:
+        # Some code that may raise an exception
+        x = 1 / 0
+    except ZeroDivisionError:
+        print("Caught ZeroDivisionError")
+
+    print("This should not print if OSError is raised")
+
+
+try:
+    example_function()
+except OSError as e:
+    print(f"Caught an OSError: {e}")
+
+print("Execution continues here if OSError is caught")

gui/package-lock.json

@@ -6,6 +6,7 @@
     "clsx": "^1.1.1",
     "cross-fetch": "^3.0.6",
     "crypto-js": "4.2.0",
+    "postcss": "^8.4.38",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
     "react-draggable": "^4.4.3",
@@ -16,7 +17,8 @@
     "react-use": "^15.3.4",
     "redux": "^4.0.5",
     "redux-thunk": "^2.3.0",
-    "reselect": "^4.0.0"
+    "reselect": "^4.0.0",
+    "resolve-url-loader": "^5.0.0"
   },
   "scripts": {
     "start": "react-scripts start",

gui/package.json

@@ -36,7 +36,7 @@ describe.each([
     [actionCreators.requestSetLicensing, { type: actions.REQUEST_SET_LICENSING }],
     [actionCreators.requestStopMatlab, { type: actions.REQUEST_STOP_MATLAB, status: 'stopping' }],
     [actionCreators.requestStartMatlab, { type: actions.REQUEST_START_MATLAB, status: 'starting' }],
-    [actionCreators.requestTerminateIntegration, { type: actions.REQUEST_TERMINATE_INTEGRATION }]
+    [actionCreators.requestShutdownIntegration, { type: actions.REQUEST_SHUTDOWN_INTEGRATION }]
 ])('Test Request actionCreators', (method, expectedAction) => {
     test(`check if an action of type  ${expectedAction.type} is returned when method actionCreator.${method.name}() is called`, () => {
         expect(method()).toEqual(expectedAction);
@@ -48,7 +48,7 @@ describe.each([
     [actionCreators.receiveStopMatlab, { matlabStatus: 'down' }, { type: actions.RECEIVE_STOP_MATLAB, status: { matlabStatus: 'down' } }],
     [actionCreators.receiveStartMatlab, { matlabStatus: 'up' }, { type: actions.RECEIVE_START_MATLAB, status: { matlabStatus: 'up' } }],
     [actionCreators.receiveError, { message: 'ERROR: License Manager Error -9', logs: null }, { type: actions.RECEIVE_ERROR, error: { message: 'ERROR: License Manager Error -9', logs: null } }],
-    [actionCreators.receiveTerminateIntegration, { licensing: {} }, { type: actions.RECEIVE_TERMINATE_INTEGRATION, status: { licensing: {} }, loadUrl: '../' }]
+    [actionCreators.requestShutdownIntegration, {}, { type: actions.REQUEST_SHUTDOWN_INTEGRATION }]
 ])('Test Receive actionCreators', (method, input, expectedAction) => {
     test(`check if an action of type  ${expectedAction.type} is returned when method actionCreator.${method.name}() is called`, () => {
         expect(method(input)).toEqual(expectedAction);
@@ -429,32 +429,6 @@ describe('Test Async actionCreators', () => {
         });
     });
 
-    it('should dispatch REQUEST_TERMINATE_INTEGRATION and RECEIVE_TERMINATE_INTEGRATION when we terminate the integration', () => {
-        fetchMock.deleteOnce('./terminate_integration', {
-            body: {
-                matlab: {
-                    status: 'down'
-                },
-                licensing: null
-            },
-            headers: { 'content-type': 'application/json' }
-        });
-
-        const expectedActionTypes = [
-            actions.REQUEST_TERMINATE_INTEGRATION,
-            actions.RECEIVE_TERMINATE_INTEGRATION
-        ];
-
-        return store
-            .dispatch(actionCreators.fetchTerminateIntegration())
-            .then(() => {
-                const receivedActions = store.getActions();
-                expect(receivedActions.map((action) => action.type)).toEqual(
-                    expectedActionTypes
-                );
-            });
-    });
-
     it('should dispatch REQUEST_STOP_MATLAB AND RECEIVE_STOP_MATLAB when we stop matlab', () => {
         fetchMock.putOnce('./start_matlab', {
             body: {

gui/src/actionCreators/actionCreators.spec.js

@@ -8,13 +8,13 @@ import {
     RECEIVE_SERVER_STATUS,
     REQUEST_SET_LICENSING,
     REQUEST_UPDATE_LICENSING,
-    REQUEST_TERMINATE_INTEGRATION,
+    REQUEST_SHUTDOWN_INTEGRATION,
     REQUEST_STOP_MATLAB,
     REQUEST_START_MATLAB,
     REQUEST_ENV_CONFIG,
     RECEIVE_SET_LICENSING,
     RECEIVE_UPDATE_LICENSING,
-    RECEIVE_TERMINATE_INTEGRATION,
+    RECEIVE_SHUTDOWN_INTEGRATION,
     RECEIVE_STOP_MATLAB,
     RECEIVE_START_MATLAB,
     RECEIVE_ERROR,
@@ -162,15 +162,15 @@ export function receiveUpdateLicensing (status) {
     };
 }
 
-export function requestTerminateIntegration () {
+export function requestShutdownIntegration () {
     return {
-        type: REQUEST_TERMINATE_INTEGRATION
+        type: REQUEST_SHUTDOWN_INTEGRATION
     };
 }
 
-export function receiveTerminateIntegration (status) {
+export function receiveShutdownIntegration (status) {
     return {
-        type: RECEIVE_TERMINATE_INTEGRATION,
+        type: RECEIVE_SHUTDOWN_INTEGRATION,
         status,
         loadUrl: '../'
     };
@@ -374,7 +374,7 @@ export function fetchUnsetLicensing () {
     };
 }
 
-export function fetchTerminateIntegration () {
+export function fetchShutdownIntegration () {
     return async function (dispatch, getState) {
         const options = {
             method: 'DELETE',
@@ -383,10 +383,10 @@ export function fetchTerminateIntegration () {
             credentials: 'same-origin'
         };
 
-        dispatch(requestTerminateIntegration());
-        const response = await fetchWithTimeout(dispatch, './terminate_integration', options, 15000);
+        dispatch(requestShutdownIntegration());
+        const response = await fetchWithTimeout(dispatch, './shutdown_integration', options, 15000);
         const data = await response.json();
-        dispatch(receiveTerminateIntegration(data));
+        dispatch(receiveShutdownIntegration(data));
     };
 }