feat(data-integrity): add checks-selector

i18n/en.pot

@@ -5,8 +5,8 @@ msgstr ""
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
-"POT-Creation-Date: 2021-11-18T16:21:37.799Z\n"
-"PO-Revision-Date: 2021-11-18T16:21:37.799Z\n"
+"POT-Creation-Date: 2022-02-25T17:25:37.537Z\n"
+"PO-Revision-Date: 2022-02-25T17:25:37.537Z\n"
 
 msgid "Not authorized"
 msgstr "Not authorized"
@@ -30,6 +30,24 @@ msgstr "Something went wrong whilst creating your job"
 msgid "CRON Expression"
 msgstr "CRON Expression"
 
+msgid "Please select checks to run."
+msgstr "Please select checks to run."
+
+msgid "Checks to run"
+msgstr "Checks to run"
+
+msgid "Run all available checks"
+msgstr "Run all available checks"
+
+msgid "Only run selected checks"
+msgstr "Only run selected checks"
+
+msgid "Severity"
+msgstr "Severity"
+
+msgid "Select checks to run."
+msgstr "Select checks to run."
+
 msgid "Delay"
 msgstr "Delay"
 
@@ -201,6 +219,133 @@ msgstr "Enrollment"
 msgid "Validation result"
 msgstr "Validation result"
 
+msgid "Program indicators with invalid expressions"
+msgstr "Program indicators with invalid expressions"
+
+msgid "Data elements without groups"
+msgstr "Data elements without groups"
+
+msgid "Indicators with invalid numerator"
+msgstr "Indicators with invalid numerator"
+
+msgid "Program rule actions without notification"
+msgstr "Program rule actions without notification"
+
+msgid "Only one \"default\" category combo should exist"
+msgstr "Only one \"default\" category combo should exist"
+
+msgid "Data elements without data sets"
+msgstr "Data elements without data sets"
+
+msgid "Category combos being invalid"
+msgstr "Category combos being invalid"
+
+msgid "Indicators with identical formulas"
+msgstr "Indicators with identical formulas"
+
+msgid "Indicators without groups"
+msgstr "Indicators without groups"
+
+msgid "Data elements in data set not in form"
+msgstr "Data elements in data set not in form"
+
+msgid "Program rules without priority"
+msgstr "Program rules without priority"
+
+msgid "Validation rules without groups"
+msgstr "Validation rules without groups"
+
+msgid "Program indicators with invalid filters"
+msgstr "Program indicators with invalid filters"
+
+msgid "Categories with no category options"
+msgstr "Categories with no category options"
+
+msgid "Program rules without condition"
+msgstr "Program rules without condition"
+
+msgid "Program rule actions without stage"
+msgstr "Program rule actions without stage"
+
+msgid "Only one \"default\" category should exist"
+msgstr "Only one \"default\" category should exist"
+
+msgid ""
+"Lists category combos that share a combination of categories with at least "
+"one other category combo"
+msgstr ""
+"Lists category combos that share a combination of categories with at least "
+"one other category combo"
+
+msgid "Org units with cyclic references"
+msgstr "Org units with cyclic references"
+
+msgid "Program rule variables without data element"
+msgstr "Program rule variables without data element"
+
+msgid "Validation rules with invalid right side expression"
+msgstr "Validation rules with invalid right side expression"
+
+msgid "Data sets not assigned to org units"
+msgstr "Data sets not assigned to org units"
+
+msgid "Data elements violating exclusive group sets"
+msgstr "Data elements violating exclusive group sets"
+
+msgid "Org unit groups without group sets"
+msgstr "Org unit groups without group sets"
+
+msgid "Program rule variables without attribute"
+msgstr "Program rule variables without attribute"
+
+msgid "Org units violating exclusive group sets"
+msgstr "Org units violating exclusive group sets"
+
+msgid "Program rule actions without data object"
+msgstr "Program rule actions without data object"
+
+msgid "Only one \"default\" category option should exist"
+msgstr "Only one \"default\" category option should exist"
+
+msgid "Only one \"default\" category option combo should exist"
+msgstr "Only one \"default\" category option combo should exist"
+
+msgid "Org units without groups"
+msgstr "Org units without groups"
+
+msgid "Program indicators without expression"
+msgstr "Program indicators without expression"
+
+msgid "Indicators violating exclusive group sets"
+msgstr "Indicators violating exclusive group sets"
+
+msgid "Periods duplicates"
+msgstr "Periods duplicates"
+
+msgid "Data elements assigned to data sets with different period types"
+msgstr "Data elements assigned to data sets with different period types"
+
+msgid "Program rules without action"
+msgstr "Program rules without action"
+
+msgid "Org units being orphaned"
+msgstr "Org units being orphaned"
+
+msgid "Validation rules with invalid left side expression"
+msgstr "Validation rules with invalid left side expression"
+
+msgid "Indicators with invalid denominator"
+msgstr "Indicators with invalid denominator"
+
+msgid "Program rule actions without section"
+msgstr "Program rule actions without section"
+
+msgid "Warning"
+msgstr "Warning"
+
+msgid "Severe"
+msgstr "Severe"
+
 msgid "Completed"
 msgstr "Completed"
 

