@thinkwise/testwise 0.1.12 → 0.1.65

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@thinkwise/testwise",
-  "version": "0.1.12",
+  "version": "0.1.65",
   "main": "dist/index.js",
   "type": "module",
   "bin": {
-    "testwise": "./scripts/add-config.js",
+    "testwise": "./scripts/main.js",
     "testwise-credentials": "./promptCredentials.js"
   },
   "scripts": {
@@ -21,22 +21,38 @@
     "axios": "^1.9.0",
     "chalk": "^5.4.1",
     "csv-parse": "^5.6.0",
+    "dotenv": "^17.2.2",
     "prompts": "^2.4.2"
   },
   "peerDependencies": {
-    "@playwright/test": "^1.52.0"
+    "@playwright/test": "^1.52.0",
+    "typescript": "^5.8.3"
   },
   "devDependencies": {
-    "@biomejs/biome": "^1.9.4",
+    "@biomejs/biome": "^2.1.2",
     "@eslint/js": "^9.28.0",
     "@playwright/test": "^1.52.0",
-    "biome": "^0.3.3",
     "eslint": "^9.28.0",
     "eslint-plugin-playwright": "^2.2.0",
     "npm-run-all": "^4.1.5",
     "typescript-eslint": "^8.34.0"
   },
-  "publishConfig": {
-    "access": "public"
-  }
+  "files": [
+    "dist/",
+    "scripts/",
+    "components/",
+    "services/",
+    "controls/",
+    "helpers/",
+    "page-extensions/",
+    "page-overrides/",
+    "index.ts",
+    "Testwise.ts",
+    "types/",
+    "enums/",
+    "tsconfig.json",
+    "example-code/",
+    "interfaces/",
+    "**/config.json"
+  ]
 }

package/page-extensions/GoToDeepLink.ts

@@ -14,8 +14,24 @@ export class GoToDeepLink {
       page: async ({ page }, use) => {
         page.goToDeepLink = async (deepLink: string): Promise<null | import('@playwright/test').Response> => {
           const url = new URL(await page.url());
+          const applicationIndex = url.hash.indexOf('#application=');
 
-          return await page.goto(`${url}/${deepLink}`);
+          if (applicationIndex !== -1) {
+            const applicationValue = url.hash.substring(applicationIndex + '#application='.length).split('/')[0];
+            url.hash = `#application=${applicationValue}`;
+          }
+
+          if (deepLink.startsWith('/')) {
+            deepLink = deepLink.substring(1);
+          }
+
+          if (url.hash.endsWith('/')) {
+            url.hash += deepLink;
+          } else {
+            url.hash += `/${deepLink}`;
+          }
+
+          return await page.goto(url.toString());
         };
 
         await use(page);

package/page-extensions/LoginFeatures.ts

@@ -1,12 +1,13 @@
 import { LoginHelper } from '../helpers/LoginHelper.js';
 import type { Test } from '../types/CoreTypes.js';
-import type { UniversalLoginOptions } from '../types/universal.js';
+import type { UniversalLoginOptions } from '../types/index.js';
 
 declare module '@playwright/test' {
   interface Page {
     logIn(): Promise<void>;
     logInWithCredentials(username: string, password: string): Promise<void>;
     logInWithOptions(options: UniversalLoginOptions): Promise<void>;
+    logOut(): Promise<void>;
   }
 }
 
@@ -31,6 +32,10 @@ export class LoginFeatures {
           await this.loginHelper.logInWithOptions(options);
         };
 
+        page.logOut = async () => {
+          await this.loginHelper.logOut();
+        };
+
         await use(page);
       }
     });

package/page-extensions/WaitEventHandler.ts

