@truedat/dq 4.36.2 → 4.36.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [4.36.4] 2022-01-19
+
+### Added
+
+- [TD-4293] Add rule implementations `events`
+
 ## [4.36.2] 2022-01-17
 
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/dq",
-  "version": "4.36.2",
+  "version": "4.36.6",
   "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.2",
-    "@truedat/df": "4.36.2",
+    "@truedat/core": "4.36.6",
+    "@truedat/df": "4.36.6",
     "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": "0f4c09d90582210ae7c98e945b8c0b7af0f9a61d"
+  "gitHead": "24162cf652f85f30de8669736abc28391fd5f6a8"
 }

package/src/components/RuleImplementationEventRow.js

@@ -0,0 +1,48 @@
+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 RuleImplementationEventRow = ({
+  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: "ruleImplementations.events.action_" + action },
+              [field, value]
+            )}
+          />
+        ))}
+      </Feed.Content>
+    </Feed.Event>
+  );
+};
+
+RuleImplementationEventRow.propTypes = {
+  user: PropTypes.object,
+  user_name: PropTypes.string,
+  ts: PropTypes.string,
+  payload: PropTypes.array,
+};
+
+export default RuleImplementationEventRow;

package/src/components/RuleImplementationEvents.js

@@ -0,0 +1,29 @@
+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 { RuleImplementationEventRow } from "./RuleImplementationEventRow";
+
+export const RuleImplementationEvents = ({ events, eventsLoading }) => {
+  return eventsLoading ? null : (
+    <Segment attached="bottom">
+      <Feed size="small">
+        {events.map((e, i) => (
+          <RuleImplementationEventRow key={i} {...e} />
+        ))}
+      </Feed>
+    </Segment>
+  );
+};
+RuleImplementationEvents.propTypes = {
+  events: PropTypes.array.isRequired,
+  eventsLoading: PropTypes.bool,
+};
+
+const mapStateToProps = (state) => ({
+  events: getParsedEvents(state),
+  eventsLoading: state.eventsLoading,
+});
+
+export default connect(mapStateToProps)(RuleImplementationEvents);

package/src/components/RuleImplementationTabs.js

@@ -7,6 +7,7 @@ import { compose } from "redux";
 import { connect } from "react-redux";
 import { FormattedMessage } from "react-intl";
 import {
+  RULE_IMPLEMENTATION_EVENTS,
   RULE_IMPLEMENTATION_RESULTS_DETAILS,
   RULE_IMPLEMENTATION_MOVE,
   RULE_IMPLEMENTATION_RESULTS,
@@ -59,6 +60,16 @@ export const RuleImplementationTabs = ({ rule, ruleImplementation, match }) => {
           <FormattedMessage id="tabs.dq.ruleImplementation.details" />
         </Menu.Item>
       )}
+      <Menu.Item
+        active={match.path === RULE_IMPLEMENTATION_EVENTS}
+        as={Link}
+        to={linkTo.RULE_IMPLEMENTATION_EVENTS({
+          id: rule.id,
+          implementation_id: ruleImplementation.id,
+        })}
+      >
+        <FormattedMessage id="tabs.dq.ruleImplementation.audit" />
+      </Menu.Item>
     </Menu>
   );
 };

package/src/components/RuleRoutes.js

@@ -1,7 +1,7 @@
 import _ from "lodash/fp";
 import React from "react";
 import PropTypes from "prop-types";
-import { Route, Switch } from "react-router-dom";
+import { Route, Switch, useRouteMatch } from "react-router-dom";
 import { connect } from "react-redux";
 import { Segment } from "semantic-ui-react";
 import { Unauthorized } from "@truedat/core/components";
