## 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
60 lines
2.0 KiB
TypeScript
60 lines
2.0 KiB
TypeScript
import unescapeJS from "unescape-js";
|
|
import { isLiteralNode, PropertyNode } from "../index";
|
|
|
|
const beginsWithLineBreakRegex = /^\s+|\s+$/;
|
|
|
|
export function sanitizeScript(js: string, evaluationVersion: number) {
|
|
// We remove any line breaks from the beginning of the script because that
|
|
// makes the final function invalid. We also unescape any escaped characters
|
|
// so that eval can happen
|
|
//default value of evalutaion version is 2
|
|
evaluationVersion = evaluationVersion ? evaluationVersion : 2;
|
|
const trimmedJS = js.replace(beginsWithLineBreakRegex, "");
|
|
return evaluationVersion > 1 ? trimmedJS : unescapeJS(trimmedJS);
|
|
}
|
|
|
|
// For the times when you need to know if something truly an object like { a: 1, b: 2}
|
|
// typeof, lodash.isObject and others will return false positives for things like array, null, etc
|
|
export const isTrueObject = (
|
|
item: unknown,
|
|
): item is Record<string, unknown> => {
|
|
return Object.prototype.toString.call(item) === "[object Object]";
|
|
};
|
|
|
|
export const getNameFromPropertyNode = (node: PropertyNode): string =>
|
|
isLiteralNode(node.key) ? String(node.key.value) : node.key.name;
|
|
|
|
type Position = {
|
|
line: number;
|
|
ch: number;
|
|
};
|
|
|
|
export const extractContentByPosition = (
|
|
content: string,
|
|
position: { from: Position; to: Position },
|
|
) => {
|
|
const eachLine = content.split("\n");
|
|
|
|
let returnedString = "";
|
|
|
|
for (let i = position.from.line; i <= position.to.line; i++) {
|
|
if (i === position.from.line) {
|
|
returnedString =
|
|
position.from.line !== position.to.line
|
|
? eachLine[position.from.line].slice(position.from.ch)
|
|
: eachLine[position.from.line].slice(
|
|
position.from.ch,
|
|
position.to.ch + 1,
|
|
);
|
|
} else if (i === position.to.line) {
|
|
returnedString += eachLine[position.to.line].slice(0, position.to.ch + 1);
|
|
} else {
|
|
returnedString += eachLine[i];
|
|
}
|
|
if (i !== position.to.line) {
|
|
returnedString += "\n";
|
|
}
|
|
}
|
|
return returnedString;
|
|
};
|