codeceptjs 3.5.15 → 3.6.0

package/lib/heal.js

@@ -0,0 +1,172 @@
+const debug = require('debug')('codeceptjs:heal');
+const colors = require('chalk');
+const Container = require('./container');
+const recorder = require('./recorder');
+const output = require('./output');
+const event = require('./event');
+
+/**
+ * @class
+ */
+class Heal {
+  constructor() {
+    this.recipes = {};
+    this.fixes = [];
+    this.prepareFns = [];
+    this.contextName = null;
+    this.numHealed = 0;
+  }
+
+  clear() {
+    this.recipes = {};
+    this.fixes = [];
+    this.prepareFns = [];
+    this.contextName = null;
+    this.numHealed = 0;
+  }
+
+  addRecipe(name, opts = {}) {
+    if (!opts.priority) opts.priority = 0;
+
+    if (!opts.fn) throw new Error(`Recipe ${name} should have a function 'fn' to execute`);
+
+    this.recipes[name] = opts;
+  }
+
+  connectToEvents() {
+    event.dispatcher.on(event.suite.before, (suite) => {
+      this.contextName = suite.title;
+    });
+
+    event.dispatcher.on(event.test.started, (test) => {
+      this.contextName = test.fullTitle();
+    });
+
+    event.dispatcher.on(event.test.finished, () => {
+      this.contextName = null;
+    });
+  }
+
+  hasCorrespondingRecipes(step) {
+    return matchRecipes(this.recipes, this.contextName)
+      .filter(r => !r.steps || r.steps.includes(step.name))
+      .length > 0;
+  }
+
+  async getCodeSuggestions(context) {
+    const suggestions = [];
+    const recipes = matchRecipes(this.recipes, this.contextName);
+
+    debug('Recipes', recipes);
+
+    const currentOutputLevel = output.level();
+    output.level(0);
+
+    for (const [property, prepareFn] of Object.entries(recipes.map(r => r.prepare).filter(p => !!p).reduce((acc, obj) => ({ ...acc, ...obj }), {}))) {
+      if (!prepareFn) continue;
+
+      if (context[property]) continue;
+      context[property] = await prepareFn(Container.support());
+    }
+
+    output.level(currentOutputLevel);
+
+    for (const recipe of recipes) {
+      let snippets = await recipe.fn(context);
+      if (!Array.isArray(snippets)) snippets = [snippets];
+
+      suggestions.push({
+        name: recipe.name,
+        snippets,
+      });
+    }
+
+    return suggestions.filter(s => !isBlank(s.snippets));
+  }
+
+  async healStep(failedStep, error, failureContext = {}) {
+    output.debug(`Trying to heal ${failedStep.toCode()} step`);
+
+    Object.assign(failureContext, {
+      error,
+      step: failedStep,
+      prevSteps: failureContext?.test?.steps?.slice(0, -1) || [],
+    });
+
+    const suggestions = await this.getCodeSuggestions(failureContext);
+
+    if (suggestions.length === 0) {
+      debug('No healing suggestions found');
+      throw error;
+    }
+
+    output.debug(`Received ${suggestions.length} suggestion${suggestions.length === 1 ? '' : 's'}`);
+
+    debug(suggestions);
+
+    for (const suggestion of suggestions) {
+      for (const codeSnippet of suggestion.snippets) {
+        try {
+          debug('Executing', codeSnippet);
+          recorder.catch((e) => {
+            debug(e);
+          });
+
+          if (typeof codeSnippet === 'string') {
+            const I = Container.support('I'); // eslint-disable-line
+            await eval(codeSnippet); // eslint-disable-line
+          } else if (typeof codeSnippet === 'function') {
+            await codeSnippet(Container.support());
+          }
+
+          this.fixes.push({
+            recipe: suggestion.name,
+            test: failureContext?.test,
+            step: failedStep,
+            snippet: codeSnippet,
+          });
+
+          recorder.add('healed', () => output.print(colors.bold.green(`  Code healed successfully by ${suggestion.name}`), colors.gray('(no errors thrown)')));
+          this.numHealed++;
+          // recorder.session.restore();
+          return;
+        } catch (err) {
+          debug('Failed to execute code', err);
+          recorder.ignoreErr(err); // healing did not help
+          recorder.catchWithoutStop(err);
+          await recorder.promise(); // wait for all promises to resolve
+        }
+      }
+    }
+    output.debug(`Couldn't heal the code for ${failedStep.toCode()}`);
+    recorder.throw(error);
+  }
+
+  static setDefaultHealers() {
+    require('./template/heal');
+  }
+}
+
+const heal = new Heal();
+
+module.exports = heal;
+
+function matchRecipes(recipes, contextName) {
+  return Object.entries(recipes)
+    .filter(([, recipe]) => !contextName || !recipe.grep || new RegExp(recipe.grep).test(contextName))
+    .sort(([, a], [, b]) => b.priority - a.priority)
+    .map(([name, recipe]) => {
+      recipe.name = name;
+      return recipe;
+    })
+    .filter(r => !!r.fn);
+}
+
+function isBlank(value) {
+  return (
+    value == null
+      || (Array.isArray(value) && value.length === 0)
+      || (typeof value === 'object' && Object.keys(value).length === 0)
+      || (typeof value === 'string' && value.trim() === '')
+  );
+}

