PromucFlow_constructor/app/client/src/utils/migrations/TableWidget.ts

808 lines
28 KiB
TypeScript
Raw Normal View History

import {
FontStyleTypes,
TextSizes,
GridDefaults,
} from "constants/WidgetConstants";
2021-12-29 11:42:07 +00:00
import {
generateTableColumnId,
getAllTableColumnKeys,
} from "widgets/TableWidget/component/TableHelpers";
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com> ## Description This PR upgrades Prettier to v2 + enforces TypeScript’s [`import type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export) syntax where applicable. It’s submitted as a separate PR so we can merge it easily. As a part of this PR, we reformat the codebase heavily: - add `import type` everywhere where it’s required, and - re-format the code to account for Prettier 2’s breaking changes: https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes This PR is submitted against `release` to make sure all new code by team members will adhere to new formatting standards, and we’ll have fewer conflicts when merging `bundle-optimizations` into `release`. (I’ll merge `release` back into `bundle-optimizations` once this PR is merged.) ### Why is this needed? This PR is needed because, for the Lodash optimization from https://github.com/appsmithorg/appsmith/commit/7cbb12af886621256224be0c93e6a465dd710ad3, we need to use `import type`. Otherwise, `babel-plugin-lodash` complains that `LoDashStatic` is not a lodash function. However, just using `import type` in the current codebase will give you this: <img width="962" alt="Screenshot 2023-03-08 at 17 45 59" src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png"> That’s because Prettier 1 can’t parse `import type` at all. To parse it, we need to upgrade to Prettier 2. ### Why enforce `import type`? Apart from just enabling `import type` support, this PR enforces specifying `import type` everywhere it’s needed. (Developers will get immediate TypeScript and ESLint errors when they forget to do so.) I’m doing this because I believe `import type` improves DX and makes refactorings easier. Let’s say you had a few imports like below. Can you tell which of these imports will increase the bundle size? (Tip: it’s not all of them!) ```ts // app/client/src/workers/Linting/utils.ts import { Position } from "codemirror"; import { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` It’s pretty hard, right? What about now? ```ts // app/client/src/workers/Linting/utils.ts import type { Position } from "codemirror"; import type { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` Now, it’s clear that only `lodash` will be bundled. This helps developers to see which imports are problematic, but it _also_ helps with refactorings. Now, if you want to see where `codemirror` is bundled, you can just grep for `import \{.*\} from "codemirror"` – and you won’t get any type-only imports. This also helps (some) bundlers. Upon transpiling, TypeScript erases type-only imports completely. In some environment (not ours), this makes the bundle smaller, as the bundler doesn’t need to bundle type-only imports anymore. ## Type of change - Chore (housekeeping or task changes that don't impact user perception) ## How Has This Been Tested? This was tested to not break the build. ### Test Plan > Add Testsmith test cases links that relate to this PR ### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) ## Checklist: ### Dev activity - [x] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag ### QA activity: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test --------- Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
2023-03-16 11:41:47 +00:00
import type { ColumnProperties } from "widgets/TableWidget/component/Constants";
import {
CellAlignmentTypes,
VerticalAlignmentTypes,
ColumnTypes,
} from "widgets/TableWidget/component/Constants";
import { Colors } from "constants/Colors";
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com> ## Description This PR upgrades Prettier to v2 + enforces TypeScript’s [`import type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export) syntax where applicable. It’s submitted as a separate PR so we can merge it easily. As a part of this PR, we reformat the codebase heavily: - add `import type` everywhere where it’s required, and - re-format the code to account for Prettier 2’s breaking changes: https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes This PR is submitted against `release` to make sure all new code by team members will adhere to new formatting standards, and we’ll have fewer conflicts when merging `bundle-optimizations` into `release`. (I’ll merge `release` back into `bundle-optimizations` once this PR is merged.) ### Why is this needed? This PR is needed because, for the Lodash optimization from https://github.com/appsmithorg/appsmith/commit/7cbb12af886621256224be0c93e6a465dd710ad3, we need to use `import type`. Otherwise, `babel-plugin-lodash` complains that `LoDashStatic` is not a lodash function. However, just using `import type` in the current codebase will give you this: <img width="962" alt="Screenshot 2023-03-08 at 17 45 59" src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png"> That’s because Prettier 1 can’t parse `import type` at all. To parse it, we need to upgrade to Prettier 2. ### Why enforce `import type`? Apart from just enabling `import type` support, this PR enforces specifying `import type` everywhere it’s needed. (Developers will get immediate TypeScript and ESLint errors when they forget to do so.) I’m doing this because I believe `import type` improves DX and makes refactorings easier. Let’s say you had a few imports like below. Can you tell which of these imports will increase the bundle size? (Tip: it’s not all of them!) ```ts // app/client/src/workers/Linting/utils.ts import { Position } from "codemirror"; import { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` It’s pretty hard, right? What about now? ```ts // app/client/src/workers/Linting/utils.ts import type { Position } from "codemirror"; import type { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` Now, it’s clear that only `lodash` will be bundled. This helps developers to see which imports are problematic, but it _also_ helps with refactorings. Now, if you want to see where `codemirror` is bundled, you can just grep for `import \{.*\} from "codemirror"` – and you won’t get any type-only imports. This also helps (some) bundlers. Upon transpiling, TypeScript erases type-only imports completely. In some environment (not ours), this makes the bundle smaller, as the bundler doesn’t need to bundle type-only imports anymore. ## Type of change - Chore (housekeeping or task changes that don't impact user perception) ## How Has This Been Tested? This was tested to not break the build. ### Test Plan > Add Testsmith test cases links that relate to this PR ### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) ## Checklist: ### Dev activity - [x] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag ### QA activity: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test --------- Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
2023-03-16 11:41:47 +00:00
import type { ColumnAction } from "components/propertyControls/ColumnActionSelectorControl";
import { cloneDeep, isString } from "lodash";
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com> ## Description This PR upgrades Prettier to v2 + enforces TypeScript’s [`import type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export) syntax where applicable. It’s submitted as a separate PR so we can merge it easily. As a part of this PR, we reformat the codebase heavily: - add `import type` everywhere where it’s required, and - re-format the code to account for Prettier 2’s breaking changes: https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes This PR is submitted against `release` to make sure all new code by team members will adhere to new formatting standards, and we’ll have fewer conflicts when merging `bundle-optimizations` into `release`. (I’ll merge `release` back into `bundle-optimizations` once this PR is merged.) ### Why is this needed? This PR is needed because, for the Lodash optimization from https://github.com/appsmithorg/appsmith/commit/7cbb12af886621256224be0c93e6a465dd710ad3, we need to use `import type`. Otherwise, `babel-plugin-lodash` complains that `LoDashStatic` is not a lodash function. However, just using `import type` in the current codebase will give you this: <img width="962" alt="Screenshot 2023-03-08 at 17 45 59" src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png"> That’s because Prettier 1 can’t parse `import type` at all. To parse it, we need to upgrade to Prettier 2. ### Why enforce `import type`? Apart from just enabling `import type` support, this PR enforces specifying `import type` everywhere it’s needed. (Developers will get immediate TypeScript and ESLint errors when they forget to do so.) I’m doing this because I believe `import type` improves DX and makes refactorings easier. Let’s say you had a few imports like below. Can you tell which of these imports will increase the bundle size? (Tip: it’s not all of them!) ```ts // app/client/src/workers/Linting/utils.ts import { Position } from "codemirror"; import { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` It’s pretty hard, right? What about now? ```ts // app/client/src/workers/Linting/utils.ts import type { Position } from "codemirror"; import type { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` Now, it’s clear that only `lodash` will be bundled. This helps developers to see which imports are problematic, but it _also_ helps with refactorings. Now, if you want to see where `codemirror` is bundled, you can just grep for `import \{.*\} from "codemirror"` – and you won’t get any type-only imports. This also helps (some) bundlers. Upon transpiling, TypeScript erases type-only imports completely. In some environment (not ours), this makes the bundle smaller, as the bundler doesn’t need to bundle type-only imports anymore. ## Type of change - Chore (housekeeping or task changes that don't impact user perception) ## How Has This Been Tested? This was tested to not break the build. ### Test Plan > Add Testsmith test cases links that relate to this PR ### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) ## Checklist: ### Dev activity - [x] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag ### QA activity: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test --------- Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
2023-03-16 11:41:47 +00:00
import type { WidgetProps } from "widgets/BaseWidget";
import type { DSLWidget } from "widgets/constants";
import { getSubstringBetweenTwoWords } from "utils/helpers";
import { traverseDSLAndMigrate } from "utils/WidgetMigrationUtils";
import { isDynamicValue } from "utils/DynamicBindingUtils";
import { stringToJS } from "components/editorComponents/ActionCreator/utils";
fix: add select options field to new row (#22003) ## Description This PR introduces new two new properties: `Same options in new row` and `New row options` for the select column type. We show these two fields when the allow add new row is turned on in table - SameOptionsInNewRow -- Boolean field ; When turned on the option for the first row is used in the new row. Default is true - Label : Use same options in new row - Tooltip : Toggle to display same choices for new row and editing existing row in column. - NewRowOptions -- Array field; when the above boolean is turned off we show this option to let people add options specifically for new row. Supports static and dynamic data, but doesn't support currentRow - Label: New row options - Tooltip : Options exclusively displayed in the column for new row addition. Fixes #20230 ## Type of change - Bug fix (non-breaking change which fixes an issue) ## How Has This Been Tested? - Cypress: - When allowAddNewRow is turned on, same new option should be true and new row option should be invisible. - When turned on same option, options of the first row should appear while editing as well as adding new row. - When turned off, New row option should be visible - Fill new row options, the new row options should appear while adding new row in select field. - New row options should not have access to the currentRow - Both the options should only be visible only when allowNewRow is true. - Should support static and dynamic values in new row options - Manual - For the new DnD Tables. Check if the above functionality is working as expected. - For Existing tables, Check if the above functionality is working as expected. This needed to be tested from migration standpoint ### Test Plan > https://github.com/appsmithorg/TestSmith/issues/2367 ### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) ## Checklist: ### Dev activity - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag ### QA activity: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test
2023-04-06 18:28:24 +00:00
import {
type ColumnProperties as ColumnPropertiesV2,
StickyType,
} from "widgets/TableWidgetV2/component/Constants";
export const isSortableMigration = (currentDSL: DSLWidget) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET" && !child.hasOwnProperty("isSortable")) {
child["isSortable"] = true;
} else if (child.children && child.children.length > 0) {
child = isSortableMigration(child);
}
return child;
});
return currentDSL;
};
export const tableWidgetPropertyPaneMigrations = (currentDSL: DSLWidget) => {
currentDSL.children = currentDSL.children?.map((_child: WidgetProps) => {
let child = cloneDeep(_child);
// If the current child is a TABLE_WIDGET
if (child.type === "TABLE_WIDGET") {
const hiddenColumns = child.hiddenColumns || [];
const columnNameMap = child.columnNameMap;
const columnSizeMap = child.columnSizeMap;
const columnTypeMap = child.columnTypeMap;
let tableColumns: string[] = [];
const dynamicBindingPathList = child.dynamicBindingPathList;
if (child.tableData.length) {
let tableData = [];
// Try parsing the table data, if it parses great
// If it does not parse, assign tableData the value as is.
try {
tableData = JSON.parse(child.tableData);
} catch (e) {
tableData = child.tableData;
}
if (
!isString(tableData) &&
dynamicBindingPathList?.findIndex((item) => item.key !== "tableData")
) {
// Get the list of column ids
tableColumns = getAllTableColumnKeys(tableData);
} else {
child.migrated = false;
}
}
// Get primaryColumns to be the list of column keys
// Use the old order if it exists, else use the new order
const primaryColumns = child.columnOrder?.length
? child.columnOrder
: tableColumns;
child.primaryColumns = {};
// const hasActions = child.columnActions && child.columnActions.length > 0;
// Generate new primarycolumns
primaryColumns.forEach((accessor: string, index: number) => {
// Get the column type from the columnTypeMap
let columnType =
columnTypeMap && columnTypeMap[accessor]
? columnTypeMap[accessor].type
: ColumnTypes.TEXT;
// If the columnType is currency make it a text type
// We're deprecating currency types
if (columnType === "currency") {
columnType = ColumnTypes.TEXT;
}
// Get a full set of column properties
const column: ColumnProperties = {
index, // Use to maintain order of columns
// The widget of the column
width:
columnSizeMap && columnSizeMap[accessor]
? columnSizeMap[accessor]
: 150,
// id of the column
id: accessor,
// default horizontal alignment
horizontalAlignment: CellAlignmentTypes.LEFT,
// default vertical alignment
verticalAlignment: VerticalAlignmentTypes.CENTER,
// columnType
columnType,
// default text color
textColor: Colors.THUNDER,
// default text size
textSize: TextSizes.PARAGRAPH,
// default font size
fontStyle: FontStyleTypes.REGULAR,
enableFilter: true,
enableSort: true,
// hide the column if it was hidden earlier using hiddenColumns
isVisible: hiddenColumns.includes(accessor) ? false : true,
// We did not have a concept of derived columns so far
isDerived: false,
// Use renamed names from the map
// or use the newly generated name
label:
columnNameMap && columnNameMap[accessor]
? columnNameMap[accessor]
: accessor,
// Generate computed value
computedValue: `{{${child.widgetName}.sanitizedTableData.map((currentRow) => ( currentRow.${accessor})}}`,
};
// copy inputForma nd outputFormat for date column types
if (columnTypeMap && columnTypeMap[accessor]) {
column.outputFormat = columnTypeMap[accessor].format || "";
column.inputFormat = columnTypeMap[accessor].inputFormat || "";
}
child.primaryColumns[column.id] = column;
});
// Get all column actions
const columnActions = child.columnActions || [];
// Get dynamicTriggerPathList
let dynamicTriggerPathList: Array<{ key: string }> =
child.dynamicTriggerPathList || [];
const columnPrefix = "customColumn";
const updatedDerivedColumns: Record<string, ColumnProperties> = {};
// Add derived column for each column action
columnActions.forEach((action: ColumnAction, index: number) => {
const column = {
index: child.primaryColumns.length + index, // Add to the end of the columns list
width: 150, // Default width
id: `${columnPrefix}${index + 1}`, // A random string which was generated previously
label: action.label, // Revert back to "Actions"
columnType: "button", // All actions are buttons
isVisible: true,
isDisabled: false,
isDerived: true,
buttonLabel: action.label,
buttonStyle: "rgb(3, 179, 101)",
buttonLabelColor: "#FFFFFF",
onClick: action.dynamicTrigger,
computedValue: "",
};
dynamicTriggerPathList.push({
key: `primaryColumns.${columnPrefix}${index + 1}.onClick`,
});
updatedDerivedColumns[column.id] = column;
child.primaryColumns[column.id] = column;
});
if (Object.keys(updatedDerivedColumns).length) {
dynamicTriggerPathList = dynamicTriggerPathList.filter(
(triggerPath: Record<string, string>) => {
triggerPath.key !== "columnActions";
},
);
}
child.dynamicTriggerPathList = dynamicTriggerPathList;
child.textSize = TextSizes.PARAGRAPH;
child.horizontalAlignment = CellAlignmentTypes.LEFT;
child.verticalAlignment = VerticalAlignmentTypes.CENTER;
child.fontStyle = FontStyleTypes.REGULAR;
child.derivedColumns = updatedDerivedColumns;
} else if (child.children && child.children.length > 0) {
child = tableWidgetPropertyPaneMigrations(child);
}
return child;
});
return currentDSL;
};
const removeSpecialChars = (value: string, limit?: number) => {
const separatorRegex = /\W+/;
return value
.split(separatorRegex)
.join("_")
.slice(0, limit || 30);
};
export const migrateTablePrimaryColumnsBindings = (currentDSL: DSLWidget) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
if (
child.primaryColumns &&
Object.keys(child.primaryColumns).length > 0
) {
const newPrimaryColumns: Record<string, ColumnProperties> = {};
for (const [key, value] of Object.entries(
child.primaryColumns as Record<string, ColumnProperties>,
)) {
const sanitizedKey = removeSpecialChars(key, 200);
const newComputedValue = value.computedValue
? value.computedValue.replace(
`${child.widgetName}.tableData.map`,
`${child.widgetName}.sanitizedTableData.map`,
)
: "";
newPrimaryColumns[sanitizedKey] = {
...value,
computedValue: newComputedValue,
};
}
child.primaryColumns = newPrimaryColumns;
child.dynamicBindingPathList = child.dynamicBindingPathList?.map(
(path) => {
path.key = path.key.split(" ").join("_");
return path;
},
);
}
} else if (child.children && child.children.length > 0) {
child = migrateTablePrimaryColumnsBindings(child);
}
return child;
});
return currentDSL;
};
export const migrateTableWidgetParentRowSpaceProperty = (
currentDSL: DSLWidget,
) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
if (child.parentRowSpace === 40) {
child.parentRowSpace = GridDefaults.DEFAULT_GRID_ROW_HEIGHT;
}
} else if (child.children && child.children.length > 0) {
child = migrateTableWidgetParentRowSpaceProperty(child);
}
return child;
});
return currentDSL;
};
export const migrateTableWidgetHeaderVisibilityProperties = (
currentDSL: DSLWidget,
) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
if (!("isVisibleSearch" in child)) {
child.isVisibleSearch = true;
child.isVisibleFilters = true;
child.isVisibleDownload = true;
child.isVisiblePagination = true;
}
} else if (child.children && child.children.length > 0) {
child = migrateTableWidgetHeaderVisibilityProperties(child);
}
return child;
});
return currentDSL;
};
export const migrateTableWidgetDelimiterProperties = (
currentDSL: DSLWidget,
) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
if (!child.delimiter) {
child.delimiter = ",";
}
} else if (child.children && child.children.length > 0) {
child = migrateTableWidgetDelimiterProperties(child);
}
return child;
});
return currentDSL;
};
export const migrateTablePrimaryColumnsComputedValue = (
currentDSL: DSLWidget,
) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
if (
child.primaryColumns &&
Object.keys(child.primaryColumns).length > 0
) {
const newPrimaryColumns: Record<string, ColumnProperties> = {};
for (const [key, value] of Object.entries(
child.primaryColumns as Record<string, ColumnProperties>,
)) {
const sanitizedKey = removeSpecialChars(key, 200);
let newComputedValue = "";
if (value.computedValue) {
newComputedValue = value.computedValue.replace(
`${child.widgetName}.sanitizedTableData.map((currentRow) => { return`,
`${child.widgetName}.sanitizedTableData.map((currentRow) => (`,
);
// change matching "}" bracket with ")"
const lastParanthesesInd = newComputedValue.length - 4;
newComputedValue =
newComputedValue.substring(0, lastParanthesesInd) +
")" +
newComputedValue.substring(lastParanthesesInd + 1);
}
newPrimaryColumns[sanitizedKey] = {
...value,
computedValue: newComputedValue,
};
}
child.primaryColumns = newPrimaryColumns;
}
} else if (child.children && child.children.length > 0) {
child = migrateTablePrimaryColumnsComputedValue(child);
}
return child;
});
return currentDSL;
};
const getUpdatedColumns = (
widgetName: string,
columns: Record<string, ColumnProperties>,
) => {
const updatedColumns: Record<string, ColumnProperties> = {};
if (columns && Object.keys(columns).length > 0) {
for (const [columnId, columnProps] of Object.entries(columns)) {
const sanitizedColumnId = removeSpecialChars(columnId, 200);
const selectedRowBindingValue = `${widgetName}.selectedRow`;
let newOnClickBindingValue = undefined;
if (
columnProps.onClick &&
columnProps.onClick.includes(selectedRowBindingValue)
) {
newOnClickBindingValue = columnProps.onClick.replace(
selectedRowBindingValue,
"currentRow",
);
}
updatedColumns[sanitizedColumnId] = columnProps;
if (newOnClickBindingValue)
updatedColumns[sanitizedColumnId].onClick = newOnClickBindingValue;
}
}
return updatedColumns;
};
export const migrateTableWidgetSelectedRowBindings = (
currentDSL: DSLWidget,
) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
child.derivedColumns = getUpdatedColumns(
child.widgetName,
child.derivedColumns as Record<string, ColumnProperties>,
);
child.primaryColumns = getUpdatedColumns(
child.widgetName,
child.primaryColumns as Record<string, ColumnProperties>,
);
} else if (child.children && child.children.length > 0) {
child = migrateTableWidgetSelectedRowBindings(child);
}
return child;
});
return currentDSL;
};
/**
* This migration sanitizes the following properties -
* primaryColumns object key, for the value of each key - id, computedValue are sanitized
* columnOrder
* dynamicBindingPathList
*
* This migration solves the following issue -
* https://github.com/appsmithorg/appsmith/issues/6897
*/
export const migrateTableSanitizeColumnKeys = (currentDSL: DSLWidget) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
const primaryColumnEntries: [string, ColumnProperties][] = Object.entries(
child.primaryColumns || {},
);
const newPrimaryColumns: Record<string, ColumnProperties> = {};
if (primaryColumnEntries.length) {
for (const [, primaryColumnEntry] of primaryColumnEntries.entries()) {
// Value is reassigned when its invalid(Faulty DSL https://github.com/appsmithorg/appsmith/issues/8979)
const [key] = primaryColumnEntry;
let [, value] = primaryColumnEntry;
const sanitizedKey = removeSpecialChars(key, 200);
let id = "";
if (value.id) {
id = removeSpecialChars(value.id, 200);
}
// When id is undefined it's likely value isn't correct and needs fixing
else if (Object.keys(value)) {
const onlyKey = Object.keys(value)[0] as keyof ColumnProperties;
const obj: ColumnProperties = value[onlyKey] as any;
if (!obj.id && !obj.columnType) {
continue;
}
value = obj;
id = removeSpecialChars(value.id, 200);
}
// Sanitizes "{{Table1.sanitizedTableData.map((currentRow) => ( currentRow.$$$random_header))}}"
// to "{{Table1.sanitizedTableData.map((currentRow) => ( currentRow._random_header))}}"
const computedValue = (value?.computedValue || "").replace(
key,
sanitizedKey,
);
newPrimaryColumns[sanitizedKey] = {
...value,
computedValue,
id,
};
}
child.primaryColumns = newPrimaryColumns;
}
// Sanitizes [ "id", "name", $$$random_header ]
// to [ "id", "name", _random_header ]
child.columnOrder = (child.columnOrder || []).map((co: string) =>
removeSpecialChars(co, 200),
);
// Sanitizes [ {key: primaryColumns.$random.header.computedValue }]
// to [ {key: primaryColumns._random_header.computedValue }]
child.dynamicBindingPathList = (child.dynamicBindingPathList || []).map(
(path) => {
const pathChunks = path.key.split("."); // primaryColumns.$random.header.computedValue -> [ "primaryColumns", "$random", "header", "computedValue"]
// tableData is a valid dynamicBindingPath and pathChunks would have just one entry
if (pathChunks.length < 2) {
return path;
}
const firstPart = pathChunks[0] + "."; // "primaryColumns."
const lastPart = "." + pathChunks[pathChunks.length - 1]; // ".computedValue"
const key = getSubstringBetweenTwoWords(
path.key,
firstPart,
lastPart,
); // primaryColumns.$random.header.computedValue -> $random.header
const sanitizedPrimaryColumnKey = removeSpecialChars(key, 200);
return {
key: firstPart + sanitizedPrimaryColumnKey + lastPart,
};
},
);
} else if (child.children && child.children.length > 0) {
child = migrateTableSanitizeColumnKeys(child);
}
return child;
});
return currentDSL;
};
export const migrateTableWidgetIconButtonVariant = (currentDSL: DSLWidget) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
const primaryColumns = child.primaryColumns as Record<
string,
ColumnProperties
>;
Object.keys(primaryColumns).forEach((accessor: string) => {
const primaryColumn = primaryColumns[accessor];
if (primaryColumn.columnType === "iconButton") {
if (!("buttonVariant" in primaryColumn)) {
primaryColumn.buttonVariant = "TERTIARY";
}
}
});
} else if (child.children && child.children.length > 0) {
child = migrateTableWidgetIconButtonVariant(child);
}
return child;
});
return currentDSL;
};
2021-12-29 11:42:07 +00:00
/*
* DO NOT USE THIS. it overwrites conputedValues of the Table Columns
*/
2021-12-29 11:42:07 +00:00
export const migrateTableWidgetNumericColumnName = (currentDSL: DSLWidget) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET") {
child.columnOrder = (child.columnOrder || []).map((col: string) =>
generateTableColumnId(col),
);
const primaryColumns = { ...child.primaryColumns };
// clear old primaryColumns
child.primaryColumns = {};
for (const key in primaryColumns) {
if (Object.prototype.hasOwnProperty.call(primaryColumns, key)) {
const column = primaryColumns[key];
const columnId = generateTableColumnId(key);
const newComputedValue = `{{${child.widgetName}.sanitizedTableData.map((currentRow) => ( currentRow.${columnId}))}}`;
// added column with old accessor
child.primaryColumns[columnId] = {
...column,
id: columnId,
computedValue: newComputedValue,
};
}
}
child.dynamicBindingPathList = (child.dynamicBindingPathList || []).map(
(path) => {
const pathChunks = path.key.split(".");
// tableData is a valid dynamicBindingPath and pathChunks would have just one entry
if (pathChunks.length < 2) {
return path;
}
const firstPart = pathChunks[0] + "."; // "primaryColumns."
const lastPart = "." + pathChunks.pop(); // ".computedValue"
const key = getSubstringBetweenTwoWords(
path.key,
firstPart,
lastPart,
); // primaryColumns.$random.header.computedValue -> $random.header
const sanitizedPrimaryColumnKey = generateTableColumnId(key);
return {
key: firstPart + sanitizedPrimaryColumnKey + lastPart,
};
},
);
} else if (child.children && child.children.length > 0) {
child = migrateTableWidgetNumericColumnName(child);
}
return child;
});
return currentDSL;
};
/*
* Adds validation object to each column in the primaryColumns
*/
export const migrateTableWidgetV2Validation = (currentDSL: DSLWidget) => {
currentDSL.children = currentDSL.children?.map((child: WidgetProps) => {
if (child.type === "TABLE_WIDGET_V2") {
const primaryColumns = child.primaryColumns;
for (const key in primaryColumns) {
if (primaryColumns.hasOwnProperty(key)) {
primaryColumns[key].validation = {};
}
}
} else if (child.children && child.children.length > 0) {
child = migrateTableWidgetV2Validation(child);
}
return child;
});
return currentDSL;
};
const oldBindingPrefix = `{{
(
(editedValue, currentRow, currentIndex) => (
`;
const newBindingPrefix = `{{
(
(editedValue, currentRow, currentIndex, isNewRow) => (
`;
const oldBindingSuffix = (tableId: string, columnName: string) => `
))
(
${tableId}.columnEditableCellValue.${columnName} || "",
${tableId}.processedTableData[${tableId}.editableCell.index] ||
Object.keys(${tableId}.processedTableData[0])
.filter(key => ["__originalIndex__", "__primaryKey__"].indexOf(key) === -1)
.reduce((prev, curr) => {
prev[curr] = "";
return prev;
}, {}),
${tableId}.editableCell.index)
}}
`;
const newBindingSuffix = (tableId: string, columnName: string) => {
return `
))
(
(${tableId}.isAddRowInProgress ? ${tableId}.newRow.${columnName} : ${tableId}.columnEditableCellValue.${columnName}) || "",
${tableId}.isAddRowInProgress ? ${tableId}.newRow : (${tableId}.processedTableData[${tableId}.editableCell.index] ||
Object.keys(${tableId}.processedTableData[0])
.filter(key => ["__originalIndex__", "__primaryKey__"].indexOf(key) === -1)
.reduce((prev, curr) => {
prev[curr] = "";
return prev;
}, {})),
${tableId}.isAddRowInProgress ? -1 : ${tableId}.editableCell.index,
${tableId}.isAddRowInProgress
)
}}
`;
};
export const migrateTableWidgetV2ValidationBinding = (
currentDSL: DSLWidget,
) => {
return traverseDSLAndMigrate(currentDSL, (widget: WidgetProps) => {
if (widget.type === "TABLE_WIDGET_V2") {
const primaryColumns = widget.primaryColumns;
for (const column in primaryColumns) {
if (
primaryColumns.hasOwnProperty(column) &&
primaryColumns[column].validation &&
primaryColumns[column].validation.isColumnEditableCellValid &&
isDynamicValue(
primaryColumns[column].validation.isColumnEditableCellValid,
)
) {
const propertyValue =
primaryColumns[column].validation.isColumnEditableCellValid;
const binding = propertyValue
.replace(oldBindingPrefix, "")
.replace(oldBindingSuffix(widget.widgetName, column), "");
primaryColumns[column].validation.isColumnEditableCellValid =
newBindingPrefix +
binding +
newBindingSuffix(widget.widgetName, column);
}
}
}
});
};
export const migrateTableWidgetV2SelectOption = (currentDSL: DSLWidget) => {
return traverseDSLAndMigrate(currentDSL, (widget: WidgetProps) => {
if (widget.type === "TABLE_WIDGET_V2") {
Object.values(
widget.primaryColumns as Record<
string,
{ columnType: string; selectOptions: string }
>,
)
.filter((column) => column.columnType === "select")
.forEach((column) => {
const selectOptions = column.selectOptions;
if (selectOptions && isDynamicValue(selectOptions)) {
column.selectOptions = `{{${
widget.widgetName
}.processedTableData.map((currentRow, currentIndex) => ( ${stringToJS(
selectOptions,
)}))}}`;
}
});
}
});
};
export const migrateMenuButtonDynamicItemsInsideTableWidget = (
currentDSL: DSLWidget,
) => {
return traverseDSLAndMigrate(currentDSL, (widget: WidgetProps) => {
if (widget.type === "TABLE_WIDGET_V2") {
const primaryColumns = widget.primaryColumns;
if (primaryColumns) {
for (const column in primaryColumns) {
if (
primaryColumns.hasOwnProperty(column) &&
primaryColumns[column].columnType === "menuButton" &&
!primaryColumns[column].menuItemsSource
) {
primaryColumns[column].menuItemsSource = "STATIC";
}
}
}
}
});
};
feat: added column freeze and unfreeze functionality to table widget (#18757) **PRD**: https://www.notion.so/appsmith/Ability-to-freeze-columns-dd118f7ed2e14e008ee305056b79874a?d=300f4968889244da9f737e1bfd8c06dc#2ddaf28e10a0475cb69f1af77b938d0b This PR adds the following features to the table widget: - Freeze the columns to the left or right of the table.(Both canvas and page view mode). - Unfreeze the frozen columns. (Both canvas and page view mode). - Columns that are left frozen, will get unfrozen at a position after the last left frozen column. (Both canvas and page view mode). - Columns that are right frozen, will get unfrozen at a position before the first right frozen column. (Both canvas and page view mode). - Column order can be persisted in the Page view mode. - Users can also unfreeze the columns that are frozen by the developers. - Columns that are frozen cannot be reordered(Both canvas and page view mode) - **Property pane changes (Columns property)**: - If the column is frozen to the left then that column should appear at top of the list. - If the column is frozen to the right then that column should appear at the bottom of the list. - The columns that are frozen cannot be moved or re-ordered in the list. They remain fixed in their position. - In-Page mode, If there is a change in frozen or unfrozen columns in multiple tables then the order of columns and frozen and unfrozen columns should get persisted on refresh i.e. changes should get persisted across refreshes.
2023-02-15 11:42:46 +00:00
export const migrateColumnFreezeAttributes = (currentDSL: DSLWidget) => {
return traverseDSLAndMigrate(currentDSL, (widget: WidgetProps) => {
if (widget.type === "TABLE_WIDGET_V2") {
const primaryColumns = widget?.primaryColumns;
// Assign default sticky value to each column
if (primaryColumns) {
for (const column in primaryColumns) {
if (!primaryColumns[column].hasOwnProperty("sticky")) {
primaryColumns[column].sticky = StickyType.NONE;
}
}
}
widget.canFreezeColumn = false;
widget.columnUpdatedAt = Date.now();
}
});
};
fix: add select options field to new row (#22003) ## Description This PR introduces new two new properties: `Same options in new row` and `New row options` for the select column type. We show these two fields when the allow add new row is turned on in table - SameOptionsInNewRow -- Boolean field ; When turned on the option for the first row is used in the new row. Default is true - Label : Use same options in new row - Tooltip : Toggle to display same choices for new row and editing existing row in column. - NewRowOptions -- Array field; when the above boolean is turned off we show this option to let people add options specifically for new row. Supports static and dynamic data, but doesn't support currentRow - Label: New row options - Tooltip : Options exclusively displayed in the column for new row addition. Fixes #20230 ## Type of change - Bug fix (non-breaking change which fixes an issue) ## How Has This Been Tested? - Cypress: - When allowAddNewRow is turned on, same new option should be true and new row option should be invisible. - When turned on same option, options of the first row should appear while editing as well as adding new row. - When turned off, New row option should be visible - Fill new row options, the new row options should appear while adding new row in select field. - New row options should not have access to the currentRow - Both the options should only be visible only when allowNewRow is true. - Should support static and dynamic values in new row options - Manual - For the new DnD Tables. Check if the above functionality is working as expected. - For Existing tables, Check if the above functionality is working as expected. This needed to be tested from migration standpoint ### Test Plan > https://github.com/appsmithorg/TestSmith/issues/2367 ### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) ## Checklist: ### Dev activity - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag ### QA activity: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test
2023-04-06 18:28:24 +00:00
export const migrateTableSelectOptionAttributesForNewRow = (
currentDSL: DSLWidget,
) => {
return traverseDSLAndMigrate(currentDSL, (widget: WidgetProps) => {
if (widget.type === "TABLE_WIDGET_V2") {
const primaryColumns = widget?.primaryColumns as ColumnPropertiesV2;
// Set default value for allowSameOptionsInNewRow
if (primaryColumns) {
Object.values(primaryColumns).forEach((column) => {
if (
column.hasOwnProperty("columnType") &&
column.columnType === "select"
) {
column.allowSameOptionsInNewRow = true;
}
});
}
}
});
};
fix: Add current index property to min max fields (#22556) Fixes #20231 - It is a new feature (non-breaking change which adds functionality) This pull request adds support for currentIndex/currentRow properties for editable columns in a table widget. This property has been specifically added for min/max/regex/Error Message/Required properties of a column. This change has been made to achieve consistency in the implementation and API of a table widget column for various properties that it has. This pull request has a migration which has been unit tested by me. Cypress tests for the feature have also been added. ## Test Plan > https://github.com/appsmithorg/TestSmith/issues/2380 ## Checklist: ### Dev activity - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag ### QA activity: - [x] Test plan has been approved by relevant developers - [x] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test Testing Plan - by developer 1. Make a column editable. 2. Check `currentIndex` and `currentRow` are available for checking validations in min/max/errorMessage/regex/required fields. 3. Since this PR also involves a migration, please check existing values in min/max/errorMessage/regex/required fields don't break after migration. Existing values in validations can include validations values of type string, boolean and other data type possible, like `{currentIndex == 1}`
2023-05-05 13:55:10 +00:00
export const migrateBindingPrefixSuffixForInlineEditValidationControl = (
currentDSL: DSLWidget,
) => {
return traverseDSLAndMigrate(currentDSL, (widget: WidgetProps) => {
if (widget.type === "TABLE_WIDGET_V2") {
const tableId = widget.widgetName;
const oldBindingPrefix = `{{((isNewRow)=>(`;
const newBindingPrefix = `{{
(
(isNewRow, currentIndex, currentRow) => (
`;
const oldBindingSuffix = `))(${tableId}.isAddRowInProgress)}}`;
const newBindingSuffix = `
))
(
${tableId}.isAddRowInProgress,
${tableId}.isAddRowInProgress ? -1 : ${tableId}.editableCell.index,
${tableId}.isAddRowInProgress ? ${tableId}.newRow : (${tableId}.processedTableData[${tableId}.editableCell.index] ||
Object.keys(${tableId}.processedTableData[0])
.filter(key => ["__originalIndex__", "__primaryKey__"].indexOf(key) === -1)
.reduce((prev, curr) => {
prev[curr] = "";
return prev;
}, {}))
)
}}
`;
const applicableValidationNames = [
"min",
"max",
"regex",
"errorMessage",
"isColumnEditableCellRequired",
];
const primaryColumns = widget?.primaryColumns as ColumnPropertiesV2;
Object.values(primaryColumns).forEach((column) => {
if (column.hasOwnProperty("validation")) {
const validations = column.validation;
for (const validationName in validations) {
if (applicableValidationNames.indexOf(validationName) == -1) {
continue;
}
const validationValue = validations[validationName];
if (typeof validationValue !== "string") {
continue;
}
let compressedValidationValue = validationValue.replace(/\s/g, "");
compressedValidationValue = compressedValidationValue.replace(
oldBindingPrefix,
newBindingPrefix,
);
compressedValidationValue = compressedValidationValue.replace(
oldBindingSuffix,
newBindingSuffix,
);
validations[validationName] = compressedValidationValue;
}
}
});
}
});
};