18560: Improves the property form's autocomplete feature.
[arvados-workbench2.git] / src / views-components / resource-properties-form / property-value-field.tsx
index e73c66beb62a17ae1f2c6ecc9301a9290d82d839..56b7fe05cffc8eec7e33b8eccc5988094feecab2 100644 (file)
 //
 // SPDX-License-Identifier: AGPL-3.0
 
-import * as React from 'react';
-import { WrappedFieldProps, Field, formValues } from 'redux-form';
-import { connect } from 'react-redux';
-import { identity } from 'lodash';
+import React from 'react';
+import { WrappedFieldProps, Field, formValues, FormName, WrappedFieldInputProps, WrappedFieldMetaProps, change } from 'redux-form';
 import { compose } from 'redux';
-import { RootState } from '~/store/store';
-import { getVocabulary } from '~/store/vocabulary/vocabulary-selctors';
-import { Autocomplete } from '~/components/autocomplete/autocomplete';
-import { Vocabulary } from '~/models/vocabulary';
-import { require } from '~/validators/require';
-import { PROPERTY_KEY_FIELD_NAME } from '~/views-components/resource-properties-form/property-key-field';
+import { Autocomplete } from 'components/autocomplete/autocomplete';
+import { Vocabulary, isStrictTag, getTagValues, getTagValueID, getTagValueLabel, PropFieldSuggestion, getPreferredTagValues } from 'models/vocabulary';
+import { PROPERTY_KEY_FIELD_ID, PROPERTY_KEY_FIELD_NAME } from 'views-components/resource-properties-form/property-key-field';
+import {
+    handleSelect,
+    handleBlur,
+    VocabularyProp,
+    ValidationProp,
+    connectVocabulary,
+    buildProps
+} from 'views-components/resource-properties-form/property-field-common';
+import { TAG_VALUE_VALIDATION } from 'validators/validators';
+import { escapeRegExp } from 'common/regexp';
+import { ChangeEvent } from 'react';
 
