From 413d96e8c4e42620ff6aeccd4d7bed318b80a4d9 Mon Sep 17 00:00:00 2001
From: yshepilov <buggygm@gmail.com>
Date: Fri, 17 Feb 2023 16:20:20 +0100
Subject: [PATCH] #362 added possibility to enable scheduling via admin UI

---
 src/model/script_config.py                    |   1 +
 .../scripts-config/ScriptConfig.vue           |   2 +-
 .../scripts-config/ScriptConfigForm.vue       | 121 ++++++++++++------
 .../scripts-config/script-fields.js           |  11 ++
 .../materializecss/material-checkboxes.css    |   2 +-
 web-src/src/common/components/checkbox.vue    |  14 +-
 web-src/src/common/utils/common.js            |   1 +
 web-src/src/login/login.js                    |   2 -
 .../scripts/script-parameters-view.vue        |  18 ++-
 web-src/tests/unit/admin/ScriptConfig_test.js | 110 +++++++++++++++-
 10 files changed, 233 insertions(+), 49 deletions(-)

diff --git a/src/model/script_config.py b/src/model/script_config.py
index 6f9eac1a..1f89c1ae 100644
--- a/src/model/script_config.py
+++ b/src/model/script_config.py
@@ -418,6 +418,7 @@ def get_sorted_config(config):
                  'output_files',
                  'requires_terminal',
                  'output_format',
+                 'scheduling',
                  'parameters']
 
     def get_order(key):
diff --git a/web-src/src/admin/components/scripts-config/ScriptConfig.vue b/web-src/src/admin/components/scripts-config/ScriptConfig.vue
index 9c05d78d..c42b7461 100644
--- a/web-src/src/admin/components/scripts-config/ScriptConfig.vue
+++ b/web-src/src/admin/components/scripts-config/ScriptConfig.vue
@@ -62,7 +62,7 @@ export default {
   height: 100%;
 }
 
