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, 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 { RunProcessAdvancedFormData, RUN_PROCESS_ADVANCED_FORM, VCPUS_FIELD, RAM_FIELD, RUNTIME_FIELD, OUTPUT_FIELD, API_FIELD } from '~/views/run-process-panel/run-process-advanced-form';
  19 import { dialogActions } from '~/store/dialog/dialog-actions';
  20 import { setBreadcrumbs } from '~/store/breadcrumbs/breadcrumbs-actions';
  21 import { matchProjectRoute } from '~/routes/routes';
  22
  23 export const runProcessPanelActions = unionize({
  24     SET_PROCESS_PATHNAME: ofType<string>(),
  25     SET_PROCESS_OWNER_UUID: ofType<string>(),
  26     SET_CURRENT_STEP: ofType<number>(),
  27     SET_STEP_CHANGED: ofType<boolean>(),
  28     SET_WORKFLOWS: ofType<WorkflowResource[]>(),
  29     SET_SELECTED_WORKFLOW: ofType<WorkflowResource>(),
  30     SET_WORKFLOW_PRESETS: ofType<WorkflowResource[]>(),
  31     SELECT_WORKFLOW_PRESET: ofType<WorkflowResource>(),
  32     SEARCH_WORKFLOWS: ofType<string>(),
  33     RESET_RUN_PROCESS_PANEL: ofType<{}>(),
  34 });
  35
  36 export interface RunProcessSecondStepDataFormProps {
  37     name: string;
  38     description: string;
  39 }
  40
  41 export const SET_WORKFLOW_DIALOG = 'setWorkflowDialog';
  42 export const RUN_PROCESS_SECOND_STEP_FORM_NAME = 'runProcessSecondStepFormName';
  43
  44 export type RunProcessPanelAction = UnionOf<typeof runProcessPanelActions>;
  45
  46 export const loadRunProcessPanel = () =>
  47     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
  48         try {
  49             dispatch(setBreadcrumbs([{ label: 'Run Process' }]));
  50             const response = await services.workflowService.list();
  51             dispatch(runProcessPanelActions.SET_WORKFLOWS(response.items));
  52         } catch (e) {
  53             return;
  54         }
  55     };
  56
  57 export const openSetWorkflowDialog = (workflow: WorkflowResource) =>
  58     (dispatch: Dispatch, getState: () => RootState) => {
  59         const selectedWorkflow = getState().runProcessPanel.selectedWorkflow;
  60         const isStepChanged = getState().runProcessPanel.isStepChanged;
  61         if (isStepChanged && selectedWorkflow && selectedWorkflow.uuid !== workflow.uuid) {
  62             dispatch(dialogActions.OPEN_DIALOG({
  63                 id: SET_WORKFLOW_DIALOG,
  64                 data: {
  65                     title: 'Form will be cleared',
  66                     text: 'Changing a workflow will clean all input fields in next step.',
  67                     confirmButtonLabel: 'Change Workflow',
  68                     workflow
  69                 }
  70             }));
  71         } else {
  72             dispatch<any>(setWorkflow(workflow, false));
  73         }
  74     };
  75
  76 export const setWorkflow = (workflow: WorkflowResource, isWorkflowChanged = true) =>
  77     (dispatch: Dispatch<any>, getState: () => RootState) => {
  78         const isStepChanged = getState().runProcessPanel.isStepChanged;
  79         if (isStepChanged && isWorkflowChanged) {
  80             dispatch(runProcessPanelActions.SET_STEP_CHANGED(false));
  81             dispatch(runProcessPanelActions.SET_SELECTED_WORKFLOW(workflow));
  82             dispatch<any>(loadPresets(workflow.uuid));
  83             dispatch(initialize(RUN_PROCESS_ADVANCED_FORM, DEFAULT_ADVANCED_FORM_VALUES));
  84         }
  85         if (!isWorkflowChanged) {
  86             dispatch(runProcessPanelActions.SET_SELECTED_WORKFLOW(workflow));
  87             dispatch<any>(loadPresets(workflow.uuid));
  88             dispatch(initialize(RUN_PROCESS_ADVANCED_FORM, DEFAULT_ADVANCED_FORM_VALUES));
  89         }
  90     };
  91
  92 export const loadPresets = (workflowUuid: string) =>
  93     async (dispatch: Dispatch<any>, _: () => RootState, { workflowService }: ServiceRepository) => {
  94         const { items } = await workflowService.presets(workflowUuid);
  95         dispatch(runProcessPanelActions.SET_WORKFLOW_PRESETS(items));
  96     };
  97
  98 export const selectPreset = (preset: WorkflowResource) =>
  99     (dispatch: Dispatch<any>) => {
 100         dispatch(runProcessPanelActions.SELECT_WORKFLOW_PRESET(preset));
 101         const inputs = getWorkflowInputs(parseWorkflowDefinition(preset)) || [];
 102         const values = inputs.reduce((values, input) => ({
 103             ...values,
 104             [input.id]: input.default,
 105         }), {});
 106         dispatch(initialize(RUN_PROCESS_INPUTS_FORM, values));
 107     };
 108
 109 export const goToStep = (step: number) =>
 110     (dispatch: Dispatch) => {
 111         if (step === 1) {
 112             dispatch(runProcessPanelActions.SET_STEP_CHANGED(true));
 113         }
 114         dispatch(runProcessPanelActions.SET_CURRENT_STEP(step));
 115     };
 116
 117 export const runProcess = async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 118     const state = getState();
 119     const basicForm = getFormValues(RUN_PROCESS_BASIC_FORM)(state) as RunProcessBasicFormData;
 120     const inputsForm = getFormValues(RUN_PROCESS_INPUTS_FORM)(state) as WorkflowInputsData;
 121     const advancedForm = getFormValues(RUN_PROCESS_ADVANCED_FORM)(state) as RunProcessAdvancedFormData || DEFAULT_ADVANCED_FORM_VALUES;
 122     const userUuid = getUserUuid(getState());
 123     if (!userUuid) { return; }
 124     const pathname = getState().runProcessPanel.processPathname;
 125     const { processOwnerUuid, selectedWorkflow } = state.runProcessPanel;
 126     const ownerUUid = !matchProjectRoute(pathname) ? userUuid : processOwnerUuid;
 127     if (selectedWorkflow) {
 128         const newProcessData = {
 129             ownerUuid: ownerUUid,
 130             name: basicForm.name,
 131             description: basicForm.description,
 132             state: ContainerRequestState.COMMITTED,
 133             mounts: createWorkflowMounts(selectedWorkflow, normalizeInputKeys(inputsForm)),
 134             runtimeConstraints: {
 135                 API: true,
 136                 vcpus: advancedForm[VCPUS_FIELD],
 137                 ram: advancedForm[RAM_FIELD],
 138                 api: advancedForm[API_FIELD],
 139             },
 140             schedulingParameters: {
 141                 max_run_time: advancedForm[RUNTIME_FIELD]
 142             },
 143             containerImage: 'arvados/jobs',
 144             cwd: '/var/spool/cwl',
 145             command: [
 146                 'arvados-cwl-runner',
 147                 '--api=containers',
 148                 '--local',
 149                 `--project-uuid=${ownerUUid}`,
 150                 '/var/lib/cwl/workflow.json#main',
 151                 '/var/lib/cwl/cwl.input.json'
 152             ],
 153             outputPath: '/var/spool/cwl',
 154             priority: 1,
 155             outputName: advancedForm[OUTPUT_FIELD] ? advancedForm[OUTPUT_FIELD] : undefined,
 156             properties: {
 157                 workflowUuid: selectedWorkflow.uuid,
 158                 workflowName: selectedWorkflow.name
 159             }
 160         };
 161         const newProcess = await services.containerRequestService.create(newProcessData);
 162         dispatch(navigateTo(newProcess.uuid));
 163     }
 164 };
 165
 166 export const DEFAULT_ADVANCED_FORM_VALUES: Partial<RunProcessAdvancedFormData> = {
 167     [VCPUS_FIELD]: 1,
 168     [RAM_FIELD]: 1073741824,
 169     [API_FIELD]: true,
 170 };
 171
 172 const normalizeInputKeys = (inputs: WorkflowInputsData): WorkflowInputsData =>
 173     Object.keys(inputs).reduce((normalizedInputs, key) => ({
 174         ...normalizedInputs,
 175         [key.split('/').slice(1).join('/')]: inputs[key],
 176     }), {});
 177 export const searchWorkflows = (term: string) => runProcessPanelActions.SEARCH_WORKFLOWS(term);