codeceptjs 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/helper/AI.js

@@ -1,39 +1,52 @@
-import Helper from '@codeceptjs/helper';
-import AiAssistant from '../ai.js';
-import standardActingHelpers from '../plugin/standardActingHelpers.js';
-import Container from '../container.js';
-import { splitByChunks, minifyHtml } from '../html.js';
+const Helper = require('@codeceptjs/helper')
+const ora = require('ora-classic')
+const fs = require('fs')
+const path = require('path')
+const ai = require('../ai')
+const standardActingHelpers = require('../plugin/standardActingHelpers')
+const Container = require('../container')
+const { splitByChunks, minifyHtml } = require('../html')
+const { beautify } = require('../utils')
+const output = require('../output')
+const { registerVariable } = require('../pause')
+
+const gtpRole = {
+  user: 'user',
+}
 
 /**
  * AI Helper for CodeceptJS.
  *
  * 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.
+ * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDriver to ensure the HTML context is available.
+ *
+ * Use it only in development mode. It is recommended to run it only inside pause() mode.
  *
  * ## Configuration
  *
- * This helper should be configured in codecept.json or codecept.conf.js
+ * This helper should be configured in codecept.conf.{js|ts}
  *
  * * `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 AI extends Helper {
   constructor(config) {
-    super(config);
-    this.aiAssistant = AiAssistant;
+    super(config)
+    this.aiAssistant = ai
 
     this.options = {
       chunkSize: 80000,
-    };
-    this.options = { ...this.options, ...config };
+    }
+    this.options = { ...this.options, ...config }
+    this.aiAssistant.enable(this.config)
   }
 
   _beforeSuite() {
-    const helpers = Container.helpers();
+    const helpers = Container.helpers()
 
     for (const helperName of standardActingHelpers) {
       if (Object.keys(helpers).indexOf(helperName) > -1) {
-        this.helper = helpers[helperName];
-        break;
+        this.helper = helpers[helperName]
+        break
       }
     }
   }
@@ -50,30 +63,34 @@ class AI extends Helper {
    * @returns {Promise<string>} - A Promise that resolves to the generated responses from the GPT model, joined by newlines.
    */
   async askGptOnPage(prompt) {
-    const html = await this.helper.grabSource();
+    const html = await this.helper.grabSource()
 
-    const htmlChunks = splitByChunks(html, this.options.chunkSize);
+    const htmlChunks = splitByChunks(html, this.options.chunkSize)
 
-    if (htmlChunks.length > 1) this.debug(`Splitting HTML into ${htmlChunks.length} chunks`);
+    if (htmlChunks.length > 1) this.debug(`Splitting HTML into ${htmlChunks.length} chunks`)
 
-    const responses = [];
+    const responses = []
 
     for (const chunk of htmlChunks) {
       const messages = [
-        { role: 'user', content: prompt },
-        { role: 'user', content: `Within this HTML: ${minifyHtml(chunk)}` },
-      ];
+        { role: gtpRole.user, content: prompt },
+        { role: gtpRole.user, content: `Within this HTML: ${await minifyHtml(chunk)}` },
+      ]
 
-      if (htmlChunks.length > 1) messages.push({ role: 'user', content: 'If action is not possible on this page, do not propose anything, I will send another HTML fragment' });
+      if (htmlChunks.length > 1)
+        messages.push({
+          role: 'user',
+          content: 'If action is not possible on this page, do not propose anything, I will send another HTML fragment',
+        })
 
-      const response = await this.aiAssistant.createCompletion(messages);
+      const response = await this._processAIRequest(messages)
 
-      console.log(response);
+      output.print(response)
 
-      responses.push(response);
+      responses.push(response)
     }
 
-    return responses.join('\n\n');
+    return responses.join('\n\n')
   }
 
   /**
@@ -89,36 +106,108 @@ class AI extends Helper {
    * @returns {Promise<string>} - A Promise that resolves to the generated response from the GPT model.
    */
   async askGptOnPageFragment(prompt, locator) {
-    const html = await this.helper.grabHTMLFrom(locator);
+    const html = await this.helper.grabHTMLFrom(locator)
 
     const messages = [
-      { role: 'user', content: prompt },
-      { role: 'user', content: `Within this HTML: ${minifyHtml(html)}` },
-    ];
+      { role: gtpRole.user, content: prompt },
+      { role: gtpRole.user, content: `Within this HTML: ${await minifyHtml(html)}` },
+    ]
 
