@truedat/dq 4.36.8 → 4.37.2

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [4.37.2] 2022-02-02
+
+### Added
+
+- [TD-4294] Rule audit tab
+
+## [4.37.1] 2022-02-02
+
+### Changed
+
+- [TD-4152] Include aditional information on implementations download
+
+## [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.8",
+  "version": "4.37.2",
   "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.8",
-    "@truedat/df": "4.36.8",
+    "@truedat/core": "4.37.2",
+    "@truedat/df": "4.37.2",
     "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": "b9b8ee80998b230697593b5d207d187971bc0724"
+  "gitHead": "ca6ba01d31ab5ec415b9b21d6ce02b418fc6e0ff"
 }

package/src/components/RuleEventRow.js

@@ -0,0 +1,47 @@
+import _ from "lodash/fp";
+import React from "react";
+import PropTypes from "prop-types";
+import { Feed } from "semantic-ui-react";
+import { useIntl } from "react-intl";
+import Moment from "react-moment";
+
+export const RuleEventRow = ({ user, user_name, ts, payload }) => {
+  const { formatMessage, locale } = useIntl();
+  const userName = _.propOr(user_name, "user_name")(user);
+
+  return _.isEmpty(payload) ? null : (
+    <Feed.Event>
+      <Feed.Content>
+        <Feed.Summary>
+          <Feed.User>{userName}</Feed.User>{" "}
+          <Feed.Date>
+            <Moment locale={locale} date={ts} format="YYYY-MM-DD HH:mm" />
+          </Feed.Date>
+        </Feed.Summary>
+        {payload.map(({ field, action, value }, i) => (
+          <Feed.Extra
+            key={i}
+            text
+            content={formatMessage(
+              {
+                id: `rules.events.action_${action}${
+                  typeof value === "undefined" || _.isObject(value) ? "" : "_to"
+                }`,
+              },
+              [field, JSON.stringify(value)]
+            )}
+          />
+        ))}
+      </Feed.Content>
+    </Feed.Event>
+  );
+};
+
+RuleEventRow.propTypes = {
+  user: PropTypes.object,
+  user_name: PropTypes.string,
+  ts: PropTypes.string,
+  payload: PropTypes.array,
+};
+
+export default RuleEventRow;

package/src/components/RuleEvents.js

@@ -0,0 +1,32 @@
+
+import React from "react";
+import PropTypes from "prop-types";
+import { Feed, Segment } from "semantic-ui-react";
+import { connect } from "react-redux";
+import { getParsedEvents } from "../selectors";
+import { RuleEventRow } from "./RuleEventRow";
+
+export const RuleEvents = ({ events, eventsLoading }) => {
+  return eventsLoading ? null : (
+    <Segment attached="bottom">
+      <Feed size="small">
+        {events.map((e, i) => (
+          <RuleEventRow key={i} {...e} />
+        ))}
+      </Feed>
+    </Segment>
+  );
+};
+RuleEvents.propTypes = {
+  events: PropTypes.array.isRequired,
+  eventsLoading: PropTypes.bool,
+};
+
+const mapStateToProps = (state) => {
+  return {
+    events: getParsedEvents(state),
+    eventsLoading: state.eventsLoading,
+  };
+};
+
+export default connect(mapStateToProps)(RuleEvents);

package/src/components/RuleImplementationsDownload.js

