## Description This PR improves the error resolution journey for users. Lint warnings are added to async JS functions which are bound to data fields (sync fields). - JSObjects are "linted" by individual properties (as opposed to being "linted" as a whole) - Only edited jsobject properties get "linted", improving jsObject linting by ~35%.(This largely depends on the size of the JSObject) <img width="500" alt="Screenshot 2023-04-03 at 11 17 45" src="https://user-images.githubusercontent.com/46670083/229482424-233f3950-ffec-46f5-8c42-680dff6a412f.png"> <img width="500" alt="Screenshot 2023-03-14 at 11 26 00" src="https://user-images.githubusercontent.com/46670083/224975572-b2d8d404-aac6-43fb-be14-20edf7c56117.png"> <img width="500" alt="Screenshot 2023-03-14 at 11 41 11" src="https://user-images.githubusercontent.com/46670083/224975952-c40848b1-69d8-489d-9b62-24127ea1a2f1.png"> Fixes #20289 Fixes #20008 ## Type of change - Bug fix (non-breaking change which fixes an issue) ## How Has This Been Tested? - CYPRESS - JEST ### 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 - [ ] 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 - [x] Test plan has been peer reviewed by QA - [x] 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
63 lines
1.8 KiB
TypeScript
63 lines
1.8 KiB
TypeScript
import { ENTITY_TYPE, Severity } from "entities/AppsmithConsole";
|
|
import LOG_TYPE from "entities/AppsmithConsole/logtype";
|
|
import type { DataTree } from "entities/DataTree/dataTreeFactory";
|
|
import { isEmpty } from "lodash";
|
|
import AppsmithConsole from "utils/AppsmithConsole";
|
|
import {
|
|
getEntityNameAndPropertyPath,
|
|
isJSAction,
|
|
} from "@appsmith/workers/Evaluation/evaluationUtils";
|
|
import type { LintErrorsStore } from "reducers/lintingReducers/lintErrorsReducers";
|
|
|
|
// We currently only log lint errors in JSObjects
|
|
export function* logLatestLintPropertyErrors({
|
|
dataTree,
|
|
errors,
|
|
}: {
|
|
errors: LintErrorsStore;
|
|
dataTree: DataTree;
|
|
}) {
|
|
const errorsToAdd = [];
|
|
const errorsToRemove = [];
|
|
|
|
for (const path of Object.keys(errors)) {
|
|
const { entityName, propertyPath } = getEntityNameAndPropertyPath(path);
|
|
const entity = dataTree[entityName];
|
|
// only log lint errors in JSObjects
|
|
if (!isJSAction(entity)) continue;
|
|
// only log lint errors (not warnings)
|
|
const lintErrorsInPath = errors[path].filter(
|
|
(error) => error.severity === Severity.ERROR,
|
|
);
|
|
const lintErrorMessagesInPath = lintErrorsInPath.map((error) => ({
|
|
type: error.errorType,
|
|
message: error.errorMessage,
|
|
lineNumber: error.line,
|
|
}));
|
|
const debuggerKey = entity.actionId + propertyPath + "-lint";
|
|
|
|
if (isEmpty(lintErrorsInPath)) {
|
|
errorsToRemove.push({ id: debuggerKey });
|
|
continue;
|
|
}
|
|
|
|
errorsToAdd.push({
|
|
payload: {
|
|
id: debuggerKey,
|
|
logType: LOG_TYPE.LINT_ERROR,
|
|
text: "LINT ERROR",
|
|
messages: lintErrorMessagesInPath,
|
|
source: {
|
|
id: entity.actionId,
|
|
name: entityName,
|
|
type: ENTITY_TYPE.JSACTION,
|
|
propertyPath,
|
|
},
|
|
},
|
|
});
|
|
}
|
|
|
|
AppsmithConsole.addErrors(errorsToAdd);
|
|
AppsmithConsole.deleteErrors(errorsToRemove);
|
|
}
|