src/store/run-process-panel/run-process-panel-actions.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { Dispatch } from 'redux';
   6 import { unionize, ofType, UnionOf } from "common/unionize";
   7 import { ServiceRepository } from "services/services";
   8 import { RootState } from 'store/store';
   9 import { getUserUuid } from "common/getuser";
  10 import { WorkflowResource, WorkflowRunnerResources, getWorkflow, getWorkflowInputs, parseWorkflowDefinition } from 'models/workflow';
  11 import { getFormValues, initialize } from 'redux-form';
  12 import { RUN_PROCESS_BASIC_FORM, RunProcessBasicFormData } from 'views/run-process-panel/run-process-basic-form';
  13 import { RUN_PROCESS_INPUTS_FORM } from 'views/run-process-panel/run-process-inputs-form';
  14 import { WorkflowInputsData } from 'models/workflow';
  15 import { createWorkflowMounts } from 'models/process';
  16 import { ContainerRequestState } from 'models/container-request';
  17 import { navigateTo } from '../navigation/navigation-action';
  18 import {
  19     RunProcessAdvancedFormData, RUN_PROCESS_ADVANCED_FORM, VCPUS_FIELD,
  20     KEEP_CACHE_RAM_FIELD, RAM_FIELD, RUNTIME_FIELD, OUTPUT_FIELD, RUNNER_IMAGE_FIELD
  21 } from 'views/run-process-panel/run-process-advanced-form';
  22 import { dialogActions } from 'store/dialog/dialog-actions';
  23 import { setBreadcrumbs } from 'store/breadcrumbs/breadcrumbs-actions';
  24
  25 export const runProcessPanelActions = unionize({
  26     SET_PROCESS_PATHNAME: ofType<string>(),
  27     SET_PROCESS_OWNER_UUID: ofType<string>(),
  28     SET_CURRENT_STEP: ofType<number>(),
  29     SET_STEP_CHANGED: ofType<boolean>(),
  30     SET_WORKFLOWS: ofType<WorkflowResource[]>(),
  31     SET_SELECTED_WORKFLOW: ofType<WorkflowResource>(),
  32     SET_WORKFLOW_PRESETS: ofType<WorkflowResource[]>(),
  33     SELECT_WORKFLOW_PRESET: ofType<WorkflowResource>(),
  34     SEARCH_WORKFLOWS: ofType<string>(),
  35     RESET_RUN_PROCESS_PANEL: ofType<{}>(),
  36 });
  37
  38 export interface RunProcessSecondStepDataFormProps {
  39     name: string;
  40     description: string;
  41 }
  42
  43 export const SET_WORKFLOW_DIALOG = 'setWorkflowDialog';
  44 export const RUN_PROCESS_SECOND_STEP_FORM_NAME = 'runProcessSecondStepFormName';
  45
  46 export type RunProcessPanelAction = UnionOf<typeof runProcessPanelActions>;
  47
  48 export const loadRunProcessPanel = () =>
  49     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
  50         try {
  51             dispatch(setBreadcrumbs([{ label: 'Run workflow' }]));
  52             const response = await services.workflowService.list();
  53             dispatch(runProcessPanelActions.SET_WORKFLOWS(response.items));
  54         } catch (e) {
  55             return;
  56         }
  57     };
  58
  59 export const openSetWorkflowDialog = (workflow: WorkflowResource) =>
  60     (dispatch: Dispatch, getState: () => RootState) => {
  61         const selectedWorkflow = getState().runProcessPanel.selectedWorkflow;
  62         const isStepChanged = getState().runProcessPanel.isStepChanged;
  63         if (isStepChanged && selectedWorkflow && selectedWorkflow.uuid !== workflow.uuid) {
  64             dispatch(dialogActions.OPEN_DIALOG({
  65                 id: SET_WORKFLOW_DIALOG,
  66                 data: {
  67                     title: 'Form will be cleared',
  68                     text: 'Changing a workflow will clean all input fields in next step.',
  69                     confirmButtonLabel: 'Change Workflow',
  70                     workflow
  71                 }
  72             }));
  73         } else {
  74             dispatch<any>(setWorkflow(workflow, false));
  75         }
  76     };
  77
  78 export const getWorkflowRunnerSettings = (workflow: WorkflowResource) => {
  79     const advancedFormValues = {};
  80     Object.assign(advancedFormValues, DEFAULT_ADVANCED_FORM_VALUES);
  81
  82     const wf = getWorkflow(parseWorkflowDefinition(workflow));
  83     const hints = wf ? wf.hints : undefined;
  84     if (hints) {
  85         const resc = hints.find(item => item.class === 'http://arvados.org/cwl#WorkflowRunnerResources') as WorkflowRunnerResources | undefined;
  86         if (resc) {
  87             if (resc.ramMin) { advancedFormValues[RAM_FIELD] = resc.ramMin * (1024 * 1024); }
  88             if (resc.coresMin) { advancedFormValues[VCPUS_FIELD] = resc.coresMin; }
  89             if (resc.keep_cache) { advancedFormValues[KEEP_CACHE_RAM_FIELD] = resc.keep_cache * (1024 * 1024); }
  90             if (resc.acrContainerImage) { advancedFormValues[RUNNER_IMAGE_FIELD] = resc.acrContainerImage; }
  91         }
  92     }
  93     return advancedFormValues;
  94 };
  95
  96 export const setWorkflow = (workflow: WorkflowResource, isWorkflowChanged = true) =>
  97     (dispatch: Dispatch<any>, getState: () => RootState) => {
  98         const isStepChanged = getState().runProcessPanel.isStepChanged;
  99
 100         const advancedFormValues = getWorkflowRunnerSettings(workflow);
 101
 102         if (isStepChanged && isWorkflowChanged) {
 103             dispatch(runProcessPanelActions.SET_STEP_CHANGED(false));
 104             dispatch(runProcessPanelActions.SET_SELECTED_WORKFLOW(workflow));
 105             dispatch<any>(loadPresets(workflow.uuid));
 106             dispatch(initialize(RUN_PROCESS_BASIC_FORM, { name: workflow.name }));
 107             dispatch(initialize(RUN_PROCESS_ADVANCED_FORM, advancedFormValues));
 108         }
 109         if (!isWorkflowChanged) {
 110             dispatch(runProcessPanelActions.SET_SELECTED_WORKFLOW(workflow));
 111             dispatch<any>(loadPresets(workflow.uuid));
 112             dispatch(initialize(RUN_PROCESS_BASIC_FORM, { name: workflow.name }));
 113             dispatch(initialize(RUN_PROCESS_ADVANCED_FORM, advancedFormValues));
 114         }
 115     };
 116
 117 export const loadPresets = (workflowUuid: string) =>
 118     async (dispatch: Dispatch<any>, _: () => RootState, { workflowService }: ServiceRepository) => {
 119         const { items } = await workflowService.presets(workflowUuid);
 120         dispatch(runProcessPanelActions.SET_WORKFLOW_PRESETS(items));
 121     };
 122
 123 export const selectPreset = (preset: WorkflowResource) =>
 124     (dispatch: Dispatch<any>) => {
 125         dispatch(runProcessPanelActions.SELECT_WORKFLOW_PRESET(preset));
 126         const inputs = getWorkflowInputs(parseWorkflowDefinition(preset)) || [];
 127         const values = inputs.reduce((values, input) => ({
 128             ...values,
 129             [input.id]: input.default,
 130         }), {});
 131         dispatch(initialize(RUN_PROCESS_INPUTS_FORM, values));
 132     };
 133
 134 export const goToStep = (step: number) =>
 135     (dispatch: Dispatch) => {
 136         if (step === 1) {
 137             dispatch(runProcessPanelActions.SET_STEP_CHANGED(true));
 138         }
 139         dispatch(runProcessPanelActions.SET_CURRENT_STEP(step));
 140     };
 141
 142 export const runProcess = async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 143     const state = getState();
 144     const basicForm = getFormValues(RUN_PROCESS_BASIC_FORM)(state) as RunProcessBasicFormData;
 145     const inputsForm = getFormValues(RUN_PROCESS_INPUTS_FORM)(state) as WorkflowInputsData;
 146     const userUuid = getUserUuid(getState());
 147     if (!userUuid) { return; }
 148     const { processOwnerUuid, selectedWorkflow } = state.runProcessPanel;
 149     const ownerUUid = processOwnerUuid ? processOwnerUuid : userUuid;
 150     if (selectedWorkflow) {
 151         const advancedForm = getFormValues(RUN_PROCESS_ADVANCED_FORM)(state) as RunProcessAdvancedFormData || getWorkflowRunnerSettings(selectedWorkflow);
 152         const newProcessData = {
 153             ownerUuid: ownerUUid,
 154             name: basicForm.name,
 155             description: basicForm.description,
 156             state: ContainerRequestState.COMMITTED,
 157             mounts: createWorkflowMounts(selectedWorkflow, normalizeInputKeys(inputsForm)),
 158             runtimeConstraints: {
 159                 API: true,
 160                 vcpus: advancedForm[VCPUS_FIELD],
 161                 ram: (advancedForm[KEEP_CACHE_RAM_FIELD] + advancedForm[RAM_FIELD]),
 162             },
 163             schedulingParameters: {
 164                 max_run_time: advancedForm[RUNTIME_FIELD]
 165             },
 166             containerImage: advancedForm[RUNNER_IMAGE_FIELD],
 167             cwd: '/var/spool/cwl',
 168             command: [
 169                 'arvados-cwl-runner',
 170                 '--api=containers',
 171                 '--local',
 172                 `--project-uuid=${ownerUUid}`,
 173                 '/var/lib/cwl/workflow.json#main',
 174                 '/var/lib/cwl/cwl.input.json'
 175             ],
 176             outputPath: '/var/spool/cwl',
 177             priority: 1,
 178             outputName: advancedForm[OUTPUT_FIELD] ? advancedForm[OUTPUT_FIELD] : `Output from ${basicForm.name}`,
 179             properties: {
 180                 template_uuid: selectedWorkflow.uuid,
 181                 workflowName: selectedWorkflow.name
 182             },
 183             useExisting: false
 184         };
 185         const newProcess = await services.containerRequestService.create(newProcessData);
 186         dispatch(navigateTo(newProcess.uuid));
 187     }
 188 };
 189
 190 const DEFAULT_ADVANCED_FORM_VALUES: Partial<RunProcessAdvancedFormData> = {
 191     [VCPUS_FIELD]: 1,
 192     [RAM_FIELD]: 1073741824,
 193     [KEEP_CACHE_RAM_FIELD]: 268435456,
 194     [RUNNER_IMAGE_FIELD]: "arvados/jobs"
 195 };
 196
 197 const normalizeInputKeys = (inputs: WorkflowInputsData): WorkflowInputsData =>
 198     Object.keys(inputs).reduce((normalizedInputs, key) => ({
 199         ...normalizedInputs,
 200         [key.split('/').slice(1).join('/')]: inputs[key],
 201     }), {});
 202 export const searchWorkflows = (term: string) => runProcessPanelActions.SEARCH_WORKFLOWS(term);