PromucFlow_constructor/app/client/src/utils/JSPaneUtils.test.ts
Favour Ohanekwu b7ca44b252
feat: Remove async/sync differentiation from Appsmith (#25399)
## Description

This PR removes the differentiation between async and sync js functions
in Appsmith

- All JS functions can run on page load 
- All JS functions can request confirmation before executing

#### PR fixes following issue(s)
Fixes #25176 
Fixes #25065
Fixes #15560
Fixes #15273 
Fixes #12639
Fixes #14229 
Fixes #13888

### Latest DP

https://ce-25399.dp.appsmith.com/

### Performance

<img width="748" alt="Screenshot 2023-08-04 at 11 05 50"
src="https://github.com/appsmithorg/appsmith/assets/46670083/580b2091-7ee7-4845-b7bf-ca76bc3e6c1f">



#### Type of change
> Please delete options that are not relevant.
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- Chore (housekeeping or task changes that don't impact user perception)
- This change requires a documentation update
>
>
>
## Testing
>
#### How Has This Been Tested?
> Please describe the tests that you ran to verify your changes. Also
list any relevant details for your test configuration.
> Delete anything that is not relevant
- [x] Manual
- [ ] Jest
- [x] Cypress
>
>
#### Test Plan
> https://github.com/appsmithorg/TestSmith/issues/2455
>
>
#### 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
- [ ] 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
- [ ] 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:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-)
have been covered
- [x] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-)
- [x] Test plan has been peer reviewed by project stakeholders and other
QA members
- [x] Manually tested functionality on DP
- [x] We had an implementation alignment call with stakeholders post QA
Round 2
- [ ] Cypress test cases have been added and approved by SDET/manual QA
- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed
- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed

---------

Co-authored-by: Nidhi <nidhi@appsmith.com>
2023-08-05 06:38:53 +01:00

837 lines
20 KiB
TypeScript

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: [],
},
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: [],
},
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: [],
},
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: [],
},
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: [],
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
},
],
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: [],
},
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: [],
},
],
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: [],
},
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: [],
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
},
],
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: [],
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\tconsole.log('content changed')}",
arguments: [],
},
],
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: [],
},
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: [],
},
{
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 },
],
},
],
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 },
],
},
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: [],
},
{
name: "myFun2",
body: "() => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
},
],
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: [],
},
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: [],
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
},
],
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: [],
},
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: [],
},
{
name: "myFun2",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
},
{
name: "myFun3",
body: "async () => {\n\t\t//use async-await or promises\n\t}",
arguments: [],
},
],
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}",
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);
});
});