-interface VocabularyProp {
-    vocabulary: Vocabulary;
+interface PropertyKeyProp {
+    propertyKeyId: string;
+    propertyKeyName: string;
 }
 
-interface PropertyKeyProp {
-    propertyKey: string;
+interface PropertyValueInputProp {
+    disabled: boolean;
 }
 
-type PropertyValueFieldProps = VocabularyProp & PropertyKeyProp;
+type PropertyValueFieldProps = VocabularyProp & PropertyKeyProp & ValidationProp & PropertyValueInputProp;
+
+export const PROPERTY_VALUE_FIELD_NAME = 'value';
+export const PROPERTY_VALUE_FIELD_ID = 'valueID';
 
-const mapStateToProps = (state: RootState): VocabularyProp => ({
-    vocabulary: getVocabulary(state.properties),
-});
+const connectVocabularyAndPropertyKey = compose(
+    connectVocabulary,
+    formValues({
+        propertyKeyId: PROPERTY_KEY_FIELD_ID,
+        propertyKeyName: PROPERTY_KEY_FIELD_NAME,
+    }),
+);
 
-export const PropertyValueField = compose(
-    connect(mapStateToProps),
-    formValues({ propertyKey: PROPERTY_KEY_FIELD_NAME })
-)(
-    (props: PropertyValueFieldProps) =>
+export const PropertyValueField = connectVocabularyAndPropertyKey(
+    ({ skipValidation, ...props }: PropertyValueFieldProps) =>
+        <span data-cy='property-field-value'>
         <Field
-            name='value'
+            name={PROPERTY_VALUE_FIELD_NAME}
             component={PropertyValueInput}
-            validate={getValidation(props)}
-            {...props} />);
+            validate={skipValidation ? undefined : getValidation(props)}
+            {...{...props, disabled: !props.propertyKeyName}} />
+        </span>
+);
 
-const PropertyValueInput = ({ input, meta, vocabulary, propertyKey }: WrappedFieldProps & PropertyValueFieldProps) =>
-    <Autocomplete
-        value={input.value}
-        onChange={input.onChange}
-        label='Value'
-        suggestions={getSuggestions(input.value, propertyKey, vocabulary)}
-        items={ITEMS_PLACEHOLDER}
-        onSelect={input.onChange}
-        renderSuggestion={identity}
-        error={meta.invalid}
-        helperText={meta.error}
-    />;
+const PropertyValueInput = ({ vocabulary, propertyKeyId, propertyKeyName, ...props }: WrappedFieldProps & PropertyValueFieldProps) =>
+    <FormName children={data => (
+        <Autocomplete
+            {...buildProps(props)}
+            label='Value'
+            disabled={props.disabled}
+            suggestions={getSuggestions(props.input.value, propertyKeyId, vocabulary)}
+            renderSuggestion={(s: PropFieldSuggestion) => (s.description || s.label)}
+            onSelect={handleSelect(PROPERTY_VALUE_FIELD_ID, data.form, props.input, props.meta)}
+            onBlur={() => {
+                // Case-insensitive search for the value in the vocabulary
+                const foundValueID =  getTagValueID(propertyKeyId, props.input.value, vocabulary);
+                if (foundValueID !== '') {
+                    props.input.value = getTagValueLabel(propertyKeyId, foundValueID, vocabulary);
+                }
+                handleBlur(PROPERTY_VALUE_FIELD_ID, data.form, props.meta, props.input, foundValueID)();
+            }}
+            onChange={(e: ChangeEvent<HTMLInputElement>) => {
+                const newValue = e.currentTarget.value;
+                const tagValueID = getTagValueID(propertyKeyId, newValue, vocabulary);
+                handleChange(data.form, tagValueID, props.input, props.meta, newValue);
+            }}
+        />
+    )} />;
 
 const getValidation = (props: PropertyValueFieldProps) =>
-    isStrictTag(props.propertyKey, props.vocabulary)
-        ? [require, matchTagValues(props)]
-        : [require];
+    isStrictTag(props.propertyKeyId, props.vocabulary)
+        ? [...TAG_VALUE_VALIDATION, matchTagValues(props)]
+        : TAG_VALUE_VALIDATION;
 
-const matchTagValues = ({ vocabulary, propertyKey }: PropertyValueFieldProps) =>
+const matchTagValues = ({ vocabulary, propertyKeyId }: PropertyValueFieldProps) =>
     (value: string) =>
-        getTagValues(propertyKey, vocabulary).find(v => v.includes(value))
+        getTagValues(propertyKeyId, vocabulary).find(v => v.label === value)
             ? undefined
             : 'Incorrect value';
 
-const getSuggestions = (value: string, tagName: string, vocabulary: Vocabulary) =>
-    getTagValues(tagName, vocabulary).filter(v => v.includes(value) && v !== value);
-
-const isStrictTag = (tagName: string, vocabulary: Vocabulary) => {
-    const tag = vocabulary.tags[tagName];
-    return tag ? tag.strict : false;
-};
-
-const getTagValues = (tagName: string, vocabulary: Vocabulary) => {
-    const tag = vocabulary.tags[tagName];
-    return tag ? tag.values : [];
+const getSuggestions = (value: string, tagName: string, vocabulary: Vocabulary) => {
+    const re = new RegExp(escapeRegExp(value), "i");
+    return getPreferredTagValues(tagName, vocabulary, value !== '').filter(
+        v => re.test((v.description || v.label)) && v.label !== value);
 };
 
-const ITEMS_PLACEHOLDER: string[] = [];
+const handleChange = (
+    formName: string,
+    tagValueID: string,
+    { onChange }: WrappedFieldInputProps,
+    { dispatch }: WrappedFieldMetaProps,
+    value: string) => {
+        onChange(value);
+        dispatch(change(formName, PROPERTY_VALUE_FIELD_NAME, value));
+        dispatch(change(formName, PROPERTY_VALUE_FIELD_ID, tagValueID));
+    };
\ No newline at end of file