@thinkwise/testwise 0.2.21 → 0.2.67

package/helpers/LoginHelper.ts

@@ -1,32 +1,24 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import type { Page } from '@playwright/test';
+import type { APIResponse, Page } from '@playwright/test';
 import { testwiseConfig } from '../services/ConfigBuilder.js';
 import type { UniversalConfigOptions, UniversalLoginOptions } from '../types/index.js';
 import { pollUntil } from './Poll.js';
 
-const _dirname = path.dirname(fileURLToPath(import.meta.url));
-const configFixture = JSON.parse(fs.readFileSync(path.resolve(_dirname, '../../config.json'), 'utf-8'));
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const configFixture = JSON.parse(fs.readFileSync(path.resolve(dirname, '../../config.json'), 'utf-8'));
 
 export class LoginHelper {
   private _page: Page;
-  private _serviceUrl: string;
-  private _metaEndpoint: string;
+  protected serviceUrl = String(testwiseConfig().get('environmentSettings.serviceUrl'));
+  protected metaEndpoint = String(testwiseConfig().get('environmentSettings.metaEndpoint'));
 
   constructor(page: Page) {
-    this._page = page;
-
-    const serviceUrl = testwiseConfig().get<string>('environmentSettings.serviceUrl');
-    const metaEndpoint = testwiseConfig().get<string>('environmentSettings.metaEndpoint');
+    if (!this.serviceUrl || this.serviceUrl === 'undefined') throw new Error('Service URL not found');
+    if (!this.metaEndpoint || this.metaEndpoint === 'undefined') throw new Error('Meta endpoint not found');
 
-    if (!serviceUrl || !metaEndpoint)
-      throw new Error(
-        'Either environmentSettings.serviceUrl or environmentSettings.metaEndpoint is not defined in the configuration.'
-      );
-
-    this._serviceUrl = serviceUrl;
-    this._metaEndpoint = metaEndpoint;
+    this._page = page;
   }
 
   /**
@@ -101,11 +93,11 @@ export class LoginHelper {
     }
 
     if (serviceUrl && metaEndpoint) {
-      this._serviceUrl = serviceUrl;
-      this._metaEndpoint = metaEndpoint;
+      this.serviceUrl = serviceUrl;
+      this.metaEndpoint = metaEndpoint;
     }
 
-    const response = await this._page.request.post(`${this._serviceUrl}/account/api/login`, {
+    const response = await this._page.request.post(`${this.serviceUrl}/account/api/login`, {
       form: {
         UserName: username,
         Password: password
@@ -116,6 +108,36 @@ export class LoginHelper {
       throw new Error(`Login failed with status code: ${response.status()}`);
     }
 
+    if (password === username && /^Worker_\d+$/.test(username)) {
+      const userPreferences = new UserPreferences(this._page, this.serviceUrl, this.metaEndpoint);
+
+      if (!options.userPreference) {
+        console.info(
+          `No user preference configuration ID provided for worker account ${username}. User preferences will be disabled to prevent unexpected test behavior.`
+        );
+      } else {
+        console.info(
+          `User preference configuration ID ${options.userPreference} provided for worker account ${username}. Attempting to disable user preferences before re-enabling with provided configuration.`
+        );
+      }
+
+      try {
+        await userPreferences.disable();
+        console.info(`Successfully disabled user preferences for worker account ${username}.`);
+
+        if (options.userPreference) {
+          await userPreferences.run(options.userPreference);
+          console.info(
+            `Successfully re-enabled user preferences for worker account ${username} with configuration ID ${options.userPreference}.`
+          );
+        }
+      } catch (error) {
+        console.warn(
+          `User preferences may not be properly configured for worker account ${username}. Tests may be unstable. Error details: ${error}`
+        );
+      }
+    }
+
     // Set the navigator.language property
     await this._page.route('**/*', (route, request) => {
       route.continue({
@@ -142,7 +164,7 @@ export class LoginHelper {
         contentType: 'application/json',
         body: JSON.stringify({
           ...configFixture,
-          serviceUrl: `${this._serviceUrl}/iam/${this._metaEndpoint}`,
+          serviceUrl: `${this.serviceUrl}/iam/${this.metaEndpoint}`,
           ...options
         })
       });
@@ -150,7 +172,7 @@ export class LoginHelper {
   }
 
   public async logOut() {
-    const response = await this._page.request.post(`${this._serviceUrl}/account/api/logout`);
+    const response = await this._page.request.post(`${this.serviceUrl}/account/api/logout`);
 
     if (![204, 401].includes(response.status())) {
       throw new Error(`Logout failed with status code: ${response.status()}`);
@@ -159,3 +181,39 @@ export class LoginHelper {
     await this._page.context().clearCookies();
   }
 }
+
+export class UserPreferences {
+  private _page: Page;
+
+  public readonly guiApplAlias = String(testwiseConfig().get<string>('environmentSettings.guiApplAlias'));
+  public readonly url: string;
+
+  constructor(requestContext: Page, serviceUrl?: string, metaEndpoint?: string) {
+    this._page = requestContext;
+
+    serviceUrl = serviceUrl ?? testwiseConfig().get<string>('environmentSettings.serviceUrl');
+    metaEndpoint = metaEndpoint ?? testwiseConfig().get<string>('environmentSettings.metaEndpoint');
+
+    if (!serviceUrl) throw new Error('Service URL not found or is empty');
+    if (!metaEndpoint) throw new Error('Meta endpoint not found or is empty');
+    if (!this.guiApplAlias) throw new Error('GUI application alias not found or is empty');
+
+    this.url = `${serviceUrl}/${metaEndpoint}/${this.guiApplAlias}`;
+  }
+
+  public async run(upConfigurationId: number) {
+    const fullUrl = `${this.url}/set_up_configuration`;
+
+    const data = {
+      up_configuration_id: upConfigurationId
+    };
+
+    await this._page.request.post(fullUrl, { headers: { 'Content-Type': 'application/json; charset=utf-8' }, data });
+  }
+
+  public async disable(): Promise<APIResponse> {
+    const fullUrl = `${this.url}/disable_up`;
+
+    return await this._page.request.post(fullUrl, { headers: { 'Content-Type': 'application/json; charset=utf-8' } });
+  }
+}

package/index.ts

@@ -12,7 +12,6 @@ console.warn = (...args: unknown[]) => logger.warn(args.join(' '));
 console.error = (...args: unknown[]) => logger.error(args.join(' '));
 console.debug = (...args: unknown[]) => logger.debug(args.join(' '));
 
-export { originalLog, originalInfo, originalWarn, originalError, originalDebug };
 export * from './artifact-builder/index.js';
 export * from './components/index.js';
 export * from './controls/index.js';
@@ -23,3 +22,4 @@ export * from './page-overrides/index.js';
 export * from './services/index.js';
 export * from './Testwise.js';
 export * from './types/index.js';
+export { originalDebug, originalError, originalInfo, originalLog, originalWarn };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkwise/testwise",
-  "version": "0.2.21",
+  "version": "0.2.67",
   "main": "dist/index.js",
   "type": "module",
   "bin": {
@@ -9,8 +9,8 @@
   },
   "scripts": {
     "lint": "eslint ./ --cache --ignore-pattern .gitignore",
-    "format:fix": "npm run lint --fix && biome check --fix --unsafe",
-    "format:check": "npm run lint && biome check",
+    "format:fix": "run-s \"lint --fix\" && biome check --fix --unsafe",
+    "format:check": "run-s \"lint \" && biome check",
     "postinstall": "node scripts/main.js postinstall"
   },
   "keywords": [],
@@ -18,7 +18,7 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "@thinkwise/backups": "^1.0.13",
+    "@thinkwise/backups": "^1.0.16",
     "@types/node": "^22.15.29",
     "axios": "^1.9.0",
     "chalk": "^5.4.1",
@@ -37,10 +37,11 @@
     "@playwright/test": "^1.56.1"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.3.8",
+    "@biomejs/biome": "^2.4.8",
     "@eslint/js": "^9.28.0",
     "eslint": "^9.39.2",
     "eslint-plugin-playwright": "^2.2.0",
+    "npm-run-all": "^4.1.5",
     "typescript-eslint": "^8.34.0"
   },
   "exports": {

package/page-extensions/GlobalComponents.ts

@@ -2,6 +2,7 @@ import type { Page } from '@playwright/test';
 import {
   ExportComponent,
   ListBarMenuComponent,
+  ManagePrefilterPopup,
   PopUpComponent,
   SnackBarComponent,
   TopBarComponent
@@ -14,6 +15,7 @@ class GlobalComponents {
   public snackBar: SnackBarComponent;
   public topBar: TopBarComponent;
   public listBarMenu: ListBarMenuComponent;
+  public managePrefilterPopup: ManagePrefilterPopup;
 
   constructor(page: Page) {
     this.popUp = new PopUpComponent(page);
@@ -21,6 +23,7 @@ class GlobalComponents {
     this.snackBar = new SnackBarComponent(page);
     this.topBar = new TopBarComponent(page);
     this.listBarMenu = new ListBarMenuComponent(page);
+    this.managePrefilterPopup = new ManagePrefilterPopup(page);
   }
 }
 

package/page-overrides/ClickOverride.ts

@@ -1,4 +1,4 @@
-import type { Locator } from '@playwright/test';
+import type { Locator, Page } from '@playwright/test';
 import { FlightTracker } from '../helpers/FlightTracker.js';
 import { testwiseConfig } from '../services/ConfigBuilder.js';
 import type { Test } from '../types/Test.js';
@@ -9,26 +9,41 @@ const continueOnError = testwiseConfig().get<boolean>('featureSettings.InflightR
 
 export class ClickOverride {
   private _test: Test;
+  private _page: Page | null = null;
   private flightTracker: FlightTracker = new FlightTracker();
 
   constructor(test: Test) {
     this._test = test.extend({
       page: async ({ page }, use) => {
+        this._page = page;
+
+        const isTrackable = (url: string, resourceType: string) => {
+          const lowerUrl = url.toLowerCase();
+
+          return (
+            resourceType === 'xhr' &&
+            !lowerUrl.includes('/detect_change(') &&
+            !lowerUrl.includes('/set_gui_start_use_log_session') &&
+            !lowerUrl.includes('download_icon') &&
+            !lowerUrl.includes('download_list_bar_grp_icon') &&
+            !lowerUrl.includes('/badge()')
+          );
+        };
+
         const overrideClickMethod = (locator: Locator): Locator => {
           const originalClickMethod = locator.click.bind(locator);
 
           page.on('request', (request) => {
-            if (request.resourceType() === 'xhr') {
+            if (isTrackable(request.url(), request.resourceType())) {
               this.flightTracker.requestsInFlight++;
             }
           });
 
           page.on('response', (response) => {
-            if (response.request().resourceType() === 'xhr') {
+            if (isTrackable(response.request().url(), response.request().resourceType())) {
               if (this.flightTracker.requestsInFlight > 0) {
                 this.flightTracker.requestsInFlight--;
               }
-
               if (this.flightTracker.requestsInFlight === 0) {
                 this.flightTracker.eventEmitter.emit('idle');
               }
@@ -42,75 +57,65 @@ export class ClickOverride {
                 await this.flightTracker.waitToContinue();
               } catch (error) {
                 console.warn('Exception while waiting for inflight requests to finish:', error);
-
+                if (this._page) {
+                  const inflightRequests = await this._page.evaluate(() => {
+                    return performance
+                      .getEntriesByType('resource')
+                      .filter((entry) => {
+                        const res = entry as PerformanceResourceTiming;
+                        return (
+                          res.initiatorType === 'xmlhttprequest' &&
+                          !res.name.includes('/detect_change(') &&
+                          !res.name.includes('/set_gui_start_use_log_session')
+                        );
+                      })
+                      .map((entry) => (entry as PerformanceResourceTiming).name);
+                  });
+                  console.debug('Current inflight XHR requests:', inflightRequests);
+                }
                 if (!continueOnError) throw error;
               }
             }
+            return;
           };
 
-          // 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));
+          const locatorMethods = [
+            'locator',
+            'filter',
+            'getByText',
+            'getByTestId',
+            'getByAltText',
+            'getByLabel',
+            'getByRole',
+            'getByPlaceholder',
+            'getByTitle'
+          ] as const;
+
+          for (const method of locatorMethods) {
+            const original = (locator[method] as (...args: unknown[]) => Locator).bind(locator);
+            (locator as unknown as Record<string, (...args: unknown[]) => Locator>)[method] = (...args: unknown[]) =>
+              overrideClickMethod(original(...args));
+          }
 
           return locator;
         };
 
-        // Override the getByTestId.click method
-        const originalGetByTestId = page.getByTestId.bind(page);
-        page.getByTestId = (...args) => overrideClickMethod(originalGetByTestId(...args));
-
-        // Override the locator.click method
-        const originalLocator = page.locator.bind(page);
-        page.locator = (...args) => overrideClickMethod(originalLocator(...args));
-
-        // Override the getByAltText.click method
-        const originalGetByAltText = page.getByAltText.bind(page);
-        page.getByAltText = (...args) => overrideClickMethod(originalGetByAltText(...args));
-
-        // Override the getByLabel.click method
-        const originalGetByLabel = page.getByLabel.bind(page);
-        page.getByLabel = (...args) => overrideClickMethod(originalGetByLabel(...args));
-
-        // Override the getByRole.click method
-        const originalGetByRole = page.getByRole.bind(page);
-        page.getByRole = (...args) => overrideClickMethod(originalGetByRole(...args));
-
-        // Override the getByPlaceholder.click method
-        const originalGetByPlaceholder = page.getByPlaceholder.bind(page);
-        page.getByPlaceholder = (...args) => overrideClickMethod(originalGetByPlaceholder(...args));
-
-        // Override the getByText.click method
-        const originalGetByText = page.getByText.bind(page);
-        page.getByText = (...args) => overrideClickMethod(originalGetByText(...args));
-
-        // Override the getByTitle.click method
-        const originalGetByTitle = page.getByTitle.bind(page);
-        page.getByTitle = (...args) => overrideClickMethod(originalGetByTitle(...args));
+        const rootMethods = [
+          'locator',
+          'getByTestId',
+          'getByAltText',
+          'getByLabel',
+          'getByRole',
+          'getByPlaceholder',
+          'getByText',
+          'getByTitle'
+        ] as const;
+
+        for (const method of rootMethods) {
+          const original = (page[method] as (...args: unknown[]) => Locator).bind(page);
+          (page as unknown as Record<string, (...args: unknown[]) => Locator>)[method] = (...args: unknown[]) =>
+            overrideClickMethod(original(...args));
+        }
 
         await use(page);
       }

package/types/Universal.ts

@@ -23,4 +23,5 @@ export type UniversalLoginOptions = {
   serviceUrl?: string;
   metaEndpoint?: string;
   config?: UniversalConfigOptions;
+  userPreference?: number;
 };