@truedat/dq 4.37.1 → 4.37.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [4.37.2] 2022-02-02
+
+### Added
+
+- [TD-4294] Rule audit tab
+
 ## [4.37.1] 2022-02-02
 
 ### Changed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/dq",
-  "version": "4.37.1",
+  "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.37.1",
-    "@truedat/df": "4.37.1",
+    "@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": "36ffd7e86efe27f38c3ae1bb616eb9eb4d444d12"
+  "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/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__/__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/messages/en.js

@@ -132,6 +132,7 @@ export default {
     "All rule implementations should be removed",
   "rule.error.rule_name_bc_id.unique_constraint":
     "Duplicated rule name. Edit name or associated business concept.",
+  
   "rule.form.accordion.select": "Select",
   "rule.form.concept.label": "Concept",
   "ruleImplementation.form.tooltip.deviation.goal":
@@ -541,6 +542,10 @@ export default {
   "rules.actions.upload.confirmation.header": "Confirm bulk upload",
   "rules.actions.upload.tooltip": "Upload Rules",
   "rules.crumbs.top": "Rules",
+  "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",
   "rules.retrieved.results": "{count} rules found",
   "rules.search.placeholder": "Search rules...",
   "rules.searching": "Searching...",
@@ -557,6 +562,7 @@ export default {
   "structureFields.dropdown.placeholder": "Fields",
   "summary.link.and": "and",
   "tabs.dq.rule": "Rule",
+  "tabs.dq.rule.audit": "Audit",
   "tabs.dq.ruleImplementation": "Implementation",
   "tabs.dq.ruleImplementation.audit": "Audit",
   "tabs.dq.ruleImplementation.details": "Details",

package/src/messages/es.js

@@ -556,6 +556,14 @@ export default {
   "rules.actions.upload.confirmation.header": "Subir ficheros de reglas",
   "rules.actions.upload.tooltip": "Subir reglas",
   "rules.crumbs.top": "Reglas",
+  "rules.events.action_created": "Regla creada",
+  "rules.events.action_changed": "Campo {0} actualizado: {1}",
+  "rules.events.action_changed_to": "Campo {0} actualizado a {1}",
+  "rules.events.action_updated": "Regla actualizada",
+  "ruleImplementations.events.action_created": "Implementación creada en regla: {0}",
+  "ruleImplementations.events.action_changed": "Campo {0} actualizado a {1}",
+  "ruleImplementations.events.action_deprecated": "Implementación archivada",
+  "ruleImplementations.events.action_moved": "Implementación movida a la regla: {0}",
   "rules.retrieved.results": "{count} reglas encontradas",
   "rules.search.placeholder": "Buscar reglas...",
   "rules.searching": "Buscando...",
@@ -573,6 +581,7 @@ export default {
   "structureFields.dropdown.placeholder": "Campos",
   "summary.link.and": "y",
   "tabs.dq.rule": "Regla",
+  "tabs.dq.rule.audit": "Auditoría",
   "tabs.dq.ruleImplementation.audit": "Auditoría",
   "tabs.dq.ruleImplementation.details": "Detalles",
   "tabs.dq.ruleImplementation.results": "Resultados",

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

@@ -0,0 +1,173 @@
+import { getParsedEvents } from "..";
+
+describe("selectors: getParsedEvents", () => {
+  const events = [
+    {
+      id: 52351,
+      service: "td_dd",
+      resource_id: 777,
+      resource_type: "rule",
+      event: "rule_created",
+      payload: {
+        active: true,
+        content: {
+          added: {
+            data_owner: null,
+            proyecto: ["P1"],
+          },
+        },
+        description: {},
+        df_name: "dq_default_template",
+        domain_id: 2,
+        goal: 20,
+        minimum: 80,
+        name: "des01",
+        result_type: "deviation",
+        updated_by: 398,
+      },
+      user_id: 398,
+      user_name: null,
+      user: {
+        email: "some.user@domain.tld",
+        full_name: "Some User",
+        id: 398,
+        user_name: "some.user@domain.tld",
+      },
+      ts: "2021-08-12T12:11:26.908147Z",
+    },
+
+    {
+      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: 100435,
+      service: "td_dd",
+      resource_id: 777,
+      resource_type: "rule",
+      event: "rule_updated",
+      payload: {
+        description: {
+          document: {
+            data: {},
+            nodes: [
+              {
+                data: {},
+                nodes: [
+                  {
+                    marks: [],
+                    object: "text",
+                    text: "Añadimos descripción a la regla",
+                  },
+                ],
+                object: "block",
+                type: "paragraph",
+              },
+            ],
+            object: "document",
+          },
+          object: "value",
+        },
+        updated_by: 171,
+      },
+      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:30:52.317357Z",
+    },
+    {
+      id: 177692,
+      service: "td_dd",
+      resource_id: 777,
+      resource_type: "rule",
+      event: "rule_updated",
+      payload: {
+        content: {
+          changed: {
+            data_stew: null,
+            principle: "Validez",
+            scheduler: "",
+            tags: "et",
+          },
+          removed: {
+            data_owner: null,
+            proyecto: ["P1"],
+          },
+        },
+        df_name: "quality_template",
+        updated_by: 426,
+      },
+      user_id: 426,
+      user_name: null,
+      user: {
+        email: "some.user@domain.tld",
+        full_name: "Some User",
+        id: 426,
+        user_name: "some.user",
+      },
+      ts: "2021-10-20T07:56:45.891087Z",
+    },
+  ];
+
+  const parsed = [
+    {
+      ...events[0],
+      payload: [{ field: "des01", action: "created" }],
+    },
+    {
+      ...events[1],
+      payload: [{ field: "domain_id", action: "changed", value: 140 }],
+    },
+    {
+      ...events[2],
+      payload: [
+        {
+          field: "description",
+          action: "changed",
+          value: "Añadimos descripción a la regla",
+        },
+      ],
+    },
+    {
+      ...events[3],
+      payload: [
+        { field: "df_name", action: "changed", value: "quality_template" },
+        { action: "changed", field: "data_stew", value: null },
+        { action: "changed", field: "principle", value: "Validez" },
+        { action: "changed", field: "scheduler", value: "" },
+        { action: "changed", field: "tags", value: "et" },
+      ],
+    },
+  ];
+
+  it("should return all the events with the new payload", () => {
+    const res = getParsedEvents({ events });
+    expect(res).toEqual(parsed);
+  });
+
+  it("should return empty array when we have no elements", () => {
+    const res = getParsedEvents({ events: [] });
+    expect(res).toHaveLength(0);
+    expect(res).toEqual(expect.arrayContaining([]));
+  });
+});

package/src/selectors/getParsedEvents.js

@@ -8,6 +8,24 @@ const getEvents = ({ events }) => {
 const transformFieldFormat = (field) =>
   _.isBoolean(field) ? _.toString(field) : field;
 
+const findDeep = (obj, key) =>
+  _.has(key, obj)
+    ? obj[key]
+    : _.flatten(
+        _.map((v) => (typeof v == "object" ? findDeep(v, key) : []), obj)
+      );
+
+const transformRulePayloadFormat = (payload, field) => {
+  switch (field) {
+    case "content":
+      return payload.content;
+    case "description":
+      return _.first(findDeep(payload.description, "text"));
+    default:
+      return payload[field];
+  }
+};
+
 const getParsedEvents = createSelector([getEvents], (events) => {
   return _.map((d) => {
     switch (d.event) {
@@ -68,6 +86,43 @@ const getParsedEvents = createSelector([getEvents], (events) => {
             }))
           )(d),
         };
+      case "rule_created":
+        return {
+          ...d,
+          payload: [
+            {
+              field: _.path("payload.name")(d),
+              action: "created",
+            },
+          ],
+        };
+
+      case "rule_updated":
+        const content = _.flow(
+          _.getOr({}, "payload.content.changed"),
+          _.toPairs,
+          _.map(([field, value]) => ({
+            field,
+            value,
+            action: "changed",
+          }))
+        )(d);
+        return {
+          ...d,
+          payload: [
+            ..._.flow(
+              _.path("payload"),
+              _.omit(["updated_by", "content"]),
+              _.keys,
+              _.map((field) => ({
+                field: field,
+                action: "changed",
+                value: transformRulePayloadFormat(d.payload, field),
+              }))
+            )(d),
+            ...content,
+          ],
+        };
 
       default:
         return {