PromucFlow_constructor/app/client/src/widgets/TableWidgetV2/widget/derived.js
Rahul Barwal d64361e225
fix: Refactor validation logic in TableWidgetV2 to improve clarity and correctness (#40679)
## Description
<ins>Problem</ins>

The table widget skipped validations for number columns when users typed
quickly and pressed Enter, accepting invalid values despite min/max
constraints.

<ins>Root cause</ins>

The validation logic had an early exit if the value was empty and the
column wasn't required. This incorrectly allowed empty values even when
min/max constraints were set. Due to async evaluations and timing
differences, a quick backspace followed by a new input and Enter led to
premature validation success.

<ins>Solution</ins>

This PR handles a refactor of the validation logic in `TableWidgetV2` to
improve clarity and correctness.
- Consolidates checks for required fields and regex validations.  
- Ensures column type validations accurately reflect constraints like
min/max.
- Prevents premature validation passes caused by async evaluation race
conditions.

Fixes #`Issue Number`  
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

/ok-to-test tags="@tag.Table"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/15160290045>
> Commit: b3022119656954765a79b1e03c5af2a4338a89c4
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=15160290045&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Table`
> Spec:
> <hr>Wed, 21 May 2025 11:35:27 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
- Enhanced validation for editable table cells to better enforce
required fields and regex patterns.
- Improved handling of empty values in required and non-required cells
for more accurate validation feedback.
- **Tests**
- Refactored and reorganized validation test suites for improved clarity
and maintainability without changing validation behavior.
- Updated end-to-end tests to improve timing and synchronization by
removing fixed waits and relying on automatic retries.
- Adjusted inline editing validation tests to reflect updated error
visibility expectations during editing.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-05-21 18:45:24 +05:30

1276 lines
38 KiB
JavaScript

/* eslint-disable @typescript-eslint/no-unused-vars*/
export default {
getSelectedRow: (props, moment, _) => {
let index = -1;
/*
* If multiRowSelection is turned on, use the last index to
* populate the selectedRowIndex
*/
if (props.multiRowSelection) {
if (
_.isArray(props.selectedRowIndices) &&
props.selectedRowIndices.length &&
props.selectedRowIndices.every((i) => _.isNumber(i))
) {
index = props.selectedRowIndices[props.selectedRowIndices.length - 1];
} else if (_.isNumber(props.selectedRowIndices)) {
index = props.selectedRowIndices;
}
} else if (
!_.isNil(props.selectedRowIndex) &&
!_.isNaN(parseInt(props.selectedRowIndex))
) {
index = parseInt(props.selectedRowIndex);
}
const rows = props.filteredTableData || props.processedTableData || [];
const primaryColumns = props.primaryColumns;
const nonDataColumnTypes = [
"editActions",
"button",
"iconButton",
"menuButton",
];
const nonDataColumnAliases = primaryColumns
? Object.values(primaryColumns)
.filter((column) => nonDataColumnTypes.includes(column.columnType))
.map((column) => column.alias)
: [];
let selectedRow;
/*
* Note(Balaji): Need to include customColumn values in the selectedRow (select, rating)
* It should have updated values.
*/
if (index > -1) {
selectedRow = { ...rows[index] };
} else {
/*
* If index is not a valid, selectedRow should have
* proper row structure with empty string values
*/
selectedRow = {};
Object.keys(rows[0]).forEach((key) => {
selectedRow[key] = "";
});
}
const keysToBeOmitted = [
"__originalIndex__",
"__primaryKey__",
...nonDataColumnAliases,
];
return _.omit(selectedRow, keysToBeOmitted);
},
//
getTriggeredRow: (props, moment, _) => {
let index = -1;
const parsedTriggeredRowIndex = parseInt(props.triggeredRowIndex);
if (!_.isNaN(parsedTriggeredRowIndex)) {
index = parsedTriggeredRowIndex;
}
const rows = props.filteredTableData || props.processedTableData || [];
const primaryColumns = props.primaryColumns;
const nonDataColumnTypes = [
"editActions",
"button",
"iconButton",
"menuButton",
];
const nonDataColumnAliases = primaryColumns
? Object.values(primaryColumns)
.filter((column) => nonDataColumnTypes.includes(column.columnType))
.map((column) => column.alias)
: [];
let triggeredRow;
/*
* Note(Balaji): Need to include customColumn values in the triggeredRow (select, rating)
* It should have updated values.
*/
if (index > -1) {
const row = rows.find((row) => row.__originalIndex__ === index);
triggeredRow = { ...row };
} else {
/*
* If triggeredRowIndex is not a valid index, triggeredRow should
* have proper row structure with empty string values
*/
triggeredRow = {};
Object.keys(rows[0]).forEach((key) => {
triggeredRow[key] = "";
});
}
const keysToBeOmitted = [
"__originalIndex__",
"__primaryKey__",
...nonDataColumnAliases,
];
return _.omit(triggeredRow, keysToBeOmitted);
},
//
getSelectedRows: (props, moment, _) => {
if (!props.multiRowSelection) {
return [];
}
let indices = [];
if (
_.isArray(props.selectedRowIndices) &&
props.selectedRowIndices.every((i) => _.isNumber(i))
) {
indices = props.selectedRowIndices;
}
const rows = props.filteredTableData || props.processedTableData || [];
const primaryColumns = props.primaryColumns;
const nonDataColumnTypes = [
"editActions",
"button",
"iconButton",
"menuButton",
];
const nonDataColumnAliases = primaryColumns
? Object.values(primaryColumns)
.filter((column) => nonDataColumnTypes.includes(column.columnType))
.map((column) => column.alias)
: [];
const keysToBeOmitted = [
"__originalIndex__",
"__primaryKey__",
...nonDataColumnAliases,
];
return indices.map((index) => _.omit(rows[index], keysToBeOmitted));
},
//
getPageSize: (props, moment, _) => {
const TABLE_SIZES = {
DEFAULT: {
COLUMN_HEADER_HEIGHT: 32,
TABLE_HEADER_HEIGHT: 38,
ROW_HEIGHT: 40,
ROW_FONT_SIZE: 14,
VERTICAL_PADDING: 6,
EDIT_ICON_TOP: 10,
},
SHORT: {
COLUMN_HEADER_HEIGHT: 32,
TABLE_HEADER_HEIGHT: 38,
ROW_HEIGHT: 30,
ROW_FONT_SIZE: 12,
VERTICAL_PADDING: 0,
EDIT_ICON_TOP: 5,
},
TALL: {
COLUMN_HEADER_HEIGHT: 32,
TABLE_HEADER_HEIGHT: 38,
ROW_HEIGHT: 60,
ROW_FONT_SIZE: 18,
VERTICAL_PADDING: 16,
EDIT_ICON_TOP: 21,
},
};
const compactMode = props.compactMode || "DEFAULT";
const componentHeight = props.componentHeight - 10;
const tableSizes = TABLE_SIZES[compactMode];
let pageSize =
(componentHeight -
tableSizes.TABLE_HEADER_HEIGHT -
tableSizes.COLUMN_HEADER_HEIGHT) /
tableSizes.ROW_HEIGHT;
return pageSize % 1 > 0.3 && props.tableData.length > pageSize
? Math.ceil(pageSize)
: Math.floor(pageSize);
},
//
getProcessedTableData: (props, moment, _) => {
let data;
let tableData;
if (props.infiniteScrollEnabled) {
/* This logic is needed as the cachedTableData will have data based on each pageNo. Since the object would be { 1: array of page 1 data, 2: array of page 2 data }, hence the values will have array of array data, hence it is flattened to store back in tableData for processing. */
tableData = _.flatten(_.values(props.cachedTableData));
} else {
tableData = props.tableData;
}
if (_.isArray(tableData)) {
/* Populate meta keys (__originalIndex__, __primaryKey__) and transient values */
data = tableData.map((row, index) => ({
...row,
__originalIndex__: index,
__primaryKey__: props.primaryColumnId
? row[props.primaryColumnId]
: undefined,
...props.transientTableData[index],
}));
} else {
data = [];
}
return data;
},
//
getOrderedTableColumns: (props, moment, _) => {
let columns = [];
let existingColumns = props.primaryColumns || {};
/*
* Assign index based on the columnOrder
*/
if (
_.isArray(props.columnOrder) &&
props.columnOrder.length > 0 &&
Object.keys(existingColumns).length > 0
) {
const newColumnsInOrder = {};
let index = 0;
_.uniq(props.columnOrder).forEach((columnId) => {
if (existingColumns[columnId]) {
newColumnsInOrder[columnId] = Object.assign(
{},
existingColumns[columnId],
{
index,
},
);
index++;
}
});
existingColumns = newColumnsInOrder;
}
const sortByColumn = props.sortOrder && props.sortOrder.column;
const isAscOrder = props.sortOrder && props.sortOrder.order === "asc";
/* set sorting flags and convert the existing columns into an array */
Object.values(existingColumns).forEach((column) => {
/* guard to not allow columns without id */
if (column.id) {
columns.push({
...column,
isAscOrder: column.id === sortByColumn ? isAscOrder : undefined,
});
}
});
return columns;
},
//
getFilteredTableData: (props, moment, _) => {
/* Make a shallow copy */
const primaryColumns = props.primaryColumns || {};
let processedTableData = [...props.processedTableData];
const derivedColumns = {};
Object.keys(primaryColumns).forEach((id) => {
if (primaryColumns[id] && primaryColumns[id].isDerived) {
derivedColumns[id] = primaryColumns[id];
}
});
if (!processedTableData || !processedTableData.length) {
return [];
}
const getTextFromHTML = (html) => {
if (!html) return "";
if (typeof html === "object") {
html = JSON.stringify(html);
}
try {
const tempDiv = document.createElement("div");
tempDiv.innerHTML = html;
return tempDiv.textContent || tempDiv.innerText || "";
} catch (e) {
return "";
}
};
/**
* Since getTextFromHTML is an expensive operation, we need to avoid calling it unnecessarily
* This optimization ensures that getTextFromHTML is only called when required
*/
const columnsWithHTML = Object.values(props.primaryColumns).filter(
(column) => column.columnType === "html",
);
const htmlColumnAliases = new Set(
columnsWithHTML.map((column) => column.alias),
);
const isFilteringByColumnThatHasHTML = props.filters?.some((filter) =>
htmlColumnAliases.has(filter.column),
);
const isSortingByColumnThatHasHTML =
props.sortOrder?.column && htmlColumnAliases.has(props.sortOrder.column);
const shouldExtractHTMLText = !!(
props.searchText ||
isFilteringByColumnThatHasHTML ||
isSortingByColumnThatHasHTML
);
const getKeyForExtractedTextFromHTML = (columnAlias) =>
`__htmlExtractedText_${columnAlias}__`;
/* extend processedTableData with values from
* - computedValues, in case of normal column
* - empty values, in case of derived column
*/
if (primaryColumns && _.isPlainObject(primaryColumns)) {
Object.entries(primaryColumns).forEach(([id, column]) => {
let computedValues = [];
if (column && column.computedValue) {
if (_.isString(column.computedValue)) {
try {
computedValues = JSON.parse(column.computedValue);
} catch (e) {
/* do nothing */
}
} else if (_.isArray(column.computedValue)) {
computedValues = column.computedValue;
}
}
/* for derived columns inject empty strings */
if (
computedValues.length === 0 &&
derivedColumns &&
derivedColumns[id]
) {
computedValues = Array(processedTableData.length).fill("");
}
computedValues.forEach((computedValue, index) => {
processedTableData[index] = {
...processedTableData[index],
[column.alias]: computedValue,
};
if (shouldExtractHTMLText && column.columnType === "html") {
processedTableData[index][
getKeyForExtractedTextFromHTML(column.alias)
] = getTextFromHTML(computedValue);
}
});
});
}
const columns = props.orderedTableColumns;
const sortByColumnId = props.sortOrder.column;
let sortedTableData;
/*
Check if there are select columns,
and if the columns are sorting by label instead of default value
*/
const selectColumnKeysWithSortByLabel = [];
Object.entries(primaryColumns).forEach(([id, column]) => {
const isColumnSortedByLabel =
column?.columnType === "select" &&
column?.sortBy === "label" &&
column?.selectOptions?.length;
if (isColumnSortedByLabel) {
selectColumnKeysWithSortByLabel.push(id);
}
});
/*
If there are select columns,
transform the specific columns data to show the label instead of the value for sorting
*/
let processedTableDataWithLabelInsteadOfValue;
if (selectColumnKeysWithSortByLabel.length) {
const transformedValueToLabelTableData = processedTableData.map((row) => {
const newRow = { ...row };
selectColumnKeysWithSortByLabel.forEach((key) => {
const value = row[key];
const isSelectOptionsAnArray = _.isArray(
primaryColumns[key].selectOptions,
);
let selectOptions;
/*
* If selectOptions is an array, check if it contains nested arrays.
* This is to handle situations where selectOptons is a javascript object and computes as a nested array.
*/
if (isSelectOptionsAnArray) {
if (_.some(primaryColumns[key].selectOptions, _.isArray)) {
/* Handle the case where selectOptions contains nested arrays - selectOptions is javascript */
selectOptions =
primaryColumns[key].selectOptions[row.__originalIndex__];
const option = selectOptions.find((option) => {
return option.value === value;
});
if (option) {
newRow[key] = option.label;
}
} else {
/* Handle the case where selectOptions is a flat array - selectOptions is plain JSON */
selectOptions = primaryColumns[key].selectOptions;
const option = selectOptions.find(
(option) => option.value === value,
);
if (option) {
newRow[key] = option.label;
}
}
} else {
/* If selectOptions is not an array, parse it as JSON - not evaluated yet, so returns as string */
selectOptions = JSON.parse(primaryColumns[key].selectOptions);
const option = selectOptions.find(
(option) => option.value === value,
);
if (option) {
newRow[key] = option.label;
}
}
});
return newRow;
});
processedTableDataWithLabelInsteadOfValue =
transformedValueToLabelTableData;
}
if (sortByColumnId) {
const sortBycolumn = columns.find(
(column) => column.id === sortByColumnId,
);
const sortByColumnOriginalId = sortBycolumn.alias;
const columnType =
sortBycolumn && sortBycolumn.columnType
? sortBycolumn.columnType
: "text";
let inputFormat = (() => {
switch (sortBycolumn.inputFormat) {
case "Epoch":
return "X";
case "Milliseconds":
return "x";
default:
return sortBycolumn.inputFormat;
}
})();
const isEmptyOrNil = (value) => {
return _.isNil(value) || value === "";
};
const isAscOrder = props.sortOrder.order === "asc";
const sortByOrder = (isAGreaterThanB) => {
if (isAGreaterThanB) {
return isAscOrder ? 1 : -1;
} else {
return isAscOrder ? -1 : 1;
}
};
const transformedTableDataForSorting =
selectColumnKeysWithSortByLabel.length
? processedTableDataWithLabelInsteadOfValue
: processedTableData;
sortedTableData = transformedTableDataForSorting.sort((a, b) => {
if (_.isPlainObject(a) && _.isPlainObject(b)) {
let [processedA, processedB] = [a, b];
if (!selectColumnKeysWithSortByLabel.length) {
const originalA = (props.tableData ??
transformedTableDataForSorting)[a.__originalIndex__];
const originalB = (props.tableData ??
transformedTableDataForSorting)[b.__originalIndex__];
[processedA, processedB] = [
{ ...a, ...originalA },
{ ...b, ...originalB },
];
}
if (
isEmptyOrNil(processedA[sortByColumnOriginalId]) ||
isEmptyOrNil(processedB[sortByColumnOriginalId])
) {
/* push null, undefined and "" values to the bottom. */
return isEmptyOrNil(processedA[sortByColumnOriginalId]) ? 1 : -1;
} else {
switch (columnType) {
case "number":
case "currency":
return sortByOrder(
Number(processedA[sortByColumnOriginalId]) >
Number(processedB[sortByColumnOriginalId]),
);
case "date":
try {
return sortByOrder(
moment(
processedA[sortByColumnOriginalId],
inputFormat,
).isAfter(
moment(processedB[sortByColumnOriginalId], inputFormat),
),
);
} catch (e) {
return -1;
}
case "url":
const column = primaryColumns[sortByColumnOriginalId];
if (column && column.displayText) {
if (_.isString(column.displayText)) {
return sortByOrder(false);
} else if (_.isArray(column.displayText)) {
return sortByOrder(
column.displayText[a.__originalIndex__]
.toString()
.toLowerCase() >
column.displayText[b.__originalIndex__]
.toString()
.toLowerCase(),
);
}
}
case "html": {
const htmlExtractedTextA =
processedA[
getKeyForExtractedTextFromHTML(sortByColumnOriginalId)
];
const htmlExtractedTextB =
processedB[
getKeyForExtractedTextFromHTML(sortByColumnOriginalId)
];
return sortByOrder(
(htmlExtractedTextA ??
getTextFromHTML(processedA[sortByColumnOriginalId])) >
(htmlExtractedTextB ??
getTextFromHTML(processedB[sortByColumnOriginalId])),
);
}
default:
return sortByOrder(
processedA[sortByColumnOriginalId].toString().toLowerCase() >
processedB[sortByColumnOriginalId].toString().toLowerCase(),
);
}
}
} else {
return isAscOrder ? 1 : 0;
}
});
/*
* When sorting is done, transform the data back to its original state
* where table data shows value instead of label
*/
if (selectColumnKeysWithSortByLabel.length) {
const transformedLabelToValueData = sortedTableData.map((row) => {
const newRow = { ...row };
selectColumnKeysWithSortByLabel.forEach((key) => {
const label = row[key];
const isSelectOptionsAnArray = _.isArray(
primaryColumns[key].selectOptions,
);
let selectOptions;
/*
* If selectOptions is an array, check if it contains nested arrays.
* This is to handle situations where selectOptons is a javascript object and computes as a nested array.
*/
if (isSelectOptionsAnArray) {
if (_.some(primaryColumns[key].selectOptions, _.isArray)) {
/* Handle the case where selectOptions contains nested arrays - selectOptions is javascript */
selectOptions =
primaryColumns[key].selectOptions[row.__originalIndex__];
const option = selectOptions.find((option) => {
return option.label === label;
});
if (option) {
newRow[key] = option.value;
}
} else {
/* Handle the case where selectOptions is a flat array - selectOptions is plain JSON */
selectOptions = primaryColumns[key].selectOptions;
const option = selectOptions.find(
(option) => option.label === label,
);
if (option) {
newRow[key] = option.value;
}
}
} else {
/* If selectOptions is not an array, parse it as JSON - not evaluated yet, so returns as string */
selectOptions = JSON.parse(primaryColumns[key].selectOptions);
const option = selectOptions.find(
(option) => option.label === label,
);
if (option) {
newRow[key] = option.value;
}
}
});
return newRow;
});
sortedTableData = transformedLabelToValueData;
}
} else {
sortedTableData = [...processedTableData];
}
const ConditionFunctions = {
isExactly: (a, b) => {
return a.toString() === b.toString();
},
empty: (a) => {
return _.isNil(a) || _.isEmpty(a.toString());
},
notEmpty: (a) => {
return !_.isNil(a) && !_.isEmpty(a.toString());
},
notEqualTo: (a, b) => {
return a.toString() !== b.toString();
},
/* Note: Duplicate of isExactly */
isEqualTo: (a, b) => {
return a.toString() === b.toString();
},
lessThan: (a, b) => {
return Number(a) < Number(b);
},
lessThanEqualTo: (a, b) => {
return Number(a) <= Number(b);
},
greaterThan: (a, b) => {
return Number(a) > Number(b);
},
greaterThanEqualTo: (a, b) => {
return Number(a) >= Number(b);
},
contains: (a, b) => {
try {
return a
.toString()
.toLowerCase()
.includes(b.toString().toLowerCase());
} catch (e) {
return false;
}
},
doesNotContain: (a, b) => {
try {
return !a
.toString()
.toLowerCase()
.includes(b.toString().toLowerCase());
} catch (e) {
return false;
}
},
startsWith: (a, b) => {
try {
return (
a.toString().toLowerCase().indexOf(b.toString().toLowerCase()) === 0
);
} catch (e) {
return false;
}
},
endsWith: (a, b) => {
try {
const _a = a.toString().toLowerCase();
const _b = b.toString().toLowerCase();
return (
_a.lastIndexOf(_b) >= 0 &&
_a.length === _a.lastIndexOf(_b) + _b.length
);
} catch (e) {
return false;
}
},
is: (a, b) => {
return moment(a).isSame(moment(b), "minute");
},
isNot: (a, b) => {
return !moment(a).isSame(moment(b), "minute");
},
isAfter: (a, b) => {
return moment(a).isAfter(moment(b), "minute");
},
isBefore: (a, b) => {
return moment(a).isBefore(moment(b), "minute");
},
isChecked: (a) => {
return a === true;
},
isUnChecked: (a) => {
return a === false;
},
};
let searchKey;
/* skipping search when client side search is turned off */
if (
props.searchText &&
(!props.onSearchTextChanged || props.enableClientSideSearch)
) {
searchKey = props.searchText.toLowerCase();
} else {
searchKey = "";
}
/*
* We need to omit hidden column values from being included
* in the search
*/
const hiddenColumns = Object.values(props.primaryColumns)
.filter((column) => !column.isVisible)
.map((column) => column.alias);
const systemColumns = ["__originalIndex__"];
const finalTableData = sortedTableData.filter((row) => {
let isSearchKeyFound = true;
const originalRow = (props.tableData ?? sortedTableData)[
row.__originalIndex__
];
const columnWithDisplayText = Object.values(props.primaryColumns).filter(
(column) => column.columnType === "url" && column.displayText,
);
/*
* For select columns with label and values, we need to include the label value
* in the search and filter data
*/
let labelValuesForSelectCell = {};
/*
* Initialize an array to store keys for columns that have the 'select' column type
* and contain selectOptions.
*/
const selectColumnKeys = [];
/*
* Iterate over the primary columns to identify which columns are of type 'select'
* and have selectOptions. These keys are pushed into the selectColumnKeys array.
*/
Object.entries(props.primaryColumns).forEach(([id, column]) => {
const isColumnSelectColumnType =
column?.columnType === "select" && column?.selectOptions?.length;
if (isColumnSelectColumnType) {
selectColumnKeys.push(id);
}
});
/*
* If there are any select columns, iterate over them to find the label value
* associated with the selected value in each row.
*/
if (selectColumnKeys.length) {
selectColumnKeys.forEach((key) => {
const value = row[key];
const isSelectOptionsAnArray = _.isArray(
primaryColumns[key].selectOptions,
);
let selectOptions = {};
/*
* If selectOptions is an array, check if it contains nested arrays.
* This is to handle situations where selectOptons is a javascript object and computes as a nested array.
*/
if (isSelectOptionsAnArray) {
const selectOptionKey = primaryColumns[key].alias;
if (_.some(primaryColumns[key].selectOptions, _.isArray)) {
/* Handle the case where selectOptions contains nested arrays - selectOptions is javascript */
selectOptions =
primaryColumns[key].selectOptions[row.__originalIndex__];
const option = selectOptions.find((option) => {
return option.value === value;
});
if (option) {
labelValuesForSelectCell[selectOptionKey] = option.label;
}
} else {
/* Handle the case where selectOptions is a flat array - selectOptions is plain JSON */
selectOptions = primaryColumns[key].selectOptions;
const option = selectOptions.find(
(option) => option.value === value,
);
if (option) {
labelValuesForSelectCell[selectOptionKey] = option.label;
}
}
} else {
/* If selectOptions is not an array, parse it as JSON - not evaluated yet, so returns as string */
selectOptions = JSON.parse(primaryColumns[key].selectOptions);
const option = selectOptions.find(
(option) => option.value === value,
);
if (option) {
labelValuesForSelectCell[selectOptionKey] = option.label;
}
}
});
}
const displayTextValues = columnWithDisplayText.reduce((acc, column) => {
let displayText;
if (_.isArray(column.displayText)) {
displayText = column.displayText[row.__originalIndex__];
} else {
displayText = column.displayText;
}
acc[column.alias] = displayText;
return acc;
}, {});
let htmlValues = {};
/*
* We don't want html tags and inline styles to match in search
*/
if (shouldExtractHTMLText) {
htmlValues = columnsWithHTML.reduce((acc, column) => {
const value = row[column.alias];
acc[column.alias] = _.isNil(value)
? ""
: row[getKeyForExtractedTextFromHTML(column.alias)] ??
getTextFromHTML(value);
return acc;
}, {});
}
const displayedRow = {
...row,
...labelValuesForSelectCell,
...displayTextValues,
...htmlValues,
};
if (searchKey) {
const combinedRowContent = [
...Object.values(_.omit(displayedRow, hiddenColumns, systemColumns)),
...Object.values(
_.omit(originalRow, [
...hiddenColumns,
...htmlColumnAliases,
...systemColumns,
]),
),
]
.join(", ")
.toLowerCase();
isSearchKeyFound = combinedRowContent.includes(searchKey);
}
if (!isSearchKeyFound) {
return false;
}
/* when there is no filter defined or when server side filtering is enabled prevent client-side filtering */
if (
!props.filters ||
props.filters.length === 0 ||
props.enableServerSideFiltering
) {
return true;
}
const filterOperator =
props.filters.length >= 2 ? props.filters[1].operator : "OR";
let isSatisfyingFilters = filterOperator === "AND";
for (let i = 0; i < props.filters.length; i++) {
let filterResult = true;
try {
const conditionFunction =
ConditionFunctions[props.filters[i].condition];
if (conditionFunction) {
/*
* We don't want html tags and inline styles to match in filter conditions
*/
const isHTMLColumn = htmlColumnAliases.has(props.filters[i].column);
const originalColValue = isHTMLColumn
? originalRow[
getKeyForExtractedTextFromHTML(props.filters[i].column)
] ?? getTextFromHTML(originalRow[props.filters[i].column])
: originalRow[props.filters[i].column];
const displayedColValue = isHTMLColumn
? displayedRow[
getKeyForExtractedTextFromHTML(props.filters[i].column)
] ?? getTextFromHTML(displayedRow[props.filters[i].column])
: displayedRow[props.filters[i].column];
filterResult =
conditionFunction(originalColValue, props.filters[i].value) ||
conditionFunction(displayedColValue, props.filters[i].value);
}
} catch (e) {
filterResult = false;
}
/* if one filter condition is not satisfied and filter operator is AND, bailout early */
if (!filterResult && filterOperator === "AND") {
isSatisfyingFilters = false;
break;
} else if (filterResult && filterOperator === "OR") {
/* if one filter condition is satisfied and filter operator is OR, bailout early */
isSatisfyingFilters = true;
break;
}
isSatisfyingFilters =
filterOperator === "AND"
? isSatisfyingFilters && filterResult
: isSatisfyingFilters || filterResult;
}
return isSatisfyingFilters;
});
return finalTableData;
},
//
getUpdatedRow: (props, moment, _) => {
let index = -1;
const parsedUpdatedRowIndex = parseInt(props.updatedRowIndex);
if (!_.isNaN(parsedUpdatedRowIndex)) {
index = parsedUpdatedRowIndex;
}
const rows = props.filteredTableData || props.processedTableData || [];
const primaryColumns = props.primaryColumns;
let updatedRow;
if (index > -1) {
const row = rows.find((row) => row.__originalIndex__ === index);
updatedRow = { ...row };
} else {
/*
* If updatedRowIndex is not a valid index, updatedRow should
* have proper row structure with empty string values
*/
updatedRow = {};
if (rows && rows[0]) {
Object.keys(rows[0]).forEach((key) => {
updatedRow[key] = "";
});
}
}
const nonDataColumnTypes = [
"editActions",
"button",
"iconButton",
"menuButton",
];
const nonDataColumnAliases = primaryColumns
? Object.values(primaryColumns)
.filter((column) => nonDataColumnTypes.includes(column.columnType))
.map((column) => column.alias)
: [];
const keysToBeOmitted = [
"__originalIndex__",
"__primaryKey__",
...nonDataColumnAliases,
];
return _.omit(updatedRow, keysToBeOmitted);
},
//
getUpdatedRows: (props, moment, _) => {
const primaryColumns = props.primaryColumns;
const nonDataColumnTypes = [
"editActions",
"button",
"iconButton",
"menuButton",
];
const nonDataColumnAliases = primaryColumns
? Object.values(primaryColumns)
.filter((column) => nonDataColumnTypes.includes(column.columnType))
.map((column) => column.alias)
: [];
const keysToBeOmitted = [
"__originalIndex__",
"__primaryKey__",
...nonDataColumnAliases,
];
/*
* case 1. If transientTableData is not empty, return aray of updated row.
* case 2. If transientTableData is empty, return empty array
*
* updated row structure
* {
* index: {{original index of the row}},
* {{primary_column}}: {{primary_column_value}} // only if primary has been set
* updatedFields: {
* {{updated_column_1}}: {{updated_column_1_value}}
* },
* allFields: {
* {{updated_column_1}}: {{updated_column_1_value}}
* {{rest of the fields from the row}}
* }
* }
*/
/* case 1 */
if (
props.transientTableData &&
!!Object.keys(props.transientTableData).length
) {
const updatedRows = [];
const tableData = props.processedTableData || props.tableData;
/* updatedRows is not sorted by index */
Object.entries(props.transientTableData)
.filter((entry) => {
return (
!_.isNil(entry[0]) && !!entry[0] && _.isFinite(Number(entry[0]))
);
})
.forEach((entry) => {
const key = entry[0];
const value = entry[1];
const row = tableData.find(
(row) => row.__originalIndex__ === Number(key),
);
updatedRows.push({
index: Number(key),
[props.primaryColumnId]: row[props.primaryColumnId],
updatedFields: value,
allFields: _.omit(row, keysToBeOmitted) || {},
});
});
return updatedRows;
} else {
/* case 2 */
return [];
}
},
//
getUpdatedRowIndices: (props, moment, _) => {
/* should return the keys of the transientTableData */
if (props.transientTableData) {
return Object.keys(props.transientTableData).map((index) =>
Number(index),
);
} else {
return [];
}
},
//
getPageOffset: (props, moment, _) => {
const pageSize = props.pageSize;
if (
Number.isFinite(props.pageNo) &&
Number.isFinite(pageSize) &&
props.pageNo >= 0 &&
pageSize >= 0
) {
/* Math.max fixes the value of (pageNo - 1) to a minimum of 0 as negative values are not valid */
return Math.max(props.pageNo - 1, 0) * pageSize;
}
return 0;
},
//
getEditableCellValidity: (props, moment, _) => {
if (
(!props.editableCell?.column && !props.isAddRowInProgress) ||
!props.primaryColumns
) {
return {};
}
const createRegex = (regex) => {
if (!regex) {
return new RegExp("//");
}
/*
* break up the regexp pattern into 4 parts: given regex, regex prefix , regex pattern, regex flags
* Example /test/i will be split into ["/test/gi", "/", "test", "gi"]
*/
const regexParts = regex.match(/(\/?)(.+)\\1([a-z]*)/i);
let parsedRegex;
if (!regexParts) {
parsedRegex = new RegExp(regex);
} else {
/*
* if we don't have a regex flags (gmisuy), convert provided string into regexp directly
*/
if (
regexParts[3] &&
!/^(?!.*?(.).*?\\1)[gmisuy]+$/.test(regexParts[3])
) {
parsedRegex = RegExp(regex);
} else {
/*
* if we have a regex flags, use it to form regexp
*/
parsedRegex = new RegExp(regexParts[2], regexParts[3]);
}
}
return parsedRegex;
};
let editableColumns = [];
const validatableColumns = ["text", "number", "currency", "date", "select"];
if (props.isAddRowInProgress) {
Object.values(props.primaryColumns)
.filter(
(column) =>
column.isEditable && validatableColumns.includes(column.columnType),
)
.forEach((column) => {
editableColumns.push([column, props.newRow[column.alias]]);
});
} else {
const editedColumn = Object.values(props.primaryColumns).find(
(column) => column.alias === props.editableCell?.column,
);
if (validatableColumns.includes(editedColumn.columnType)) {
editableColumns.push([editedColumn, props.editableCell?.value]);
}
}
const validationMap = {};
editableColumns.forEach(([editedColumn, value]) => {
let isValid = true;
if (editedColumn && editedColumn.validation) {
const validation = editedColumn.validation;
/**
* General validations
* 1. isColumnEditableCellValid
* 2. regex
* 3. isColumnEditableCellRequired
* 4. number/currency min/max
*/
if (
!_.isNil(validation.isColumnEditableCellValid) &&
!validation.isColumnEditableCellValid
) {
isValid = false;
} else if (
validation.regex &&
!createRegex(validation.regex).test(value)
) {
isValid = false;
} else if (
validation.isColumnEditableCellRequired &&
(value === "" || _.isNil(value))
) {
isValid = false;
} else {
switch (editedColumn.columnType) {
case "number":
case "currency":
if (
!_.isNil(validation.min) &&
validation.min !== "" &&
validation.min > value
) {
isValid = false;
}
if (
!_.isNil(validation.max) &&
validation.max !== "" &&
validation.max < value
) {
isValid = false;
}
break;
}
}
}
validationMap[editedColumn.alias] = isValid;
});
return validationMap;
},
//
getTableHeaders: (props, moment, _) => {
const columns = props.primaryColumns
? Object.values(props.primaryColumns)
: [];
return columns
.sort((a, b) => a.index - b.index)
.map((column) => ({
id: column?.id,
label: column?.label,
isVisible: column?.isVisible,
}));
},
//
};