@truedat/dq 4.54.3 → 4.54.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [4.54.4] 2022-10-25
+
+### Added
+
+- [TD-3765] Add empty datset status for rule results
+
 ## [4.54.3] 2022-10-25
 
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/dq",
-  "version": "4.54.3",
+  "version": "4.54.4",
   "description": "Truedat Web Data Quality Module",
   "sideEffects": false,
   "jsnext:main": "src/index.js",
@@ -34,7 +34,7 @@
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^12.0.0",
     "@testing-library/user-event": "^13.2.1",
-    "@truedat/test": "4.54.0",
+    "@truedat/test": "4.54.4",
     "babel-jest": "^28.1.0",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "babel-plugin-lodash": "^3.3.4",
@@ -93,8 +93,8 @@
   },
   "dependencies": {
     "@apollo/client": "^3.7.0",
-    "@truedat/core": "4.54.3",
-    "@truedat/df": "4.54.3",
+    "@truedat/core": "4.54.4",
+    "@truedat/df": "4.54.4",
     "graphql": "^15.5.3",
     "path-to-regexp": "^1.7.0",
     "prop-types": "^15.8.1",
@@ -114,5 +114,5 @@
     "react-dom": ">= 16.8.6 < 17",
     "semantic-ui-react": ">= 0.88.2 < 2.1"
   },
-  "gitHead": "3491865891d8b2e2b7ea41aef81a43ef16005c36"
+  "gitHead": "065f4870d4b2195564585d7d70fec26b475f337a"
 }

package/src/components/ImplementationResultBar.js

@@ -1,6 +1,7 @@
 import _ from "lodash/fp";
 import React from "react";
 import PropTypes from "prop-types";
+import { DateTime } from "@truedat/core/components/DateTime";
 import { Popup } from "semantic-ui-react";
 import { Link } from "react-router-dom";
 import { FormattedMessage, useIntl } from "react-intl";
@@ -17,6 +18,14 @@ export default function ImplementationResultBar({ implementation }) {
           color: "failed",
           resultText: intl.formatMessage({ id: "quality.error" }),
         }
