PromucFlow_constructor/app/client/src/workers/Evaluation/functionDeterminer.ts
Rishabh Rathod 6b751d914e
fix: improve error message and performance in JS functions (#19137)
## Description


- Added logic to replace async function undefined error with
"{{actionName}} cannot be used in this field".
- This change improves performance for 
  - ParseJSActions
  - Triggers execution
  - Each Appsmith framework action execution.
- This change adds all platform functions to evalContext permanently.

Fixes #12179
Fixes #13273

Internal discussion for error message :-
https://theappsmith.slack.com/archives/C02K0SZQ7V3/p1667457021297869?thread_ts=1667385039.225229&cid=C02K0SZQ7V3

## Type of change

- Bug fix (non-breaking change which fixes an issue)
- Performance improvement


## How Has This Been Tested?

- Manual
- Jest
- Cypress

### Test Plan

- [ ] https://github.com/appsmithorg/TestSmith/issues/2086

### 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:
- [ ] 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: Aishwarya UR <aishwarya@appsmith.com>
2022-12-23 15:34:39 +05:30

73 lines
2.2 KiB
TypeScript

import { addDataTreeToContext } from "@appsmith/workers/Evaluation/Actions";
import { EvalContext, assignJSFunctionsToContext } from "./evaluate";
import { DataTree } from "entities/DataTree/dataTreeFactory";
class FunctionDeterminer {
private evalContext: EvalContext = {};
setupEval(dataTree: DataTree, resolvedFunctions: Record<string, any>) {
/**** Setting the eval context ****/
const evalContext: EvalContext = {
ALLOW_ASYNC: false,
IS_ASYNC: false,
};
addDataTreeToContext({
dataTree,
EVAL_CONTEXT: evalContext,
isTriggerBased: true,
});
assignJSFunctionsToContext(evalContext, resolvedFunctions);
// Set it to self so that the eval function can have access to it
// as global data. This is what enables access all appsmith
// entity properties from the global context
Object.assign(self, evalContext);
this.evalContext = evalContext;
}
setOffEval() {
for (const entityName in this.evalContext) {
if (this.evalContext.hasOwnProperty(entityName)) {
// @ts-expect-error: Types are not available
delete self[entityName];
}
}
}
isFunctionAsync(userFunction: unknown, logs: unknown[] = []) {
self.TRIGGER_COLLECTOR = [];
self.IS_ASYNC = false;
return (function() {
try {
if (typeof userFunction === "function") {
if (userFunction.constructor.name === "AsyncFunction") {
// functions declared with an async keyword
self.IS_ASYNC = true;
} else {
const returnValue = userFunction();
if (!!returnValue && returnValue instanceof Promise) {
self.IS_ASYNC = true;
}
if (self.TRIGGER_COLLECTOR.length) {
self.IS_ASYNC = true;
}
}
}
} catch (e) {
// We do not want to throw errors for internal operations, to users.
// logLevel should help us in debugging this.
logs.push({ error: "Error when determining async function" + e });
}
const isAsync = !!self.IS_ASYNC;
return isAsync;
})();
}
}
export const functionDeterminer = new FunctionDeterminer();