@@ -12,6 +12,7 @@ import {
   RULE_IMPLEMENTATION_RESULT_DETAILS,
   RULE_IMPLEMENTATION_RESULTS_DETAILS,
   RULE_IMPLEMENTATION,
+  RULE_IMPLEMENTATION_EVENTS,
   RULE_IMPLEMENTATION_NEW,
   RULE_IMPLEMENTATION_CLONE,
   RULE_IMPLEMENTATION_EDIT,
@@ -32,6 +33,7 @@ import NewRuleImplementation from "./NewRuleImplementation";
 import Rule from "./Rule";
 import RuleCrumbs from "./RuleCrumbs";
 import RuleImplementation from "./RuleImplementation";
+import RuleImplementationEvents from "./RuleImplementationEvents";
 import RuleImplementationLoader from "./RuleImplementationLoader";
 import RuleImplementationProperties from "./RuleImplementationProperties";
 import RuleImplementationResults from "./RuleImplementationResults";
@@ -47,6 +49,9 @@ const DomainsLoader = React.lazy(() =>
 const DynamicFormViewer = React.lazy(() =>
   import("@truedat/df/components/DynamicFormViewer")
 );
+const EventsLoader = React.lazy(() =>
+  import("@truedat/audit/components/EventsLoader")
+);
 const TemplatesLoader = React.lazy(() =>
   import("@truedat/df/templates/components/TemplatesLoader")
 );
@@ -56,6 +61,12 @@ const ImplementationStructuresLoader = React.lazy(() =>
 const QualityTemplatesLoader = () => <TemplatesLoader scope="dq" />;
 const ImplementationTemplatesLoader = () => <TemplatesLoader scope="ri" />;
 
+const ImplementationEventsLoader = () => {
+  const match = useRouteMatch();
+  const id = _.path("params.implementation_id")(match);
+  return <EventsLoader resource_id={id} resource_type="implementation" />;
+};
+
 const RuleRoutes = ({
   ruleLoaded,
   ruleImplementationLoaded,
@@ -132,6 +143,7 @@ const RuleRoutes = ({
                       <RuleCrumbs />
                       <Segment>
                         <RuleSubscriptionLoader />
+                        <RuleImplementationLoader />
                         <RuleImplementationsFromRuleLoader />
                         {ruleLoaded && <Rule />}
                         {ruleLoaded && <RuleFormImplementations />}
@@ -139,6 +151,25 @@ const RuleRoutes = ({
                     </>
                   )}
                 />
+                <Route
+                  exact
+                  path={RULE_IMPLEMENTATION_EVENTS}
+                  render={() => (
+                    <>
+                      <RuleCrumbs />
+                      <Segment>
+                        <ImplementationEventsLoader />
+                        <RuleImplementationLoader />
+                        {ruleLoaded && ruleImplementationLoaded && (
+                          <RuleImplementation>
+                            <RuleImplementationEvents />
+                          </RuleImplementation>
+                        )}
+                      </Segment>
+                    </>
+                  )}
+                />
+
                 <Route
                   exact
                   path={RULE_IMPLEMENTATION_NEW}
@@ -271,7 +302,6 @@ const RuleRoutes = ({
                     <>
                       <Segment>
                         <RuleImplementationLoader />
-
                         {ruleLoaded && ruleImplementationLoaded && (
                           <>
                             <RuleCrumbs />

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

@@ -21,6 +21,7 @@ const renderOpts = {
     en: {
       "tabs.dq.ruleImplementation.results": "results",
       "tabs.dq.ruleImplementation": "implementation",
+      "tabs.dq.ruleImplementation.audit": "events",
       "ruleImplementation.actions.clone": "clone",
       "ruleImplementation.actions.move": "move",
       "ruleImplementation.actions.edit": "edit",

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

@@ -0,0 +1,43 @@
+import React from "react";
+import { render } from "@truedat/test/render";
+import { RuleImplementationEvents } from "../RuleImplementationEvents";
+
+describe("<RuleImplementationEvents />", () => {
+  const events = [
+    {
+      id: 1,
+      service: "service",
+      event: "implementation_restored",
+      resource_id: 100,
+      ts: "2019-08-12T02:00:00Z",
+      payload: [{ field: "foo", action: "restored" }],
+    },
+    {
+      id: 2,
+      service: "service",
+      event: "implementation_deprecated",
+      resource_id: 100,
+      ts: "2019-09-12T02:00:00Z",
+      payload: [{ field: "bar", action: "deprecated" }],
+    },
+  ];
+  const renderOpts = {
+    messages: {
+      en: {
+        "ruleImplementations.events.field_restored": "implementation restored",
+        "ruleImplementations.events.field_deprecated":
+          "implementation deprecated",
+      },
+    },
+  };
+
+  const props = { events };
+
+  it("matches the latest snapshot", () => {
+    const { container } = render(
+      <RuleImplementationEvents {...props} />,
+      renderOpts
+    );
+    expect(container).toMatchSnapshot();
+  });
+});

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

@@ -140,6 +140,12 @@ exports[`<RuleImplementation /> matches the latest snapshot 1`] = `
     >
       results
     </a>
+    <a
+      class="item"
+      href="/rules/1/implementations/1/events"
+    >
+      events
+    </a>
   </div>
 </div>
 `;

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

@@ -0,0 +1,74 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`<RuleImplementationEvents /> 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"
+            />
+             
+            <div
+              class="date"
+            >
+              <time
+                datetime="1565575200000"
+              >
+                2019-08-12 02:00
+              </time>
+            </div>
+          </div>
+          <div
+            class="text extra"
+          >
+            ruleImplementations.events.action_restored
+          </div>
+        </div>
+      </div>
+      <div
+        class="event"
+      >
+        <div
+          class="content"
+        >
+          <div
+            class="summary"
+          >
+            <a
+              class="user"
+            />
+             
+            <div
+              class="date"
+            >
+              <time
+                datetime="1568253600000"
+              >
+                2019-09-12 02:00
+              </time>
+            </div>
+          </div>
+          <div
+            class="text extra"
+          >
+            ruleImplementations.events.action_deprecated
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+`;

package/src/components/index.js

@@ -12,6 +12,7 @@ import QualityRoutes from "./QualityRoutes";
 import Rule from "./Rule";
 import RuleForm from "./RuleForm";
 import RuleFormImplementations from "./RuleFormImplementations";
+import RuleImplementationEvents from "./RuleImplementationEvents";
 import RuleImplementationsFromRuleLoader from "./RuleImplementationsFromRuleLoader";
 import RuleImplementationsLoader from "./RuleImplementationsLoader";
 import RuleLoader from "./RuleLoader";
@@ -35,6 +36,7 @@ export {
   Rule,
   RuleForm,
   RuleFormImplementations,
+  RuleImplementationEvents,
   RuleImplementationsLoader,
   RuleImplementationsFromRuleLoader,
   RuleLoader,

package/src/messages/en.js

@@ -5,6 +5,7 @@ export default {
   "actions.prev": "Previous",
   "actions.save": "Save",
   "actions.submit": "Submit",
+  "alert.deleteRuleImplementation.failed.header": "Error deprecating implementation",
   "alert.createExecutionGroup.success.content":
     "{count} implementations queued for execution",
   "alert.createExecutionGroup.success.header": "Executions scheduled",
@@ -464,6 +465,12 @@ export default {
   "ruleImplementations.actions.upload.tooltip": "Upload Implementations",
   "ruleImplementations.actions.upload.confirmation.header":
     "Confirm bulk upload",
+  "ruleImplementations.events.action_created": "Implementation created on rule: {0}",
+  "ruleImplementations.events.action_changed": "Field {0} changed to {1}",
+  "ruleImplementations.events.action_deprecated": "Implementation deprecated",
+  "ruleImplementations.events.action_moved": "Implementation moved to rule: {0}",
+  "ruleImplementations.events.action_restored": "Implementation restored",
+  "ruleImplementations.events.action_updated": "Implementation updated",
   "ruleImplementations.header": "Quality Implementations",
   "ruleImplementations.props.business_concept": "Concept",
   "ruleImplementations.props.status": "Status",
@@ -549,6 +556,7 @@ export default {
   "summary.link.and": "and",
   "tabs.dq.rule": "Rule",
   "tabs.dq.ruleImplementation": "Implementation",
+  "tabs.dq.ruleImplementation.audit": "Audit",
   "tabs.dq.ruleImplementation.details": "Details",
   "tabs.dq.ruleImplementation.results": "Results",
   "tabs.dq.ruleImplementations": "Implementations",

package/src/messages/es.js

@@ -5,6 +5,7 @@ export default {
   "actions.prev": "Anterior",
   "actions.save": "Guardar",
   "actions.submit": "Guardar",
+  "alert.deleteRuleImplementation.failed.header": "Error al archivar implementación",
   "alert.createExecutionGroup.success.content":
     "Se ha solicitado la ejecución de {count} implementaciones",
   "alert.createExecutionGroup.success.header": "Ejecuciones programadas",
@@ -476,6 +477,12 @@ export default {
   "ruleImplementations.actions.create": "Crear nueva implementación",
   "ruleImplementations.actions.edit": "Editar implementación",
   "ruleImplementations.actions.popup.deprecated": "Implementaciones Archivadas",
+  "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}",
+  "ruleImplementations.events.action_restored": "Implementación restaurada",
+  "ruleImplementations.events.action_updated": "Implementación actualizada",
   "ruleImplementations.header": "Implementaciones de calidad",
   "ruleImplementations.props.business_concept": "Concepto",
   "ruleImplementations.props.executable.false": "Interna",
@@ -564,6 +571,7 @@ export default {
   "structureFields.dropdown.placeholder": "Campos",
   "summary.link.and": "y",
   "tabs.dq.rule": "Regla",
+  "tabs.dq.ruleImplementation.audit": "Auditoría",
   "tabs.dq.ruleImplementation.details": "Detalles",
   "tabs.dq.ruleImplementation.results": "Resultados",
   "tabs.dq.ruleImplementation": "Implementación",

package/src/selectors/getParsedEvents.js

@@ -0,0 +1,86 @@
+import _ from "lodash/fp";
+import { createSelector } from "reselect";
+
+const getEvents = ({ events }) => {
+  return events;
+};
+
+const transformFieldFormat = (field) =>
+  _.isBoolean(field) ? _.toString(field) : field;
+
+const getParsedEvents = createSelector([getEvents], (events) => {
+  return _.map((d) => {
+    switch (d.event) {
+      case "implementation_created":
+        return {
+          ...d,
+          payload: [
+            {
+              field: _.path("payload.rule_name")(d),
+              action: "created",
+            },
+          ],
+        };
+      case "implementation_moved":
+        return {
+          ...d,
+          payload: [
+            {
+              field: _.path("payload.rule_name")(d),
+              action: "moved",
+            },
+          ],
+        };
+      case "implementation_restored":
+        return {
+          ...d,
+          payload: [
+            {
+              field: _.path("payload.implementation_key")(d),
+              action: "restored",
+            },
+          ],
+        };
+      case "implementation_deleted":
+        return {};
+      case "implementation_deprecated":
+        return {
+          ...d,
+          payload: [
+            {
+              field: _.path("payload.implementation_key")(d),
+              action: "deprecated",
+            },
+          ],
+        };
+      case "implementation_changed":
+        return {
+          ...d,
+          payload: _.flow(
+            _.path("payload.df_content.changed"),
+            _.keys,
+            _.map((e) => ({
+              field: e,
+              action: "changed",
+              value: transformFieldFormat(
+                _.path(`payload.df_content.changed.${e}`)(d)
+              ),
+            }))
+          )(d),
+        };
+
+      default:
+        return {
+          ...d,
+          payload: [
+            {
+              field: _.path("payload.implementation_key")(d),
+              action: "updated",
+            },
+          ],
+        };
+    }
+  })(events);
+});
+
+export { getParsedEvents };

package/src/selectors/index.js

@@ -28,3 +28,4 @@ export { getRuleImplementationSelectedFilters } from "./getRuleImplementationSel
 export { getRuleImplementationSelectedFilterValues } from "./getRuleImplementationSelectedFilterValues";
 export { getRuleImplementationSelectedFilterActiveValues } from "./getRuleImplementationSelectedFilterActiveValues";
 export * from "./getImplementationStructures";
+export { getParsedEvents } from "./getParsedEvents";