Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Task/WP-211: In app form add target path text input for every file input #845

Closed
wants to merge 17 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 51 additions & 10 deletions client/src/components/Applications/AppForm/AppForm.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@ import { Link } from 'react-router-dom';
import { getSystemName } from 'utils/systems';
import FormSchema from './AppFormSchema';
import {
checkAndSetDefaultTargetPath,
isTargetPathField,
getInputFieldFromTargetPathField,
getQueueMaxMinutes,
getMaxMinutesValidation,
getNodeCountValidation,
getCoresPerNodeValidation,
getTargetPathFieldName,
updateValuesForQueue,
} from './AppFormUtils';
import DataFilesSelectModal from '../../DataFiles/DataFilesModals/DataFilesSelectModal';
Expand Down Expand Up @@ -467,9 +471,39 @@ export const AppSchemaForm = ({ app }) => {
appFields.fileInputs[k].readOnly
)
return;
return { name: k, sourceUrl: v };
return {
name: k,
sourceUrl: v,
targetPath: app.definition.jobAttributes.fileInputs.find(
(file) => file.name === k
).targetPath,
};
})
.filter((fileInput) => fileInput && fileInput.sourceUrl); // filter out any empty values
// Transform input field values into format that jobs service wants
job.fileInputs = Object.values(
Object.entries(job.fileInputs)
.map(([k, v]) => {
return {
name: k,
sourceUrl: !isTargetPathField(k) ? v : null,
targetDir: isTargetPathField(k) ? v : null,
};
})
.filter((fileInput) => fileInput.sourceUrl || fileInput.targetDir) // filter out any empty values
.reduce((acc, entry) => { // merge input field and targetPath fields into one.
const key = getInputFieldFromTargetPathField(entry.name);
if (!acc[key]) {
acc[key] = {};
}
acc[key]['name'] = key;
acc[key]['sourceUrl'] =
acc[key]['sourceUrl'] ?? entry.sourceUrl;
acc[key]['targetPath'] =
acc[key]['targetPath'] ?? entry.targetDir;
return acc;
}, {})
).flat();

job.parameterSet = Object.assign(
{},
Expand Down Expand Up @@ -559,16 +593,23 @@ export const AppSchemaForm = ({ app }) => {
</div>
{Object.entries(appFields.fileInputs).map(
([name, field]) => {
// TODOv3 handle fileInputArrays https://jira.tacc.utexas.edu/browse/TV3-81
// TODOv3 handle fileInputArrays https://jira.tacc.utexas.edu/browse/WP-81
return (
<FormField
{...field}
name={`fileInputs.${name}`}
tapisFile
SelectModal={DataFilesSelectModal}
placeholder="Browse Data Files"
key={`fileInputs.${name}`}
/>
isTargetPathField(name)?
<FormField
{...field}
name={`fileInputs.${name}`}
placeholder="Target Path Name"
key={`fileInputs.${name}`}
/>:
<FormField
{...field}
name={`fileInputs.${name}`}
tapisFile
SelectModal={DataFilesSelectModal}
placeholder="Browse Data Files"
key={`fileInputs.${name}`}
/>
);
}
)}
Expand Down
26 changes: 26 additions & 0 deletions client/src/components/Applications/AppForm/AppFormSchema.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import * as Yup from 'yup';
import {
checkAndSetDefaultTargetPath,
getTargetPathFieldName,
} from './AppFormUtils';

const FormSchema = (app) => {
const appFields = {
Expand Down Expand Up @@ -131,6 +135,28 @@ const FormSchema = (app) => {
input.sourceUrl === null || typeof input.sourceUrl === 'undefined'
? ''
: input.sourceUrl;

// Add targetDir for all sourceUrl
const targetPathName = getTargetPathFieldName(input.name);
appFields.schema.fileInputs[targetPathName] = Yup.string();
appFields.schema.fileInputs[targetPathName] = appFields.schema.fileInputs[
targetPathName
].matches(
/^tapis:\/\//g,
"Input file Target Directory must be a valid Tapis URI, starting with 'tapis://'"
);

appFields.schema.fileInputs[targetPathName] = false;
appFields.fileInputs[targetPathName] = {
label: 'Target Path for ' + input.name,
description:
"The target path is the location to which data are copied from the input. Empty target path or '*' indicates, the simple directory or file name from the input path is automatically assign to the target path.",
required: false,
readOnly: false,
type: 'text',
};
appFields.defaults.fileInputs[targetPathName] =
checkAndSetDefaultTargetPath(input.targetPath);
});
return appFields;
};
Expand Down
56 changes: 56 additions & 0 deletions client/src/components/Applications/AppForm/AppFormUtils.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import * as Yup from 'yup';
import { getSystemName } from 'utils/systems';

export const TARGET_PATH_FIELD_PREFIX = '_TargetPath_';

export const getQueueMaxMinutes = (app, queueName) => {
return app.exec_sys.batchLogicalQueues.find((q) => q.name === queueName)
.maxMinutes;
Expand Down Expand Up @@ -165,3 +167,57 @@ export const updateValuesForQueue = (app, values) => {

return updatedValues;
};

/**
* Get the field name used for target path in AppForm
*
* @function
* @param {String} inputFieldName
* @returns {String} field Name prefixed with target path
*/
export const getTargetPathFieldName = (inputFieldName) => {
return TARGET_PATH_FIELD_PREFIX + inputFieldName;
};

/**
* Whether a field name is a system defined field for Target Path
*
* @function
* @param {String} inputFieldName
* @returns {String} field Name suffixed with target path
*/
export const isTargetPathField = (inputFieldName) => {
return inputFieldName && inputFieldName.startsWith(TARGET_PATH_FIELD_PREFIX);
};

/**
* From target path field name, derive the original input field name.
*
* @function
* @param {String} targetPathFieldName
* @returns {String} actual field name
*/
export const getInputFieldFromTargetPathField = (targetPathFieldName) => {
return targetPathFieldName.replace(TARGET_PATH_FIELD_PREFIX, '');
};

/**
* Sets the default value if target path is not set.
*
* @function
* @param {String} targetPathFieldValue
* @returns {String} target path value
*/
export const checkAndSetDefaultTargetPath = (targetPathFieldValue) => {
if (targetPathFieldValue === null || targetPathFieldValue === undefined) {
return '*';
}

targetPathFieldValue = targetPathFieldValue.trim();

if (targetPathFieldValue.trim() === '') {
return '*';
}

return targetPathFieldValue;
};
Loading