-    const response = await this.aiAssistant.createCompletion(messages);
+    const response = await this._processAIRequest(messages)
 
-    console.log(response);
+    output.print(response)
 
-    return response;
+    return response
   }
 
   /**
-   * Send a general request to ChatGPT and return response.
+   * Send a general request to AI and return response.
    * @param {string} prompt
    * @returns {Promise<string>} - A Promise that resolves to the generated response from the GPT model.
    */
   async askGptGeneralPrompt(prompt) {
-    const messages = [
-      { role: 'user', content: prompt },
-    ];
+    const messages = [{ role: gtpRole.user, content: prompt }]
+
+    const response = await this._processAIRequest(messages)
+
+    output.print(response)
+
+    return response
+  }
+
+  /**
+   * Generates PageObject for current page using AI.
+   *
+   * It saves the PageObject to the output directory. You can review the page object and adjust it as needed and move to pages directory.
+   * Prompt can be customized in a global config file.
+   *
+   * ```js
+   * // create page object for whole page
+   * I.askForPageObject('home');
+   *
+   * // create page object with extra prompt
+   * I.askForPageObject('home', 'implement signIn(username, password) method');
+   *
+   * // create page object for a specific element
+   * I.askForPageObject('home', null, '.detail');
+   * ```
+   *
+   * Asks for a page object based on the provided page name, locator, and extra prompt.
+   *
+   * @async
+   * @param {string} pageName - The name of the page to retrieve the object for.
+   * @param {string|null} [extraPrompt=null] - An optional extra prompt for additional context or information.
+   * @param {string|null} [locator=null] - An optional locator to find a specific element on the page.
+   * @returns {Promise<Object>} A promise that resolves to the requested page object.
+   */
+  async askForPageObject(pageName, extraPrompt = null, locator = null) {
+    const spinner = ora(' Processing AI request...').start()
+
+    try {
+      const html = locator ? await this.helper.grabHTMLFrom(locator) : await this.helper.grabSource()
+      await this.aiAssistant.setHtmlContext(html)
+      const response = await this.aiAssistant.generatePageObject(extraPrompt, locator)
+      spinner.stop()
+
+      if (!response[0]) {
+        output.error('No response from AI')
+        return ''
+      }
 
-    const response = await this.aiAssistant.createCompletion(messages);
+      const code = beautify(response[0])
 
-    console.log(response);
+      output.print('----- Generated PageObject ----')
+      output.print(code)
+      output.print('-------------------------------')
+
+      const fileName = path.join(output_dir, `${pageName}Page-${Date.now()}.js`)
+
+      output.print(output.styles.bold(`Page object for ${pageName} is saved to ${output.styles.bold(fileName)}`))
+      fs.writeFileSync(fileName, code)
+
+      try {
+        registerVariable('page', require(fileName))
+        output.success('Page object registered for this session as `page` variable')
+        output.print('Use `=>page.methodName()` in shell to run methods of page object')
+        output.print('Use `click(page.locatorName)` to check locators of page object')
+      } catch (err) {
+        output.error('Error while registering page object')
+        output.error(err.message)
+      }
+
+      return code
+    } catch (e) {
+      spinner.stop()
+      throw Error(`Something went wrong! ${e.message}`)
+    }
+  }
 
-    return response;
+  async _processAIRequest(messages) {
+    const spinner = ora(' Processing AI request...').start()
+    const response = await this.aiAssistant.createCompletion(messages)
+    spinner.stop()
+    return response
   }
 }
 
-export default AI;
+module.exports = AI

package/lib/helper/ApiDataFactory.js

