Add more extensive types.

.gitignore

@@ -12,3 +12,4 @@ test/cypress/reports
 .vscode
 .aider*
 src/**/*.js
+src/**/*.d.ts

src/CtrError.ts

@@ -1,7 +1,5 @@
 export default class CtrError extends Error {
-
   constructor(message: any) {
     super(`cypress-terminal-report: ${message}`);
   }
-
 }

src/collector/LogCollectBaseControl.ts

@@ -1,9 +1,13 @@
 import CtrError from '../CtrError';
+import {ExtendedSupportOptions} from "../installLogsCollector.types";
+import LogCollectorState from "./LogCollectorState";
+import {TestData} from "../types";
 
-export default class LogCollectBaseControl {
-  collectorState: any;
-  config: any;
-  prepareLogs(logStackIndex: any, testData: any) {
+export default abstract class LogCollectBaseControl {
+  protected abstract collectorState: LogCollectorState;
+  protected abstract config: ExtendedSupportOptions;
+
+  prepareLogs(logStackIndex: number, testData: TestData) {
     let logsCopy = this.collectorState.consumeLogStacks(logStackIndex);
 
     if (logsCopy === null) {

src/collector/LogCollectBrowserConsole.ts

@@ -1,14 +1,11 @@
 import CONSTANTS from '../constants';
 import utils from '../utils';
+import LogCollectorState from "./LogCollectorState";
+import {ExtendedSupportOptions} from "../installLogsCollector.types";
+import {Severity} from "../types";
 
 export default class LogCollectBrowserConsole {
-  collectorState: any;
-  config: any;
-
-  constructor(collectorState: any, config: any) {
-    this.config = config;
-    this.collectorState = collectorState;
-  }
+  constructor(protected collectorState: LogCollectorState, protected config: ExtendedSupportOptions) {}
 
   register() {
     const oldConsoleMethods = {};
@@ -17,16 +14,15 @@ export default class LogCollectBrowserConsole {
       : 'window:before:load';
 
     Cypress.on(event, () => {
-      const docIframe = window.parent.document.querySelector("[id*='Your project: ']") ||
-        window.parent.document.querySelector("[id*='Your App']");
-      // @ts-expect-error TS(2531): Object is possibly 'null'.
-      const appWindow = docIframe.contentWindow;
+      const docIframe = (window.parent.document.querySelector("[id*='Your project: ']") ||
+        window.parent.document.querySelector("[id*='Your App']")) as HTMLIFrameElement;
+      const appWindow = docIframe.contentWindow as Window & typeof globalThis;
 
       // In case of component tests the even will be called multiple times. Prevent registering multiple times.
-      if (appWindow._ctr_registered) {
+      if (!appWindow || (appWindow as any)._ctr_registered) {
         return;
       }
-      appWindow._ctr_registered = true;
+      (appWindow as any)._ctr_registered = true;
 
       const processArg = (arg: any) => {
         if (['string', 'number', 'undefined', 'function'].includes(typeof arg)) {
@@ -47,7 +43,11 @@ export default class LogCollectBrowserConsole {
         return utils.jsonStringify(arg);
       };
 
-      const createWrapper = (method: any, logType: any, type = CONSTANTS.SEVERITY.SUCCESS) => {
+      const createWrapper = (
+        method: 'warn' | 'error' | 'debug' | 'info' | 'log',
+        logType: any,
+        type: Severity = CONSTANTS.SEVERITY.SUCCESS
+      ) => {
         // @ts-expect-error TS(7053): Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
         oldConsoleMethods[method] = appWindow.console[method];
 

src/collector/LogCollectCypressCommand.ts

@@ -1,14 +1,11 @@
 import CONSTANTS from '../constants';
 import utils from '../utils';
+import LogFormat from "./LogFormat";
+import LogCollectorState from "./LogCollectorState";
+import {ExtendedSupportOptions} from "../installLogsCollector.types";
 
 export default class LogCollectCypressCommand {
-  collectorState: any;
-  config: any;
-
-  constructor(collectorState: any, config: any) {
-    this.config = config;
-    this.collectorState = collectorState;
-  }
+  constructor(protected collectorState: LogCollectorState, protected config: ExtendedSupportOptions) {}
 
   register() {
     const isOfInterest = (options: any) => options.instrument === 'command' &&
@@ -27,15 +24,15 @@ export default class LogCollectCypressCommand {
       return message;
     };
 
-    Cypress.on('log:added', (options: any) => {
+    Cypress.on('log:added', (options) => {
       if (isOfInterest(options)) {
         const log = formatLogMessage(options);
-        const severity = options.state === 'failed' ? CONSTANTS.SEVERITY.ERROR : '';
+        const severity = options.state === 'failed' ? CONSTANTS.SEVERITY.ERROR : CONSTANTS.SEVERITY.SUCCESS;
         this.collectorState.addLog([CONSTANTS.LOG_TYPES.CYPRESS_COMMAND, log, severity], options.id);
       }
     });
 
-    Cypress.on('log:changed', (options: any) => {
+    Cypress.on('log:changed', (options) => {
       if (isOfInterest(options)) {
         const log = formatLogMessage(options);
         const severity = options.state === 'failed' ? CONSTANTS.SEVERITY.ERROR : CONSTANTS.SEVERITY.SUCCESS;

src/collector/LogCollectCypressFetch.ts

@@ -1,15 +1,12 @@
 import CONSTANTS from '../constants';
 import LogFormat from "./LogFormat";
+import LogCollectorState from "./LogCollectorState";
+import {ExtendedSupportOptions} from "../installLogsCollector.types";
 
 export default class LogCollectCypressFetch {
-  collectorState: any;
-  config: any;
-  format: any;
-
-  constructor(collectorState: any, config: any) {
-    this.config = config;
-    this.collectorState = collectorState;
+  format: LogFormat;
 
+  constructor(protected collectorState: LogCollectorState, protected config: ExtendedSupportOptions) {
     this.format = new LogFormat(config);
   }
 
@@ -21,17 +18,17 @@ export default class LogCollectCypressFetch {
       (consoleProps(options)["Request went to origin?"] !== 'yes' ? 'STUBBED ' : '') +
       consoleProps(options).Method + ' ' + consoleProps(options).URL;
 
-    const formatDuration = (durationInMs: any) => durationInMs < 1000 ? `${durationInMs} ms` : `${durationInMs / 1000} s`;
+    const formatDuration = (durationInMs: number) => durationInMs < 1000 ? `${durationInMs} ms` : `${durationInMs / 1000} s`;
 
-    Cypress.on('log:added', (options: any) => {
+    Cypress.on('log:added', (options) => {
       if (options.instrument === 'command' && options.name === 'request' && options.displayName === 'fetch') {
         const log = formatFetch(options);
-        const severity = options.state === 'failed' ? CONSTANTS.SEVERITY.WARNING : '';
+        const severity = options.state === 'failed' ? CONSTANTS.SEVERITY.WARNING : CONSTANTS.SEVERITY.SUCCESS;
         this.collectorState.addLog([CONSTANTS.LOG_TYPES.CYPRESS_FETCH, log, severity], options.id);
       }
     });
 
-    Cypress.on('log:changed', async (options: any) => {
+    Cypress.on('log:changed', async (options) => {
       if (
         options.instrument === 'command' && options.name === 'request' && options.displayName === 'fetch' &&
         options.state !== 'pending'

src/collector/LogCollectCypressIntercept.ts

@@ -1,24 +1,21 @@
 import CONSTANTS from '../constants';
 import LogFormat from "./LogFormat";
+import LogCollectorState from "./LogCollectorState";
+import {ExtendedSupportOptions} from "../installLogsCollector.types";
 
 Object.defineProperty(RegExp.prototype, "toJSON", {
   value: RegExp.prototype.toString
 });
 
 export default class LogCollectCypressIntercept {
-  collectorState: any;
-  config: any;
-  format: any;
-
-  constructor(collectorState: any, config: any) {
-    this.config = config;
-    this.collectorState = collectorState;
+  format: LogFormat;
 
+  constructor(protected collectorState: LogCollectorState, protected config: ExtendedSupportOptions) {
     this.format = new LogFormat(config);
   }
 
   register() {
-    Cypress.Commands.overwrite('intercept', (originalFn: any, ...args: any[]) => {
+    Cypress.Commands.overwrite('intercept', (originalFn, ...args) => {
       let message = '';
 
       if (typeof args[0] === "string" && CONSTANTS.HTTP_METHODS.includes(args[0].toUpperCase())) {

src/collector/LogCollectCypressLog.ts

@@ -1,17 +1,13 @@
 import CONSTANTS from '../constants';
+import LogCollectorState from "./LogCollectorState";
+import {ExtendedSupportOptions} from "../installLogsCollector.types";
 
 export default class LogCollectCypressLog {
-  collectorState: any;
-  config: any;
-
-  constructor(collectorState: any, config: any) {
-    this.config = config;
-    this.collectorState = collectorState;
-  }
+  constructor(protected collectorState: LogCollectorState, protected config: ExtendedSupportOptions) {}
 
   register() {
-    Cypress.Commands.overwrite('log', (subject: any, ...args: any[]) => {
-      this.collectorState.addLog([CONSTANTS.LOG_TYPES.CYPRESS_LOG, args.join(' ')]);
+    Cypress.Commands.overwrite('log', (subject, ...args) => {
+      this.collectorState.addLog([CONSTANTS.LOG_TYPES.CYPRESS_LOG, args.join(' '), CONSTANTS.SEVERITY.SUCCESS]);
       subject(...args);
     });
   }

src/collector/LogCollectCypressRequest.ts

@@ -1,26 +1,23 @@
 import CONSTANTS from '../constants';
 import LogFormat from "./LogFormat";
+import LogCollectorState from "./LogCollectorState";
+import {ExtendedSupportOptions} from "../installLogsCollector.types";
 
 export default class LogCollectCypressRequest {
-  collectorState: any;
-  config: any;
-  format: any;
-
-  constructor(collectorState: any, config: any) {
-    this.config = config;
-    this.collectorState = collectorState;
+  format: LogFormat;
 
+  constructor(protected collectorState: LogCollectorState, protected config: ExtendedSupportOptions) {
     this.format = new LogFormat(config);
   }
 
   register() {
-    const isValidHttpMethod = (str: any) => typeof str === 'string' && CONSTANTS.HTTP_METHODS.some((s: any) => str.toUpperCase().includes(s));
+    const isValidHttpMethod = (str: any) => typeof str === 'string' && CONSTANTS.HTTP_METHODS.some((s) => str.toUpperCase().includes(s));
 
     const isNetworkError = (e: any) => e.message && e.message.startsWith('`cy.request()` failed trying to load:');
 
     const isStatusCodeFailure = (e: any) => e.message && e.message.startsWith('`cy.request()` failed on:');
 
-    const parseRequestStatusCodeFailureMessage = (message: any) => {
+    const parseRequestStatusCodeFailureMessage = (message: string) => {
       const responseStart = '\n\nThe response we got was:\n\n';
       const statusStart = 'Status: ';
       const headersStart = '\nHeaders: ';
@@ -46,7 +43,7 @@ export default class LogCollectCypressRequest {
       return {status: statusStr, headers: headersStr, body: bodyStr.trimEnd()};
     };
 
-    const parseRequestNetworkError = (message: any) => {
+    const parseRequestNetworkError = (message: string) => {
       const errorPartStart = 'We received this error at the network level:\n\n  > ';
       const errorPrefix = 'Error: ';
       if (message.indexOf(errorPartStart) === -1) {
@@ -138,7 +135,7 @@ export default class LogCollectCypressRequest {
                       },
                     });
 
-                  this.collectorState.addLog([CONSTANTS.LOG_TYPES.CYPRESS_REQUEST, log]);
+                  this.collectorState.addLog([CONSTANTS.LOG_TYPES.CYPRESS_REQUEST, log, CONSTANTS.SEVERITY.SUCCESS]);
                   return response;
                 });
             });

src/collector/LogCollectCypressXhr.ts

@@ -1,15 +1,12 @@
 import CONSTANTS from '../constants';
 import LogFormat from "./LogFormat";
+import LogCollectorState from "./LogCollectorState";
+import {ExtendedSupportOptions} from "../installLogsCollector.types";
 
 export default class LogCollectCypressXhr {
-  collectorState: any;
-  config: any;
-  format: any;
-
-  constructor(collectorState: any, config: any) {
-    this.config = config;
-    this.collectorState = collectorState;
+  format: LogFormat;
 
+  constructor(protected collectorState: LogCollectorState, protected config: ExtendedSupportOptions) {
     this.format = new LogFormat(config);
   }
 
@@ -22,19 +19,19 @@ export default class LogCollectCypressXhr {
 
     const formatDuration = (durationInMs: any) => durationInMs < 1000 ? `${durationInMs} ms` : `${durationInMs / 1000} s`;
 
-    Cypress.on('log:added', (options: any) => {
+    Cypress.on('log:added', (options) => {
       if (
         options.instrument === 'command' &&
         consoleProps(options) &&
         options.displayName === 'xhr'
       ) {
         const log = formatXhr(options);
-        const severity = options.state === 'failed' ? CONSTANTS.SEVERITY.WARNING : '';
+        const severity = options.state === 'failed' ? CONSTANTS.SEVERITY.WARNING : CONSTANTS.SEVERITY.SUCCESS;
         this.collectorState.addLog([CONSTANTS.LOG_TYPES.CYPRESS_XHR, log, severity], options.id);
       }
     });
 
-    Cypress.on('log:changed', async (options: any) => {
+    Cypress.on('log:changed', async (options) => {
       if (
         options.instrument === 'command' &&
         ['request', 'xhr'].includes(options.name) &&