Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
6df0810cc9
PromucFlow_constructor/app/client/src/utils/migrations/TextWidget.test.ts

619 lines
14 KiB
TypeScript
Raw Normal View History

fix: add overflow property in text-widget (#12160)
2022-03-31 04:48:51 +00:00
import {
migrateTextStyleFromTextWidget,
migrateScrollTruncateProperties,
} from "utils/migrations/TextWidget";
import { FontStyleTypes, TextSizes } from "constants/WidgetConstants";
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 { DSLWidget } from "widgets/constants";
fix: add overflow property in text-widget (#12160)
2022-03-31 04:48:51 +00:00
import { OverflowTypes } from "widgets/TextWidget/constants";
const inputDsl1: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textStyle: "LABEL",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
renderMode: "CANVAS",
},
],
};
const inputDsl2: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textStyle: "HEADING",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
renderMode: "CANVAS",
},
],
};
const inputDsl3: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textStyle: "BODY",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
renderMode: "CANVAS",
},
],
};
const outputDsl1: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.PARAGRAPH,
fontStyle: FontStyleTypes.BOLD,
renderMode: "CANVAS",
},
],
};
const outputDsl2: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.HEADING1,
fontStyle: FontStyleTypes.BOLD,
renderMode: "CANVAS",
},
],
};
const outputDsl3: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.PARAGRAPH,
renderMode: "CANVAS",
},
],
};
describe("Text Widget Property Pane Upgrade", () => {
it("To test text widget textStyle property is migrated", () => {
const newDsl = migrateTextStyleFromTextWidget(inputDsl1);
expect(JSON.stringify(newDsl) === JSON.stringify(outputDsl1));
});
it("To test text widget textStyle property is migrated", () => {
const newDsl = migrateTextStyleFromTextWidget(inputDsl2);
expect(JSON.stringify(newDsl) === JSON.stringify(outputDsl2));
});
it("To test text widget textStyle property is migrated", () => {
const newDsl = migrateTextStyleFromTextWidget(inputDsl3);
expect(JSON.stringify(newDsl) === JSON.stringify(outputDsl3));
});
});
const inputDsl4: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.PARAGRAPH,
fontStyle: FontStyleTypes.BOLD,
renderMode: "CANVAS",
shouldScroll: true,
shouldTruncate: false,
},
],
};
const outputDsl4: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.PARAGRAPH,
fontStyle: FontStyleTypes.BOLD,
renderMode: "CANVAS",
overflow: OverflowTypes.SCROLL,
},
],
};
const inputDsl5: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.PARAGRAPH,
fontStyle: FontStyleTypes.BOLD,
renderMode: "CANVAS",
shouldScroll: true,
shouldTruncate: true,
},
],
};
const outputDsl5: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.PARAGRAPH,
fontStyle: FontStyleTypes.BOLD,
renderMode: "CANVAS",
overflow: OverflowTypes.TRUNCATE,
},
],
};
const inputDsl6: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.PARAGRAPH,
fontStyle: FontStyleTypes.BOLD,
renderMode: "CANVAS",
shouldScroll: false,
shouldTruncate: false,
},
],
};
const outputDsl6: DSLWidget = {
widgetName: "MainContainer",
backgroundColor: "none",
rightColumn: 1118,
snapColumns: 16,
detachFromLayout: true,
widgetId: "0",
topRow: 0,
bottomRow: 1280,
containerStyle: "none",
snapRows: 33,
parentRowSpace: 1,
type: "CANVAS_WIDGET",
canExtend: true,
version: 15,
minHeight: 1292,
parentColumnSpace: 1,
dynamicTriggerPathList: [],
dynamicBindingPathList: [],
leftColumn: 0,
isLoading: false,
parentId: "",
renderMode: "CANVAS",
children: [
{
isVisible: true,
text: "Label",
textAlign: "LEFT",
widgetName: "Text1",
version: 1,
type: "TEXT_WIDGET",
isLoading: false,
parentColumnSpace: 67.375,
parentRowSpace: 40,
leftColumn: 3,
rightColumn: 7,
topRow: 1,
bottomRow: 2,
parentId: "0",
widgetId: "yf8bhokz7d",
dynamicBindingPathList: [],
fontSize: TextSizes.PARAGRAPH,
fontStyle: FontStyleTypes.BOLD,
renderMode: "CANVAS",
overflow: OverflowTypes.NONE,
},
],
};
describe("Text Widget Scroll and Truncate Property migrate", () => {
it("Overflow value should be SCROLL instead of shouldScroll true", () => {
const newDsl = migrateScrollTruncateProperties(inputDsl4);
expect(newDsl).toEqual(outputDsl4);
});
it("Overflow value should be TRUNCATE instead of shouldTruncate true", () => {
const newDsl = migrateScrollTruncateProperties(inputDsl5);
expect(newDsl).toEqual(outputDsl5);
});
it("Overflow value should be NONE in case of shouldScroll and shouldTruncate are false", () => {
const newDsl = migrateScrollTruncateProperties(inputDsl6);
expect(newDsl).toEqual(outputDsl6);
});
});
Reference in New Issue Copy Permalink