@@ -1,6 +1,7 @@
-import path from 'path';
-import Helper from '@codeceptjs/helper';
-import REST from './REST';
+const path = require('path')
+
+const Helper = require('@codeceptjs/helper')
+const REST = require('./REST')
 
 /**
  * Helper for managing remote data using REST API.
@@ -183,67 +184,67 @@ import REST from './REST';
  */
 class ApiDataFactory extends Helper {
   constructor(config) {
-    super(config);
+    super(config)
 
     const defaultConfig = {
       cleanup: true,
       REST: {},
       factories: {},
       returnId: false,
-    };
-    this.config = Object.assign(defaultConfig, this.config);
+    }
+    this.config = Object.assign(defaultConfig, this.config)
 
-    if (this.config.headers) this.config.REST.defaultHeaders = this.config.headers;
-    if (this.config.onRequest) this.config.REST.onRequest = this.config.onRequest;
-    this.restHelper = new REST(Object.assign(this.config.REST, { endpoint: this.config.endpoint }));
-    this.factories = this.config.factories;
+    if (this.config.headers) this.config.REST.defaultHeaders = this.config.headers
+    if (this.config.onRequest) this.config.REST.onRequest = this.config.onRequest
+    this.restHelper = new REST(Object.assign(this.config.REST, { endpoint: this.config.endpoint }))
+    this.factories = this.config.factories
 
     for (const factory in this.factories) {
-      const factoryConfig = this.factories[factory];
+      const factoryConfig = this.factories[factory]
       if (!factoryConfig.uri && !factoryConfig.create) {
         throw new Error(`Uri for factory "${factory}" is not defined. Please set "uri" parameter:
 
           "factories": {
             "${factory}": {
             "uri": ...
-        `);
+        `)
       }
 
-      if (!factoryConfig.create) factoryConfig.create = { post: factoryConfig.uri };
-      if (!factoryConfig.delete) factoryConfig.delete = { delete: `${factoryConfig.uri}/{id}` };
+      if (!factoryConfig.create) factoryConfig.create = { post: factoryConfig.uri }
+      if (!factoryConfig.delete) factoryConfig.delete = { delete: `${factoryConfig.uri}/{id}` }
 
-      this.factories[factory] = factoryConfig;
+      this.factories[factory] = factoryConfig
     }
 
-    this.created = {};
-    Object.keys(this.factories).forEach(f => this.created[f] = []);
+    this.created = {}
+    Object.keys(this.factories).forEach((f) => (this.created[f] = []))
   }
 
   static _checkRequirements() {
     try {
-      require('axios');
-      require('rosie');
+      require('axios')
+      require('rosie')
     } catch (e) {
-      return ['axios', 'rosie'];
+      return ['axios', 'rosie']
     }
   }
 
   _after() {
     if (!this.config.cleanup || this.config.cleanup === false) {
-      return Promise.resolve();
+      return Promise.resolve()
     }
-    const promises = [];
+    const promises = []
 
     // clean up all created items
     for (const factoryName in this.created) {
-      const createdItems = this.created[factoryName];
-      if (!createdItems.length) continue;
-      this.debug(`Deleting ${createdItems.length} ${factoryName}(s)`);
+      const createdItems = this.created[factoryName]
+      if (!createdItems.length) continue
+      this.debug(`Deleting ${createdItems.length} ${factoryName}(s)`)
       for (const id in createdItems) {
-        promises.push(this._requestDelete(factoryName, createdItems[id]));
+        promises.push(this._requestDelete(factoryName, createdItems[id]))
       }
     }
-    return Promise.all(promises);
+    return Promise.all(promises)
   }
 
   /**
@@ -265,9 +266,9 @@ class ApiDataFactory extends Helper {
    * @returns {Promise<*>}
    */
   have(factory, params, options) {
-    const item = this._createItem(factory, params, options);
-    this.debug(`Creating ${factory} ${JSON.stringify(item)}`);
-    return this._requestCreate(factory, item);
+    const item = this._createItem(factory, params, options)
+    this.debug(`Creating ${factory} ${JSON.stringify(item)}`)
+    return this._requestCreate(factory, item)
   }
 
   /**
@@ -290,27 +291,27 @@ class ApiDataFactory extends Helper {
    * @param {*} [options]
    */
   haveMultiple(factory, times, params, options) {
-    const promises = [];
+    const promises = []
     for (let i = 0; i < times; i++) {
-      promises.push(this.have(factory, params, options));
+      promises.push(this.have(factory, params, options))
     }
-    return Promise.all(promises);
+    return Promise.all(promises)
   }
 
   _createItem(model, data, options) {
     if (!this.factories[model]) {
-      throw new Error(`Factory ${model} is not defined in config`);
+      throw new Error(`Factory ${model} is not defined in config`)
     }
-    let modulePath = this.factories[model].factory;
+    let modulePath = this.factories[model].factory
     try {
       try {
-        require.resolve(modulePath);
+        require.resolve(modulePath)
       } catch (e) {
-        modulePath = path.join(global.codecept_dir, modulePath);
+        modulePath = path.join(global.codecept_dir, modulePath)
       }
       // check if the new syntax `export default new Factory()` is used and loads the builder, otherwise loads the module that used old syntax `module.exports = new Factory()`.
-      const builder = require(modulePath).default || require(modulePath);
-      return builder.build(data, options);
+      const builder = require(modulePath).default || require(modulePath)
+      return builder.build(data, options)
     } catch (err) {
       throw new Error(`Couldn't load factory file from ${modulePath}, check that
 
@@ -321,17 +322,17 @@ class ApiDataFactory extends Helper {
 points to valid factory file.
 Factory file should export an object with build method.
 
-Current file error: ${err.message}`);
+Current file error: ${err.message}`)
     }
   }
 
   _fetchId(body, factory) {
     if (this.config.factories[factory].fetchId) {
-      return this.config.factories[factory].fetchId(body);
+      return this.config.factories[factory].fetchId(body)
     }
-    if (body.id) return body.id;
-    if (body[factory] && body[factory].id) return body[factory].id;
-    return null;
+    if (body.id) return body.id
+    if (body[factory] && body[factory].id) return body[factory].id
+    return null
   }
 
   /**
@@ -342,27 +343,27 @@ Current file error: ${err.message}`);
    * @param {*} data
    */
   _requestCreate(factory, data) {
-    let request = createRequestFromFunction(this.factories[factory].create, data);
+    let request = createRequestFromFunction(this.factories[factory].create, data)
 
     if (!request) {
-      const method = Object.keys(this.factories[factory].create)[0];
-      const url = this.factories[factory].create[method];
+      const method = Object.keys(this.factories[factory].create)[0]
+      const url = this.factories[factory].create[method]
       request = {
         method,
         url,
         data,
-      };
+      }
     }
 
-    request.baseURL = this.config.endpoint;
+    request.baseURL = this.config.endpoint
 
     return this.restHelper._executeRequest(request).then((resp) => {
-      const id = this._fetchId(resp.data, factory);
-      this.created[factory].push(id);
-      this.debugSection('Created', `Id: ${id}`);
-      if (this.config.returnId) return id;
-      return resp.data;
-    });
+      const id = this._fetchId(resp.data, factory)
+      this.created[factory].push(id)
+      this.debugSection('Created', `Id: ${id}`)
+      if (this.config.returnId) return id
+      return resp.data
+    })
   }
 
   /**
@@ -373,37 +374,40 @@ Current file error: ${err.message}`);
    * @param {*} id
    */
   _requestDelete(factory, id) {
-    if (!this.factories[factory].delete) return;
-    let request = createRequestFromFunction(this.factories[factory].delete, id);
+    if (!this.factories[factory].delete) return
+    let request = createRequestFromFunction(this.factories[factory].delete, id)
 
     if (!request) {
-      const method = Object.keys(this.factories[factory].delete)[0];
+      const method = Object.keys(this.factories[factory].delete)[0]
 
-      const url = this.factories[factory].delete[method].replace('{id}', id);
+      const url = this.factories[factory].delete[method].replace('{id}', id)
 
       request = {
         method,
         url,
-      };
+      }
     }
 
-    request.baseURL = this.config.endpoint;
+    request.baseURL = this.config.endpoint
 
     if (request.url.match(/^undefined/)) {
-      return this.debugSection('Please configure the delete request in your ApiDataFactory helper', 'delete: () => ({ method: \'DELETE\',  url: \'/api/users\' })');
+      return this.debugSection(
+        'Please configure the delete request in your ApiDataFactory helper',
+        "delete: () => ({ method: 'DELETE',  url: '/api/users' })",
+      )
     }
 
     return this.restHelper._executeRequest(request).then(() => {
-      const idx = this.created[factory].indexOf(id);
-      this.debugSection('Deleted Id', `Id: ${id}`);
-      this.created[factory].splice(idx, 1);
-    });
+      const idx = this.created[factory].indexOf(id)
+      this.debugSection('Deleted Id', `Id: ${id}`)
+      this.created[factory].splice(idx, 1)
+    })
   }
 }
 
-export default ApiDataFactory;
+module.exports = ApiDataFactory
 
 function createRequestFromFunction(param, data) {
-  if (typeof param !== 'function') return;
-  return param(data);
+  if (typeof param !== 'function') return
+  return param(data)
 }