@@ -0,0 +1,26 @@
+import { GlobalWaitEventHandler } from '../helpers/GlobalWaitEventHandler.js';
+import type { Test } from '../types/CoreTypes.js';
+
+declare module '@playwright/test' {
+  interface Page {
+    waitEventHandler: GlobalWaitEventHandler;
+  }
+}
+
+export class WaitEventHandler {
+  private _test: Test;
+
+  constructor(test: Test) {
+    this._test = test.extend({
+      page: async ({ page }, use) => {
+        page.waitEventHandler = new GlobalWaitEventHandler(page);
+
+        await use(page);
+      }
+    });
+  }
+
+  get test() {
+    return this._test;
+  }
+}

package/page-extensions/index.ts

@@ -0,0 +1,3 @@
+export * from './GoToDeepLink.js';
+export * from './LoginFeatures.js';
+export * from './UserSimulation.js';

package/page-overrides/ClickOverride.ts

@@ -1,48 +1,82 @@
-import { type Locator, expect } from '@playwright/test';
-import { InflightRequestsTracker } from '../helpers/InflightRequestTracker.js';
+import type { Locator } from '@playwright/test';
+import { FlightTracker } from '../helpers/FlightTracker.js';
 import { testwiseConfig } from '../services/ConfigBuilder.js';
 import type { Test } from '../types/CoreTypes.js';
 
