Skip to content
New issue

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

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

Already on GitHub? # to your account

CRDCDH-1137 Allow validation in Submitted state #368

Merged
merged 2 commits into from
May 16, 2024
Merged
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
62 changes: 51 additions & 11 deletions src/components/DataSubmissions/ValidationControls.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ import { useSnackbar } from 'notistack';
import { useAuthContext } from '../Contexts/AuthContext';
import StyledRadioButton from "../Questionnaire/StyledRadioButton";
import { VALIDATE_SUBMISSION, ValidateSubmissionResp } from '../../graphql';
import { getDefaultValidationType, getValidationTypes } from '../../utils';
import {
getDefaultValidationTarget,
getDefaultValidationType,
getValidationTypes,
} from "../../utils";
import FlowWrapper from './FlowWrapper';

type Props = {
Expand Down Expand Up @@ -90,8 +94,27 @@ const StyledRadioControl = styled(FormControlLabel)({
},
});

const ValidateRoles: User["role"][] = ["Submitter", "Data Curator", "Organization Owner", "Admin"];
const ValidateStatuses: Submission["status"][] = ["In Progress", "Withdrawn", "Rejected"];
/**
* Base set of user roles that can validate a submission.
*/
const BaseValidateRoles: User["role"][] = [
"Submitter",
"Data Curator",
"Organization Owner",
"Admin",
];

/**
* A map from Submission Status to the user roles that can validate the submission for that status.
*
* @note All of the permission logic really should be refactored into a hook or otherwise.
*/
const ValidateMap: Partial<Record<Submission["status"], User["role"][]>> = {
"In Progress": BaseValidateRoles,
Withdrawn: BaseValidateRoles,
Rejected: BaseValidateRoles,
Submitted: ["Data Curator", "Admin"],
};

/**
* Provides the UI for validating a data submission's assets.
Expand All @@ -104,27 +127,29 @@ const ValidationControls: FC<Props> = ({ dataSubmission, onValidate }: Props) =>
const { enqueueSnackbar } = useSnackbar();

const [validationType, setValidationType] = useState<ValidationType>(null);
const [uploadType, setUploadType] = useState<ValidationTarget>("New");
const [uploadType, setUploadType] = useState<ValidationTarget>(null);
const [isLoading, setIsLoading] = useState<boolean>(false);
const [isValidating, setIsValidating] = useState<boolean>(dataSubmission?.fileValidationStatus === "Validating"
|| dataSubmission?.metadataValidationStatus === "Validating");

const canValidateMetadata: boolean = useMemo(() => {
if (!user?.role || ValidateRoles.includes(user?.role) === false) {
const permissionMap = ValidateMap[dataSubmission?.status];
if (!user?.role || !dataSubmission?.status || !permissionMap) {
return false;
}
if (!dataSubmission?.status || ValidateStatuses.includes(dataSubmission?.status) === false) {
if (permissionMap.includes(user.role) === false) {
return false;
}

return dataSubmission?.metadataValidationStatus !== null;
}, [user?.role, dataSubmission?.metadataValidationStatus, dataSubmission?.status]);

const canValidateFiles: boolean = useMemo(() => {
if (!user?.role || ValidateRoles.includes(user?.role) === false) {
const permissionMap = ValidateMap[dataSubmission?.status];
if (!user?.role || !dataSubmission?.status || !permissionMap) {
return false;
}
if (!dataSubmission?.status || ValidateStatuses.includes(dataSubmission?.status) === false) {
if (permissionMap.includes(user.role) === false) {
return false;
}

Expand Down Expand Up @@ -167,7 +192,7 @@ const ValidationControls: FC<Props> = ({ dataSubmission, onValidate }: Props) =>
onValidate?.(true);
}

setValidationType(getDefaultValidationType(dataSubmission));
setValidationType(getDefaultValidationType(dataSubmission, user, ValidateMap));
setUploadType("New");
setIsLoading(false);
};
Expand All @@ -185,7 +210,18 @@ const ValidationControls: FC<Props> = ({ dataSubmission, onValidate }: Props) =>
return;
}

setValidationType(getDefaultValidationType(dataSubmission));
setValidationType(getDefaultValidationType(dataSubmission, user, ValidateMap));
}, [dataSubmission, user]);

useEffect(() => {
if (uploadType !== null) {
return;
}
if (typeof dataSubmission === "undefined") {
return;
}

setUploadType(getDefaultValidationTarget(dataSubmission, user, ValidateMap));
}, [dataSubmission]);

return (
Expand Down Expand Up @@ -225,7 +261,11 @@ const ValidationControls: FC<Props> = ({ dataSubmission, onValidate }: Props) =>
value="New"
control={<StyledRadioButton readOnly={false} />}
label="New Uploaded Data"
disabled={!canValidateFiles && !canValidateMetadata}
disabled={
(!canValidateFiles && !canValidateMetadata)
// NOTE: No new data to validate if the submission is already submitted
|| dataSubmission?.status === "Submitted"
}
/>
<StyledRadioControl
value="All"
Expand Down
41 changes: 39 additions & 2 deletions src/utils/dataValidationUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,26 @@ export const getValidationTypes = (validationType: ValidationType): string[] =>
* Determines the default "Validation Type" for the given data submission.
*
* @param dataSubmission The data submission to get the default validation type for.
* @param user The current user.
* @param permissionMap The map of permissions for each submission status.
* @returns The default validation type for the given data submission.
*/
export const getDefaultValidationType = (dataSubmission: Submission): ValidationType => {
const { metadataValidationStatus, fileValidationStatus } = dataSubmission || {};
export const getDefaultValidationType = (
dataSubmission: Submission,
user: User,
permissionMap: Partial<Record<Submission["status"], User["role"][]>>
): ValidationType => {
const { role } = user || {};
const { status, metadataValidationStatus, fileValidationStatus } = dataSubmission || {};

if (
status === "Submitted"
&& permissionMap["Submitted"]?.includes(role)
&& metadataValidationStatus
&& fileValidationStatus
) {
return "All";
}
if (metadataValidationStatus !== null) {
return "Metadata";
}
Expand All @@ -33,3 +48,25 @@ export const getDefaultValidationType = (dataSubmission: Submission): Validation

return "Metadata";
};

/**
* Determines the default Validation Target.
*
* @param dataSubmission The data submission to get the default validation type for.
* @param user The current user.
* @param permissionMap The map of permissions for each submission status.
*/
export const getDefaultValidationTarget = (
dataSubmission: Submission,
user: User,
permissionMap: Partial<Record<Submission["status"], User["role"][]>>
): ValidationTarget => {
const { role } = user || {};
const { status } = dataSubmission || {};

if (status === "Submitted" && permissionMap["Submitted"]?.includes(role)) {
return "All";
}

return "New";
};
Loading