@thinkwise/testwise 0.2.67 → 0.2.103

package/page-overrides/ClickOverride.ts

@@ -1,80 +1,58 @@
-import type { Locator, Page } from '@playwright/test';
+import type { Locator } from '@playwright/test';
 import { FlightTracker } from '../helpers/FlightTracker.js';
 import { testwiseConfig } from '../services/ConfigBuilder.js';
 import type { Test } from '../types/Test.js';
 
 const waitForRequestsToComplete =
   testwiseConfig().get<boolean>('featureSettings.InflightRequests.waitForRequestsToComplete') ?? true;
-const continueOnError = testwiseConfig().get<boolean>('featureSettings.InflightRequests.continueOnError') ?? true;
 
+/**
+ * Playwright fixture layer that wraps every Locator `click()` call to wait
+ * for in-flight XHR requests to settle before returning control to the test.
+ *
+ * **Why this exists:** The Thinkwise application fires XHR calls immediately
+ * after a click (save, navigation, data load). Without this override a test
+ * that clicks a button and then immediately reads a value races against the
+ * server response. `ClickOverride` uses `FlightTracker` under the hood to
+ * block until all relevant requests finish.
+ *
+ * **How to disable** (if a specific test must opt out):
+ * Set `featureSettings.InflightRequests.waitForRequestsToComplete: false` in
+ * `Testwise.json` — but this is rarely needed.
+ */
 export class ClickOverride {
   private _test: Test;
-  private _page: Page | null = null;
-  private flightTracker: FlightTracker = new FlightTracker();
 
+  /**
+   * Extends the Playwright `Test` fixture to wrap every locator's `click` method with
+   * in-flight XHR tracking via `FlightTracker`, waiting for all relevant requests to
+   * settle after each click. Behaviour is configurable via `featureSettings.InflightRequests`.
+   * @param test - The Playwright `Test` fixture to extend.
+   */
   constructor(test: Test) {
     this._test = test.extend({
       page: async ({ page }, use) => {
-        this._page = page;
+        const flightTracker = new FlightTracker();
 
-        const isTrackable = (url: string, resourceType: string) => {
-          const lowerUrl = url.toLowerCase();
+        page.on('request', (request) => {
+          flightTracker.handleRequestStarted(request.url(), request.resourceType());
+        });
 
-          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()')
-          );
-        };
+        page.on('response', (response) => {
+          flightTracker.handleRequestFinished(response.request().url());
+        });
+
+        page.on('requestfailed', (request) => {
+          flightTracker.handleRequestFailed(request.url());
+        });
 
         const overrideClickMethod = (locator: Locator): Locator => {
           const originalClickMethod = locator.click.bind(locator);
 
-          page.on('request', (request) => {
-            if (isTrackable(request.url(), request.resourceType())) {
-              this.flightTracker.requestsInFlight++;
-            }
-          });
-
-          page.on('response', (response) => {
-            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');
-              }
-            }
-          });
-
           locator.click = async (options) => {
             await originalClickMethod(options);
             if (waitForRequestsToComplete) {
-              try {
-                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;
-              }
+              await flightTracker.waitToContinue();
             }
             return;
           };
@@ -122,6 +100,9 @@ export class ClickOverride {
     });
   }
 
+  /**
+   * Returns the extended `Test` fixture with the click override active.
+   */
   get test() {
     return this._test;
   }

package/page-overrides/FillOverride.ts

@@ -7,10 +7,41 @@ const requestWatchlist: string[] = testwiseConfig().get<string[]>('featureSettin
 const waitForRequestsToComplete =
   testwiseConfig().get<boolean>('featureSettings.InflightRequests.waitForRequestsToComplete') ?? true;
 
+const locatorMethods = [
+  'locator',
+  'getByText',
+  'getByTestId',
+  'getByAltText',
+  'getByLabel',
+  'getByRole',
+  'getByPlaceholder',
+  'getByTitle'
+] as const;
+
+/**
+ * Playwright fixture layer that wraps every Locator `fill()` call to wait
+ * for in-flight XHR requests to settle before returning control to the test.
+ *
+ * **Why this exists:** After filling a lookup or auto-complete field the
+ * Thinkwise application fires XHR calls to search/resolve the typed value.
+ * Without this override, subsequent assertions or interactions race against
+ * those server responses. `FillOverride` uses `FlightTracker` to block until
+ * all relevant requests on the watchlist finish.
+ *
+ * The `featureSettings.InflightRequests.paths` list in `Testwise.json`
+ * controls which API endpoints are watched during fill operations.
+ */
 export class FillOverride {
   private _test: Test;
   private flightTracker: FlightTracker = new FlightTracker();
 
+  /**
+   * Extends the Playwright `Test` fixture to wrap every locator's `fill` method:
+   * waits for watched in-flight requests to settle, fills the element, and — for
+   * qualifying form fields — triggers a `/staged` response wait and blurs the element
+   * if the value changed. Watchlist and behaviour are configurable via `featureSettings`.
+   * @param test - The Playwright `Test` fixture to extend.
+   */
   constructor(test: Test) {
     this._test = test.extend({
       page: async ({ page }, use) => {
@@ -35,101 +66,56 @@ export class FillOverride {
         }
 
         const overrideFillMethod = (locator: Locator) => {
-          const originalFillMethod = locator.fill.bind(locator);
+          const originalFill = 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 formFieldTestIdPrefix: string = 'form-field__';
-
-            const isQualifyingFormField = await locator.evaluate((el, formFieldTestIdPrefix) => {
-              const elementTestId = el.getAttribute('data-testid');
+            if (waitForRequestsToComplete) await this.flightTracker.waitToContinue();
 
-              const parentWithFormSectionTestId = el.closest('[data-testid^="form-section__"]');
+            const [valueIsDifferent, isQualifyingFormField] = await Promise.all([
+              locator.inputValue().then((v) => v !== value),
+              locator.evaluate((el) => {
+                const testId = el.getAttribute('data-testid');
+                return (
+                  !!testId && testId.includes('form-field__') && el.closest('[data-testid^="form-section__"]') !== null
+                );
+              })
+            ]);
 
-              if (elementTestId) {
-                return elementTestId.includes(formFieldTestIdPrefix) && parentWithFormSectionTestId !== null;
-              }
-              return false;
-            }, formFieldTestIdPrefix);
-
-            if (valueIsDifferent && isQualifyingFormField) {
-              await page.waitEventHandler.waitForCanContinue();
-              page.waitEventHandler.waitForResponse('/staged');
-            }
+            await page.waitEventHandler.waitForCanContinue();
 
-            await originalFillMethod(value, options);
+            await originalFill(value, options);
 
             if (isQualifyingFormField) {
+              if (valueIsDifferent) page.waitEventHandler.waitForResponse('/staged');
               await locator.evaluate((el) => {
-                const ariaExpanded = el.getAttribute('aria-expanded');
-
-                if (!ariaExpanded) el.blur();
+                if (!el.getAttribute('aria-expanded')) 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));
+          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[]) =>
+              overrideFillMethod(original(...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));
+        for (const method of locatorMethods) {
+          const original = (page[method] as (...args: unknown[]) => Locator).bind(page);
+          (page as unknown as Record<string, (...args: unknown[]) => Locator>)[method] = (...args: unknown[]) =>
+            overrideFillMethod(original(...args));
+        }
 
         await use(page);
       }
     });
   }
 
+  /**
+   * Returns the extended `Test` fixture with the fill override active.
+   */
   get test() {
     return this._test;
   }

package/promptCredentials.js

@@ -84,7 +84,7 @@ const questions = [
 (async () => {
   const credentialsResponse = await prompts(questions);
 
-  if (!credentialsResponse || !credentialsResponse.username || !credentialsResponse.password) {
+  if (!credentialsResponse?.username || !credentialsResponse.password) {
     exitWithError('Username or password was not given');
   }
 

package/scripts/Testwise.template.json

@@ -22,7 +22,7 @@
       "paths" : ["/stage", "/layout()", "/context()"]
     },
     "other" : {
-      "loginTimeout" : 30000
+      "loginTimeout" : 60000
     }
   }
 }