src/components/FormFields/DataIntegrityChecksField.js

@@ -0,0 +1,158 @@
+import React, { useCallback, useRef, useState } from 'react'
+import { PropTypes } from '@dhis2/prop-types'
+import i18n from '@dhis2/d2-i18n'
+import {
+    FieldGroup,
+    Radio,
+    Transfer,
+    TransferOption,
+    ReactFinalForm,
+    InputFieldFF,
+    Help,
+} from '@dhis2/ui'
+import cx from 'classnames'
+import { hooks } from '../Store'
+import {
+    getCheckName,
+    severityMap,
+} from '../../services/server-translations/dataIntegrityChecks'
+import styles from './DataIntegrityChecksField.module.css'
+
+const { Field, useField } = ReactFinalForm
+
+const VALIDATOR = value =>
+    value && value.length < 1
+        ? i18n.t('Please select checks to run.')
+        : undefined
+
+const DataIntegrityChecksField = ({ label, name }) => {
+    const options = hooks.useParameterOptions('dataIntegrityChecks')
+    const {
+        input: { value, onChange },
+    } = useField(name)
+
+    const hasValue = !!value && value.length > 0
+    const [runSelected, setRunSelected] = useState(hasValue)
+
+    const translatedOptions = options
+        .map(option => ({
+            ...option,
+            value: option.name,
+            label: getCheckName(option.name),
+            severity: severityMap[option.severity],
+        }))
+        .sort((a, b) => a.label.localeCompare(b.label))
+
+    const toggle = ({value}) => {
+        const checked = value === 'true'
+
+        if (!checked) {
+            // clear checks when "Run all" is selected
+            onChange([])
+        }
+        setRunSelected(checked)
+    }
+
+    return (
+        <FieldGroup label={i18n.t('Checks to run')}>
+            <Radio
+                name={'checksToRun'}
+                value={String(false)}
+                label={i18n.t('Run all available checks')}
+                checked={!runSelected}
+                onChange={toggle}
+            />
+            <Radio
+                name={'checksToRun'}
+                value={String(true)}
+                label={i18n.t('Only run selected checks')}
+                checked={runSelected}
+                onChange={toggle}
+            />
+            <Field
+                name={name}
+                component={ChecksTransfer}
+                options={translatedOptions}
+                label={label}
+                validate={VALIDATOR}
+                // conditional rendering of FinalForm-fields cause some issues,
+                // see https://github.com/final-form/react-final-form/issues/809
+                hidden={!runSelected}
+            />
+        </FieldGroup>
+    )
+}
+
+const LabelComponent = ({ label, severity, highlighted, disabled }) => (
+    <div
+        className={cx(styles.transferOption, {
+            [styles.highlighted]: highlighted,
+            [styles.disabled]: disabled,
+        })}
+    >
+        <div className={styles.optionName}>{label}</div>
+        <div className={cx(styles.optionSeverity, {
+            [styles.highlighted]: highlighted
+        })}>{`${i18n.t(
+            'Severity'
+        )}: ${severity}`}</div>
+    </div>
+)
+
+LabelComponent.propTypes = TransferOption.propTypes
+
+const renderOption = option => (
+    <TransferOption {...option} label={<LabelComponent {...option} />} />
+)
+
+const ChecksTransfer = ({ input, meta, options = [], hidden }) => {
+    const { onChange } = input
+
+    const handleChange = useCallback(
+        ({ selected }) => {
+            onChange(selected)
+        },
+        [onChange]
+    )
+
+    if (hidden) {
+        return null
+    }
+
+    const isErr = meta.touched && meta.invalid
+
+    return (
+        <>
+            <Transfer
+                options={options}
+                onChange={handleChange}
+                selected={input.value || []}
+                renderOption={renderOption}
+                maxSelections={Infinity}
+                enableOrderChange={true}
+                filterable={true}
+                height={'450px'}
+                selectedEmptyComponent={<SelectedEmptyComponent />}
+                className={styles.transfer}
+            />
+            {isErr && <Help error={isErr}>{meta.error}</Help>}
+        </>
+    )
+}
+
+ChecksTransfer.propTypes = InputFieldFF.propTypes
+
+const SelectedEmptyComponent = () => (
+    <p className={styles.selectedEmptyComponent}>
+        {i18n.t('Select checks to run.')}
+    </p>
+)
+
+const { string } = PropTypes
+
+DataIntegrityChecksField.propTypes = {
+    label: string.isRequired,
+    name: string.isRequired,
+}
+
+export default DataIntegrityChecksField

