Merge pull request #257 from Progi1984/captureErrors

`utilsPlaywright` : Improve system for capturing errors

Author: Progi1984

src/data/types/globals.ts

@@ -39,17 +39,33 @@ type GlobalBrowser = {
   sandboxArgs: Array<string>
   acceptDownloads: boolean
   config: GlobalBrowserConfig
-  interceptErrors: any
+  captureErrors: boolean
 }
 
 type GlobalPSConfig = {
   parametersFile: string
 }
 
+type GlobalBrowserErrorConsole = {
+  url: string
+  error: string
+}
+
+type GlobalBrowserErrorJs = {
+  url: string
+  error: string
+}
+
+type GlobalBrowserErrorResponse = {
+  url: string
+  requestUrl: string
+  status: string
+}
+
 type GlobalBrowserErrors = {
-  responses: Array<any>
-  js: Array<any>
-  console: Array<any>
+  responses: Array<GlobalBrowserErrorResponse>
+  js: Array<GlobalBrowserErrorJs>
+  console: Array<GlobalBrowserErrorConsole>
 }
 
 type GlobalScreenshot = {
@@ -78,6 +94,9 @@ export type {
   GlobalBrowser,
   GlobalBrowserConfig,
   GlobalPSConfig,
+  GlobalBrowserErrorConsole,
+  GlobalBrowserErrorJs,
+  GlobalBrowserErrorResponse,
   GlobalBrowserErrors,
   GlobalScreenshot,
   GlobalMaildevConfig,

src/utils/playwright.ts

@@ -1,3 +1,4 @@
+import {GlobalBrowserErrorConsole, GlobalBrowserErrorJs, GlobalBrowserErrorResponse} from '@data/types/globals';
 import {
   APIRequestContext,
   BrowserContext,
@@ -20,7 +21,7 @@ export default {
    * @param attempt {number} Number of attempts to restart browser creation if function throw error
    * @return {Promise<Browser>}
    */
-  async createBrowser(attempt = 1): Promise<Browser> {
+  async createBrowser(attempt: number = 1): Promise<Browser> {
     const browsers: Record<string, BrowserType> = {
       chromium,
       webkit,
@@ -95,8 +96,8 @@ export default {
   async newTab(context: BrowserContext): Promise<Page> {
     const page = await context.newPage();
 
-    if (global.BROWSER.interceptErrors) {
-      await this.interceptAllErrors(page);
+    if (global.BROWSER.captureErrors) {
+      await this.captureAllErrors(page);
     }
     return page;
   },
@@ -119,11 +120,63 @@ export default {
     await browser.close();
   },
 
+  /**
+   * Get last opened tab (The current active tab)
+   * @param browser {Browser} Browser given
+   * @returns {Promise<Page>}
+   */
+  async getLastOpenedTab(browser: Browser): Promise<Page | null> {
+    // Get contexts
+    const contexts = browser.contexts();
+
+    // Return null if no context found
+    if (contexts.length === 0) {
+      return null;
+    }
+
+    // Get pages from last created context
+    const tabs = contexts[contexts.length - 1].pages();
+
+    // Return null if no tabs found
+    if (tabs.length === 0) {
+      return null;
+    }
+
+    return tabs[tabs.length - 1];
+  },
+
+  /**
+   * Returns the number of tabs
+   * @param browserContext {BrowserContext} Browser given
+   * @returns {number}
+   */
+  getNumberTabs(browserContext: BrowserContext): number {
+    // Get pages from last created context
+    return browserContext.pages().length;
+  },
+
+  /**
+   * Returns if errors are captured
+   * @returns boolean
+   */
+  isErrorsCaptured(): boolean {
+    return global.BROWSER.captureErrors;
+  },
+
+  /**
+   * Define if errors are captured
+   * @param captureErrors {boolean}
+   * @returns void
+   */
+  setErrorsCaptured(captureErrors: boolean): void {
+    global.BROWSER.captureErrors = captureErrors;
+  },
+
   /**
    * Intercept response errors
    * @param page {Page} Browser tab given
    */
-  interceptResponseErrors(page: Page): void {
+  captureResponseErrors(page: Page): void {
     page.on('response', (response) => {
       const status = response.status().toString();
       const url = page.url();
@@ -139,7 +192,7 @@ export default {
    * Intercept js errors
    * @param page {Page} Browser tab given
    */
-  interceptJsErrors(page: Page): void {
+  captureJsErrors(page: Page): void {
     page.on('pageerror', (e) => {
       global.browserErrors.js.push(
         {
@@ -154,7 +207,7 @@ export default {
    * Intercept console errors
    * @param page {Page} Browser tab given
    */
-  interceptConsoleErrors(page: Page): void {
+  captureConsoleErrors(page: Page): void {
     page.on('console', (msg) => {
       if (msg.type() === 'error') {
         global.browserErrors.console.push({
@@ -169,44 +222,51 @@ export default {
    * Intercept all errors (response, js, console)
    * @param page {Page} Browser tab given
    */
-  interceptAllErrors(page: Page): void {
-    this.interceptResponseErrors(page);
-    this.interceptJsErrors(page);
-    this.interceptConsoleErrors(page);
+  captureAllErrors(page: Page): void {
+    this.captureResponseErrors(page);
+    this.captureJsErrors(page);
+    this.captureConsoleErrors(page);
   },
 
   /**
-   * Get last opened tab (The current active tab)
-   * @param browser {Browser} Browser given
-   * @returns {Promise<Page>}
+   * Returns Console captured errors
    */
-  async getLastOpenedTab(browser: Browser): Promise<Page | null> {
-    // Get contexts
-    const contexts = browser.contexts();
+  getConsoleErrors(): Array<GlobalBrowserErrorConsole> {
+    return global.browserErrors.console;
+  },
 
-    // Return null if no context found
-    if (contexts.length === 0) {
-      return null;
-    }
+  /**
+   * Returns JS captured errors
+   */
+  getJsErrors(): Array<GlobalBrowserErrorJs> {
+    return global.browserErrors.js;
+  },
 
-    // Get pages from last created context
-    const tabs = contexts[contexts.length - 1].pages();
+  /**
+   * Returns Response captured errors
+   */
+  getResponseErrors(): Array<GlobalBrowserErrorResponse> {
+    return global.browserErrors.responses;
+  },
 
-    // Return null if no tabs found
-    if (tabs.length === 0) {
-      return null;
-    }
+  /**
+   * Reset Console captured errors
+   */
+  resetConsoleErrors(): void {
+    global.browserErrors.console = [];
+  },
 
-    return tabs[tabs.length - 1];
+  /**
+   * Reset JS captured errors
+   */
+  resetJsErrors(): void {
+    global.browserErrors.js = [];
   },
 
   /**
-   * Returns the number of tabs
-   * @param browserContext {BrowserContext} Browser given
-   * @returns {number}
+   * Reset Response captured errors
    */
-  getNumberTabs(browserContext: BrowserContext): number {
-    // Get pages from last created context
-    return browserContext.pages().length;
+  resetResponseErrors(): void {
+    global.browserErrors.responses = [];
   },
 };