2022-06-03 10:25:38 +00:00
|
|
|
import { get, has } from "lodash";
|
|
|
|
|
import {
|
|
|
|
|
combineDynamicBindings,
|
|
|
|
|
getDynamicBindings,
|
|
|
|
|
isDynamicValue,
|
|
|
|
|
THEME_BINDING_REGEX,
|
|
|
|
|
} from "utils/DynamicBindingUtils";
|
2023-09-06 12:15:04 +00:00
|
|
|
import WidgetFactory from "WidgetProvider/factory";
|
2022-06-03 10:25:38 +00:00
|
|
|
import { parseSchemaItem } from "widgets/WidgetUtils";
|
2022-11-28 04:44:31 +00:00
|
|
|
import { ROOT_SCHEMA_KEY } from "widgets/JSONFormWidget/constants";
|
2022-06-03 10:25:38 +00:00
|
|
|
import { getFieldStylesheet } from "widgets/JSONFormWidget/helper";
|
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 { UpdateWidgetPropertyPayload } from "actions/controlActions";
|
|
|
|
|
import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
|
2022-06-03 10:25:38 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* get properties to update for reset
|
|
|
|
|
*/
|
|
|
|
|
export const getPropertiesToUpdateForReset = (
|
|
|
|
|
canvasWidgets: CanvasWidgetsReduxState,
|
|
|
|
|
) => {
|
|
|
|
|
const propertiesToUpdate: UpdateWidgetPropertyPayload[] = [];
|
|
|
|
|
|
|
|
|
|
// ignoring these properites as these are objects itself
|
|
|
|
|
// these are used in json form, table and button group
|
|
|
|
|
// to style the children fields/components/widgets
|
|
|
|
|
const propertiesToIgnore = [
|
|
|
|
|
"childStylesheet",
|
|
|
|
|
"submitButtonStyles",
|
|
|
|
|
"resetButtonStyles",
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
// iterating over canvas widgets and their properties
|
|
|
|
|
// so that we can compare them with the value in stylesheet
|
|
|
|
|
// and if they are different, reset the value to the one stored
|
|
|
|
|
// in stylesheet
|
|
|
|
|
Object.keys(canvasWidgets).map((widgetId) => {
|
|
|
|
|
const widget = canvasWidgets[widgetId];
|
2022-11-28 04:44:31 +00:00
|
|
|
const stylesheetValue = WidgetFactory.getWidgetStylesheetConfigMap(
|
|
|
|
|
widget.type,
|
|
|
|
|
);
|
2022-06-03 10:25:38 +00:00
|
|
|
const modifications: any = {};
|
|
|
|
|
|
|
|
|
|
if (stylesheetValue) {
|
|
|
|
|
Object.keys(stylesheetValue)
|
|
|
|
|
.filter((propertyKey) => !propertiesToIgnore.includes(propertyKey))
|
|
|
|
|
.map((propertyKey) => {
|
|
|
|
|
if (
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
|
|
|
// @ts-ignore
|
|
|
|
|
THEME_BINDING_REGEX.test(stylesheetValue[propertyKey]) &&
|
|
|
|
|
stylesheetValue[propertyKey] !== widget[propertyKey]
|
|
|
|
|
) {
|
|
|
|
|
modifications[propertyKey] = stylesheetValue[propertyKey];
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
if (widget.type === "TABLE_WIDGET") {
|
|
|
|
|
Object.keys(widget.primaryColumns).map((primaryColumnKey) => {
|
|
|
|
|
const primaryColumn = widget.primaryColumns[primaryColumnKey];
|
|
|
|
|
const childStylesheetValue =
|
|
|
|
|
widget.childStylesheet[primaryColumn.columnType];
|
|
|
|
|
|
|
|
|
|
if (childStylesheetValue) {
|
|
|
|
|
Object.keys(childStylesheetValue).map((childPropertyKey) => {
|
|
|
|
|
const { jsSnippets, stringSegments } = getDynamicBindings(
|
|
|
|
|
childStylesheetValue[childPropertyKey],
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
const js = combineDynamicBindings(jsSnippets, stringSegments);
|
|
|
|
|
const computedValue = `{{${widget.widgetName}.sanitizedTableData.map((currentRow) => ( ${js}))}}`;
|
|
|
|
|
|
|
|
|
|
if (computedValue !== primaryColumn[childPropertyKey]) {
|
|
|
|
|
modifications[
|
|
|
|
|
`primaryColumns.${primaryColumnKey}.${childPropertyKey}`
|
|
|
|
|
] = computedValue;
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (widget.type === "BUTTON_GROUP_WIDGET") {
|
|
|
|
|
Object.keys(widget.groupButtons).map((groupButtonName: string) => {
|
|
|
|
|
const groupButton = widget.groupButtons[groupButtonName];
|
|
|
|
|
|
2022-11-28 04:44:31 +00:00
|
|
|
const childStylesheetValue = stylesheetValue?.childStylesheet?.button;
|
|
|
|
|
|
|
|
|
|
childStylesheetValue &&
|
|
|
|
|
Object.keys(childStylesheetValue).map((childPropertyKey) => {
|
|
|
|
|
if (
|
|
|
|
|
get(childStylesheetValue, childPropertyKey) !==
|
|
|
|
|
groupButton[childPropertyKey]
|
|
|
|
|
) {
|
|
|
|
|
modifications[
|
|
|
|
|
`groupButtons.${groupButtonName}.${childPropertyKey}`
|
|
|
|
|
] = get(childStylesheetValue, childPropertyKey);
|
|
|
|
|
}
|
|
|
|
|
});
|
2022-06-03 10:25:38 +00:00
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (widget.type === "JSON_FORM_WIDGET") {
|
|
|
|
|
if (has(widget, "schema")) {
|
|
|
|
|
parseSchemaItem(
|
|
|
|
|
widget.schema[ROOT_SCHEMA_KEY],
|
|
|
|
|
`schema.${ROOT_SCHEMA_KEY}`,
|
|
|
|
|
(schemaItem, propertyPath) => {
|
|
|
|
|
const fieldStylesheet = getFieldStylesheet(
|
2022-06-30 10:22:20 +00:00
|
|
|
widget.widgetName,
|
2022-06-03 10:25:38 +00:00
|
|
|
schemaItem.fieldType,
|
2022-11-28 04:44:31 +00:00
|
|
|
(WidgetFactory.getWidgetStylesheetConfigMap(widget.type) || {})
|
|
|
|
|
.childStylesheet as any,
|
2022-06-03 10:25:38 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
|
|
Object.keys(fieldStylesheet).map((fieldPropertyKey) => {
|
|
|
|
|
const fieldStylesheetValue = fieldStylesheet[fieldPropertyKey];
|
|
|
|
|
|
|
|
|
|
if (
|
|
|
|
|
isDynamicValue(fieldStylesheetValue) &&
|
2022-06-30 10:22:20 +00:00
|
|
|
fieldStylesheetValue !== get(schemaItem, fieldPropertyKey)
|
2022-06-03 10:25:38 +00:00
|
|
|
) {
|
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
|
|
|
modifications[`${[propertyPath]}.${fieldPropertyKey}`] =
|
|
|
|
|
fieldStylesheetValue;
|
2022-06-03 10:25:38 +00:00
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// reset submit button
|
2022-11-28 04:44:31 +00:00
|
|
|
(["submitButtonStyles", "resetButtonStyles"] as const).map(
|
|
|
|
|
(buttonStyleKey) => {
|
|
|
|
|
Object.keys(get(stylesheetValue, buttonStyleKey, {})).map(
|
|
|
|
|
(propertyKey) => {
|
|
|
|
|
const buttonStylesheetValue = get(
|
|
|
|
|
stylesheetValue,
|
|
|
|
|
`${buttonStyleKey}.${propertyKey}`,
|
|
|
|
|
) as string;
|
2022-06-03 10:25:38 +00:00
|
|
|
|
2022-11-28 04:44:31 +00:00
|
|
|
if (
|
|
|
|
|
buttonStylesheetValue &&
|
|
|
|
|
typeof buttonStylesheetValue === "string" &&
|
|
|
|
|
THEME_BINDING_REGEX.test(buttonStylesheetValue) &&
|
|
|
|
|
buttonStylesheetValue !==
|
|
|
|
|
widget[buttonStyleKey][propertyKey] &&
|
|
|
|
|
buttonStylesheetValue !== widget[buttonStyleKey][propertyKey]
|
|
|
|
|
) {
|
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
|
|
|
modifications[`${buttonStyleKey}.${propertyKey}`] =
|
|
|
|
|
buttonStylesheetValue;
|
2022-11-28 04:44:31 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
},
|
|
|
|
|
);
|
2022-06-03 10:25:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (Object.keys(modifications).length > 0) {
|
|
|
|
|
propertiesToUpdate.push({
|
|
|
|
|
widgetId,
|
|
|
|
|
updates: {
|
|
|
|
|
modify: modifications,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
return propertiesToUpdate;
|
|
|
|
|
};
|