feat(ui/data-contract): Data contract UI under Validation Tab #10625

amit-apptware · 2024-05-31T15:00:57Z

Screencast.from.14-06-24.04.42.06.PM.IST.webm

Test cases

Tested with below scenarios on OSS for Data Contract Feature:

Checked with assertion type Dataset, Volume -> combined in Data Quality
Checked with assertion type Freshness -> it is showing as Freshness section on Data Contract Tab
Assigned Data contract symbol to assertion list as like SaaS does
Data contract symbol is redirecting correctly to Data Contract Tab
Adding Contract and Removing contract also working Properly

Checklist

The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
Links to related issues (if applicable)
Tests for the changes have been added/updated (if applicable)
Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Tested Below Scenarios:

Checked with assertion type Dataset, Volume -> combined in Data Quality
Checked with assertion type Freshness -> it is showing as Freshness section on Data Contract Tab
Assigned Data contract symbol to assertion list as like SaaS does
Data contract symbol is redirecting correctly to Data Contract Tab
Adding Contract and Removing contract also working Properly

… tab

datahub-web-react/src/app/entity/shared/tabs/Dataset/Validations/AcrylAssertionsList.tsx

datahub-web-react/src/graphql/monitor.graphql

datahub-web-react/src/graphql/actionRequest.graphql

datahub-web-react/src/graphql/contract.graphql

...ct/src/app/entity/shared/tabs/Dataset/Validations/contract/proposal/DataContractProposal.tsx

datahub-web-react/src/app/entity/shared/tabs/Dataset/Validations/fieldDescriptionUtils.ts

...entity/shared/tabs/Dataset/Validations/contract/builder/DataContractAssertionGroupSelect.tsx

datahub-web-react/src/app/entity/shared/tabs/Dataset/Validations/acrylTypes.tsx

…or contract

…-datacontract-tab

…tem on data contract

datahub-web-react/package.json

datahub-web-react/src/app/entity/shared/tabs/Dataset/Validations/assertionUtils.tsx

jayacryl · 2024-06-13T13:52:19Z

datahub-web-react/src/app/entity/shared/tabs/Dataset/Validations/DatasetAssertionsList.tsx

nice, for context john - Amit did a minimal set of changes to make the existing assertion list in OSS selectable (check/uncheck option). This will work for OSS until we get to porting over our acryl assertion list code.

jayacryl · 2024-06-13T13:53:33Z

datahub-web-react/src/app/entity/shared/tabs/Dataset/Validations/ValidationsTab.tsx

@@ -77,6 +81,26 @@ export const ValidationsTab = () => {
        },
    ];

+    if (appConfig.config.featureFlags?.dataContractsEnabled) {
+        // If contracts feature is enabled, add to list.
+


super nit we can remove space

jayacryl · 2024-06-13T13:58:05Z

datahub-web-react/src/app/entity/shared/tabs/Dataset/Validations/VolumeAssertionDescription.tsx

+const getPropertyFromVolumeType = (type: VolumeAssertionType) => {
+    switch (type) {
+        case VolumeAssertionType.RowCountTotal:
+            return 'rowCountTotal' as VolumeTypeField;
+        case VolumeAssertionType.RowCountChange:
+            return 'rowCountChange' as VolumeTypeField;
+        case VolumeAssertionType.IncrementingSegmentRowCountTotal:
+            return 'incrementingSegmentRowCountTotal' as VolumeTypeField;
+        case VolumeAssertionType.IncrementingSegmentRowCountChange:
+            return 'incrementingSegmentRowCountChange' as VolumeTypeField;
+        default:
+            throw new Error(`Unknown volume assertion type: ${type}`);
+    }
+};
+
+const getVolumeTypeInfo = (volumeAssertion: VolumeAssertionInfo) => {
+    const result = volumeAssertion[getPropertyFromVolumeType(volumeAssertion.type)];
+    if (!result) {
+        return undefined;
+    }
+    return result;
+};
+
+const getIsRowCountChange = (type: VolumeAssertionType) => {
+    return [VolumeAssertionType.RowCountChange, VolumeAssertionType.IncrementingSegmentRowCountChange].includes(type);
+};
+
+const getVolumeTypeDescription = (volumeType: VolumeAssertionType) => {
+    switch (volumeType) {
+        case VolumeAssertionType.RowCountTotal:
+        case VolumeAssertionType.IncrementingSegmentRowCountTotal:
+            return 'has';
+        case VolumeAssertionType.RowCountChange:
+        case VolumeAssertionType.IncrementingSegmentRowCountChange:
+            return 'should grow by';
+        default:
+            throw new Error(`Unknown volume type ${volumeType}`);
+    }
+};
+
+const getOperatorDescription = (operator: AssertionStdOperator) => {
+    switch (operator) {
+        case AssertionStdOperator.GreaterThanOrEqualTo:
+            return 'at least';
+        case AssertionStdOperator.LessThanOrEqualTo:
+            return 'at most';
+        case AssertionStdOperator.Between:
+            return 'between';
+        default:
+            throw new Error(`Unknown operator ${operator}`);
+    }
+};
+
+const getValueChangeTypeDescription = (valueChangeType: AssertionValueChangeType) => {
+    switch (valueChangeType) {
+        case AssertionValueChangeType.Absolute:
+            return 'rows';
+        case AssertionValueChangeType.Percentage:
+            return '%';
+        default:
+            throw new Error(`Unknown value change type ${valueChangeType}`);
+    }
+};
+
+const getParameterDescription = (parameters: AssertionStdParameters) => {
+    if (parameters.value) {
+        return formatNumberWithoutAbbreviation(
+            parseMaybeStringAsFloatOrDefault(parameters.value.value, parameters.value.value),
+        );
+    }
+    if (parameters.minValue && parameters.maxValue) {
+        return `${formatNumberWithoutAbbreviation(
+            parseMaybeStringAsFloatOrDefault(parameters.minValue.value, parameters.minValue.value),
+        )} and ${formatNumberWithoutAbbreviation(
+            parseMaybeStringAsFloatOrDefault(parameters.maxValue.value, parameters.maxValue.value),
+        )}`;
+    }
+    throw new Error('Invalid assertion parameters provided');
+};


Since it's a lot of utils before the component code begins I wonder if it's worth moving this to a utils file.
And I know in SaaS we have many of these under the assertion/builder/... folder. So we should modify SaaS to take it out of that assertion/builder/... folder utils file and put it in a higher level common folder.

datahub-web-react/src/app/entity/shared/tabs/Dataset/Validations/fieldDescriptionUtils.ts

jayacryl · 2024-06-14T17:15:31Z

datahub-web-react/yarn.lock

undo all changes in lock file

…on validation tab

jayacryl · 2024-06-18T15:03:18Z

Looks like there's failing checks, please fix before merge.

…b-project#10625) Co-authored-by: jayacryl <[email protected]>

Co-authored-by: jayacryl <[email protected]>

jayacryl and others added 4 commits May 30, 2024 11:08

feat(graphql) data contract resolvers for graphql

bdd9667

feat(data-contract): Add initial file for data contract on validation…

a240d12

… tab

feat(data-contract): add datacontract tab file and its graphql files

2704ca7

feat(data-contract): add modal files to create contract

6785fc9

github-actions bot added product PR or Issue related to the DataHub UI/UX community-contribution PR or Issue raised by member(s) of DataHub Community labels May 31, 2024

vercel bot deployed to Preview May 31, 2024 15:15 View deployment