chore(core): lint

This commit is contained in:
karishmas6
2024-07-31 05:43:32 +05:30
parent 040c7a9ce6
commit b628aca0c6

View File

@@ -39,11 +39,11 @@ export default class Interpreter extends EventEmitter {
private options: InterpreterOptions; private options: InterpreterOptions;
private concurrency : Concurrency; private concurrency: Concurrency;
private stopper : Function | null = null; private stopper: Function | null = null;
private log : typeof log; private log: typeof log;
constructor(workflow: WorkflowFile, options?: Partial<InterpreterOptions>) { constructor(workflow: WorkflowFile, options?: Partial<InterpreterOptions>) {
super(); super();
@@ -87,7 +87,7 @@ export default class Interpreter extends EventEmitter {
* @param workflow Current **initialized** workflow (array of where-what pairs). * @param workflow Current **initialized** workflow (array of where-what pairs).
* @returns {PageState} State of the current page. * @returns {PageState} State of the current page.
*/ */
private async getState(page: Page, workflow: Workflow) : Promise<PageState> { private async getState(page: Page, workflow: Workflow): Promise<PageState> {
/** /**
* All the selectors present in the current Workflow * All the selectors present in the current Workflow
*/ */
@@ -98,7 +98,7 @@ export default class Interpreter extends EventEmitter {
* @param selector Selector to be queried * @param selector Selector to be queried
* @returns True if the targetted element is actionable, false otherwise. * @returns True if the targetted element is actionable, false otherwise.
*/ */
const actionable = async (selector: string) : Promise<boolean> => { const actionable = async (selector: string): Promise<boolean> => {
try { try {
const proms = [ const proms = [
page.isEnabled(selector, { timeout: 500 }), page.isEnabled(selector, { timeout: 500 }),
@@ -115,7 +115,7 @@ export default class Interpreter extends EventEmitter {
/** /**
* Object of selectors present in the current page. * Object of selectors present in the current page.
*/ */
const presentSelectors : SelectorArray = await Promise.all( const presentSelectors: SelectorArray = await Promise.all(
selectors.map(async (selector) => { selectors.map(async (selector) => {
if (await actionable(selector)) { if (await actionable(selector)) {
return [selector]; return [selector];
@@ -142,7 +142,7 @@ export default class Interpreter extends EventEmitter {
* @param context Current browser context. * @param context Current browser context.
* @returns True if `where` is applicable in the given context, false otherwise * @returns True if `where` is applicable in the given context, false otherwise
*/ */
private applicable(where: Where, context: PageState, usedActions : string[] = []) : boolean { private applicable(where: Where, context: PageState, usedActions: string[] = []): boolean {
/** /**
* Given two arbitrary objects, determines whether `subset` is a subset of `superset`.\ * Given two arbitrary objects, determines whether `subset` is a subset of `superset`.\
* \ * \
@@ -161,7 +161,7 @@ export default class Interpreter extends EventEmitter {
*/ */
const parsedValue = Array.isArray(value) ? arrayToObject(value) : value; const parsedValue = Array.isArray(value) ? arrayToObject(value) : value;
const parsedSuperset : Record<string, unknown> = {}; const parsedSuperset: Record<string, unknown> = {};
parsedSuperset[key] = Array.isArray(superset[key]) parsedSuperset[key] = Array.isArray(superset[key])
? arrayToObject(<any>superset[key]) ? arrayToObject(<any>superset[key])
: superset[key]; : superset[key];
@@ -234,7 +234,7 @@ export default class Interpreter extends EventEmitter {
* @param page Playwright Page object * @param page Playwright Page object
* @param steps Array of actions. * @param steps Array of actions.
*/ */
private async carryOutSteps(page: Page, steps: What[]) : Promise<void> { private async carryOutSteps(page: Page, steps: What[]): Promise<void> {
/** /**
* Defines overloaded (or added) methods/actions usable in the workflow. * Defines overloaded (or added) methods/actions usable in the workflow.
* If a method overloads any existing method of the Page class, it accepts the same set * If a method overloads any existing method of the Page class, it accepts the same set
@@ -243,15 +243,15 @@ export default class Interpreter extends EventEmitter {
* Also, following piece of code defines functions to be run in the browser's context. * Also, following piece of code defines functions to be run in the browser's context.
* Beware of false linter errors - here, we know better! * Beware of false linter errors - here, we know better!
*/ */
const wawActions : Record<CustomFunctions, (...args: any[]) => void> = { const wawActions: Record<CustomFunctions, (...args: any[]) => void> = {
screenshot: async (params: PageScreenshotOptions) => { screenshot: async (params: PageScreenshotOptions) => {
const screenshotBuffer = await page.screenshot({ const screenshotBuffer = await page.screenshot({
...params, path: undefined, ...params, path: undefined,
}); });
await this.options.binaryCallback(screenshotBuffer, 'image/png'); await this.options.binaryCallback(screenshotBuffer, 'image/png');
}, },
enqueueLinks: async (selector : string) => { enqueueLinks: async (selector: string) => {
const links : string[] = await page.locator(selector) const links: string[] = await page.locator(selector)
.evaluateAll( .evaluateAll(
// @ts-ignore // @ts-ignore
(elements) => elements.map((a) => a.href).filter((x) => x), (elements) => elements.map((a) => a.href).filter((x) => x),
@@ -277,7 +277,7 @@ export default class Interpreter extends EventEmitter {
await page.close(); await page.close();
}, },
scrape: async (selector?: string) => { scrape: async (selector?: string) => {
const scrapeResults : Record<string, string>[] = <any> await page const scrapeResults: Record<string, string>[] = <any>await page
// eslint-disable-next-line // eslint-disable-next-line
// @ts-ignore // @ts-ignore
.evaluate((s) => scrape(s ?? null), selector); .evaluate((s) => scrape(s ?? null), selector);
@@ -296,7 +296,7 @@ export default class Interpreter extends EventEmitter {
this.options.serializableCallback(scrapeResult); this.options.serializableCallback(scrapeResult);
}, },
scroll: async (pages? : number) => { scroll: async (pages?: number) => {
await page.evaluate(async (pagesInternal) => { await page.evaluate(async (pagesInternal) => {
for (let i = 1; i <= (pagesInternal ?? 1); i += 1) { for (let i = 1; i <= (pagesInternal ?? 1); i += 1) {
// @ts-ignore // @ts-ignore
@@ -304,9 +304,9 @@ export default class Interpreter extends EventEmitter {
} }
}, pages ?? 1); }, pages ?? 1);
}, },
script: async (code : string) => { script: async (code: string) => {
const AsyncFunction : FunctionConstructor = Object.getPrototypeOf( const AsyncFunction: FunctionConstructor = Object.getPrototypeOf(
async () => {}, async () => { },
).constructor; ).constructor;
const x = new AsyncFunction('page', 'log', code); const x = new AsyncFunction('page', 'log', code);
await x(page, this.log); await x(page, this.log);
@@ -328,7 +328,7 @@ export default class Interpreter extends EventEmitter {
const levels = step.action.split('.'); const levels = step.action.split('.');
const methodName = levels[levels.length - 1]; const methodName = levels[levels.length - 1];
let invokee : any = page; let invokee: any = page;
for (const level of levels.splice(0, levels.length - 1)) { for (const level of levels.splice(0, levels.length - 1)) {
invokee = invokee[level]; invokee = invokee[level];
} }
@@ -344,8 +344,8 @@ export default class Interpreter extends EventEmitter {
} }
} }
private async runLoop(p : Page, workflow: Workflow) { private async runLoop(p: Page, workflow: Workflow) {
const usedActions : string[] = []; const usedActions: string[] = [];
let lastAction = null; let lastAction = null;
let repeatCount = 0; let repeatCount = 0;
@@ -423,7 +423,7 @@ export default class Interpreter extends EventEmitter {
* @param {ParamType} params Workflow specific, set of parameters * @param {ParamType} params Workflow specific, set of parameters
* for the `{$param: nameofparam}` fields. * for the `{$param: nameofparam}` fields.
*/ */
public async run(page: Page, params? : ParamType) : Promise<void> { public async run(page: Page, params?: ParamType): Promise<void> {
if (this.stopper) { if (this.stopper) {
throw new Error('This Interpreter is already running a workflow. To run another workflow, please, spawn another Interpreter.'); throw new Error('This Interpreter is already running a workflow. To run another workflow, please, spawn another Interpreter.');
} }
@@ -448,7 +448,7 @@ export default class Interpreter extends EventEmitter {
this.stopper = null; this.stopper = null;
} }
public async stop() : Promise<void> { public async stop(): Promise<void> {
if (this.stopper) { if (this.stopper) {
await this.stopper(); await this.stopper();
this.stopper = null; this.stopper = null;