+      : ruleResult?.records === 0
+      ? {
+          color: "empyDataset",
+          resultText: intl.formatMessage(
+            { id: `quality.result.empty_dataset.date` },
+            { date: <DateTime value={ruleResult.date} /> }
+          ),
+        }
       : calculateResultDecoration({
           ruleResult,
           ruleImplementation: implementation,
@@ -41,6 +50,10 @@ export default function ImplementationResultBar({ implementation }) {
       className: "not-executed-color",
       tooltip: "no_execution",
     },
+    empyDataset: {
+      className: "empty-dataset-color",
+      tooltip: "empty_dataset",
+    },
     failed: {
       className: "failed-color",
       tooltip: "failed",

package/src/components/RuleImplementationsDownload.js

@@ -26,7 +26,9 @@ const staticContentLabels = [
   "quality_result.under_minimum",
   "quality_result.under_goal",
   "quality_result.over_goal",
+  "quality_result.failed",
   "quality_result.no_execution",
+  "quality_result.empty_dataset",
   "executable.true",
   "executable.false",
 ];

package/src/components/RuleResultDecorator.js

@@ -26,6 +26,15 @@ export const calculateResultDecoration = ({
       color: "red",
       resultText,
     };
+  } else if (ruleResult?.records === 0) {
+    const resultText = formatMessage({ id: "quality_result.empty_dataset" });
+    return {
+      iconName: "warning circle",
+      resultText: resultText,
+      color: "grey",
+      resultText,
+      inverted: true,
+    };
   }
 
   const { resultType, result_type } = ruleImplementation;
@@ -62,16 +71,22 @@ export const RuleResultDecorator = ({
   if (nilResult(ruleResult) && isNil(date)) {
     return null;
   }
-  const { iconName, color, resultText, iconTitle } = calculateResultDecoration({
-    ruleResult,
-    ruleImplementation,
-    date,
-    intl,
-  });
+  const { iconName, color, resultText, iconTitle, inverted } =
+    calculateResultDecoration({
+      ruleResult,
+      ruleImplementation,
+      date,
+      intl,
+    });
 
   return (
     <>
-      <Icon name={iconName} title={iconTitle} color={color} />
+      <Icon
+        inverted={inverted}
+        name={iconName}
+        title={iconTitle}
+        color={color}
+      />
       {resultText}
     </>
   );

package/src/components/RuleResultDetails.js

@@ -18,11 +18,20 @@ const GeneralInformation = ({ ruleImplementation, ruleResult }) => {
           {formatMessage({ id: "ruleResult.props.quality" })}
         </Table.Cell>
         <Table.Cell>
-          <Icon
-            name="circle"
-            color={selectColor({ ...ruleImplementation, ...ruleResult })}
-          />
-          {`${parseFloat(ruleResult.result)} %`}
+          {ruleResult.records === 0 ? (
+            <>
+              <Icon inverted color="grey" name="warning circle" />
+              {formatMessage({ id: "quality_result.empty_dataset" })}
+            </>
+          ) : (
+            <>
+              <Icon
+                name="circle"
+                color={selectColor({ ...ruleImplementation, ...ruleResult })}
+              />
+              {`${parseFloat(ruleResult.result)} %`}
+            </>
+          )}
         </Table.Cell>
       </Table.Row>
 

package/src/components/RuleResultRow.js

@@ -70,11 +70,20 @@ export const RuleResultRow = ({
           </Link>
         </Table.Cell>
         <Table.Cell>
-          <Icon
-            name="circle"
-            color={selectColor({ ...ruleImplementation, ...ruleResult })}
-          />
-          {`${parseFloat(ruleResult.result)} %`}
+          {ruleResult.records === 0 ? (
+            <>
+              <Icon inverted color="grey" name="warning circle" />
+              {formatMessage({ id: "quality_result.empty_dataset" })}
+            </>
+          ) : (
+            <>
+              <Icon
+                name="circle"
+                color={selectColor({ ...ruleImplementation, ...ruleResult })}
+              />
+              {`${parseFloat(ruleResult.result)} %`}
+            </>
+          )}
         </Table.Cell>
         {_.includes("records")(optionalColumns) ? (
           <Table.Cell>{formatNumber(ruleResult.records)}</Table.Cell>

package/src/components/RuleSummary.js

@@ -26,15 +26,23 @@ const mapSummary = (implementations) => {
         goal,
         minimum,
         result_type,
-        execution_result_info: { errors, result },
+        execution_result_info: { errors, result, records },
       } = implementation;
-      const color = selectColor({ errors, result, minimum, goal, result_type });
+      const color = selectColor({
+        errors,
+        result,
+        minimum,
+        goal,
+        result_type,
+        records,
+      });
       return _.set(color, summary[color] + 1)(summary);
     },
     {
       green: 0,
       yellow: 0,
       red: 0,
+      grey: 0,
     }
   )(executedImplementations);
   return {
@@ -43,6 +51,7 @@ const mapSummary = (implementations) => {
     overGoal: quality.green,
     underGoal: quality.yellow,
     underMinimum: quality.red,
+    emptyDataset: quality.grey,
   };
 };
 
@@ -117,6 +126,12 @@ const SummaryBars = (props) => {
         className: "failed-color",
         tooltip: "failed",
       })}
+      {SummaryBar({
+        ...props,
+        key: "emptyDataset",
+        className: "empty-dataset-color",
+        tooltip: "empty_dataset",
+      })}
     </div>
   );
 };
@@ -125,8 +140,16 @@ export const RuleSummary = ({ implementations }) => {
   const [showPercentages, setShowPercentages] = useState(true);
 
   const summary = mapSummary(implementations);
-  const { overGoal, underGoal, underMinimum, notExecuted, failed } = summary;
-  const total = notExecuted + failed + overGoal + underGoal + underMinimum;
+  const {
+    overGoal,
+    underGoal,
+    underMinimum,
+    notExecuted,
+    failed,
+    emptyDataset,
+  } = summary;
+  const total =
+    notExecuted + failed + overGoal + underGoal + underMinimum + emptyDataset;
 
   const percentages = _.mapValues((value) => (value / total) * 100)(summary);
 

package/src/components/Subscription.js

@@ -63,6 +63,17 @@ export const SubscriptionContent = ({ subscription, setSubscription }) => {
         checked={_.includes("fail")(statuses)}
         onChange={handleEventTypeChange}
       />
+      <Form.Checkbox
+        name="empty_dataset"
+        label={
+          <label>
+            <Icon inverted color="grey" name="warning circle" />
+            <FormattedMessage id="subscriptions.status.empty_dataset" />
+          </label>
+        }
+        checked={_.includes("empty_dataset")(statuses)}
+        onChange={handleEventTypeChange}
+      />
       <Form.Checkbox
         name="error"
         label={

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

@@ -43,6 +43,23 @@ describe("<RuleResultDecorator />", () => {
     expect(queryByTitle("no_data")).toBeInTheDocument();
   });
 
+  it("decorates a empty dataset result", () => {
+    const ruleImplementation = { resultType: "percentage" };
+    const props = {
+      ruleResult: {
+        result: 0,
+        records: 0,
+        errors: 0,
+        result_text: "Empty dataset",
+      },
+    };
+    const { container } = render(
+      <RuleResultDecorator ruleImplementation={ruleImplementation} {...props} />
+    );
+    expect(container).toMatchSnapshot();
+    expect(container).toHaveTextContent("Empty dataset");
+  });
+
   it("handles missing execution result", () => {
     const { container } = render(<RuleResultDecorator />);
     expect(container).toBeEmptyDOMElement();

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

@@ -71,6 +71,46 @@ describe("<RuleResultDetails>", () => {
     expect(getByText("Base64_value")).toBeInTheDocument();
   });
 
+  it("with empty datset", () => {
+    const props = _.update("ruleResult", () => ({
+      result: "0",
+      records: 0,
+      date: "2022-06-24",
+      errors: 0,
+      hasSegments: false,
+    }))(commonProps);
+
+    const { container } = render(
+      <Suspense fallback={null}>
+        <RuleResultDetails {...props} />
+      </Suspense>,
+      renderOpts
+    );
+    expect(container).toMatchSnapshot();
+    expect(container).toHaveTextContent("Empty dataset");
+  });
+
+  it("with empty ruleResult", () => {
+    const props = {
+      ruleImplementation: {
+        id: 1,
+        implementation_key: "key",
+        minimum: 10,
+        goal: 20,
+        resultType: "percentage",
+      },
+      ruleResult: {},
+    };
+
+    const { container } = render(
+      <Suspense fallback={null}>
+        <RuleResultDetails {...props} />
+      </Suspense>,
+      renderOpts
+    );
+    expect(container).toMatchSnapshot();
+  });
+
   it("without details", () => {
     const { container } = render(
       <Suspense fallback={null}>

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

@@ -120,6 +120,31 @@ describe("<RuleResultRow />", () => {
     ).toBeInTheDocument();
   });
 
+  it("grey icon when result is empty dataset", () => {
+    const props = {
+      rule: { id: 10 },
+      ruleImplementation: {
+        id: 23,
+        minimum: 81,
+        goal: 90,
+        resultType: "percentage",
+      },
+      ruleResult: { id: 54, result: 0, records: 0 },
+      date: "2019-08-12T02:00:00Z",
+    };
+
+    const { container } = render(
+      <table>
+        <tbody>
+          <RuleResultRow {...props} />
+        </tbody>
+      </table>
+    );
+    expect(
+      container.querySelector("td > i.grey.circle.icon")
+    ).toBeInTheDocument();
+  });
+
   it("renders delete cell in RuleResultRow when user is admin", () => {
     const props = {
       rule: { id: 10 },

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

@@ -39,6 +39,16 @@ describe("<RuleSummary />", () => {
     },
   };
 
+  const emptyDataset = {
+    ...implementationLimits,
+    execution_result_info: {
+      date: "2021-07-19T00:01:20Z",
+      records: 0,
+      result: "0",
+      result_text: "quality_result.empty_dataset",
+    },
+  };
+
   it("render 100% overGoal implementations", () => {
     const props = {
       implementations: [overGoalExecution],
@@ -61,13 +71,13 @@ describe("<RuleSummary />", () => {
     expect(container).toHaveTextContent("33%");
   });
 
-  it("render 50% not executed, failed implementations", () => {
+  it("render 25% not executed, failed implementations and empty_dataset", () => {
     const props = {
-      implementations: [notExecuted, failedExecution],
+      implementations: [notExecuted, failedExecution, emptyDataset],
     };
     const { container } = render(<RuleSummary {...props} />);
     expect(container).toMatchSnapshot();
-    expect(container).toHaveTextContent("50%");
+    expect(container).toHaveTextContent("25%");
   });
 
   it("render without implementations", () => {

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

@@ -1,5 +1,15 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`<RuleResultDecorator /> decorates a empty dataset result 1`] = `
+<div>
+  <i
+    aria-hidden="true"
+    class="grey warning circle inverted icon"
+  />
+  Empty dataset
+</div>
+`;
+
 exports[`<RuleResultDecorator /> decorates a percentage result 1`] = `
 <div>
   <i

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

@@ -123,6 +123,99 @@ exports[`<RuleResultDetails> matches the latest snapshot 1`] = `
 </div>
 `;
 
+exports[`<RuleResultDetails> with empty datset 1`] = `
+<div>
+  <table
+    class="ui table implementation-results medium"
+  >
+    <thead
+      class=""
+    >
+      <tr
+        class=""
+      >
+        <th
+          class=""
+          colspan="2"
+        >
+          Information
+        </th>
+      </tr>
+    </thead>
+    <tbody
+      class=""
+    >
+      <tr
+        class=""
+      >
+        <td
+          class=""
+        >
+          Quality
+        </td>
+        <td
+          class=""
+        >
+          <i
+            aria-hidden="true"
+            class="grey warning circle inverted icon"
+          />
+          Empty dataset
+        </td>
+      </tr>
+      <tr
+        class=""
+      >
+        <td
+          class=""
+        >
+          Date
+        </td>
+        <td
+          class=""
+        >
+          <time
+            datetime="1656028800000"
+          >
+            2022-06-24 00:00
+          </time>
+        </td>
+      </tr>
+      <tr
+        class=""
+      >
+        <td
+          class=""
+        >
+          Records
+        </td>
+        <td
+          class=""
+        >
+          0
+        </td>
+      </tr>
+      <tr
+        class=""
+      >
+        <td
+          class=""
+        >
+          Errors
+        </td>
+        <td
+          class=""
+        >
+          0
+        </td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+`;
+
+exports[`<RuleResultDetails> with empty ruleResult 1`] = `<div />`;
+
 exports[`<RuleResultDetails> without details 1`] = `
 <div>
   <table

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

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`<RuleSummary /> render 33% overGoal, underGoal, underMinimum implementations 1`] = `
+exports[`<RuleSummary /> render 25% not executed, failed implementations and empty_dataset 1`] = `
 <div>
   <div>
     <div
@@ -10,33 +10,33 @@ exports[`<RuleSummary /> render 33% overGoal, underGoal, underMinimum implementa
         class="rule-summary"
       >
         <span
-          class="over-goal-color"
-          style="width: 33.33333333333333%;"
+          class="not-executed-color"
+          style="width: 25%;"
         >
           <span
             class="value"
           >
-            33%
+            25%
           </span>
         </span>
         <span
-          class="under-goal-color"
-          style="width: 33.33333333333333%;"
+          class="failed-color"
+          style="width: 25%;"
         >
           <span
             class="value"
           >
-            33%
+            25%
           </span>
         </span>
         <span
-          class="under-minimum-color"
-          style="width: 33.33333333333333%;"
+          class="empty-dataset-color"
+          style="width: 50%;"
         >
           <span
             class="value"
           >
-            33%
+            50%
           </span>
         </span>
       </div>
@@ -45,7 +45,7 @@ exports[`<RuleSummary /> render 33% overGoal, underGoal, underMinimum implementa
 </div>
 `;
 
-exports[`<RuleSummary /> render 50% not executed, failed implementations 1`] = `
+exports[`<RuleSummary /> render 33% overGoal, underGoal, underMinimum implementations 1`] = `
 <div>
   <div>
     <div
@@ -55,23 +55,33 @@ exports[`<RuleSummary /> render 50% not executed, failed implementations 1`] = `
         class="rule-summary"
       >
         <span
-          class="not-executed-color"
-          style="width: 50%;"
+          class="over-goal-color"
+          style="width: 33.33333333333333%;"
         >
           <span
             class="value"
           >
-            50%
+            33%
           </span>
         </span>
         <span
-          class="failed-color"
-          style="width: 50%;"
+          class="under-goal-color"
+          style="width: 33.33333333333333%;"
         >
           <span
             class="value"
           >
-            50%
+            33%
+          </span>
+        </span>
+        <span
+          class="under-minimum-color"
+          style="width: 33.33333333333333%;"
+        >
+          <span
+            class="value"
+          >
+            33%
           </span>
         </span>
       </div>

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

@@ -156,6 +156,26 @@ exports[`<SubscriptionContent /> matches the latest snapshot 1`] = `
     name="fail"
     onChange={[Function]}
   />
+  <FormCheckbox
+    as={[Function]}
+    checked={false}
+    control={[Function]}
+    label={
+      <label>
+        <Icon
+          as="i"
+          color="grey"
+          inverted={true}
+          name="warning circle"
+        />
+        <Memo(MemoizedFormattedMessage)
+          id="subscriptions.status.empty_dataset"
+        />
+      </label>
+    }
+    name="empty_dataset"
+    onChange={[Function]}
+  />
   <FormCheckbox
     as={[Function]}
     checked={false}

package/src/functions/selectors.js

@@ -7,9 +7,10 @@ export const selectColor = ({
   goal,
   result_type,
   resultType,
+  records,
 }) => {
   const type = _.defaultTo(result_type)(resultType);
-  if (_.isNil(errors) && _.isNil(result)) return "grey";
+  if ((_.isNil(errors) && _.isNil(result)) || records == 0) return "grey";
   else if (type == "percentage") {
     if (result < minimum) {
       return "red";

package/src/messages/en.js

@@ -129,6 +129,7 @@ export default {
   "quality.range.errors_number": "error count",
   "quality.range.percentage": "%",
   "quality.result": "Result",
+  "quality.result.empty_dataset.date": "0 records at {date}",
   "quality.result.deviation.date": "{result}% at {date}",
   "quality.result.deviation.description": "{result}%",
   "quality.result.errors_number.date": "{result} errors at {date}",
@@ -152,6 +153,7 @@ export default {
   "quality.thresholds": "Limits",
   "quality.type": "Type",
   "quality.updated_at": "Last changed",
+  "quality_result.empty_dataset": "Empty dataset",
   "quality_result.failed": "Failed",
   "quality_result.no_execution": "Not executed",
   "quality_result.over_goal": "Over goal",
@@ -539,9 +541,11 @@ export default {
   "ruleImplementations.props.last_execution_at": "Last Execution",
   "ruleImplementations.props.minimum": "Threshold",
   "ruleImplementations.props.minimum.placeholder": "Threshold value",
+  "ruleImplementations.props.quality_result.empty_dataset": "Empty data",
   "ruleImplementations.props.quality_result.no_execution": "Not executed",
   "ruleImplementations.props.quality_result.over_goal": "Over goal",
   "ruleImplementations.props.quality_result.under_goal": "Under goal",
+  "ruleImplementations.props.quality_result.failed": "Failed",
   "ruleImplementations.props.quality_result.under_minimum": "Under threshold",
   "ruleImplementations.props.result": "Quality",
   "ruleImplementations.props.result_type": "Result Type",

package/src/messages/es.js

@@ -133,6 +133,7 @@ export default {
   "quality.range.errors_number": "errores",
   "quality.range.percentage": "%",
   "quality.result": "Resultado",
+  "quality.result.empty_dataset.date": "Sin datos a {date}",
   "quality.result.deviation.date": "{result}% de precisión a {date}",
   "quality.result.deviation.description": "{result}%",
   "quality.result.errors_number.date": "{result} errores a {date}",
@@ -157,6 +158,7 @@ export default {
   "quality.type": "Tipo",
   "quality.updated_at": "Último cambio",
   "quality_result.failed": "Fallida",
+  "quality_result.empty_dataset": "Sin datos",
   "quality_result.no_execution": "No ejecutada",
   "quality_result.over_goal": "Cumple el objetivo",
   "quality_result.under_goal": "Por debajo del objetivo",
@@ -555,10 +557,12 @@ export default {
   "ruleImplementations.props.last_execution_at": "Última ejecución",
   "ruleImplementations.props.minimum": "Valor umbral",
   "ruleImplementations.props.minimum.placeholder": "Umbral",
+  "ruleImplementations.props.quality_result.empty_dataset": "Sin datos",
   "ruleImplementations.props.quality_result.no_execution": "No ejecutada",
   "ruleImplementations.props.quality_result.over_goal": "Cumple el objetivo",
   "ruleImplementations.props.quality_result.under_goal":
     "Por debajo del objetivo",
+  "ruleImplementations.props.quality_result.failed": "Fallida",
   "ruleImplementations.props.quality_result.under_minimum":
     "Por debajo del umbral",
   "ruleImplementations.props.result": "Calidad",

package/src/styles/ruleSummary.less

@@ -57,6 +57,9 @@
   .failed-color {
     background-color: @failedRuleColor;
   }
+  .empty-dataset-color {
+    background-color: @emptyDataColor;
+  }
 }
 
 .pointer {