implements a safer way to revert to original data if update policies fail

This commit is contained in:
James
2020-07-02 00:46:03 -04:00
parent d04babe933
commit a34698371e
8 changed files with 31 additions and 28 deletions

View File

@@ -1,10 +0,0 @@
const flattenFilters = [{
test: (_, value) => {
const hasValidProperty = Object.prototype.hasOwnProperty.call(value, 'valid');
const hasValueProperty = Object.prototype.hasOwnProperty.call(value, 'value');
return (hasValidProperty && hasValueProperty);
},
}];
export default flattenFilters;

View File

@@ -254,6 +254,9 @@ const Form = (props) => {
contextValue.validateForm = () => {
return !Object.values(fields).some((field) => {
if (field.valid === false) {
console.log(field, ' is not valid');
}
return field.valid === false;
});
};

View File

@@ -8,7 +8,7 @@ import { v4 as uuidv4 } from 'uuid';
import withCondition from '../../withCondition';
import Button from '../../../elements/Button';
import reducer from '../rowReducer';
import useForm from '../../Form/useForm';
import useFormFields from '../../Form/useFormFields';
import DraggableSection from '../../DraggableSection';
import { useRenderedFields } from '../../RenderFields';
import Error from '../../Error';
@@ -67,7 +67,7 @@ const Flexible = (props) => {
const dataToInitialize = initialData || defaultValue;
const [rows, dispatchRows] = useReducer(reducer, []);
const { customComponentsPath } = useRenderedFields();
const { getDataByPath } = useForm();
const { getDataByPath } = useFormFields();
const addRow = (index, blockType) => {
const data = getDataByPath(path);

View File

@@ -8,7 +8,7 @@ import Button from '../../../elements/Button';
import DraggableSection from '../../DraggableSection';
import reducer from '../rowReducer';
import { useRenderedFields } from '../../RenderFields';
import useForm from '../../Form/useForm';
import useFormFields from '../../Form/useFormFields';
import useFieldType from '../../useFieldType';
import Error from '../../Error';
import { repeater } from '../../../../../fields/validations';
@@ -39,7 +39,7 @@ const Repeater = (props) => {
const dataToInitialize = initialData || defaultValue;
const [rows, dispatchRows] = useReducer(reducer, []);
const { customComponentsPath } = useRenderedFields();
const { getDataByPath } = useForm();
const { getDataByPath } = useFormFields();
const path = pathFromProps || name;

View File

@@ -46,7 +46,7 @@ const Upload = (props) => {
const fieldType = useFieldType({
path,
required,
initialData,
initialData: initialData?.id,
defaultValue,
validate,
});
@@ -166,7 +166,9 @@ Upload.propTypes = {
required: PropTypes.bool,
readOnly: PropTypes.bool,
defaultValue: PropTypes.string,
initialData: PropTypes.shape({}),
initialData: PropTypes.shape({
id: PropTypes.string,
}),
validate: PropTypes.func,
width: PropTypes.string,
style: PropTypes.shape({}),

View File

@@ -51,7 +51,7 @@ const update = async (args) => {
doc.setLocale(locale, fallbackLocale);
}
const docJSON = doc.toJSON({ virtuals: true });
options.originalDoc = doc.toJSON({ virtuals: true });
// /////////////////////////////////////
// 2. Execute before update hook
@@ -67,7 +67,7 @@ const update = async (args) => {
// 3. Merge updates into existing data
// /////////////////////////////////////
options.data = deepmerge(docJSON, options.data, { arrayMerge: overwriteMerge });
options.data = deepmerge(options.originalDoc, options.data, { arrayMerge: overwriteMerge });
// /////////////////////////////////////
// 4. Execute field-level hooks, policies, and validation

View File

@@ -3,13 +3,14 @@ const { ValidationError } = require('../errors');
module.exports = async (config, operation) => {
const {
data: fullData,
originalDoc: fullOriginalDoc,
operationName,
hook,
} = operation;
// Maintain a top-level list of promises
// so that all async field policies / validations / hooks
// can run in tandem
// can run in parallel
const validationPromises = [];
const policyPromises = [];
const hookPromises = [];
@@ -28,15 +29,19 @@ module.exports = async (config, operation) => {
}
};
const createPolicyPromise = async (data, field) => {
const createPolicyPromise = async (data, originalDoc, field) => {
const resultingData = data;
if (field.policies && field.policies[operationName]) {
const result = await field.policies[operationName](operation);
if (!result) {
if (!result && operationName === 'create') {
delete resultingData[field.name];
}
if (!result && operationName === 'update' && originalDoc[field.name] !== undefined) {
resultingData[field.name] = originalDoc[field.name];
}
}
};
@@ -48,7 +53,7 @@ module.exports = async (config, operation) => {
}
};
const traverseFields = (fields, data = {}, path) => {
const traverseFields = (fields, data = {}, originalDoc = {}, path) => {
fields.forEach((field) => {
const dataCopy = data;
@@ -63,20 +68,21 @@ module.exports = async (config, operation) => {
if (data[field.name] === 'false') dataCopy[field.name] = false;
}
policyPromises.push(createPolicyPromise(data, field));
policyPromises.push(createPolicyPromise(data, originalDoc, field));
hookPromises.push(createHookPromise(data, field));
if (field.fields) {
if (field.name === undefined) {
traverseFields(field.fields, data, path);
traverseFields(field.fields, data, originalDoc, path);
} else if (field.type === 'repeater' || field.type === 'flexible') {
if (Array.isArray(data[field.name])) {
data[field.name].forEach((rowData, i) => {
traverseFields(field.fields, rowData, `${path}${field.name}.${i}.`);
const originalDocRow = originalDoc && originalDoc[field.name] && originalDoc[field.name][i];
traverseFields(field.fields, rowData, originalDocRow || undefined, `${path}${field.name}.${i}.`);
});
}
} else {
traverseFields(field.fields, data[field.name], `${path}${field.name}.`);
traverseFields(field.fields, data[field.name], originalDoc[field.name], `${path}${field.name}.`);
}
}
@@ -98,7 +104,7 @@ module.exports = async (config, operation) => {
// //////////////////////////////////////////
try {
traverseFields(config.fields, fullData, '');
traverseFields(config.fields, fullData, fullOriginalDoc, '');
await Promise.all(validationPromises);
if (errors.length > 0) {