## 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>
281 lines
11 KiB
TypeScript
281 lines
11 KiB
TypeScript
import type { Action } from "entities/Action/index";
|
|
import _ from "lodash";
|
|
import { EvaluationSubstitutionType } from "entities/DataTree/dataTreeFactory";
|
|
import {
|
|
alternateViewTypeInputConfig,
|
|
isHidden,
|
|
ViewTypes,
|
|
} from "components/formControls/utils";
|
|
import {
|
|
PaginationSubComponent,
|
|
SortingSubComponent,
|
|
WhereClauseSubComponent,
|
|
allowedControlTypes,
|
|
getViewType,
|
|
} from "components/formControls/utils";
|
|
import formControlTypes from "utils/formControl/formControlTypes";
|
|
import { getAllBindingPathsForGraphqlPagination } from "utils/editor/EditorBindingPaths";
|
|
import EditorControlTypes from "utils/editor/EditorControlTypes";
|
|
|
|
const dynamicFields = [
|
|
formControlTypes.QUERY_DYNAMIC_TEXT,
|
|
formControlTypes.QUERY_DYNAMIC_INPUT_TEXT,
|
|
];
|
|
|
|
type ReactivePaths = Record<string, EvaluationSubstitutionType>;
|
|
type BindingPaths = ReactivePaths;
|
|
const getCorrectEvaluationSubstitutionType = (substitutionType?: string) => {
|
|
if (substitutionType) {
|
|
if (substitutionType === EvaluationSubstitutionType.SMART_SUBSTITUTE) {
|
|
return EvaluationSubstitutionType.SMART_SUBSTITUTE;
|
|
} else if (substitutionType === EvaluationSubstitutionType.PARAMETER) {
|
|
return EvaluationSubstitutionType.PARAMETER;
|
|
}
|
|
}
|
|
return EvaluationSubstitutionType.TEMPLATE;
|
|
};
|
|
|
|
export const getBindingAndReactivePathsOfAction = (
|
|
action: Action,
|
|
formConfig?: any[],
|
|
): { reactivePaths: ReactivePaths; bindingPaths: BindingPaths } => {
|
|
let reactivePaths: ReactivePaths = {
|
|
data: EvaluationSubstitutionType.TEMPLATE,
|
|
isLoading: EvaluationSubstitutionType.TEMPLATE,
|
|
datasourceUrl: EvaluationSubstitutionType.TEMPLATE,
|
|
};
|
|
const bindingPaths: BindingPaths = {};
|
|
if (!formConfig) {
|
|
reactivePaths = {
|
|
...reactivePaths,
|
|
config: EvaluationSubstitutionType.TEMPLATE,
|
|
};
|
|
return {
|
|
reactivePaths,
|
|
bindingPaths,
|
|
};
|
|
}
|
|
// NOTE:
|
|
// there's a difference in how the bindingPaths should look when in component and json viewType mode.
|
|
// for example in json mode, sorting component bindingPath should be formData.sortBy.data.(column | order)
|
|
// in component mode, the sorting component binding path should be more specific e.g. formData.sortBy.data[0].(column | order)
|
|
// the condition below checks if the viewType of the config and computes the binding path respectively
|
|
const recursiveFindBindingPaths = (formConfig: any) => {
|
|
if (formConfig.children) {
|
|
formConfig.children.forEach(recursiveFindBindingPaths);
|
|
} else {
|
|
const configPath = getDataTreeActionConfigPath(formConfig.configProperty);
|
|
if (dynamicFields.includes(formConfig.controlType)) {
|
|
if (!isHidden(action, formConfig.hidden)) {
|
|
bindingPaths[configPath] = getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
}
|
|
} else if (
|
|
// this else if checks the viewType and computes the binding path respectively(as explained above),
|
|
// while the other else-ifs below checks specifically for component viewType mode.
|
|
"alternateViewTypes" in formConfig &&
|
|
Array.isArray(formConfig.alternateViewTypes) &&
|
|
formConfig.alternateViewTypes.length > 0 &&
|
|
formConfig.alternateViewTypes.includes(ViewTypes.JSON) &&
|
|
getViewType(action, formConfig.configProperty) === ViewTypes.JSON
|
|
) {
|
|
bindingPaths[configPath] = getCorrectEvaluationSubstitutionType(
|
|
alternateViewTypeInputConfig().evaluationSubstitutionType,
|
|
);
|
|
} else if (formConfig.controlType === formControlTypes.ARRAY_FIELD) {
|
|
let actionValue = _.get(action, formConfig.configProperty);
|
|
if (Array.isArray(actionValue)) {
|
|
actionValue = actionValue.filter((val) => val);
|
|
for (let i = 0; i < actionValue.length; i++) {
|
|
formConfig.schema.forEach((schemaField: any) => {
|
|
if (
|
|
schemaField.key in actionValue[i] &&
|
|
dynamicFields.includes(schemaField.controlType)
|
|
) {
|
|
const arrayConfigPath = `${configPath}[${i}].${schemaField.key}`;
|
|
bindingPaths[arrayConfigPath] =
|
|
getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
} else if (formConfig.controlType === formControlTypes.WHERE_CLAUSE) {
|
|
const recursiveFindBindingPathsForWhereClause = (
|
|
newConfigPath: string,
|
|
actionValue: any,
|
|
) => {
|
|
if (
|
|
actionValue &&
|
|
actionValue.hasOwnProperty("children") &&
|
|
Array.isArray(actionValue.children)
|
|
) {
|
|
actionValue.children.forEach((value: any, index: number) => {
|
|
const childrenPath = getBindingOrConfigPathsForWhereClauseControl(
|
|
newConfigPath,
|
|
WhereClauseSubComponent.Children,
|
|
index,
|
|
);
|
|
recursiveFindBindingPathsForWhereClause(childrenPath, value);
|
|
});
|
|
} else {
|
|
if (actionValue.hasOwnProperty("key")) {
|
|
const keyPath = getBindingOrConfigPathsForWhereClauseControl(
|
|
newConfigPath,
|
|
WhereClauseSubComponent.Key,
|
|
undefined,
|
|
);
|
|
bindingPaths[keyPath] = getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
}
|
|
if (actionValue.hasOwnProperty("value")) {
|
|
const valuePath = getBindingOrConfigPathsForWhereClauseControl(
|
|
newConfigPath,
|
|
WhereClauseSubComponent.Value,
|
|
undefined,
|
|
);
|
|
bindingPaths[valuePath] = getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
}
|
|
}
|
|
};
|
|
|
|
const actionValue = _.get(action, formConfig.configProperty);
|
|
if (
|
|
actionValue &&
|
|
actionValue.hasOwnProperty("children") &&
|
|
Array.isArray(actionValue.children)
|
|
) {
|
|
actionValue.children.forEach((value: any, index: number) => {
|
|
const childrenPath = getBindingOrConfigPathsForWhereClauseControl(
|
|
configPath,
|
|
WhereClauseSubComponent.Children,
|
|
index,
|
|
);
|
|
recursiveFindBindingPathsForWhereClause(childrenPath, value);
|
|
});
|
|
}
|
|
} else if (formConfig.controlType === formControlTypes.PAGINATION) {
|
|
const limitPath = getBindingOrConfigPathsForPaginationControl(
|
|
PaginationSubComponent.Offset,
|
|
configPath,
|
|
);
|
|
const offsetPath = getBindingOrConfigPathsForPaginationControl(
|
|
PaginationSubComponent.Limit,
|
|
configPath,
|
|
);
|
|
bindingPaths[limitPath] = getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
bindingPaths[offsetPath] = getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
} else if (formConfig.controlType === formControlTypes.SORTING) {
|
|
const actionValue = _.get(action, formConfig.configProperty);
|
|
if (Array.isArray(actionValue)) {
|
|
actionValue.forEach((fieldConfig: any, index: number) => {
|
|
const columnPath = getBindingOrConfigPathsForSortingControl(
|
|
SortingSubComponent.Column,
|
|
configPath,
|
|
index,
|
|
);
|
|
bindingPaths[columnPath] = getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
const OrderPath = getBindingOrConfigPathsForSortingControl(
|
|
SortingSubComponent.Order,
|
|
configPath,
|
|
index,
|
|
);
|
|
bindingPaths[OrderPath] = getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
});
|
|
}
|
|
} else if (formConfig.controlType === formControlTypes.ENTITY_SELECTOR) {
|
|
if (Array.isArray(formConfig.schema)) {
|
|
formConfig.schema.forEach((schemaField: any) => {
|
|
let columnPath = "";
|
|
if (
|
|
allowedControlTypes.includes(schemaField.controlType) &&
|
|
!!schemaField.configProperty
|
|
) {
|
|
columnPath = getBindingOrConfigPathsForEntitySelectorControl(
|
|
schemaField.configProperty,
|
|
);
|
|
}
|
|
bindingPaths[columnPath] = getCorrectEvaluationSubstitutionType(
|
|
formConfig.evaluationSubstitutionType,
|
|
);
|
|
});
|
|
}
|
|
} else if (
|
|
formConfig.controlType === EditorControlTypes.E_GRAPHQL_PAGINATION
|
|
) {
|
|
const allPaths = getAllBindingPathsForGraphqlPagination(configPath);
|
|
allPaths.forEach(({ key, value }) => {
|
|
if (key && value) {
|
|
bindingPaths[key] = value as EvaluationSubstitutionType;
|
|
}
|
|
});
|
|
}
|
|
}
|
|
};
|
|
formConfig.forEach(recursiveFindBindingPaths);
|
|
reactivePaths = {
|
|
...reactivePaths,
|
|
...bindingPaths,
|
|
};
|
|
return { reactivePaths, bindingPaths };
|
|
};
|
|
|
|
export const getBindingOrConfigPathsForSortingControl = (
|
|
fieldName: SortingSubComponent.Order | SortingSubComponent.Column,
|
|
baseConfigProperty: string,
|
|
index?: number,
|
|
): string => {
|
|
if (_.isNumber(index)) {
|
|
return `${baseConfigProperty}[${index}].${fieldName}`;
|
|
} else {
|
|
return `${baseConfigProperty}.${fieldName}`;
|
|
}
|
|
};
|
|
|
|
export const getBindingOrConfigPathsForPaginationControl = (
|
|
fieldName: PaginationSubComponent.Limit | PaginationSubComponent.Offset,
|
|
baseConfigProperty: string,
|
|
): string => {
|
|
return `${baseConfigProperty}.${fieldName}`;
|
|
};
|
|
|
|
export const getBindingOrConfigPathsForWhereClauseControl = (
|
|
configPath: string,
|
|
fieldName:
|
|
| WhereClauseSubComponent.Children
|
|
| WhereClauseSubComponent.Condition
|
|
| WhereClauseSubComponent.Key
|
|
| WhereClauseSubComponent.Value,
|
|
index?: number,
|
|
): string => {
|
|
if (fieldName === "children" && _.isNumber(index)) {
|
|
return `${configPath}.${fieldName}[${index}]`;
|
|
} else if (configPath && fieldName) {
|
|
return `${configPath}.${fieldName}`;
|
|
}
|
|
return "";
|
|
};
|
|
|
|
export const getBindingOrConfigPathsForEntitySelectorControl = (
|
|
baseConfigProperty: string,
|
|
): string => {
|
|
// Entity selector schemas/components have their own distinct configProperties and have little to do with their parents(They are independent entities).
|
|
return getDataTreeActionConfigPath(baseConfigProperty);
|
|
};
|
|
|
|
export const getDataTreeActionConfigPath = (propertyPath: string) =>
|
|
propertyPath.replace("actionConfiguration.", "config.");
|