@truedat/dq 4.36.9 → 4.37.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [4.37.0] 2022-01-25
+
+### Changed
+
+- [TD-2564] `DatasetForm` now has a configurable `defaultFilters` prop
+- Simplified `DatasetForm` and `FiltersField` components by removing obscure
+  code for installation-specific custom filters
+
 ## [4.36.4] 2022-01-19
 
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/dq",
-  "version": "4.36.9",
+  "version": "4.37.0",
   "description": "Truedat Web Data Quality Module",
   "sideEffects": false,
   "jsnext:main": "src/index.js",
@@ -82,8 +82,8 @@
   },
   "dependencies": {
     "@apollo/client": "^3.4.10",
-    "@truedat/core": "4.36.9",
-    "@truedat/df": "4.36.9",
+    "@truedat/core": "4.37.0",
+    "@truedat/df": "4.37.0",
     "axios": "^0.19.2",
     "graphql": "^15.5.3",
     "path-to-regexp": "^1.7.0",
@@ -103,5 +103,5 @@
     "react-dom": ">= 16.8.6 < 17",
     "semantic-ui-react": ">= 0.88.2 < 2.1"
   },
-  "gitHead": "4b56a9ae46e2454719a2ae31022bc0d700a65dd3"
+  "gitHead": "a2584d116d738be9a237f26c617e1400d4a24803"
 }

package/src/components/__tests__/RuleImplementationEvents.spec.js