-.script-config h5 {
+.script-config >>> h5 {
   margin-left: 0.75rem;
   margin-top: 0.5rem;
   margin-bottom: 2rem;
diff --git a/web-src/src/admin/components/scripts-config/ScriptConfigForm.vue b/web-src/src/admin/components/scripts-config/ScriptConfigForm.vue
index 5f8ddd78..ad6d2f2b 100644
--- a/web-src/src/admin/components/scripts-config/ScriptConfigForm.vue
+++ b/web-src/src/admin/components/scripts-config/ScriptConfigForm.vue
@@ -12,25 +12,6 @@
     <div class="row">
       <TextArea v-model="description" :config="descriptionField" class="col s12"/>
     </div>
-    <div class="row">
-      <div v-if="allowAllUsers" class="input-field col s9">
-        <input id="allowed_users_disabled" disabled type="text" value="All users">
-        <label class="active" for="allowed_users_disabled">Allowed users</label>
-      </div>
-      <ChipsList v-else v-model="allowedUsers" class="col s9" title="Allowed users"/>
-      <CheckBox v-model="allowAllUsers" :config="allowAllField"
-                class="col s2 offset-s1 checkbox-field"/>
-    </div>
-
-    <div class="row">
-      <div v-if="allowAllAdmins" class="input-field col s9">
-        <input id="admin_users_disabled" disabled type="text" value="Any admin">
-        <label class="active" for="admin_users_disabled">Admin users</label>
-      </div>
-      <ChipsList v-else v-model="adminUsers" class="col s9" title="Admin users"/>
-      <CheckBox v-model="allowAllAdmins" :config="allowAllAdminsField"
-                class="col s2 offset-s1 checkbox-field"/>
-    </div>
 
     <div class="row">
       <Combobox v-model="outputFormat" :config="outputFormatField" class="col s3"/>
@@ -39,16 +20,56 @@
       <TextField v-model="includeScript" :config="includeScriptField" class="col s5 offset-s1"/>
     </div>
 
-    <div class="row">
-      <CheckBox v-model="globalInstances" :config="globalInstancesField"
-                class="col s3 checkbox-field"/>
+    <div>
+      <h5>Access</h5>
+      <div class="row">
+        <div v-if="allowAllUsers" class="input-field col s9">
+          <input id="allowed_users_disabled" disabled type="text" value="All users">
+          <label class="active" for="allowed_users_disabled">Allowed users</label>
+        </div>
+        <ChipsList v-else v-model="allowedUsers" class="col s9" title="Allowed users"/>
+        <CheckBox v-model="allowAllUsers" :config="allowAllField"
+                  class="col s2 offset-s1 checkbox-field"/>
+      </div>
+      <div class="row">
+        <div v-if="allowAllAdmins" class="input-field col s9">
+          <input id="admin_users_disabled" disabled type="text" value="Any admin">
+          <label class="active" for="admin_users_disabled">Admin users</label>
+        </div>
+        <ChipsList v-else v-model="adminUsers" class="col s9" title="Admin users"/>
+        <CheckBox v-model="allowAllAdmins" :config="allowAllAdminsField"
+                  class="col s2 offset-s1 checkbox-field"/>
+      </div>
+      <div class="row">
+        <CheckBox v-model="globalInstances" :config="globalInstancesField"
+                  class="col s3 checkbox-field"/>
+      </div>
     </div>
+
+    <div>
+      <h5>Scheduling</h5>
+      <div class="row">
+        <div class="col s12">This section allows users to schedule scripts to be executed in the future.</div>
+      </div>
+      <div class="row">
+        <CheckBox v-model="schedulingEnabled" :config="schedulingEnabledField"
+                  class="col s3 checkbox-field"/>
+        <CheckBox v-model="schedulingAutoCleanup" :config="schedulingAutoCleanupField"
+                  :disabled="schedulingAutoCleanupDisabled || !schedulingEnabled"
+                  class="col s3 checkbox-field"/>
+      </div>
+    </div>
+
   </form>
 </template>
 
 <script>
+import ScriptPathField from '@/admin/components/scripts-config/script-edit/ScriptField'
+import {allowAllAdminsField} from '@/admin/components/scripts-config/script-fields';
+import {NEW_SCRIPT} from '@/admin/store/script-config-module'
 import CheckBox from '@/common/components/checkbox';
 import ChipsList from '@/common/components/ChipsList';
+import Combobox from '@/common/components/combobox'
 import TextArea from '@/common/components/TextArea';
 import TextField from '@/common/components/textfield'
 import {forEachKeyValue, isEmptyArray, isEmptyString, isNull} from '@/common/utils/common';
@@ -56,19 +77,17 @@ import get from 'lodash/get';
 import {
   allowAllField,
   descriptionField,
+  globalInstancesField,
   groupField,
   includeScriptField,
   nameField,
   outputFormatField,
   requiresTerminalField,
-  globalInstancesField,
+  schedulingAutoCleanupField,
+  schedulingEnabledField,
   scriptPathField,
   workDirField
 } from './script-fields';
-import {allowAllAdminsField} from '@/admin/components/scripts-config/script-fields';
-import Combobox from '@/common/components/combobox'
-import ScriptPathField from '@/admin/components/scripts-config/script-edit/ScriptField'
-import {NEW_SCRIPT} from '@/admin/store/script-config-module'
 
 
 export default {
@@ -93,6 +112,9 @@ export default {
       workingDirectory: null,
       requiresTerminal: null,
       globalInstances: null,
+      schedulingEnabled: null,
+      schedulingAutoCleanup: null,
+      schedulingAutoCleanupDisabled: null,
       includeScript: null,
       outputFormat: null,
       allowedUsers: [],
@@ -109,6 +131,8 @@ export default {
       outputFormatField,
       requiresTerminalField,
       globalInstancesField,
+      schedulingEnabledField,
+      schedulingAutoCleanupField,
       includeScriptField
     }
   },
@@ -133,15 +157,6 @@ export default {
         }
       });
     });
