424d2f6965
## 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>
410 lines
12 KiB
TypeScript
410 lines
12 KiB
TypeScript
import { PluginType } from "entities/Action";
|
|
import { generateDataTreeJSAction } from "entities/DataTree/dataTreeJSAction";
|
|
import type { JSCollectionData } from "reducers/entityReducers/jsActionsReducer";
|
|
|
|
describe("generateDataTreeJSAction", () => {
|
|
it("generate js collection in data tree", () => {
|
|
const jsCollection: JSCollectionData = {
|
|
isLoading: false,
|
|
config: {
|
|
id: "1234",
|
|
applicationId: "app123",
|
|
workspaceId: "workspace123",
|
|
name: "JSObject2",
|
|
pageId: "page123",
|
|
pluginId: "plugin123",
|
|
pluginType: PluginType.JS,
|
|
actionIds: [],
|
|
archivedActionIds: [],
|
|
actions: [
|
|
{
|
|
id: "abcd",
|
|
applicationId: "app123",
|
|
workspaceId: "workspace123",
|
|
pluginType: PluginType.JS,
|
|
pluginId: "plugin123",
|
|
name: "myFun2",
|
|
fullyQualifiedName: "JSObject2.myFun2",
|
|
datasource: {
|
|
userPermissions: [],
|
|
name: "UNUSED_DATASOURCE",
|
|
pluginId: "plugin123",
|
|
workspaceId: "workspace123",
|
|
messages: [],
|
|
isValid: true,
|
|
new: true,
|
|
},
|
|
pageId: "page123",
|
|
collectionId: "1234",
|
|
actionConfiguration: {
|
|
timeoutInMillisecond: 10000,
|
|
// @ts-expect-error: paginationType does not exists on JSAction
|
|
paginationType: "NONE",
|
|
encodeParamsToggle: true,
|
|
body: "async () => {\n\t\t//use async-await or promises\n\t}",
|
|
jsArguments: [],
|
|
isAsync: true,
|
|
},
|
|
executeOnLoad: false,
|
|
dynamicBindingPathList: [
|
|
{
|
|
key: "body",
|
|
},
|
|
],
|
|
isValid: true,
|
|
invalids: [],
|
|
messages: [],
|
|
jsonPathKeys: [
|
|
"async () => {\n\t\t//use async-await or promises\n\t}",
|
|
],
|
|
confirmBeforeExecute: false,
|
|
userPermissions: [
|
|
"read:actions",
|
|
"execute:actions",
|
|
"manage:actions",
|
|
],
|
|
validName: "JSObject2.myFun2",
|
|
},
|
|
{
|
|
id: "623973054d9aea1b062af87b",
|
|
applicationId: "app123",
|
|
workspaceId: "workspace123",
|
|
pluginType: "JS",
|
|
pluginId: "plugin123",
|
|
name: "myFun1",
|
|
fullyQualifiedName: "JSObject2.myFun1",
|
|
datasource: {
|
|
userPermissions: [],
|
|
name: "UNUSED_DATASOURCE",
|
|
pluginId: "plugin123",
|
|
workspaceId: "workspace123",
|
|
messages: [],
|
|
isValid: true,
|
|
new: true,
|
|
},
|
|
pageId: "page123",
|
|
collectionId: "1234",
|
|
actionConfiguration: {
|
|
timeoutInMillisecond: 10000,
|
|
// @ts-expect-error: paginationType does not exists on JSAction
|
|
paginationType: "NONE",
|
|
encodeParamsToggle: true,
|
|
body: "() => {\n\t\t//write code here\n\t}",
|
|
jsArguments: [],
|
|
isAsync: false,
|
|
},
|
|
executeOnLoad: false,
|
|
clientSideExecution: true,
|
|
dynamicBindingPathList: [
|
|
{
|
|
key: "body",
|
|
},
|
|
],
|
|
isValid: true,
|
|
invalids: [],
|
|
messages: [],
|
|
jsonPathKeys: ["() => {\n\t\t//write code here\n\t}"],
|
|
confirmBeforeExecute: false,
|
|
userPermissions: [
|
|
"read:actions",
|
|
"execute:actions",
|
|
"manage:actions",
|
|
],
|
|
validName: "JSObject2.myFun1",
|
|
},
|
|
],
|
|
archivedActions: [],
|
|
body: "export default {\n\tmyVar1: [],\n\tmyVar2: {},\n\tmyFun1: () => {\n\t\t//write code here\n\t},\n\tmyFun2: async () => {\n\t\t//use async-await or promises\n\t}\n}",
|
|
variables: [
|
|
{
|
|
name: "myVar1",
|
|
value: [],
|
|
},
|
|
{
|
|
name: "myVar2",
|
|
value: {},
|
|
},
|
|
],
|
|
},
|
|
data: {
|
|
abcd: {
|
|
users: [{ id: 1, name: "John" }],
|
|
},
|
|
},
|
|
};
|
|
const expected = {
|
|
myVar1: [],
|
|
myVar2: {},
|
|
ENTITY_TYPE: "JSACTION",
|
|
body: "export default {\n\tmyVar1: [],\n\tmyVar2: {},\n\tmyFun1: () => {\n\t\t//write code here\n\t},\n\tmyFun2: async () => {\n\t\t//use async-await or promises\n\t}\n}",
|
|
|
|
myFun2: {
|
|
data: {
|
|
users: [{ id: 1, name: "John" }],
|
|
},
|
|
},
|
|
myFun1: {
|
|
data: {},
|
|
},
|
|
__config__: {
|
|
name: "JSObject2",
|
|
actionId: "1234",
|
|
pluginType: "JS",
|
|
ENTITY_TYPE: "JSACTION",
|
|
|
|
meta: {
|
|
myFun2: {
|
|
arguments: [],
|
|
isAsync: true,
|
|
confirmBeforeExecute: false,
|
|
},
|
|
myFun1: {
|
|
arguments: [],
|
|
isAsync: false,
|
|
confirmBeforeExecute: false,
|
|
},
|
|
},
|
|
bindingPaths: {
|
|
body: "SMART_SUBSTITUTE",
|
|
myFun2: "SMART_SUBSTITUTE",
|
|
myFun1: "SMART_SUBSTITUTE",
|
|
myVar1: "SMART_SUBSTITUTE",
|
|
myVar2: "SMART_SUBSTITUTE",
|
|
},
|
|
dynamicBindingPathList: [
|
|
{
|
|
key: "body",
|
|
},
|
|
{
|
|
key: "myVar1",
|
|
},
|
|
{
|
|
key: "myVar2",
|
|
},
|
|
{
|
|
key: "myFun2",
|
|
},
|
|
{
|
|
key: "myFun1",
|
|
},
|
|
],
|
|
variables: ["myVar1", "myVar2"],
|
|
dependencyMap: {
|
|
body: ["myFun2", "myFun1"],
|
|
},
|
|
reactivePaths: {
|
|
body: "SMART_SUBSTITUTE",
|
|
myFun1: "SMART_SUBSTITUTE",
|
|
myFun2: "SMART_SUBSTITUTE",
|
|
myVar1: "SMART_SUBSTITUTE",
|
|
myVar2: "SMART_SUBSTITUTE",
|
|
},
|
|
},
|
|
};
|
|
const result = generateDataTreeJSAction(jsCollection);
|
|
expect(result).toStrictEqual(expected);
|
|
});
|
|
it("replaces 'this' in body with js object name", () => {
|
|
const jsCollection: JSCollectionData = {
|
|
isLoading: false,
|
|
config: {
|
|
id: "1234",
|
|
applicationId: "app123",
|
|
workspaceId: "workspace123",
|
|
name: "JSObject2",
|
|
pageId: "page123",
|
|
pluginId: "plugin123",
|
|
pluginType: PluginType.JS,
|
|
actionIds: [],
|
|
archivedActionIds: [],
|
|
actions: [
|
|
{
|
|
id: "abcd",
|
|
applicationId: "app123",
|
|
workspaceId: "workspace123",
|
|
pluginType: PluginType.JS,
|
|
pluginId: "plugin123",
|
|
name: "myFun2",
|
|
fullyQualifiedName: "JSObject2.myFun2",
|
|
datasource: {
|
|
userPermissions: [],
|
|
name: "UNUSED_DATASOURCE",
|
|
pluginId: "plugin123",
|
|
workspaceId: "workspace123",
|
|
messages: [],
|
|
isValid: true,
|
|
new: true,
|
|
},
|
|
pageId: "page123",
|
|
collectionId: "1234",
|
|
actionConfiguration: {
|
|
timeoutInMillisecond: 10000,
|
|
// @ts-expect-error: paginationType does not exists on JSAction
|
|
paginationType: "NONE",
|
|
encodeParamsToggle: true,
|
|
body: "async () => {\n\t\t//use async-await or promises\n\t}",
|
|
jsArguments: [],
|
|
isAsync: true,
|
|
},
|
|
executeOnLoad: false,
|
|
dynamicBindingPathList: [
|
|
{
|
|
key: "body",
|
|
},
|
|
],
|
|
isValid: true,
|
|
invalids: [],
|
|
messages: [],
|
|
jsonPathKeys: [
|
|
"async () => {\n\t\t//use async-await or promises\n\t}",
|
|
],
|
|
confirmBeforeExecute: false,
|
|
userPermissions: [
|
|
"read:actions",
|
|
"execute:actions",
|
|
"manage:actions",
|
|
],
|
|
validName: "JSObject2.myFun2",
|
|
},
|
|
{
|
|
id: "623973054d9aea1b062af87b",
|
|
applicationId: "app123",
|
|
workspaceId: "workspace123",
|
|
pluginType: "JS",
|
|
pluginId: "plugin123",
|
|
name: "myFun1",
|
|
fullyQualifiedName: "JSObject2.myFun1",
|
|
datasource: {
|
|
userPermissions: [],
|
|
name: "UNUSED_DATASOURCE",
|
|
pluginId: "plugin123",
|
|
workspaceId: "workspace123",
|
|
messages: [],
|
|
isValid: true,
|
|
new: true,
|
|
},
|
|
pageId: "page123",
|
|
collectionId: "1234",
|
|
actionConfiguration: {
|
|
timeoutInMillisecond: 10000,
|
|
// @ts-expect-error: paginationType does not exists on JSAction
|
|
paginationType: "NONE",
|
|
encodeParamsToggle: true,
|
|
body: "() => {\n\t\t//write code here\n\t}",
|
|
jsArguments: [],
|
|
isAsync: false,
|
|
},
|
|
executeOnLoad: false,
|
|
clientSideExecution: true,
|
|
dynamicBindingPathList: [
|
|
{
|
|
key: "body",
|
|
},
|
|
],
|
|
isValid: true,
|
|
invalids: [],
|
|
messages: [],
|
|
jsonPathKeys: ["() => {\n\t\t//write code here\n\t}"],
|
|
confirmBeforeExecute: false,
|
|
userPermissions: [
|
|
"read:actions",
|
|
"execute:actions",
|
|
"manage:actions",
|
|
],
|
|
validName: "JSObject2.myFun1",
|
|
},
|
|
],
|
|
archivedActions: [],
|
|
body: "export default {\n\tmyVar1: [],\n\tmyVar2: {},\n\tmyFun1: () => {\n\t\t//write code here\n\t return this.myFun2},\n\tmyFun2: async () => {\n\t\t//use async-await or promises\n\t}\n}",
|
|
variables: [
|
|
{
|
|
name: "myVar1",
|
|
value: [],
|
|
},
|
|
{
|
|
name: "myVar2",
|
|
value: {},
|
|
},
|
|
],
|
|
},
|
|
data: {
|
|
abcd: {
|
|
users: [{ id: 1, name: "John" }],
|
|
},
|
|
},
|
|
};
|
|
|
|
const expected = {
|
|
myVar1: [],
|
|
myVar2: {},
|
|
body: "export default {\n\tmyVar1: [],\n\tmyVar2: {},\n\tmyFun1: () => {\n\t\t//write code here\n\t return JSObject2.myFun2},\n\tmyFun2: async () => {\n\t\t//use async-await or promises\n\t}\n}",
|
|
ENTITY_TYPE: "JSACTION",
|
|
__config__: {
|
|
ENTITY_TYPE: "JSACTION",
|
|
meta: {
|
|
myFun2: {
|
|
arguments: [],
|
|
isAsync: true,
|
|
confirmBeforeExecute: false,
|
|
},
|
|
myFun1: {
|
|
arguments: [],
|
|
isAsync: false,
|
|
confirmBeforeExecute: false,
|
|
},
|
|
},
|
|
bindingPaths: {
|
|
body: "SMART_SUBSTITUTE",
|
|
myFun2: "SMART_SUBSTITUTE",
|
|
myFun1: "SMART_SUBSTITUTE",
|
|
myVar1: "SMART_SUBSTITUTE",
|
|
myVar2: "SMART_SUBSTITUTE",
|
|
},
|
|
dynamicBindingPathList: [
|
|
{
|
|
key: "body",
|
|
},
|
|
{
|
|
key: "myVar1",
|
|
},
|
|
{
|
|
key: "myVar2",
|
|
},
|
|
{
|
|
key: "myFun2",
|
|
},
|
|
{
|
|
key: "myFun1",
|
|
},
|
|
],
|
|
variables: ["myVar1", "myVar2"],
|
|
dependencyMap: {
|
|
body: ["myFun2", "myFun1"],
|
|
},
|
|
name: "JSObject2",
|
|
actionId: "1234",
|
|
pluginType: "JS",
|
|
reactivePaths: {
|
|
body: "SMART_SUBSTITUTE",
|
|
myFun1: "SMART_SUBSTITUTE",
|
|
myFun2: "SMART_SUBSTITUTE",
|
|
myVar1: "SMART_SUBSTITUTE",
|
|
myVar2: "SMART_SUBSTITUTE",
|
|
},
|
|
},
|
|
|
|
myFun2: {
|
|
data: {
|
|
users: [{ id: 1, name: "John" }],
|
|
},
|
|
},
|
|
myFun1: {
|
|
data: {},
|
|
},
|
|
};
|
|
|
|
const result = generateDataTreeJSAction(jsCollection);
|
|
expect(result).toStrictEqual(expected);
|
|
});
|
|
});
|