PromucFlow_constructor/app/client/src/components/propertyControls/ComputeTablePropertyControl.tsx
Ivan Akulov 424d2f6965
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
7cbb12af88,
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 17:11:47 +05:30

177 lines
4.8 KiB
TypeScript

import React from "react";
import type { ControlProps } from "./BaseControl";
import BaseControl from "./BaseControl";
import { StyledDynamicInput } from "./StyledControls";
import type { CodeEditorExpected } from "components/editorComponents/CodeEditor";
import type { EditorTheme } from "components/editorComponents/CodeEditor/EditorConfig";
import {
EditorModes,
EditorSize,
TabBehaviour,
} from "components/editorComponents/CodeEditor/EditorConfig";
import type { ColumnProperties } from "widgets/TableWidget/component/Constants";
import { isDynamicValue } from "utils/DynamicBindingUtils";
import styled from "styled-components";
import { isString } from "utils/helpers";
import {
JSToString,
stringToJS,
} from "components/editorComponents/ActionCreator/utils";
import CodeEditor from "components/editorComponents/LazyCodeEditorWrapper";
const PromptMessage = styled.span`
line-height: 17px;
`;
const CurlyBraces = styled.span`
color: ${(props) => props.theme.colors.codeMirror.background.hoverState};
background-color: #ffffff;
border-radius: 2px;
padding: 2px;
margin: 0px 2px;
font-size: 10px;
`;
export function InputText(props: {
label: string;
value: string;
onChange: (event: React.ChangeEvent<HTMLTextAreaElement> | string) => void;
evaluatedValue?: any;
expected?: CodeEditorExpected;
placeholder?: string;
dataTreePath?: string;
additionalDynamicData: Record<string, Record<string, unknown>>;
theme: EditorTheme;
}) {
const {
additionalDynamicData,
dataTreePath,
evaluatedValue,
expected,
onChange,
placeholder,
theme,
value,
} = props;
return (
<StyledDynamicInput>
<CodeEditor
additionalDynamicData={additionalDynamicData}
dataTreePath={dataTreePath}
evaluatedValue={evaluatedValue}
expected={expected}
input={{
value: value,
onChange: onChange,
}}
mode={EditorModes.TEXT_WITH_BINDING}
placeholder={placeholder}
promptMessage={
<PromptMessage>
Access the current cell using <CurlyBraces>{"{{"}</CurlyBraces>
currentRow.columnName
<CurlyBraces>{"}}"}</CurlyBraces>
</PromptMessage>
}
size={EditorSize.EXTENDED}
tabBehaviour={TabBehaviour.INDENT}
theme={theme}
/>
</StyledDynamicInput>
);
}
class ComputeTablePropertyControl extends BaseControl<ComputeTablePropertyControlProps> {
render() {
const {
dataTreePath,
defaultValue,
expected,
label,
propertyValue,
theme,
} = this.props;
const tableId = this.props.widgetProperties.widgetName;
const value =
propertyValue && isDynamicValue(propertyValue)
? ComputeTablePropertyControl.getInputComputedValue(
propertyValue,
tableId,
)
: propertyValue
? propertyValue
: defaultValue;
const evaluatedProperties = this.props.widgetProperties;
const columns: Record<string, ColumnProperties> =
evaluatedProperties.primaryColumns || {};
const currentRow: { [key: string]: any } = {};
Object.keys(columns).forEach((id: string) => {
currentRow[id] = undefined;
});
// Load default value in evaluated value
if (value && !propertyValue) {
this.onTextChange(value);
}
return (
<InputText
additionalDynamicData={{
currentRow,
}}
dataTreePath={dataTreePath}
expected={expected}
label={label}
onChange={this.onTextChange}
theme={theme}
value={value}
/>
);
}
static getInputComputedValue = (propertyValue: string, tableId: string) => {
const value = `${propertyValue.substring(
`{{${tableId}.sanitizedTableData.map((currentRow) => ( `.length,
propertyValue.length - 4,
)}`;
const stringValue = JSToString(value);
return stringValue;
};
getComputedValue = (value: string, tableId: string) => {
const stringToEvaluate = stringToJS(value);
if (stringToEvaluate === "") {
return stringToEvaluate;
}
return `{{${tableId}.sanitizedTableData.map((currentRow) => ( ${stringToEvaluate}))}}`;
};
onTextChange = (event: React.ChangeEvent<HTMLTextAreaElement> | string) => {
let value = "";
if (typeof event !== "string") {
value = event.target?.value;
} else {
value = event;
}
if (isString(value)) {
const output = this.getComputedValue(
value,
this.props.widgetProperties.widgetName,
);
this.updateProperty(this.props.propertyName, output);
} else {
this.updateProperty(this.props.propertyName, value);
}
};
static getControlType() {
return "COMPUTE_VALUE";
}
}
export interface ComputeTablePropertyControlProps extends ControlProps {
defaultValue?: string;
}
export default ComputeTablePropertyControl;