Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
76fadb4123
PromucFlow_constructor/app/client/src/utils/JSPaneUtils.test.ts
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

863 lines
20 KiB
TypeScript
Raw Blame History

import { PluginType } from "entities/Action";
import type { JSCollection } from "entities/JSCollection";
import type { ParsedBody } from "./JSPaneUtils";
import { getDifferenceInJSCollection } from "./JSPaneUtils";
const JSObject1: JSCollection = {
id: "1234",
applicationId: "app123",
workspaceId: "workspace123",
name: "JSObject2",
pageId: "page123",
pluginId: "plugin123",
pluginType: PluginType.JS,
actionIds: [],
archivedActionIds: [],
actions: [
{
id: "fun2",
applicationId: "app123",
workspaceId: "workspace123",
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,
clientSideExecution: true,
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: "fun1",
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: {},
},
],
};
const JSObject2: JSCollection = {
id: "1234",
applicationId: "app123",
workspaceId: "workspace123",
name: "JSObject2",
pageId: "page123",
pluginId: "plugin123",
pluginType: PluginType.JS,
actionIds: [],
archivedActionIds: [],
actions: [
{
id: "fun1",
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",
},
{
id: "fun2",
applicationId: "app123",
workspaceId: "workspace123",
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,
clientSideExecution: true,
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",
},
],
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: {},
},
],
};
const parsedBodyWithRenamedAction: ParsedBody = {
actions: [
{
name: "myFun11",
body: "() => {\n\t\t//write code here\n\t}",
arguments: [],
isAsync: false,
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
isAsync: true,
},
],
variables: [
{
name: "myVar1",
value: [],
},
{
name: "myVar2",
value: {},
},
],
};
const resultRenamedActions = {
newActions: [],
updateActions: [
{
id: "fun1",
applicationId: "app123",
workspaceId: "workspace123",
pluginType: "JS",
pluginId: "plugin123",
name: "myFun11",
fullyQualifiedName: "JSObject2.myFun1",
datasource: {
userPermissions: [],
name: "UNUSED_DATASOURCE",
pluginId: "plugin123",
workspaceId: "workspace123",
messages: [],
isValid: true,
new: true,
},
pageId: "page123",
collectionId: "1234",
actionConfiguration: {
timeoutInMillisecond: 10000,
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",
},
],
deletedActions: [],
nameChangedActions: [
{
id: "fun1",
collectionId: "1234",
oldName: "myFun1",
newName: "myFun11",
pageId: "page123",
},
],
changedVariables: [],
};
const parsedBodyWithDeletedAction: ParsedBody = {
actions: [
{
name: "myFun1",
body: "() => {\n\t\t//write code here\n\t}",
arguments: [],
isAsync: false,
},
],
variables: [
{
name: "myVar1",
value: [],
},
{
name: "myVar2",
value: {},
},
],
};
const resultDeletedActions = {
newActions: [],
updateActions: [],
deletedActions: [
{
id: "fun2",
applicationId: "app123",
workspaceId: "workspace123",
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,
paginationType: "NONE",
encodeParamsToggle: true,
body: "async () => {\n\t\t//use async-await or promises\n\t}",
jsArguments: [],
isAsync: true,
},
executeOnLoad: false,
clientSideExecution: true,
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",
},
],
nameChangedActions: [],
changedVariables: [],
};
const parsedBodyWithChangedVariable: ParsedBody = {
actions: [
{
name: "myFun1",
body: "() => {\n\t\t//write code here\n\t}",
arguments: [],
isAsync: false,
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
isAsync: true,
},
],
variables: [
{
name: "myVar1",
value: "app",
},
{
name: "myVar2",
value: {},
},
],
};
const resultChangedVariable = {
newActions: [],
updateActions: [],
deletedActions: [],
nameChangedActions: [],
changedVariables: [
{
name: "myVar1",
value: "app",
},
],
};
const parsedBodyWithChangeInBody: ParsedBody = {
actions: [
{
name: "myFun1",
body: "() => {\n\t\t//write code here\n\t}",
arguments: [],
isAsync: false,
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\tconsole.log('content changed')}",
arguments: [],
isAsync: true,
},
],
variables: [
{
name: "myVar1",
value: [],
},
{
name: "myVar2",
value: {},
},
],
};
const resultChangedBody = {
newActions: [],
updateActions: [
{
id: "fun2",
applicationId: "app123",
workspaceId: "workspace123",
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,
paginationType: "NONE",
encodeParamsToggle: true,
body: "async () => {\n\t\t//use async-await or promises\n\tconsole.log('content changed')}",
jsArguments: [],
isAsync: true,
},
executeOnLoad: false,
clientSideExecution: true,
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",
},
],
deletedActions: [],
nameChangedActions: [],
changedVariables: [],
};
const parsedBodyWithChangedParameters: ParsedBody = {
actions: [
{
name: "myFun1",
body: "() => {\n\t\t//write code here\n\t}",
arguments: [],
isAsync: false,
},
{
name: "myFun2",
body: "async (a,b) => {\n\t\t//use async-await or promises\n\t}",
arguments: [
{ name: "a", value: undefined },
{ name: "b", value: undefined },
],
isAsync: true,
},
],
variables: [
{
name: "myVar1",
value: [],
},
{
name: "myVar2",
value: {},
},
],
};
const resultChangedParameters = {
newActions: [],
updateActions: [
{
id: "fun2",
applicationId: "app123",
workspaceId: "workspace123",
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,
paginationType: "NONE",
encodeParamsToggle: true,
body: "async (a,b) => {\n\t\t//use async-await or promises\n\t}",
jsArguments: [
{ name: "a", value: undefined },
{ name: "b", value: undefined },
],
isAsync: true,
},
executeOnLoad: false,
clientSideExecution: true,
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",
},
],
deletedActions: [],
nameChangedActions: [],
changedVariables: [],
};
const parsedBodyWithRemovedAsync: ParsedBody = {
actions: [
{
name: "myFun1",
body: "() => {\n\t\t//write code here\n\t}",
arguments: [],
isAsync: false,
},
{
name: "myFun2",
body: "() => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
isAsync: false,
},
],
variables: [
{
name: "myVar1",
value: [],
},
{
name: "myVar2",
value: {},
},
],
};
const resultRemovedAsync = {
newActions: [],
updateActions: [
{
id: "fun2",
applicationId: "app123",
workspaceId: "workspace123",
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,
paginationType: "NONE",
encodeParamsToggle: true,
body: "() => {\n\t\t//use async-await or promises\n\t}",
jsArguments: [],
isAsync: false,
},
executeOnLoad: false,
clientSideExecution: true,
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",
},
],
deletedActions: [],
nameChangedActions: [],
changedVariables: [],
};
const parsedBodyWithAddedAsync: ParsedBody = {
actions: [
{
name: "myFun1",
body: "async () => {\n\t\t//write code here\n\t}",
arguments: [],
isAsync: true,
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
isAsync: true,
},
],
variables: [
{
name: "myVar1",
value: [],
},
{
name: "myVar2",
value: {},
},
],
};
const resultAddedAsync = {
newActions: [],
updateActions: [
{
id: "fun1",
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,
paginationType: "NONE",
encodeParamsToggle: true,
body: "async () => {\n\t\t//write code here\n\t}",
jsArguments: [],
isAsync: true,
},
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",
},
],
deletedActions: [],
nameChangedActions: [],
changedVariables: [],
};
const parsedBodyWithAddedAction: ParsedBody = {
actions: [
{
name: "myFun1",
body: "() => {\n\t\t//write code here\n\t}",
arguments: [],
isAsync: false,
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
isAsync: true,
},
{
name: "myFun3",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
isAsync: true,
},
],
variables: [
{
name: "myVar1",
value: [],
},
{
name: "myVar2",
value: {},
},
],
};
const resultAddedAction = {
newActions: [
{
name: "myFun3",
executeOnLoad: false,
pageId: "page123",
collectionId: "1234",
workspaceId: "workspace123",
actionConfiguration: {
body: "async () => {\n\t\t//use async-await or promises\n\t}",
isAsync: true,
timeoutInMillisecond: 0,
jsArguments: [],
},
},
],
updateActions: [],
deletedActions: [],
nameChangedActions: [],
changedVariables: [],
};
describe("getDifferenceInJSCollection", () => {
it("gets name changed js action", () => {
const result = getDifferenceInJSCollection(
parsedBodyWithRenamedAction,
JSObject1,
);
expect(resultRenamedActions).toStrictEqual(result);
});
it("gets deleted js action", () => {
const result = getDifferenceInJSCollection(
parsedBodyWithDeletedAction,
JSObject1,
);
expect(resultDeletedActions).toStrictEqual(result);
});
it("gets added js action ", () => {
const result = getDifferenceInJSCollection(
parsedBodyWithAddedAction,
JSObject2,
);
expect(resultAddedAction).toStrictEqual(result);
});
it("gets changed variable value in difference", () => {
const result = getDifferenceInJSCollection(
parsedBodyWithChangedVariable,
JSObject2,
);
expect(resultChangedVariable).toStrictEqual(result);
});
it("gets updated body value in difference", () => {
const result = getDifferenceInJSCollection(
parsedBodyWithChangeInBody,
JSObject2,
);
expect(resultChangedBody).toStrictEqual(result);
});
it("gets updated params value in difference", () => {
const result = getDifferenceInJSCollection(
parsedBodyWithChangedParameters,
JSObject2,
);
expect(resultChangedParameters).toStrictEqual(result);
});
it("gets removed async tag in difference", () => {
const result = getDifferenceInJSCollection(
parsedBodyWithRemovedAsync,
JSObject2,
);
expect(resultRemovedAsync).toStrictEqual(result);
});
it("gets added async tag value in difference", () => {
const result = getDifferenceInJSCollection(
parsedBodyWithAddedAsync,
JSObject2,
);
expect(resultAddedAsync).toStrictEqual(result);
});
});
Reference in New Issue View Git Blame Copy Permalink