+const waitForRequestsToComplete =
+  testwiseConfig().get<boolean>('featureSettings.InflightRequests.waitForRequestsToComplete') ?? true;
+const continueOnError = testwiseConfig().get<boolean>('featureSettings.InflightRequests.continueOnError') ?? true;
+
 export class ClickOverride {
   private _test: Test;
+  private flightTracker: FlightTracker = new FlightTracker();
 
   constructor(test: Test) {
     this._test = test.extend({
       page: async ({ page }, use) => {
-        const overrideClickMethod = (locator: Locator) => {
+        const overrideClickMethod = (locator: Locator): Locator => {
           const originalClickMethod = locator.click.bind(locator);
 
-          locator.click = async (options) => {
-            if (testwiseConfig().get<boolean>('InflightRequests.waitForRequestsToComplete') === true) {
-              const tracker = new InflightRequestsTracker(page);
+          page.on('request', (request) => {
+            if (request.resourceType() === 'xhr') {
+              this.flightTracker.requestsInFlight++;
+            }
+          });
 
-              await Promise.all([
-                originalClickMethod(options),
+          page.on('response', (response) => {
+            if (response.request().resourceType() === 'xhr') {
+              if (this.flightTracker.requestsInFlight > 0) {
+                this.flightTracker.requestsInFlight--;
+              }
 
-                // Ensure at least one XHR request is issued
-                Promise.race([
-                  page.waitForRequest((request) => request.resourceType() === 'xhr'),
-                  new Promise((resolve) => setTimeout(resolve, 50)) // Wait briefly to ensure the XHR request is in flight
-                ])
-              ]);
+              if (this.flightTracker.requestsInFlight === 0) {
+                this.flightTracker.eventEmitter.emit('idle');
+              }
+            }
+          });
 
-              // Wait for all XHR requests to finish
+          locator.click = async (options) => {
+            await originalClickMethod(options);
+            if (waitForRequestsToComplete) {
               try {
-                await expect
-                  .poll(() => tracker.inflightRequests().filter((request) => request.resourceType() === 'xhr').length, {
-                    timeout: 3000
-                  })
-                  .toBe(0);
-              } catch (e) {
-                console.warn('Exception while waiting for inflight requests to finish:', e);
-
-                if (testwiseConfig().get<boolean>('InflightRequests.swallowPollingExceptions') === false) throw e;
+                await this.flightTracker.waitToContinue();
+              } catch (error) {
+                console.warn('Exception while waiting for inflight requests to finish:', error);
+
+                if (!continueOnError) throw error;
               }
-            } else {
-              await originalClickMethod(options);
             }
           };
 
+          // Ensure chaining works by overriding methods that return new Locators
+          const originalLocatorMethod = locator.locator.bind(locator);
+          locator.locator = (...args) => overrideClickMethod(originalLocatorMethod(...args));
+
+          // Override the filter method so returned locators also have custom click logic
+          const originalFilterMethod = locator.filter?.bind(locator);
+          locator.filter = (...args) => overrideClickMethod(originalFilterMethod(...args));
+
+          const originalGetByTextMethod = locator.getByText.bind(locator);
+          locator.getByText = (...args) => overrideClickMethod(originalGetByTextMethod(...args));
+
+          const originalGetByTestIdMethod = locator.getByTestId.bind(locator);
+          locator.getByTestId = (...args) => overrideClickMethod(originalGetByTestIdMethod(...args));
+
+          const originalGetByAltTextMethod = locator.getByAltText.bind(locator);
+          locator.getByAltText = (...args) => overrideClickMethod(originalGetByAltTextMethod(...args));
+
+          const originalGetByLabelMethod = locator.getByLabel.bind(locator);
+          locator.getByLabel = (...args) => overrideClickMethod(originalGetByLabelMethod(...args));
+
+          const originalGetByRoleMethod = locator.getByRole.bind(locator);
+          locator.getByRole = (...args) => overrideClickMethod(originalGetByRoleMethod(...args));
+
+          const originalGetByPlaceholderMethod = locator.getByPlaceholder.bind(locator);
+          locator.getByPlaceholder = (...args) => overrideClickMethod(originalGetByPlaceholderMethod(...args));
+
+          const originalGetByTitleMethod = locator.getByTitle.bind(locator);
+          locator.getByTitle = (...args) => overrideClickMethod(originalGetByTitleMethod(...args));
+
           return locator;
         };
 

package/page-overrides/FillOverride.ts

@@ -0,0 +1,133 @@
+import type { Locator } from '@playwright/test';
+import { FlightTracker } from '../helpers/FlightTracker.js';
+import { testwiseConfig } from '../services/ConfigBuilder.js';
+import type { Test } from '../types/CoreTypes.js';
+
+const requestWatchlist: string[] = testwiseConfig().get<string[]>('featureSettings.InflightRequests.paths') ?? [];
+const waitForRequestsToComplete =
+  testwiseConfig().get<boolean>('featureSettings.InflightRequests.waitForRequestsToComplete') ?? true;
+
+export class FillOverride {
+  private _test: Test;
+  private flightTracker: FlightTracker = new FlightTracker();
+
+  constructor(test: Test) {
+    this._test = test.extend({
+      page: async ({ page }, use) => {
+        if (waitForRequestsToComplete) {
+          requestWatchlist.forEach((stringToMatch) => {
+            page.on('request', (request) => {
+              if (request.url().includes(stringToMatch)) {
+                this.flightTracker.requestsInFlight++;
+              }
+            });
+
+            page.on('response', (response) => {
+              if (response.url().includes(stringToMatch)) {
+                if (this.flightTracker.requestsInFlight > 0) this.flightTracker.requestsInFlight--;
+
+                if (this.flightTracker.requestsInFlight === 0) {
+                  this.flightTracker.eventEmitter.emit('idle');
+                }
+              }
+            });
+          });
+        }
+
+        const overrideFillMethod = (locator: Locator) => {
+          const originalFillMethod = locator.fill.bind(locator);
+
+          locator.fill = async (value, options) => {
+            try {
+              if (waitForRequestsToComplete) await this.flightTracker.waitToContinue();
+            } catch (e) {
+              console.warn('Exception:', e);
+              this.flightTracker.requestsInFlight = 0;
+            }
+
+            const currentValue = await locator.inputValue();
+            const valueIsDifferent = currentValue !== value;
+
+            const testIdWhitelist: string[] = ['form-field__'];
+
+            const isWhitelisted = await locator.evaluate((el, testIdWhitelist) => {
+              const elementTestId = el.getAttribute('data-testid');
+              if (elementTestId) {
+                return testIdWhitelist.some((whitelistedId) => elementTestId.includes(whitelistedId));
+              }
+              return false;
+            }, testIdWhitelist);
+
+            if (valueIsDifferent && isWhitelisted) {
+              await page.waitEventHandler.waitForCanContinue();
+              page.waitEventHandler.waitForResponse('/staged');
+            }
+
+            await originalFillMethod(value, options);
+
+            if (isWhitelisted) {
+              await locator.evaluate((el) => {
+                const ariaExpanded = el.getAttribute('aria-expanded');
+
+                if (!ariaExpanded) el.blur();
+              });
+            }
+          };
+
+          const originalLocatorMethod = locator.locator.bind(locator);
+          locator.locator = (...args) => overrideFillMethod(originalLocatorMethod(...args));
+
+          const originalGetByTextMethod = locator.getByText.bind(locator);
+          locator.getByText = (...args) => overrideFillMethod(originalGetByTextMethod(...args));
+
+          const originalGetByTestIdMethod = locator.getByTestId.bind(locator);
+          locator.getByTestId = (...args) => overrideFillMethod(originalGetByTestIdMethod(...args));
+
+          const originalGetByAltTextMethod = locator.getByAltText.bind(locator);
+          locator.getByAltText = (...args) => overrideFillMethod(originalGetByAltTextMethod(...args));
+
+          const originalGetByLabelMethod = locator.getByLabel.bind(locator);
+          locator.getByLabel = (...args) => overrideFillMethod(originalGetByLabelMethod(...args));
+
+          const originalGetByRoleMethod = locator.getByRole.bind(locator);
+          locator.getByRole = (...args) => overrideFillMethod(originalGetByRoleMethod(...args));
+
+          const originalGetByPlaceholderMethod = locator.getByPlaceholder.bind(locator);
+          locator.getByPlaceholder = (...args) => overrideFillMethod(originalGetByPlaceholderMethod(...args));
+
+          const originalGetByTitleMethod = locator.getByTitle.bind(locator);
+          locator.getByTitle = (...args) => overrideFillMethod(originalGetByTitleMethod(...args));
+
+          return locator;
+        };
+
+        // Override the locator method on the page object
+        const originalLocator = page.locator.bind(page);
+        page.locator = (...args) => overrideFillMethod(originalLocator(...args));
+
+        const originalGetByTestId = page.getByTestId.bind(page);
+        const originalGetByAltText = page.getByAltText.bind(page);
+        const originalGetByLabel = page.getByLabel.bind(page);
+        const originalGetByRole = page.getByRole.bind(page);
+        const originalGetByPlaceholder = page.getByPlaceholder.bind(page);
+        const originalGetByText = page.getByText.bind(page);
+        const originalGetByTitle = page.getByTitle.bind(page);
+
+        // Override other top-level methods as before
+        page.getByTestId = (...args) => overrideFillMethod(originalGetByTestId(...args));
+        page.getByAltText = (...args) => overrideFillMethod(originalGetByAltText(...args));
+        page.getByLabel = (...args) => overrideFillMethod(originalGetByLabel(...args));
+        page.getByRole = (...args) => overrideFillMethod(originalGetByRole(...args));
+        page.getByPlaceholder = (...args) => overrideFillMethod(originalGetByPlaceholder(...args));
+        page.getByText = (...args) => overrideFillMethod(originalGetByText(...args));
+        page.getByTitle = (...args) => overrideFillMethod(originalGetByTitle(...args));
+
+        await use(page);
+      }
+    });
+  }
+
+  get test() {
+    return this._test;
+  }
+}

package/page-overrides/index.ts

@@ -0,0 +1 @@
+export * from './ClickOverride.js';

package/promptCredentials.js

@@ -1,113 +1,124 @@
-#!/usr/bin/env node
-import chalk from 'chalk';
-import process from 'node:process';
-import { spawnSync } from 'node:child_process';
-import { readFileSync } from 'node:fs';
-import prompts from 'prompts';
-
-const packageScripts = JSON.parse(readFileSync('./package.json')).scripts;
-
-function exitWithError(error) {
-  console.log(chalk.red(error));
-  process.exit(1);
-}
-
-function startTestSolution() {
-  console.log('Now starting test solution...');
-  spawnSync(`yarn --cwd ../ ${args.join(' ')}`, { shell: true, stdio: 'inherit' });
-  process.exit();
-}
-
-const args = process.argv.slice(2);
-
-if (!args.length) {
-  exitWithError('Error: Got too few parameters. Usage: yarn test:credentials test');
-}
-
-const yarnScriptToExec = args[0];
-
-if (!packageScripts[yarnScriptToExec]) {
-  exitWithError(`Error: Given script "${yarnScriptToExec}" doesn't exist in package.json.`);
-}
-
-// INCOMING HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-// temp fix to be reworked when converting this file to TS
-import fs from 'node:fs';
-import path from 'node:path';
-
-const indiciumURL = (() => {
-  try {
-    const configPath = path.resolve(process.cwd(), './Testwise.json');
-    const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
-    return config.environmentSettings?.serviceUrl || '';
-  } catch (error) {
-    console.error('Error reading Testwise.json:', error);
-    return '';
-  }
-})();
-
-// END OF HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-if (process.env.SF_TEST_USERNAME && process.env.SF_TEST_PASSWORD) {
-  console.log('Using SF_TEST_USERNAME and SF_TEST_PASSWORD environment variables.');
-  startTestSolution();
-}
-
-const questions = [{
-  type: 'text',
-  name: 'username',
-  message: 'Username:',
-  validate: (value) => {
-    if (!value?.length) {
-      return 'Username is required';
-    }
-
-    if (value.toLowerCase() === 'demo') {
-      return 'Running tests locally with demo is forbidden as it results in dataset concurrency problems'
-    }
-
-    return true;
-  }
-}, {
-  type: 'invisible',
-  name: 'password',
-  message: 'Password:',
-  validate: (value) => !value?.length ? 'Password is required' : true
-}];
-
-(async () => {
-  const credentialsResponse = await prompts(questions);
-
-  if (!credentialsResponse || !credentialsResponse.username || !credentialsResponse.password) {
-    exitWithError('Username or password was not given');
-  }
-
-  const { password, username } = credentialsResponse;
-  const params = new URLSearchParams();
-
-  params.append('UserName', username);
-  params.append('Password', password);
-
-  const fetch = (await import('node-fetch')).default;
-  const authResponse = await fetch(`${indiciumURL}/account/api/login`, { method: 'POST', body: params });
-
-  if (authResponse.status === 204) {
-    console.log('Confirmed credentials work @', indiciumURL);
-  } else {
-    const confirmResponse = await prompts([{
-      type: 'confirm',
-      name: 'value',
-      message: `Can't login to ${indiciumURL} with the given credentials. Continue anyways?`,
-      initial: true
-    }]);
-
-    if (!confirmResponse.value) {
-      return;
-    }
-  }
-
-  process.env.SF_TEST_USERNAME = username;
-  process.env.SF_TEST_PASSWORD = password;
-
-  startTestSolution();
-})();
+#!/usr/bin/env node
+import { spawnSync } from 'node:child_process';
+import { readFileSync } from 'node:fs';
+import process from 'node:process';
+import chalk from 'chalk';
+import prompts from 'prompts';
+
+const packageScripts = JSON.parse(readFileSync('./package.json')).scripts;
+
+function exitWithError(error) {
+  console.log(chalk.red(error));
+  process.exit(1);
+}
+
+function startTestSolution() {
+  console.log('Now starting test solution...');
+  spawnSync(`yarn --cwd ../ ${args.join(' ')}`, {
+    shell: true,
+    stdio: 'inherit'
+  });
+  process.exit();
+}
+
+const args = process.argv.slice(2);
+
+if (!args.length) {
+  exitWithError('Error: Got too few parameters. Usage: yarn test:credentials test');
+}
+
+const yarnScriptToExec = args[0];
+
+if (!packageScripts[yarnScriptToExec]) {
+  exitWithError(`Error: Given script "${yarnScriptToExec}" doesn't exist in package.json.`);
+}
+
+// INCOMING HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+// temp fix to be reworked when converting this file to TS
+import fs from 'node:fs';
+import path from 'node:path';
+
+const indiciumURL = (() => {
+  try {
+    const configPath = path.resolve(process.cwd(), './Testwise.json');
+    const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+    return config.environmentSettings?.serviceUrl || '';
+  } catch (error) {
+    console.error('Error reading Testwise.json:', error);
+    return '';
+  }
+})();
+
+// END OF HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+if (process.env.SF_TEST_USERNAME && process.env.SF_TEST_PASSWORD) {
+  console.log('Using SF_TEST_USERNAME and SF_TEST_PASSWORD environment variables.');
+  startTestSolution();
+}
+
+const questions = [
+  {
+    type: 'text',
+    name: 'username',
+    message: 'Username:',
+    validate: (value) => {
+      if (!value?.length) {
+        return 'Username is required';
+      }
+
+      if (value.toLowerCase() === 'demo') {
+        return 'Running tests locally with demo is forbidden as it results in dataset concurrency problems';
+      }
+
+      return true;
+    }
+  },
+  {
+    type: 'invisible',
+    name: 'password',
+    message: 'Password:',
+    validate: (value) => (!value?.length ? 'Password is required' : true)
+  }
+];
+
+(async () => {
+  const credentialsResponse = await prompts(questions);
+
+  if (!credentialsResponse || !credentialsResponse.username || !credentialsResponse.password) {
+    exitWithError('Username or password was not given');
+  }
+
+  const { password, username } = credentialsResponse;
+  const params = new URLSearchParams();
+
+  params.append('UserName', username);
+  params.append('Password', password);
+
+  const fetch = (await import('node-fetch')).default;
+  const authResponse = await fetch(`${indiciumURL}/account/api/login`, {
+    method: 'POST',
+    body: params
+  });
+
+  if (authResponse.status === 204) {
+    console.log('Confirmed credentials work @', indiciumURL);
+  } else {
+    const confirmResponse = await prompts([
+      {
+        type: 'confirm',
+        name: 'value',
+        message: `Can't login to ${indiciumURL} with the given credentials. Continue anyways?`,
+        initial: true
+      }
+    ]);
+
+    if (!confirmResponse.value) {
+      return;
+    }
+  }
+
+  process.env.SF_TEST_USERNAME = username;
+  process.env.SF_TEST_PASSWORD = password;
+
+  startTestSolution();
+})();

package/scripts/Testwise.template.json

@@ -8,12 +8,15 @@
     "logger" : {
       "logDir" : "logs",
       "logLevel" : "info",
+      "applyLogLevelToConsoleOutput" : false,
       "logByDay" : true,
       "bufferSizeLimit" : -1
     },
     "InflightRequests" : {
       "waitForRequestsToComplete" : true,
-      "swallowPollingExceptions" : true
+      "waitTimeout" : 5000,
+      "continueOnError" : true,
+      "paths" : ["/stage", "/layout()", "/context()"]
     },
     "other" : {
       "loginTimeout" : 30000

package/scripts/main.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import process from 'node:process';
+import { setup } from './setup.js';
+
+if (process.argv[2] === 'install') {
+  setup();
+} else if (process.argv[2] === 'sync') {
+  console.log('This feature is coming soon!');
+} else {
+  console.warn('Command unknown. Use "install" or "sync".');
+}