-
-    this.$watch('globalInstances', (globalInstances) => {
-      if (globalInstances) {
-        this.$set(this.value, 'access', {'shared_access': {'type': 'ALL_USERS'}});
-      } else {
-        this.$delete(this.value, 'access');
-      }
-    });
-
   },
 
   watch: {
@@ -153,12 +168,14 @@ export default {
         this.description = config['description'];
         this.workingDirectory = config['working_directory'];
         this.requiresTerminal = get(config, 'requires_terminal', true);
-        this.globalInstances = false;
-        if (config?.access?.shared_access?.type == "ALL_USERS"){
-          this.globalInstances = true;
-        }
+        this.globalInstances = config?.access?.shared_access?.type === 'ALL_USERS';
         this.includeScript = config['include'];
         this.outputFormat = config['output_format'];
+
+        this.schedulingEnabled = config.scheduling?.enabled === true
+        this.schedulingAutoCleanupDisabled = !isEmptyArray(config['output_files'])
+        this.schedulingAutoCleanup = this.schedulingAutoCleanupDisabled ? false : config.scheduling?.['auto_cleanup']
+
         this.updateAccessFieldInVm(config,
             'allowedUsers',
             'allowAllUsers',
@@ -180,6 +197,19 @@ export default {
     },
     adminUsers() {
       this.updateAdminUsers();
+    },
+    globalInstances() {
+      if (this.globalInstances) {
+        this.$set(this.value, 'access', {'shared_access': {'type': 'ALL_USERS'}});
+      } else {
+        this.$delete(this.value, 'access');
+      }
+    },
+    schedulingEnabled() {
+      this.updateScheduling()
+    },
+    schedulingAutoCleanup() {
+      this.updateScheduling()
     }
   },
 
@@ -217,6 +247,17 @@ export default {
       }
       this[vmPropertyName] = users.filter(u => u !== '*');
       this[vmAllowAllPropertyName] = isNull(config[valuePropertyName]) || users.includes('*');
+    },
+    updateScheduling() {
+      if (this.schedulingEnabled) {
+        const schedulingConf = {'enabled': this.schedulingEnabled}
+        if (!isNull(this.schedulingAutoCleanup) && (!this.schedulingAutoCleanupDisabled)) {
+          schedulingConf['auto_cleanup'] = this.schedulingAutoCleanup
+        }
+        this.$set(this.value, 'scheduling', schedulingConf)
+      } else {
+        this.$delete(this.value, 'scheduling')
+      }
     }
   }
 }