@@ -10,7 +10,8 @@ const staticHeaderLabels = [
   "implementation_key",
   "implementation_type",
   "rule",
-  "template",
+  "rule_template",
+  "implementation_template",
   "goal",
   "minimum",
   "business_concept",

package/src/components/RuleRoutes.js

@@ -9,6 +9,7 @@ import { useAuthorized } from "@truedat/core/hooks";
 import {
   RULE,
   RULE_EDIT,
+  RULE_EVENTS,
   RULE_IMPLEMENTATION_RESULT_DETAILS,
   RULE_IMPLEMENTATION_RESULTS_DETAILS,
   RULE_IMPLEMENTATION,
@@ -32,6 +33,7 @@ import NewRule from "./NewRule";
 import NewRuleImplementation from "./NewRuleImplementation";
 import Rule from "./Rule";
 import RuleCrumbs from "./RuleCrumbs";
+import RuleEvents from "./RuleEvents";
 import RuleImplementation from "./RuleImplementation";
 import RuleImplementationEvents from "./RuleImplementationEvents";
 import RuleImplementationLoader from "./RuleImplementationLoader";
@@ -61,6 +63,12 @@ const ImplementationStructuresLoader = React.lazy(() =>
 const QualityTemplatesLoader = () => <TemplatesLoader scope="dq" />;
 const ImplementationTemplatesLoader = () => <TemplatesLoader scope="ri" />;
 
+const RuleEventsLoader = () => {
+  const match = useRouteMatch();
+  const id = _.path("params.id")(match);
+  return <EventsLoader resource_id={id} resource_type="rule" />;
+};
+
 const ImplementationEventsLoader = () => {
   const match = useRouteMatch();
   const id = _.path("params.implementation_id")(match);
@@ -135,6 +143,22 @@ const RuleRoutes = ({
                     </>
                   )}
                 />
+
+                <Route
+                  exact
+                  path={RULE_EVENTS}
+                  render={() => (
+                    <>
+                      <RuleCrumbs />
+                      <Segment>
+                        <RuleEventsLoader />
+                        {ruleLoaded && <Rule />}
+                        {ruleLoaded && <RuleEvents />}
+                      </Segment>
+                    </>
+                  )}
+                />
+
                 <Route
                   exact
                   path={RULE_IMPLEMENTATIONS}

package/src/components/RuleTabs.js

@@ -6,7 +6,12 @@ import { Link } from "react-router-dom";
 import { connect } from "react-redux";
 import { FormattedMessage } from "react-intl";
 import { usePath } from "@truedat/core/hooks";
-import { RULE, RULE_IMPLEMENTATIONS, linkTo } from "@truedat/core/routes";
+import {
+  RULE,
+  RULE_IMPLEMENTATIONS,
+  RULE_EVENTS,
+  linkTo,
+} from "@truedat/core/routes";
 
 const RuleTabs = ({ rule }) => {
   const path = usePath();
@@ -22,6 +27,15 @@ const RuleTabs = ({ rule }) => {
       >
         <FormattedMessage id="tabs.dq.ruleImplementations" />
       </Menu.Item>
+      <Menu.Item
+        active={path === RULE_EVENTS}
+        as={Link}
+        to={linkTo.RULE_EVENTS({
+          id: rule.id,
+        })}
+      >
+        <FormattedMessage id="tabs.dq.rule.audit" />
+      </Menu.Item>
     </Menu>
   );
 };

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

@@ -0,0 +1,33 @@
+import React from "react";
+import { render } from "@truedat/test/render";
+import { RuleEventRow } from "../RuleEventRow";
+
+describe("<RuleEventsRow />", () => {
+  const props = {
+    payload: [
+      {
+        field: "field1",
+        action: "changed",
+        value: "new value",
+      },
+    ],
+    user_name: "some.user@domain.tld",
+    user: {
+      email: "some.user@domain.tld",
+      full_name: "Some User",
+      id: 142,
+      user_name: "some.user@domain.tld",
+    },
+    ts: "2021-09-16T07:36:32.848603Z",
+  };
+  const renderOpts = {
+    messages: {
+      en: { "rules.events.action_changed_to": "Field {0} changed to: {1}" },
+    },
+  };
+
+  it("matches the latest snapshot", () => {
+    const { container } = render(<RuleEventRow {...props} />, renderOpts);
+    expect(container).toMatchSnapshot();
+  });
+});

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

@@ -0,0 +1,64 @@
+import React from "react";
+import { render } from "@truedat/test/render";
+import { RuleEvents } from "../RuleEvents";
+import { getParsedEvents } from "../../selectors/getParsedEvents";
+
+describe("<RuleEvents />", () => {
+  const events = [
+    {
+      id: 100217,
+      service: "td_dd",
+      resource_id: 777,
+      resource_type: "rule",
+      event: "rule_updated",
+      payload: {
+        domain_id: 140,
+      },
+      user_id: 142,
+      user_name: null,
+      user: {
+        email: "some.user@domain.tld",
+        full_name: "Some User",
+        id: 142,
+        user_name: "some.user@domain.tld"
+      },
+      ts: "2021-09-16T07:36:32.848603Z"
+    },
+    {
+      id: 100436,
+      service: "td_dd",
+      resource_id: 777,
+      resource_type: "rule",
+      event: "rule_updated",
+      payload: {
+        domain_id: 168
+      },
+      user_id: 171,
+      user_name: null,
+      user: {
+        email: "some.user@domain.tld",
+        full_name: "Some User",
+        id: 171,
+        user_name: "some.user"
+      },
+      ts: "2021-09-16T09:31:03.061864Z"
+    },
+  ];
+  const renderOpts = {
+    messages: {
+      en: {
+        "rules.events.action_created": "Rule created",
+        "rules.events.action_changed": "Field {0} changed: {1}",
+        "rules.events.action_changed_to": "Field {0} changed to: {1}",
+        "rules.events.action_updated": "Rule updated",
+      },
+    },
+  };
+
+  const props = { events: getParsedEvents({ events }), eventsLoading: false };
+
+  it("matches the latest snapshot", () => {
+    const { container } = render(<RuleEvents {...props} />, renderOpts);
+    expect(container).toMatchSnapshot();
+  });
+});

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__/RuleEventRow.spec.js.snap

@@ -0,0 +1,38 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`<RuleEventsRow /> matches the latest snapshot 1`] = `
+<div>
+  <div
+    class="event"
+  >
+    <div
+      class="content"
+    >
+      <div
+        class="summary"
+      >
+        <a
+          class="user"
+        >
+          some.user@domain.tld
+        </a>
+         
+        <div
+          class="date"
+        >
+          <time
+            datetime="1631777792848"
+          >
+            2021-09-16 07:36
+          </time>
+        </div>
+      </div>
+      <div
+        class="text extra"
+      >
+        Field field1 changed to: "new value"
+      </div>
+    </div>
+  </div>
+</div>
+`;

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

@@ -0,0 +1,78 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`<RuleEvents /> matches the latest snapshot 1`] = `
+<div>
+  <div
+    class="ui bottom attached segment"
+  >
+    <div
+      class="ui small feed"
+    >
+      <div
+        class="event"
+      >
+        <div
+          class="content"
+        >
+          <div
+            class="summary"
+          >
+            <a
+              class="user"
+            >
+              some.user@domain.tld
+            </a>
+             
+            <div
+              class="date"
+            >
+              <time
+                datetime="1631777792848"
+              >
+                2021-09-16 07:36
+              </time>
+            </div>
+          </div>
+          <div
+            class="text extra"
+          >
+            Field domain_id changed to: 140
+          </div>
+        </div>
+      </div>
+      <div
+        class="event"
+      >
+        <div
+          class="content"
+        >
+          <div
+            class="summary"
+          >
+            <a
+              class="user"
+            >
+              some.user
+            </a>
+             
+            <div
+              class="date"
+            >
+              <time
+                datetime="1631784663061"
+              >
+                2021-09-16 09:31
+              </time>
+            </div>
+          </div>
+          <div
+            class="text extra"
+          >
+            Field domain_id changed to: 168
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+`;

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;