Fixing validity reset issue where getFieldFromState always returned a field (now retursn null if field does not exist). Fixes #425

Author: davidkpiano

docs/api/actions.md

@@ -804,13 +804,16 @@ dispatch(actions.validateFieldsErrors('user', {
 ```
 
 <h2 id="actions-resetValidity"></h2>
-## `actions.resetValidity(model)`
+## `actions.resetValidity(model, [omitKeys])`
 Resets the `.validity` and `.errors` for the field model to the `.validity` and `.errors` of the initial field state.
 
+If `omitKeys` is specified as an array, it will only reset the validity to the omitted keys by removing them from the current validity/errors.
+
 _Alias:_ `actions.resetErrors(model)`
 
 ### Arguments
 - `model` _(String | Function)_: the model whose validity and errors will be reset.
+- `omitKeys` _(Array)_: the keys to reset by omitting them. Default: `false` (will reset all keys)
 
 
 

src/actions/field-actions.js

@@ -9,8 +9,10 @@ import isValidityInvalid from '../utils/is-validity-invalid';
 import invertValidity from '../utils/invert-validity';
 import { trackable } from '../utils/track';
 import getForm from '../utils/get-form';
+import getFieldFromState from '../utils/get-field-from-state';
 import isValid from '../form/is-valid';
 import NULL_ACTION from '../constants/null-action';
+import omit from 'lodash/omit';
 
 const focus = trackable((model) => ({
   type: actionTypes.FOCUS,
@@ -57,6 +59,29 @@ const setValidity = trackable((model, validity, options = {}) => ({
   [options.errors ? 'errors' : 'validity']: validity,
 }));
 
+const resetValidity = trackable((model, omitKeys = false) => {
+  if (!omitKeys) {
+    return {
+      type: actionTypes.RESET_VALIDITY,
+      model,
+    };
+  }
+
+  return (dispatch, getState) => {
+    const field = getFieldFromState(getState(), model);
+
+    if (!field) {
+      dispatch(NULL_ACTION);
+    } else {
+      dispatch({
+        type: actionTypes.SET_VALIDITY,
+        model,
+        validity: omit(field.validity, omitKeys),
+      });
+    }
+  };
+});
+
 const setFieldsValidity = trackable((model, fieldsValidity, options = {}) => ({
   type: actionTypes.SET_FIELDS_VALIDITY,
   model,
@@ -76,11 +101,6 @@ const setFieldsErrors = trackable((model, fieldsErrors, options) =>
     errors: true,
   }));
 
-const resetValidity = trackable((model) => ({
-  type: actionTypes.RESET_VALIDITY,
-  model,
-}));
-
 const resetErrors = resetValidity;
 
 const setTouched = trackable((model) => ({

src/components/control-component.js

@@ -23,6 +23,7 @@ import validityKeys from '../constants/validity-keys';
 import { dispatchBatchIfNeeded } from '../actions/batch-actions';
 import resolveModel from '../utils/resolve-model';
 import isNative from '../utils/is-native';
+import { initialFieldState } from '../reducers/form-reducer';
 
 const findDOMNode = !isNative
   ? require('react-dom').findDOMNode
@@ -96,7 +97,8 @@ function mapStateToProps(state, props) {
   } = props;
 
   const modelString = getModel(model, state);
-  const fieldValue = getFieldFromState(state, modelString);
+  const fieldValue = getFieldFromState(state, modelString)
+    || initialFieldState;
 
   return {
     model: modelString,
@@ -192,7 +194,7 @@ class Control extends Component {
       const keys = Object.keys(validators)
         .concat(Object.keys(errors));
 
-      dispatch(actions.setValidity(model, omit(fieldValue.validity, keys)));
+      dispatch(actions.resetValidity(model, keys));
     }
   }
 

src/components/errors-component.js

@@ -13,6 +13,7 @@ import getFieldFromState from '../utils/get-field-from-state';
 import getModel from '../utils/get-model';
 import isValid from '../form/is-valid';
 import resolveModel from '../utils/resolve-model';
+import { initialFieldState } from '../reducers/form-reducer';
 
 function showErrors(field, form, show = true) {
   if (typeof show === 'function') {
@@ -163,7 +164,8 @@ function mapStateToProps(state, { model }) {
   const modelString = getModel(model, state);
 
   const formValue = getForm(state, modelString).$form;
-  const fieldValue = getFieldFromState(state, modelString);
+  const fieldValue = getFieldFromState(state, modelString)
+    || initialFieldState;
 
   return {
     model: modelString,

src/components/field-component.js

@@ -15,6 +15,7 @@ import shallowCompareWithoutChildren from '../utils/shallow-compare-without-chil
 import getModel from '../utils/get-model';
 import getFieldFromState from '../utils/get-field-from-state';
 import resolveModel from '../utils/resolve-model';
+import { initialFieldState } from '../reducers/form-reducer';
 
 const fieldPropTypes = {
   model: PropTypes.oneOfType([
@@ -67,7 +68,8 @@ function mapStateToProps(state, props) {
   } = props;
 
   const modelString = getModel(model, state);
-  const fieldValue = getFieldFromState(state, modelString);
+  const fieldValue = getFieldFromState(state, modelString)
+    || initialFieldState;
 
   return {
     model: modelString,

src/reducers/form/change-action-reducer.js

@@ -37,7 +37,7 @@ function updateFieldValue(field, action) {
       result = [];
 
       Object.keys(field).forEach((key) => {
-        if (!!~removeKeysArray.indexOf(+key) || key === '$form') return;
+        if (!!~removeKeysArray.indexOf(+key) || (key === '$form')) return;
 
         result[key] = field[key];
       });

src/utils/get-field-from-state.js

@@ -1,6 +1,5 @@
 import get from './get';
 import toPath from './to-path';
-import { initialFieldState } from '../reducers/form-reducer';
 import getForm from './get-form';
 import isPlainObject from 'lodash/isPlainObject';
 
@@ -13,11 +12,10 @@ export default function getFieldFromState(state, modelString) {
 
   const formPath = toPath(form.$form.model);
   const fieldPath = toPath(modelString).slice(formPath.length);
-  const field = get(form, fieldPath, initialFieldState);
+  const field = get(form, fieldPath);
 
+  if (!field) return null;
   if (isPlainObject(field) && '$form' in field) return field.$form;
 
-  if (!field) return initialFieldState;
-
   return field;
 }