src/components/FormFields/DataIntegrityChecksField.module.css

@@ -0,0 +1,27 @@
+.transfer {
+    margin-top: 8px;
+}
+
+.transferOption {
+        font-size: 14px;
+        padding: 4px 0px;
+}
+
+.optionName {
+    font-weight: 500;
+    margin-bottom: 4px;
+}
+
+.optionSeverity {
+    font-weight: 400;
+    font-size: 13px;
+    color: var(--colors-grey600);
+}
+
+.transferOption.highlighted .optionSeverity {
+    color: var(--colors-grey300);
+}
+
+.selectedEmptyComponent {
+    text-align: center;
+}

src/components/FormFields/ParameterFields.js

@@ -6,13 +6,23 @@ import { hooks } from '../Store'
 import { formatToString } from './formatters'
 import SkipTableTypesField from './SkipTableTypesField'
 import LabeledOptionsField from './LabeledOptionsField'
+import DataIntegrityChecksField from './DataIntegrityChecksField'
 import styles from './ParameterFields.module.css'
 
 const { Field } = ReactFinalForm
 
 // The key under which the parameters will be sent to the backend
 const FIELD_NAME = 'jobParameters'
 
+const getCustomComponent = (jobType, parameterName) => {
+    if (jobType === 'DATA_INTEGRITY' && parameterName === 'checks') {
+        return DataIntegrityChecksField
+    } else if (parameterName === 'skipTableTypes') {
+        return SkipTableTypesField
+    }
+    return null
+}
+
 // Renders all parameters for a given jobtype
 const ParameterFields = ({ jobType }) => {
     const parameters = hooks.useJobTypeParameters(jobType)
@@ -29,11 +39,12 @@ const ParameterFields = ({ jobType }) => {
         }
         let parameterComponent = null
 
-        // Specific case, as the options here need specific translations
-        if (name === 'skipTableTypes') {
+        const CustomParameterComponent = getCustomComponent(jobType, name)
+
+        if (CustomParameterComponent) {
             return (
                 <Box marginTop="16px" key={name}>
-                    <SkipTableTypesField
+                    <CustomParameterComponent
                         {...defaultProps}
                         parameterName={name}
                     />