@@ -24,9 +24,8 @@ describe("<RuleImplementationEvents />", () => {
   const renderOpts = {
     messages: {
       en: {
-        "ruleImplementations.events.field_restored": "implementation restored",
-        "ruleImplementations.events.field_deprecated":
-          "implementation deprecated",
+        "ruleImplementations.events.action_deprecated": "deprecated",
+        "ruleImplementations.events.action_restored": "restored",
       },
     },
   };

package/src/components/__tests__/__snapshots__/RuleImplementationEvents.spec.js.snap

@@ -34,7 +34,7 @@ exports[`<RuleImplementationEvents /> matches the latest snapshot 1`] = `
           <div
             class="text extra"
           >
-            ruleImplementations.events.action_restored
+            restored
           </div>
         </div>
       </div>
@@ -64,7 +64,7 @@ exports[`<RuleImplementationEvents /> matches the latest snapshot 1`] = `
           <div
             class="text extra"
           >
-            ruleImplementations.events.action_deprecated
+            deprecated
           </div>
         </div>
       </div>

package/src/components/ruleImplementationForm/DatasetForm.js

@@ -5,8 +5,7 @@ import { connect } from "react-redux";
 import { useIntl } from "react-intl";
 import { dropAt, replaceAt } from "@truedat/core/services/arrays";
 import { Button } from "semantic-ui-react";
-import { setImplementationFilterValues } from "../../routines";
-import { getRuleImplementationFormFilters } from "../../selectors";
+import { datasetDefaultFiltersSelector } from "../../selectors";
 import "../../styles/ruleImplementationForm/DatasetForm.less";
 
 const StructureSelectorInputField = React.lazy(() =>
@@ -14,10 +13,9 @@ const StructureSelectorInputField = React.lazy(() =>
 );
 
 export const DatasetForm = ({
-  customFilters,
+  defaultFilters,
   structures,
   selector,
-  setImplementationFilterValues,
   setStructures,
   setSelector,
 }) => {
@@ -66,12 +64,9 @@ export const DatasetForm = ({
   const setStructure = ({ index, value: param_value }) => {
     const structureChanged = hasChangedStructure(index, param_value);
     const value = structureChanged ? setAliasIndex(param_value) : param_value;
-    if (index === 0 && structureChanged) {
-      setStructures([value ? { ...value } : {}]);
-      setImplementationFilterValues({ value: _.get("structure")(value) });
-    } else if (_.isNil(index))
+    if (_.isNil(index)) {
       setStructures([...structures, value ? { ...value } : {}]);
-    else if (value) {
+    } else if (value) {
       const mergedValue = { ..._.nth(index)(structures), ...value };
       setStructures(replaceAt(index, mergedValue)(structures));
     } else setStructures(deleteStructure(index, structures));
@@ -88,13 +83,6 @@ export const DatasetForm = ({
     return dropAt(index)(structures);
   };
 
-  const buildDefaultFilters = (i) => {
-    const defaultFilters = { "class.raw": [""] };
-    return i == 0
-      ? { defaultFilters }
-      : { defaultFilters: { ...defaultFilters, ...customFilters } };
-  };
-
   return (
     <>
       {structures.map((structure, index) => (
@@ -102,7 +90,7 @@ export const DatasetForm = ({
           active={index === selector}
           joined={index > 0}
           key={index}
-          options={buildDefaultFilters(index)}
+          defaultFilters={defaultFilters}
           onChange={(value) => {
             setSelector(-1);
             onChange(index, { structure: value });
@@ -125,27 +113,22 @@ export const DatasetForm = ({
           setStructure({ value: { join_type: "inner" } });
         }}
       >
-        {formatMessage({
-          id: "dataset.form.button.add_structure",
-        })}
+        {formatMessage({ id: "dataset.form.button.add_structure" })}
       </Button>
     </>
   );
 };
 
 DatasetForm.propTypes = {
-  customFilters: PropTypes.object,
+  defaultFilters: PropTypes.object,
   structures: PropTypes.array,
   selector: PropTypes.number,
   setStructures: PropTypes.func,
   setSelector: PropTypes.func,
-  setImplementationFilterValues: PropTypes.func,
 };
 
 const mapStateToProps = (state) => ({
-  customFilters: getRuleImplementationFormFilters(state),
+  defaultFilters: datasetDefaultFiltersSelector(state),
 });
 
-export default connect(mapStateToProps, { setImplementationFilterValues })(
-  DatasetForm
-);
+export default connect(mapStateToProps)(DatasetForm);

package/src/components/ruleImplementationForm/FiltersField.js

@@ -1,8 +1,6 @@
 import _ from "lodash/fp";
 import React, { useState } from "react";
-import { connect } from "react-redux";
 import PropTypes from "prop-types";
-import { getRuleImplementationFormFilters } from "../../selectors";
 import { getStructureFields } from "../../selectors/getStructureFields";
 import DateField from "./DateField";
 import DateTimeField from "./DateTimeField";
@@ -36,7 +34,6 @@ const reducedStructureColumns = [
 ];
 
 export const FiltersField = ({
-  customFilters,
   parentStructures,
   label,
   operator,
@@ -97,9 +94,7 @@ export const FiltersField = ({
         <StructureSelectorInputField
           active={active}
           joined={false}
-          options={{
-            defaultFilters: { "class.raw": ["field"], ...customFilters },
-          }}
+          defaultFilters={{ "class.raw": ["field"] }}
           onChange={(value) => {
             onChange(null, {
               data_structure_id: _.prop("id")(value),
@@ -159,7 +154,6 @@ export const FiltersField = ({
 };
 
 FiltersField.propTypes = {
-  customFilters: PropTypes.object,
   label: PropTypes.string,
   parentStructures: PropTypes.array,
   operator: PropTypes.object,
@@ -171,8 +165,4 @@ FiltersField.propTypes = {
   typeCastModifiers: PropTypes.array,
 };
 
-const mapStateToProps = (state) => ({
-  customFilters: getRuleImplementationFormFilters(state),
-});
-
-export default connect(mapStateToProps)(FiltersField);
+export default FiltersField;

package/src/components/ruleImplementationForm/__tests__/DataSetForm.spec.js

@@ -1,76 +1,36 @@
-import React from "react";
-import { intl } from "@truedat/test/intl-stub";
-import { shallow } from "enzyme";
-import { DatasetForm } from "../DatasetForm";
+import React, { Suspense } from "react";
+import { waitFor } from "@testing-library/react";
+import { render } from "@truedat/test/render";
+import DatasetForm from "../DatasetForm";
 
-// workaround for enzyme issue with React.useContext
-// see https://github.com/airbnb/enzyme/issues/2176#issuecomment-532361526
-jest.spyOn(React, "useContext").mockImplementation(() => intl);
+const renderOpts = {
+  messages: { en: { "dataset.form.button.add_structure": "add_structure" } },
+};
 
 describe("<DatasetForm />", () => {
   const setStructures = jest.fn();
   const setSelector = jest.fn();
   const selector = -1;
   const setImplementationKey = jest.fn();
-  const setImplementationFilterValues = jest.fn();
   const implementationKey = "Impl";
-  const structures = [
-    {
-      structure: {
-        id: 1,
-        name: "strcuture1",
-        path: [],
-        system: { name: "system" }
-      }
-    },
-    {
-      join_type: "inner",
-      structure: {
-        id: 2,
-        name: "structure2",
-        path: [],
-        system: { name: "system" }
-      },
-      clauses: [{ id: 100 }, { id: 200 }]
-    }
-  ];
+  const structures = [1, 2];
 
-  const customFilters = { "foo.bar": ["baz"] };
   const props = {
     implementationKey,
-    customFilters,
-    structures,
-    setStructures,
-    setSelector,
     selector,
-    setImplementationFilterValues,
-    setImplementationKey
+    setImplementationKey,
+    setSelector,
+    setStructures,
+    structures,
   };
 
   it("matches the latest snapshot", () => {
-    const wrapper = shallow(<DatasetForm {...props} />);
-    expect(wrapper).toMatchSnapshot();
-  });
-
-  it("renders all StructureSelectorInputField", () => {
-    const wrapper = shallow(<DatasetForm {...props} />);
-    const selectors = wrapper.find("lazy");
-    expect(selectors).toHaveLength(structures.length);
-  });
-
-  it("all custom filter props are correct", () => {
-    const wrapper = shallow(<DatasetForm {...props} />);
-    const selectors = wrapper.find("lazy");
-    expect(selectors.first().prop("options")).toEqual({
-      defaultFilters: {
-        "class.raw": [""]
-      }
-    });
-    expect(selectors.last().prop("options")).toEqual({
-      defaultFilters: {
-        "class.raw": [""],
-        "foo.bar": ["baz"]
-      }
-    });
+    const { container } = render(
+      <Suspense fallback={null}>
+        <DatasetForm {...props} />
+      </Suspense>,
+      renderOpts
+    );
+    expect(container).toMatchSnapshot();
   });
 });

package/src/components/ruleImplementationForm/__tests__/FiltersField.spec.js

@@ -17,42 +17,28 @@ describe("<FiltersField />", () => {
       id: 1,
       name: "structure1",
       path: ["structure1"],
-      system: { external_id: "oracle_test", id: 29, name: "Oracle" }
-    }
+      system: { external_id: "oracle_test", id: 29, name: "Oracle" },
+    },
   ];
 
-  const customFilters = { "foo.bar": ["baz"] };
   const operator = {
     group: "references",
     name: "references",
     value_type: "field",
     value_type_filter: "any",
-    scope: "validation"
+    scope: "validation",
   };
   const props = {
-    customFilters,
     parentStructures,
     fieldType,
     onChange,
     name,
     operator,
-    value
+    value,
   };
 
   it("matches the latest snapshot", () => {
     const wrapper = shallow(<FiltersField {...props} />);
     expect(wrapper).toMatchSnapshot();
   });
-
-  it("renders StructureSelectorInputField with valid props", () => {
-    const wrapper = shallow(<FiltersField {...props} />);
-    const selectors = wrapper.find("lazy");
-    expect(selectors).toHaveLength(1);
-    expect(selectors.first().prop("options")).toEqual({
-      defaultFilters: {
-        "class.raw": ["field"],
-        "foo.bar": ["baz"]
-      }
-    });
-  });
 });

package/src/components/ruleImplementationForm/__tests__/__snapshots__/DataSetForm.spec.js.snap

@@ -1,153 +1,13 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`<DatasetForm /> matches the latest snapshot 1`] = `
-<Fragment>
-  <lazy
-    active={false}
-    joined={false}
-    key="0"
-    onChange={[Function]}
-    onChangeField={[Function]}
-    onClick={[Function]}
-    onDelete={[Function]}
-    options={
-      Object {
-        "defaultFilters": Object {
-          "class.raw": Array [
-            "",
-          ],
-        },
-      }
-    }
-    selectedStructure={
-      Object {
-        "structure": Object {
-          "id": 1,
-          "name": "strcuture1",
-          "path": Array [],
-          "system": Object {
-            "name": "system",
-          },
-        },
-      }
-    }
-    structures={
-      Array [
-        Object {
-          "structure": Object {
-            "id": 1,
-            "name": "strcuture1",
-            "path": Array [],
-            "system": Object {
-              "name": "system",
-            },
-          },
-        },
-        Object {
-          "clauses": Array [
-            Object {
-              "id": 100,
-            },
-            Object {
-              "id": 200,
-            },
-          ],
-          "join_type": "inner",
-          "structure": Object {
-            "id": 2,
-            "name": "structure2",
-            "path": Array [],
-            "system": Object {
-              "name": "system",
-            },
-          },
-        },
-      ]
-    }
-    systemRequired={false}
-  />
-  <lazy
-    active={false}
-    joined={true}
-    key="1"
-    onChange={[Function]}
-    onChangeField={[Function]}
-    onClick={[Function]}
-    onDelete={[Function]}
-    options={
-      Object {
-        "defaultFilters": Object {
-          "class.raw": Array [
-            "",
-          ],
-          "foo.bar": Array [
-            "baz",
-          ],
-        },
-      }
-    }
-    selectedStructure={
-      Object {
-        "clauses": Array [
-          Object {
-            "id": 100,
-          },
-          Object {
-            "id": 200,
-          },
-        ],
-        "join_type": "inner",
-        "structure": Object {
-          "id": 2,
-          "name": "structure2",
-          "path": Array [],
-          "system": Object {
-            "name": "system",
-          },
-        },
-      }
-    }
-    structures={
-      Array [
-        Object {
-          "structure": Object {
-            "id": 1,
-            "name": "strcuture1",
-            "path": Array [],
-            "system": Object {
-              "name": "system",
-            },
-          },
-        },
-        Object {
-          "clauses": Array [
-            Object {
-              "id": 100,
-            },
-            Object {
-              "id": 200,
-            },
-          ],
-          "join_type": "inner",
-          "structure": Object {
-            "id": 2,
-            "name": "structure2",
-            "path": Array [],
-            "system": Object {
-              "name": "system",
-            },
-          },
-        },
-      ]
-    }
-    systemRequired={false}
-  />
-  <Button
-    as="button"
+<div>
+  <button
+    class="ui button"
     id="add-structure-button"
-    onClick={[Function]}
+    style="display: none;"
   >
-    dataset.form.button.add_structure
-  </Button>
-</Fragment>
+    add_structure
+  </button>
+</div>
 `;

package/src/components/ruleImplementationForm/__tests__/__snapshots__/FiltersField.spec.js.snap

@@ -3,23 +3,18 @@
 exports[`<FiltersField /> matches the latest snapshot 1`] = `
 <lazy
   active={false}
+  defaultFilters={
+    Object {
+      "class.raw": Array [
+        "field",
+      ],
+    }
+  }
   fieldWidth={15}
   joined={false}
   onChange={[Function]}
   onClick={[Function]}
   onDelete={[Function]}
-  options={
-    Object {
-      "defaultFilters": Object {
-        "class.raw": Array [
-          "field",
-        ],
-        "foo.bar": Array [
-          "baz",
-        ],
-      },
-    }
-  }
   selectedStructure={
     Object {
       "structure": "1",

package/src/reducers/index.js

@@ -17,7 +17,6 @@ import { ruleImplementation } from "./ruleImplementation";
 import { ruleImplementationCount } from "./ruleImplementationCount";
 import { ruleImplementationCreating } from "./ruleImplementationCreating";
 import { ruleImplementationFilters } from "./ruleImplementationFilters";
-import { ruleImplementationFilterValues } from "./ruleImplementationFilterValues";
 import { ruleImplementationLoading } from "./ruleImplementationLoading";
 import { ruleImplementationQuery } from "./ruleImplementationQuery";
 import { ruleImplementationRaw } from "./ruleImplementationRaw";
@@ -65,7 +64,6 @@ export {
   ruleImplementationCount,
   ruleImplementationCreating,
   ruleImplementationFilters,
-  ruleImplementationFilterValues,
   ruleImplementationLoading,
   ruleImplementationQuery,
   ruleImplementationRaw,

package/src/routines.js

@@ -48,9 +48,6 @@ export const updateDeletionQuery = createRoutine("UPDATE_DELETION_QUERY");
 export const uploadRules = createRoutine("UPLOAD_RULES");
 export const uploadImplementations = createRoutine("UPLOAD_IMPLEMENTATIONS");
 export const clearStructure = createRoutine("CLEAR_STRUCTURE");
-export const setImplementationFilterValues = createRoutine(
-  "SET_IMPLEMENTATION_FILTER_VALUES"
-);
 export const searchRuleImplementations = createRoutine(
   "SEARCH_RULE_IMPLEMENTATIONS"
 );

package/src/selectors/__tests__/datasetDefaultFiltersSelector.spec.js

@@ -0,0 +1,17 @@
+import {
+  datasetDefaultFiltersSelector,
+  defaultFilters,
+} from "../datasetDefaultFiltersSelector";
+
+describe("datasetDefaultFiltersSelector", () => {
+  it("returns datasetDefaultFilters if present the state", () => {
+    const datasetDefaultFilters = { "class.raw": ["foo", "bar"] };
+    const state = { datasetDefaultFilters };
+    expect(datasetDefaultFiltersSelector(state)).toBe(datasetDefaultFilters);
+  });
+
+  it("returns the default value if datasetDefaultFilters is not present in the state", () => {
+    const state = {};
+    expect(datasetDefaultFiltersSelector(state)).toBe(defaultFilters);
+  });
+});

package/src/selectors/datasetDefaultFiltersSelector.js

@@ -0,0 +1,8 @@
+import _ from "lodash/fp";
+
+export const defaultFilters = { "class.raw": ["table"] };
+
+export const datasetDefaultFiltersSelector = _.propOr(
+  defaultFilters,
+  "datasetDefaultFilters"
+);

package/src/selectors/index.js

@@ -1,3 +1,4 @@
+export { datasetDefaultFiltersSelector } from "./datasetDefaultFiltersSelector";
 export { getImplementationsExecution } from "./getImplementationsExecution";
 export { getRuleAvailableFilters } from "./getRuleAvailableFilters";
 export { getRuleSelectedFilters } from "./getRuleSelectedFilters";
@@ -22,7 +23,6 @@ export {
   defaultImplementationColumns,
 } from "./getRuleImplementationColumns";
 export { getPreviousRuleImplementationQuery } from "./getPreviousRuleImplementationQuery";
-export { getRuleImplementationFormFilters } from "./getRuleImplementationFormFilters";
 export { getRuleImplementationAvailableFilters } from "./getRuleImplementationAvailableFilters";
 export { getRuleImplementationSelectedFilters } from "./getRuleImplementationSelectedFilters";
 export { getRuleImplementationSelectedFilterValues } from "./getRuleImplementationSelectedFilterValues";

package/src/reducers/__tests__/ruleImplementationFilterValues.spec.js

@@ -1,36 +0,0 @@
-import { clearRule, setImplementationFilterValues } from "../../routines";
-import { ruleImplementationFilterValues } from "..";
-
-const fooState = { foo: "bar" };
-const value = { system: { name: "Whatever" } };
-
-describe("reducers: ruleImplementationFilterValues", () => {
-  const initialState = null;
-
-  it("should provide the initial state", () => {
-    expect(ruleImplementationFilterValues(undefined, {})).toEqual(initialState);
-  });
-
-  it("should handle the setImplementationFilterValues.TRIGGER action", () => {
-    expect(
-      ruleImplementationFilterValues(fooState, {
-        type: setImplementationFilterValues.TRIGGER,
-        payload: { value }
-      })
-    ).toEqual(value);
-  });
-
-  it("should handle the clearRule.TRIGGER action", () => {
-    expect(
-      ruleImplementationFilterValues(fooState, {
-        type: clearRule.TRIGGER
-      })
-    ).toEqual(null);
-  });
-
-  it("should ignore unknown actions", () => {
-    expect(ruleImplementationFilterValues(fooState, { type: "FOO" })).toBe(
-      fooState
-    );
-  });
-});

package/src/reducers/ruleImplementationFilterValues.js

@@ -1,20 +0,0 @@
-import { clearRule, setImplementationFilterValues } from "../routines";
-
-/** @type {string} */
-export const initialState = null;
-
-export const ruleImplementationFilterValues = (
-  state = initialState,
-  { type, payload }
-) => {
-  switch (type) {
-    case setImplementationFilterValues.TRIGGER: {
-      const { value } = payload;
-      return value;
-    }
-    case clearRule.TRIGGER:
-      return initialState;
-    default:
-      return state;
-  }
-};

package/src/selectors/__tests__/getRuleImplementationFormFilters.spec.js

@@ -1,22 +0,0 @@
-import { getRuleImplementationFormFilters } from "..";
-
-const ruleImplementationFormFilters = [
-  { name: "system.name", filter: "system.name.raw", values: v => [v] }
-];
-
-const ruleImplementationFilterValues = { system: { name: "foo" } };
-
-describe("selectors: getRuleImplementationFormFilters", () => {
-  it("should return null when params do not exists", () => {
-    const res = getRuleImplementationFormFilters({});
-    expect(res).toMatchObject({});
-  });
-
-  it("should return default filters", () => {
-    const res = getRuleImplementationFormFilters({
-      ruleImplementationFormFilters,
-      ruleImplementationFilterValues
-    });
-    expect(res).toMatchObject({ "system.name.raw": ["foo"] });
-  });
-});

package/src/selectors/getRuleImplementationFormFilters.js

@@ -1,19 +0,0 @@
-import _ from "lodash/fp";
-import { createSelector } from "reselect";
-
-export const getRuleImplementationFormFilters = createSelector(
-  [
-    _.prop("ruleImplementationFilterValues"),
-    _.prop("ruleImplementationFormFilters")
-  ],
-  (ruleImplementationFilterValues, ruleImplementationFormFilters) =>
-    ruleImplementationFilterValues && ruleImplementationFormFilters
-      ? _.reduce(
-          (acc, { name, filter, values }) => ({
-            ...acc,
-            [filter]: values(_.path(name)(ruleImplementationFilterValues))
-          }),
-          {}
-        )(ruleImplementationFormFilters)
-      : {}
-);