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