diff --git a/web-src/src/admin/components/scripts-config/script-fields.js b/web-src/src/admin/components/scripts-config/script-fields.js
index 2a5b5186..d1b265bd 100644
--- a/web-src/src/admin/components/scripts-config/script-fields.js
+++ b/web-src/src/admin/components/scripts-config/script-fields.js
@@ -40,4 +40,15 @@ export const includeScriptField = {
 export const globalInstancesField = {
     name: 'Shared Script Instances',
     description: 'Allows script instances to be shared by all users'
+};
+
+export const schedulingEnabledField = {
+    name: 'Enabled',
+    description: 'Enables possibility to schedule scripts'
+};
+
+export const schedulingAutoCleanupField = {
+    name: 'Auto cleanup',
+    description: 'Mark finished scripts as seen by user, i.e. remove from active tabs. '
+        + 'Always disabled when output_files are specified'
 };
\ No newline at end of file
diff --git a/web-src/src/assets/css/materializecss/material-checkboxes.css b/web-src/src/assets/css/materializecss/material-checkboxes.css
index 19e5ef81..918f29b0 100644
--- a/web-src/src/assets/css/materializecss/material-checkboxes.css
+++ b/web-src/src/assets/css/materializecss/material-checkboxes.css
@@ -1,4 +1,4 @@
-.script-server [type=checkbox]:not(:checked):disabled + span:not(.lever):before {
+.script-server [type=checkbox]:not(:checked):not(:indeterminate):disabled + span:not(.lever):before {
     background: none;
     border: 2px solid var(--font-color-disabled);
 }
\ No newline at end of file
diff --git a/web-src/src/common/components/checkbox.vue b/web-src/src/common/components/checkbox.vue
index b45be4ae..30dc428a 100644
--- a/web-src/src/common/components/checkbox.vue
+++ b/web-src/src/common/components/checkbox.vue
@@ -4,20 +4,24 @@
            ref="checkbox"
            :checked="boolValue"
            type="checkbox"
+           :disabled="disabled"
            @input="emitValueChange"/>
     <span>{{ config.name }}</span>
   </label>
 </template>
 
 <script>
-import {toBoolean} from '@/common/utils/common';
+import {isNull, toBoolean} from '@/common/utils/common';
 
 export default {
   props: {
     'value': {
       type: [Boolean, String, Number]
     },
-    'config': Object
+    'config': Object,
+    'disabled': {
+      type: [Boolean]
+    }
   },
 
   computed: {
@@ -27,11 +31,17 @@ export default {
   },
 
   mounted: function () {
+    this.$refs.checkbox.indeterminate = isNull(this.value)
     this.emitValueChange();
   },
 
   methods: {
     emitValueChange() {
+      if (this.$refs.checkbox.indeterminate) {
+        this.$emit('input', undefined);
+        return;
+      }
+
       this.$emit('input', this.$refs.checkbox.checked);
     }
   },
diff --git a/web-src/src/common/utils/common.js b/web-src/src/common/utils/common.js
index a27f0565..b254f117 100644
--- a/web-src/src/common/utils/common.js
+++ b/web-src/src/common/utils/common.js
@@ -396,6 +396,7 @@ export function setInputValue(inputField, value, triggerEvent) {
 
     if (inputField.type === 'checkbox') {
         inputField.checked = value;
+        inputField.indeterminate = isNull(value)
     } else {
         inputField.value = value;
     }
diff --git a/web-src/src/login/login.js b/web-src/src/login/login.js
index 084f944d..6a9e08f2 100644
--- a/web-src/src/login/login.js
+++ b/web-src/src/login/login.js
@@ -124,8 +124,6 @@ function processCurrentOauthState() {
     var queryStateToken = getQueryParameter('state');
     if (oauthState || oauthResponseCode) {
         if (!oauthState && oauthResponseCode) {
-            console.log('oauth_state=' + oauthState);
-            console.log('oauthResponseCode=' + oauthResponseCode);
             showError('Invalid client state. Please try to relogin');
             return;
         }
diff --git a/web-src/src/main-app/components/scripts/script-parameters-view.vue b/web-src/src/main-app/components/scripts/script-parameters-view.vue
index c47dc56c..1ebe7794 100644
--- a/web-src/src/main-app/components/scripts/script-parameters-view.vue
+++ b/web-src/src/main-app/components/scripts/script-parameters-view.vue
@@ -5,7 +5,7 @@
           :is="getComponentType(parameter)"
           :key="parameter.name"
           :config="parameter"
-          :value="parameterValues[parameter.name]"
+          :value="getParameterValue(parameter)"
           :class="{'inline': isInline(parameter)}"
           class="parameter"
           :forceValue="forcedValueParameters.includes(parameter.name)"
@@ -20,10 +20,11 @@ import Checkbox from '@/common/components/checkbox'
 import Combobox from '@/common/components/combobox'
 import FileUpload from '@/common/components/file_upload'
 import ServerFileField from '@/common/components/server_file_field'
+import TextArea from '@/common/components/TextArea'
 import Textfield from '@/common/components/textfield'
+import {isNull} from '@/common/utils/common';
 import {mapActions, mapState} from 'vuex'
 import {comboboxTypes, isRecursiveFileParameter} from '../../utils/model_helper'
-import TextArea from '@/common/components/TextArea'
 
 export default {
   name: 'script-parameters-view',
@@ -69,6 +70,19 @@ export default {
 
     setParameterValue(parameterName, value) {
       this.setParameterValueInStore({parameterName, value});
+    },
+
+    getParameterValue(parameter) {
+      const value = this.parameterValues[parameter.name];
+      if (!isNull(value)) {
+        return value;
+      }
+
+      if (parameter.withoutValue) {
+        return false;
+      }
+
+      return value;
     }
   }
 }
diff --git a/web-src/tests/unit/admin/ScriptConfig_test.js b/web-src/tests/unit/admin/ScriptConfig_test.js
index 31a85bfd..a194af74 100644
--- a/web-src/tests/unit/admin/ScriptConfig_test.js
+++ b/web-src/tests/unit/admin/ScriptConfig_test.js
@@ -58,7 +58,7 @@ describe('Test ScriptConfig', function () {
     };
 
     async function _setValueByUser(fieldName, value) {
-        const form = configComponent.find(ScriptConfigForm);
+        const form = configComponent.findComponent(ScriptConfigForm);
         await setValueByUser(form.vm, fieldName, value);
     }
 
@@ -86,6 +86,82 @@ describe('Test ScriptConfig', function () {
 
             expect(configComponent.get('.path-textfield input').element.value).toBe('ping')
         });
+
+        async function runSchedulingConfigTest(
+            config,
+            expectedEnabled,
+            expectedAutoCleanup,
+            expectedCleanupDisabled,
+            expectedValue) {
+            store.state.scriptConfig.scriptConfig = config;
+
+            await vueTicks();
+
+            expect(_findField('Enabled').value).toBe(expectedEnabled)
+            expect(_findField('Auto cleanup').value).toBe(expectedAutoCleanup)
+            expect(_findField('Auto cleanup').disabled).toBe(expectedCleanupDisabled)
+
+            expect(store.state.scriptConfig.scriptConfig.scheduling).toEqual(expectedValue)
+        }
+
+        it('Test show scheduling when no config', async function () {
+            await runSchedulingConfigTest(
+                {},
+                false,
+                undefined,
+                true,
+                undefined
+            )
+        })
+
+        it('Test show scheduling when empty config', async function () {
+            await runSchedulingConfigTest(
+                {
+                    'scheduling': {}
+                },
+                false,
+                undefined,
+                true,
+                {}
+            )
+        })
+
+        it('Test show scheduling when enabled', async function () {
+            await runSchedulingConfigTest(
+                {
+                    'scheduling': {'enabled': true}
+                },
+                true,
+                undefined,
+                false,
+                {'enabled': true}
+            )
+        })
+
+        it('Test show scheduling when enabled and auto_cleanup', async function () {
+            await runSchedulingConfigTest(
+                {
+                    'scheduling': {'enabled': true, 'auto_cleanup': true}
+                },
+                true,
+                true,
+                false,
+                {'enabled': true, 'auto_cleanup': true}
+            )
+        })
+
+        it('Test show scheduling when enabled and auto_cleanup and output_files', async function () {
+            await runSchedulingConfigTest(
+                {
+                    'scheduling': {'enabled': true, 'auto_cleanup': true},
+                    'output_files': ['test']
+                },
+                true,
+                false,
+                true,
+                {'enabled': true}
+            )
+        })
     });
 
     describe('Test edit config', function () {
@@ -170,4 +246,36 @@ describe('Test ScriptConfig', function () {
         });
     });
 
+    describe('Test edit scheduling', function () {
+        it('Test set enabled true', async function () {
+            store.state.scriptConfig.scriptConfig = {};
+
+            await vueTicks();
+
+            await _setValueByUser('Enabled', true);
+
+            expect(store.state.scriptConfig.scriptConfig.scheduling).toEqual({'enabled': true});
+        });
+
+        it('Test set enabled false', async function () {
+            store.state.scriptConfig.scriptConfig = {'scheduling': {'enabled': true, 'auto_cleanup': true}};
+
+            await vueTicks();
+
+            await _setValueByUser('Enabled', false)
+
+            expect(store.state.scriptConfig.scriptConfig.scheduling).toBeNil()
+        });
+
+        it('Test set auto cleanup enabled', async function () {
+            store.state.scriptConfig.scriptConfig = {'scheduling': {'enabled': true}}
+
+            await vueTicks()
+
+            await _setValueByUser('Auto cleanup', true)
+
+            expect(store.state.scriptConfig.scriptConfig.scheduling).toEqual({'enabled': true, 'auto_cleanup': true})
+        });
+    });
+
 });
\ No newline at end of file