package/lib/helper/{OpenAI.js → AI.js}

@@ -1,25 +1,25 @@
 const Helper = require('@codeceptjs/helper');
-const AiAssistant = require('../ai');
+const ai = require('../ai');
 const standardActingHelpers = require('../plugin/standardActingHelpers');
 const Container = require('../container');
 const { splitByChunks, minifyHtml } = require('../html');
 
 /**
- * OpenAI Helper for CodeceptJS.
+ * AI Helper for CodeceptJS.
  *
- * This helper class provides integration with the OpenAI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
+ * This helper class provides integration with the AI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
  * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDrvier to ensure the HTML context is available.
  *
  * ## Configuration
  *
  * This helper should be configured in codecept.json or codecept.conf.js
  *
- * * `chunkSize`: (optional, default: 80000) - The maximum number of characters to send to the OpenAI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
+ * * `chunkSize`: (optional, default: 80000) - The maximum number of characters to send to the AI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
  */
-class OpenAI extends Helper {
+class AI extends Helper {
   constructor(config) {
     super(config);
-    this.aiAssistant = new AiAssistant();
+    this.aiAssistant = ai;
 
     this.options = {
       chunkSize: 80000,
@@ -39,7 +39,7 @@ class OpenAI extends Helper {
   }
 
   /**
-   * Asks the OpenAI GPT language model a question based on the provided prompt within the context of the current page's HTML.
+   * Asks the AI GPT language model a question based on the provided prompt within the context of the current page's HTML.
    *
    * ```js
    * I.askGptOnPage('what does this page do?');
@@ -77,7 +77,7 @@ class OpenAI extends Helper {
   }
 
   /**
-   * Asks the OpenAI GPT-3.5 language model a question based on the provided prompt within the context of a specific HTML fragment on the current page.
+   * Asks the AI a question based on the provided prompt within the context of a specific HTML fragment on the current page.
    *
    * ```js
    * I.askGptOnPageFragment('describe features of this screen', '.screen');
@@ -113,9 +113,7 @@ class OpenAI extends Helper {
       { role: 'user', content: prompt },
     ];
 
-    const completion = await this.aiAssistant.createCompletion(messages);
-
-    const response = completion?.data?.choices[0]?.message?.content;
+    const response = await this.aiAssistant.createCompletion(messages);
 
     console.log(response);
 
@@ -123,4 +121,4 @@ class OpenAI extends Helper {
   }
 }
 
-module.exports = OpenAI;
+module.exports = AI;

package/lib/helper/Playwright.js

@@ -33,7 +33,7 @@ const ElementNotFound = require('./errors/ElementNotFound');
 const RemoteBrowserConnectionRefused = require('./errors/RemoteBrowserConnectionRefused');
 const Popup = require('./extras/Popup');
 const Console = require('./extras/Console');
-const { findReact, findVue } = require('./extras/PlaywrightReactVueLocator');
+const { findReact, findVue, findByPlaywrightLocator } = require('./extras/PlaywrightReactVueLocator');
 
 let playwright;
 let perfTiming;
@@ -50,8 +50,9 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
 const {
   seeElementError, dontSeeElementError, dontSeeElementInDOMError, seeElementInDOMError,
 } = require('./errors/ElementAssertion');
-const { createAdvancedTestResults, allParameterValuePairsMatchExtreme, extractQueryObjects } = require('./networkTraffics/utils');
-const { log } = require('../output');
+const {
+  dontSeeTraffic, seeTraffic, grabRecordedNetworkTraffics, stopRecordingTraffic, flushNetworkTraffics,
+} = require('./network/actions');
 
 const pathSeparator = path.sep;
 
@@ -100,6 +101,7 @@ const pathSeparator = path.sep;
  * @prop {boolean} [bypassCSP] - bypass Content Security Policy or CSP
  * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
  * @prop {object} [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
+ * @prop {string} [testIdAttribute=data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
  */
 const config = {};
 
@@ -379,6 +381,7 @@ class Playwright extends Helper {
       highlightElement: false,
     };
 
+    process.env.testIdAttribute = 'data-testid';
     config = Object.assign(defaults, config);
 
     if (availableBrowsers.indexOf(config.browser) < 0) {
@@ -464,6 +467,7 @@ class Playwright extends Helper {
     try {
       await playwright.selectors.register('__value', createValueEngine);
       await playwright.selectors.register('__disabled', createDisabledEngine);
+      if (process.env.testIdAttribute) await playwright.selectors.setTestIdAttribute(process.env.testIdAttribute);
     } catch (e) {
       console.warn(e);
     }
@@ -2468,7 +2472,7 @@ class Playwright extends Helper {
   async waitNumberOfVisibleElements(locator, num, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
     locator = new Locator(locator, 'css');
-    await this.context;
+
     let waiter;
     const context = await this._getContext();
     if (locator.isCSS()) {
@@ -2957,7 +2961,7 @@ class Playwright extends Helper {
    * This method allows intercepting and mocking requests & responses. [Learn more about it](https://playwright.dev/docs/network#handle-requests)
    *
    * @param {string|RegExp} [url] URL, regex or pattern for to match URL
-   * @param {function} [handler] a function to process reques
+   * @param {function} [handler] a function to process request
    */
   async mockRoute(url, handler) {
     return this.browserContext.route(...arguments);
@@ -2973,7 +2977,7 @@ class Playwright extends Helper {
    * If no handler is passed, all mock requests for the rote are disabled.
    *
    * @param {string|RegExp} [url] URL, regex or pattern for to match URL
-   * @param {function} [handler] a function to process reques
+   * @param {function} [handler] a function to process request
    */
   async stopMockingRoute(url, handler) {
     return this.browserContext.unroute(...arguments);
@@ -3007,37 +3011,6 @@ class Playwright extends Helper {
     });
   }
 
-  /**
-   * {{> grabRecordedNetworkTraffics }}
-   */
-  async grabRecordedNetworkTraffics() {
-    if (!this.recording || !this.recordedAtLeastOnce) {
-      throw new Error('Failure in test automation. You use "I.grabRecordedNetworkTraffics", but "I.startRecordingTraffic" was never called before.');
-    }
-
-    const promises = this.requests.map(async (request) => {
-      const resp = await request.response;
-      let body;
-      try {
-        // There's no 'body' for some requests (redirect etc...)
-        body = JSON.parse((await resp.body()).toString());
-      } catch (e) {
-        // only interested in JSON, not HTML responses.
-      }
-
-      return {
-        url: resp.url(),
-        response: {
-          status: resp.status(),
-          statusText: resp.statusText(),
-          body,
-        },
-      };
-    });
-
-    return Promise.all(promises);
-  }
-
   /**
    * Blocks traffic of a given URL or a list of URLs.
    *
@@ -3117,67 +3090,19 @@ class Playwright extends Helper {
   }
 
   /**
+   *
    * {{> flushNetworkTraffics }}
    */
   flushNetworkTraffics() {
-    this.requests = [];
+    flushNetworkTraffics.call(this);
   }
 
   /**
+   *
    * {{> stopRecordingTraffic }}
    */
   stopRecordingTraffic() {
-    this.page.removeAllListeners('request');
-    this.recording = false;
-  }
-
-  /**
-   * {{> seeTraffic }}
-   */
-  async seeTraffic({
-    name, url, parameters, requestPostData, timeout = 10,
-  }) {
-    if (!name) {
-      throw new Error('Missing required key "name" in object given to "I.seeTraffic".');
-    }
-
-    if (!url) {
-      throw new Error('Missing required key "url" in object given to "I.seeTraffic".');
-    }
-
-    if (!this.recording || !this.recordedAtLeastOnce) {
-      throw new Error('Failure in test automation. You use "I.seeTraffic", but "I.startRecordingTraffic" was never called before.');
-    }
-
-    for (let i = 0; i <= timeout * 2; i++) {
-      const found = this._isInTraffic(url, parameters);
-      if (found) {
-        return true;
-      }
-      await new Promise((done) => {
-        setTimeout(done, 1000);
-      });
-    }
-
-    // check request post data
-    if (requestPostData && this._isInTraffic(url)) {
-      const advancedTestResults = createAdvancedTestResults(url, requestPostData, this.requests);
-
-      assert.equal(advancedTestResults, true, `Traffic named "${name}" found correct URL ${url}, BUT the post data did not match:\n ${advancedTestResults}`);
-    } else if (parameters && this._isInTraffic(url)) {
-      const advancedTestResults = createAdvancedTestResults(url, parameters, this.requests);
-
-      assert.fail(
-        `Traffic named "${name}" found correct URL ${url}, BUT the query parameters did not match:\n`
-        + `${advancedTestResults}`,
-      );
-    } else {
-      assert.fail(
-        `Traffic named "${name}" not found in recorded traffic within ${timeout} seconds.\n`
-        + `Expected url: ${url}.\n`
-        + `Recorded traffic:\n${this._getTrafficDump()}`,
-      );
-    }
+    stopRecordingTraffic.call(this);
   }
 
   /**
@@ -3214,83 +3139,34 @@ class Playwright extends Helper {
   }
 
   /**
-   * {{> dontSeeTraffic }}
    *
+   * {{> grabRecordedNetworkTraffics }}
    */
-  dontSeeTraffic({ name, url }) {
-    if (!this.recordedAtLeastOnce) {
-      throw new Error('Failure in test automation. You use "I.dontSeeTraffic", but "I.startRecordingTraffic" was never called before.');
-    }
-
-    if (!name) {
-      throw new Error('Missing required key "name" in object given to "I.dontSeeTraffic".');
-    }
-
-    if (!url) {
-      throw new Error('Missing required key "url" in object given to "I.dontSeeTraffic".');
-    }
-
-    if (this._isInTraffic(url)) {
-      assert.fail(`Traffic with name "${name}" (URL: "${url}') found, but was not expected to be found.`);
-    }
+  async grabRecordedNetworkTraffics() {
+    return grabRecordedNetworkTraffics.call(this);
   }
 
   /**
-   * Checks if URL with parameters is part of network traffic. Returns true or false. Internal method for this helper.
    *
-   * @param url URL to look for.
-   * @param [parameters] Parameters that this URL needs to contain
-   * @return {boolean} Whether or not URL with parameters is part of network traffic.
-   * @private
+   * {{> seeTraffic }}
    */
-  _isInTraffic(url, parameters) {
-    let isInTraffic = false;
-    this.requests.forEach((request) => {
-      if (isInTraffic) {
-        return; // We already found traffic. Continue with next request
-      }
-
-      if (!request.url.match(new RegExp(url))) {
-        return; // url not found in this request. continue with next request
-      }
-
-      // URL has matched. Now we check the parameters
-
-      if (parameters) {
-        const advancedReport = allParameterValuePairsMatchExtreme(extractQueryObjects(request.url), parameters);
-        if (advancedReport === true) {
-          isInTraffic = true;
-        }
-      } else {
-        isInTraffic = true;
-      }
-    });
-
-    return isInTraffic;
+  async seeTraffic({
+    name, url, parameters, requestPostData, timeout = 10,
+  }) {
+    await seeTraffic.call(this, ...arguments);
   }
 
   /**
-   * Returns all URLs of all network requests recorded so far during execution of test scenario.
    *
-   * @return {string} List of URLs recorded as a string, separated by new lines after each URL
-   * @private
+   * {{> dontSeeTraffic }}
+   *
    */
-  _getTrafficDump() {
-    let dumpedTraffic = '';
-    this.requests.forEach((request) => {
-      dumpedTraffic += `${request.method} - ${request.url}\n`;
-    });
-    return dumpedTraffic;
+  dontSeeTraffic({ name, url }) {
+    dontSeeTraffic.call(this, ...arguments);
   }
 
   /**
-   * Starts recording of websocket messages.
-   * This also resets recorded websocket messages.
-   *
-   * ```js
-   * await I.startRecordingWebSocketMessages();
-   * ```
-   *
+   * {{> startRecordingWebSocketMessages }}
    */
   async startRecordingWebSocketMessages() {
     this.flushWebSocketMessages();
@@ -3324,11 +3200,7 @@ class Playwright extends Helper {
   }
 
   /**
-   * Stops recording WS messages. Recorded WS messages is not flashed.
-   *
-   * ```js
-   * await I.stopRecordingWebSocketMessages();
-   * ```
+   * {{> stopRecordingWebSocketMessages }}
    */
   async stopRecordingWebSocketMessages() {
     await this.cdpSession.send('Network.disable');
@@ -3455,6 +3327,7 @@ function buildLocatorString(locator) {
 async function findElements(matcher, locator) {
   if (locator.react) return findReact(matcher, locator);
   if (locator.vue) return findVue(matcher, locator);
+  if (locator.pw) return findByPlaywrightLocator.call(this, matcher, locator);
   locator = new Locator(locator, 'css');
 
   return matcher.locator(buildLocatorString(locator)).all();
@@ -3462,6 +3335,8 @@ async function findElements(matcher, locator) {
 
 async function findElement(matcher, locator) {
   if (locator.react) return findReact(matcher, locator);
+  if (locator.vue) return findVue(matcher, locator);
+  if (locator.pw) return findByPlaywrightLocator.call(this, matcher, locator);
   locator = new Locator(locator, 'css');
 
   return matcher.locator(buildLocatorString(locator)).first();
@@ -3517,6 +3392,7 @@ async function proceedClick(locator, context = null, options = {}) {
 async function findClickable(matcher, locator) {
   if (locator.react) return findReact(matcher, locator);
   if (locator.vue) return findVue(matcher, locator);
+  if (locator.pw) return findByPlaywrightLocator.call(this, matcher, locator);
 
   locator = new Locator(locator);
   if (!locator.isFuzzy()) return findElements.call(this, matcher, locator);