codeceptjs 4.0.0-rc.2 → 4.0.0-rc.20

package/lib/helper/Puppeteer.js

@@ -8,6 +8,7 @@ import promiseRetry from 'promise-retry'
 import Locator from '../locator.js'
 import recorder from '../recorder.js'
 import store from '../store.js'
+import { checkFocusBeforeType, checkFocusBeforePressKey } from './extras/focusCheck.js'
 import { includes as stringIncludes } from '../assert/include.js'
 import { urlEquals, equals } from '../assert/equal.js'
 import { empty } from '../assert/empty.js'
@@ -26,17 +27,25 @@ import {
   isModifierKey,
   requireWithFallback,
   normalizeSpacesInString,
+  normalizePath,
+  resolveUrl,
+  getMimeType,
+  base64EncodeFile,
 } from '../utils.js'
 import { isColorProperty, convertColorToRGBA } from '../colorUtils.js'
 import ElementNotFound from './errors/ElementNotFound.js'
+import MultipleElementsFound from './errors/MultipleElementsFound.js'
 import RemoteBrowserConnectionRefused from './errors/RemoteBrowserConnectionRefused.js'
 import Popup from './extras/Popup.js'
 import Console from './extras/Console.js'
 import { highlightElement } from './scripts/highlightElement.js'
 import { blurElement } from './scripts/blurElement.js'
+import { dropFile } from './scripts/dropFile.js'
 import { dontSeeElementError, seeElementError, dontSeeElementInDOMError, seeElementInDOMError } from './errors/ElementAssertion.js'
 import { dontSeeTraffic, seeTraffic, grabRecordedNetworkTraffics, stopRecordingTraffic, flushNetworkTraffics } from './network/actions.js'
 import WebElement from '../element/WebElement.js'
+import { selectElement } from './extras/elementSelection.js'
+import { fillRichEditor } from './extras/richTextEditor.js'
 
 let puppeteer
 
@@ -266,6 +275,7 @@ class Puppeteer extends Helper {
       show: false,
       defaultPopupAction: 'accept',
       highlightElement: false,
+      strict: false,
     }
 
     return Object.assign(defaults, config)
@@ -743,7 +753,7 @@ class Puppeteer extends Helper {
     }
 
     if (this.options.trace) {
-      const fileName = `${`${global.output_dir}${path.sep}trace${path.sep}${uuidv4()}_${clearString(this.currentRunningTest.title)}`.slice(0, 245)}.json`
+      const fileName = `${`${store.outputDir}${path.sep}trace${path.sep}${uuidv4()}_${clearString(this.currentRunningTest.title)}`.slice(0, 245)}.json`
       const dir = path.dirname(fileName)
       if (!fileExists(dir)) fs.mkdirSync(dir)
       await this.page.tracing.start({ screenshots: true, path: fileName })
@@ -814,9 +824,26 @@ class Puppeteer extends Helper {
    * {{ react }}
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
-    const el = await this._locateElement(locator)
-    if (!el) {
-      throw new ElementNotFound(locator, 'Element to move cursor to')
+    let context = null
+    if (typeof offsetX !== 'number') {
+      context = offsetX
+      offsetX = 0
+    }
+
+    let el
+    if (context) {
+      const contextEls = await findElements.call(this, this.page, context)
+      assertElementExists(contextEls, context, 'Context element')
+      const els = await findElements.call(this, contextEls[0], locator)
+      if (!els || els.length === 0) {
+        throw new ElementNotFound(locator, 'Element to move cursor to')
+      }
+      el = els[0]
+    } else {
+      el = await this._locateElement(locator)
+      if (!el) {
+        throw new ElementNotFound(locator, 'Element to move cursor to')
+      }
     }
 
     // Use manual mouse.move instead of .hover() so the offset can be added to the coordinates
@@ -984,6 +1011,14 @@ class Puppeteer extends Helper {
    */
   async _locateElement(locator) {
     const context = await this.context
+    const elementIndex = store.currentStep?.opts?.elementIndex
+    if (this.options.strict || elementIndex) {
+      const elements = await findElements.call(this, context, locator)
+      if (elements.length === 0) {
+        throw new ElementNotFound(locator, 'Element', 'was not found')
+      }
+      return selectElement(elements, locator, this)
+    }
     return findElement.call(this, context, locator)
   }
 
@@ -1001,7 +1036,7 @@ class Puppeteer extends Helper {
     if (!els || els.length === 0) {
       throw new ElementNotFound(locator, 'Checkbox or radio')
     }
-    return els[0]
+    return selectElement(els, locator, this)
   }
 
   /**
@@ -1158,8 +1193,16 @@ class Puppeteer extends Helper {
    * {{> seeElement }}
    * {{ react }}
    */
-  async seeElement(locator) {
-    let els = await this._locate(locator)
+  async seeElement(locator, context = null) {
+    let els
+    if (context) {
+      const contextPage = await this.context
+      const contextEls = await findElements.call(this, contextPage, context)
+      assertElementExists(contextEls, context, 'Context element')
+      els = await findElements.call(this, contextEls[0], locator)
+    } else {
+      els = await this._locate(locator)
+    }
     els = (await Promise.all(els.map(el => el.boundingBox() && el))).filter(v => v)
     // Puppeteer visibility was ignored? | Remove when Puppeteer is fixed
     els = await Promise.all(els.map(async el => (await el.evaluate(node => window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none')) && el))
@@ -1174,8 +1217,16 @@ class Puppeteer extends Helper {
    * {{> dontSeeElement }}
    * {{ react }}
    */
-  async dontSeeElement(locator) {
-    let els = await this._locate(locator)
+  async dontSeeElement(locator, context = null) {
+    let els
+    if (context) {
+      const contextPage = await this.context
+      const contextEls = await findElements.call(this, contextPage, context)
+      assertElementExists(contextEls, context, 'Context element')
+      els = await findElements.call(this, contextEls[0], locator)
+    } else {
+      els = await this._locate(locator)
+    }
     els = (await Promise.all(els.map(el => el.boundingBox() && el))).filter(v => v)
     // Puppeteer visibility was ignored? | Remove when Puppeteer is fixed
     els = await Promise.all(els.map(async el => (await el.evaluate(node => window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none')) && el))
@@ -1276,7 +1327,7 @@ class Puppeteer extends Helper {
    * @param {string} [downloadPath='downloads'] change this parameter to set another directory for saving
    */
   async handleDownloads(downloadPath = 'downloads') {
-    downloadPath = path.join(global.output_dir, downloadPath)
+    downloadPath = path.join(store.outputDir, downloadPath)
     if (!fs.existsSync(downloadPath)) {
       fs.mkdirSync(downloadPath, '0777')
     }
@@ -1338,7 +1389,7 @@ class Puppeteer extends Helper {
       },
     })
 
-    const outputFile = path.join(`${global.output_dir}/${fileName}`)
+    const outputFile = path.join(`${store.outputDir}/${fileName}`)
 
     try {
       await new Promise((resolve, reject) => {
@@ -1498,6 +1549,7 @@ class Puppeteer extends Helper {
    * {{> pressKeyWithKeyNormalization }}
    */
   async pressKey(key) {
+    await checkFocusBeforePressKey(this, key)
     const modifiers = []
     if (Array.isArray(key)) {
       for (let k of key) {
@@ -1526,6 +1578,8 @@ class Puppeteer extends Helper {
    * {{> type }}
    */
   async type(keys, delay = null) {
+    await checkFocusBeforeType(this)
+
     if (!Array.isArray(keys)) {
       keys = keys.toString()
       keys = keys.split('')
@@ -1541,10 +1595,19 @@ class Puppeteer extends Helper {
    * {{> fillField }}
    * {{ react }}
    */
-  async fillField(field, value) {
-    const els = await findVisibleFields.call(this, field)
+  async fillField(field, value, context = null) {
+    let els = await findVisibleFields.call(this, field, context)
+    if (!els.length) {
+      els = await findFields.call(this, field, context)
+    }
     assertElementExists(els, field, 'Field')
-    const el = els[0]
+    const el = selectElement(els, field, this)
+
+    if (await fillRichEditor(this, el, value)) {
+      highlightActiveElement.call(this, el, await this._getContext())
+      return this._waitForAction()
+    }
+
     const tag = await el.getProperty('tagName').then(el => el.jsonValue())
     const editable = await el.getProperty('contenteditable').then(el => el.jsonValue())
     if (tag === 'INPUT' || tag === 'TEXTAREA') {
@@ -1562,8 +1625,8 @@ class Puppeteer extends Helper {
   /**
    * {{> clearField }}
    */
-  async clearField(field) {
-    return this.fillField(field, '')
+  async clearField(field, context = null) {
+    return this.fillField(field, '', context)
   }
 
   /**
@@ -1571,29 +1634,30 @@ class Puppeteer extends Helper {
    *
    * {{ react }}
    */
-  async appendField(field, value) {
-    const els = await findVisibleFields.call(this, field)
+  async appendField(field, value, context = null) {
+    const els = await findVisibleFields.call(this, field, context)
     assertElementExists(els, field, 'Field')
-    highlightActiveElement.call(this, els[0], await this._getContext())
-    await els[0].press('End')
-    await els[0].type(value.toString(), { delay: this.options.pressKeyDelay })
+    const el = selectElement(els, field, this)
+    highlightActiveElement.call(this, el, await this._getContext())
+    await el.press('End')
+    await el.type(value.toString(), { delay: this.options.pressKeyDelay })
     return this._waitForAction()
   }
 
   /**
    * {{> seeInField }}
    */
-  async seeInField(field, value) {
+  async seeInField(field, value, context = null) {
     const _value = typeof value === 'boolean' ? value : value.toString()
-    return proceedSeeInField.call(this, 'assert', field, _value)
+    return proceedSeeInField.call(this, 'assert', field, _value, context)
   }
 
   /**
    * {{> dontSeeInField }}
    */
-  async dontSeeInField(field, value) {
+  async dontSeeInField(field, value, context = null) {
     const _value = typeof value === 'boolean' ? value : value.toString()
-    return proceedSeeInField.call(this, 'negate', field, _value)
+    return proceedSeeInField.call(this, 'negate', field, _value, context)
   }
 
   /**
@@ -1601,46 +1665,71 @@ class Puppeteer extends Helper {
    *
    * {{> attachFile }}
    */
-  async attachFile(locator, pathToFile) {
-    const file = path.join(global.codecept_dir, pathToFile)
+  async attachFile(locator, pathToFile, context = null) {
+    const file = path.join(store.codeceptDir, pathToFile)
 
     if (!fileExists(file)) {
       throw new Error(`File at ${file} can not be found on local system`)
     }
-    const els = await findFields.call(this, locator)
-    assertElementExists(els, locator, 'Field')
-    await els[0].uploadFile(file)
+    const els = await findFields.call(this, locator, context)
+    if (els.length) {
+      const el = selectElement(els, locator, this)
+      const tag = await el.evaluate(el => el.tagName)
+      const type = await el.evaluate(el => el.type)
+      if (tag === 'INPUT' && type === 'file') {
+        await el.uploadFile(file)
+        return this._waitForAction()
+      }
+    }
+
+    const targetEls = els.length ? els : await this._locate(locator)
+    assertElementExists(targetEls, locator, 'Element')
+    const el = selectElement(targetEls, locator, this)
+    const fileData = {
+      base64Content: base64EncodeFile(file),
+      fileName: path.basename(file),
+      mimeType: getMimeType(path.basename(file)),
+    }
+    await el.evaluate(dropFile, fileData)
     return this._waitForAction()
   }
 
   /**
    * {{> selectOption }}
    */
-  async selectOption(select, option) {
-    const context = await this._getContext()
+  async selectOption(select, option, context = null) {
+    const pageContext = await this._getContext()
     const matchedLocator = new Locator(select)
 
+    let contextEl
+    if (context) {
+      const contextEls = await findElements.call(this, pageContext, context)
+      assertElementExists(contextEls, context, 'Context element')
+      contextEl = contextEls[0]
+    }
+
     // Strict locator
     if (!matchedLocator.isFuzzy()) {
       this.debugSection('SelectOption', `Strict: ${JSON.stringify(select)}`)
-      const els = await this._locate(select)
+      const els = contextEl ? await findElements.call(this, contextEl, select) : await this._locate(select)
       assertElementExists(els, select, 'Selectable element')
-      return proceedSelect.call(this, context, els[0], option)
+      return proceedSelect.call(this, pageContext, selectElement(els, select, this), option)
     }
 
     // Fuzzy: try combobox
     this.debugSection('SelectOption', `Fuzzy: "${matchedLocator.value}"`)
-    let els = await findByRole(context, { role: 'combobox', name: matchedLocator.value })
-    if (els?.length) return proceedSelect.call(this, context, els[0], option)
+    const comboboxSearchCtx = contextEl || pageContext
+    let els = await findByRole(comboboxSearchCtx, { role: 'combobox', name: matchedLocator.value })
+    if (els?.length) return proceedSelect.call(this, pageContext, selectElement(els, select, this), option)
 
     // Fuzzy: try listbox
-    els = await findByRole(context, { role: 'listbox', name: matchedLocator.value })
-    if (els?.length) return proceedSelect.call(this, context, els[0], option)
+    els = await findByRole(comboboxSearchCtx, { role: 'listbox', name: matchedLocator.value })
+    if (els?.length) return proceedSelect.call(this, pageContext, selectElement(els, select, this), option)
 
     // Fuzzy: try native select
-    const visibleEls = await findVisibleFields.call(this, select)
+    const visibleEls = await findVisibleFields.call(this, select, context)
     assertElementExists(visibleEls, select, 'Selectable field')
-    return proceedSelect.call(this, context, visibleEls[0], option)
+    return proceedSelect.call(this, pageContext, selectElement(visibleEls, select, this), option)
   }
 
   /**
@@ -1691,7 +1780,7 @@ class Puppeteer extends Helper {
     const currentUrl = await this._getPageUrl()
     const baseUrl = this.options.url || 'http://localhost'
     const actualPath = new URL(currentUrl, baseUrl).pathname
-    return equals('url path').assert(path, actualPath)
+    return equals('url path').assert(normalizePath(path), normalizePath(actualPath))
   }
 
   /**
@@ -1701,7 +1790,7 @@ class Puppeteer extends Helper {
     const currentUrl = await this._getPageUrl()
     const baseUrl = this.options.url || 'http://localhost'
     const actualPath = new URL(currentUrl, baseUrl).pathname
-    return equals('url path').negate(path, actualPath)
+    return equals('url path').negate(normalizePath(path), normalizePath(actualPath))
   }
 
   /**
@@ -2441,6 +2530,7 @@ class Puppeteer extends Helper {
    */
   async waitInUrl(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
+    const expectedUrl = resolveUrl(urlPart, this.options.url)
 
     return this.page
       .waitForFunction(
@@ -2449,12 +2539,12 @@ class Puppeteer extends Helper {
           return currUrl.indexOf(urlPart) > -1
         },
         { timeout: waitTimeout },
-        urlPart,
+        expectedUrl,
       )
       .catch(async e => {
-        const currUrl = await this._getPageUrl() // Required because the waitForFunction can't return data.
+        const currUrl = await this._getPageUrl()
         if (/Waiting failed:/i.test(e.message) || /failed: timeout/i.test(e.message)) {
-          throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`)
+          throw new Error(`expected url to include ${expectedUrl}, but found ${currUrl}`)
         } else {
           throw e
         }
@@ -2466,18 +2556,13 @@ class Puppeteer extends Helper {
    */
   async waitUrlEquals(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
-
-    const baseUrl = this.options.url
-    let expectedUrl = urlPart
-    if (urlPart.indexOf('http') < 0) {
-      expectedUrl = baseUrl + urlPart
-    }
+    const expectedUrl = resolveUrl(urlPart, this.options.url)
 
     return this.page
       .waitForFunction(
         url => {
           const currUrl = decodeURIComponent(window.location.href)
-          return currUrl.indexOf(url) > -1
+          return currUrl === url
         },
         { timeout: waitTimeout },
         expectedUrl,
@@ -2485,11 +2570,36 @@ class Puppeteer extends Helper {
       .catch(async e => {
         const currUrl = await this._getPageUrl()
         if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
-          if (!currUrl.includes(expectedUrl)) {
-            throw new Error(`expected url to be ${expectedUrl}, but found ${currUrl}`)
-          } else {
-            throw new Error(`expected url not loaded, error message: ${e.message}`)
-          }
+          throw new Error(`expected url to be ${expectedUrl}, but found ${currUrl}`)
+        } else {
+          throw e
+        }
+      })
+  }
+
+  /**
+   * {{> waitCurrentPathEquals }}
+   */
+  async waitCurrentPathEquals(path, sec = null) {
+    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
+    const normalizedPath = normalizePath(path)
+
+    return this.page
+      .waitForFunction(
+        expectedPath => {
+          const actualPath = window.location.pathname
+          const normalizePath = p => (p === '' || p === '/' ? '/' : p.replace(/\/+/g, '/').replace(/\/$/, '') || '/')
+          return normalizePath(actualPath) === expectedPath
+        },
+        { timeout: waitTimeout },
+        normalizedPath,
+      )
+      .catch(async e => {
+        const currUrl = await this._getPageUrl()
+        const baseUrl = this.options.url || 'http://localhost'
+        const actualPath = new URL(currUrl, baseUrl).pathname
+        if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
+          throw new Error(`expected path to be ${normalizedPath}, but found ${normalizePath(actualPath)}`)
         } else {
           throw e
         }
@@ -3026,10 +3136,11 @@ async function proceedClick(locator, context = null, options = {}) {
   } else {
     assertElementExists(els, locator, 'Clickable element')
   }
+  const el = selectElement(els, locator, this)
 
-  highlightActiveElement.call(this, els[0], await this._getContext())
+  highlightActiveElement.call(this, el, await this._getContext())
 
-  await els[0].click(options)
+  await el.click(options)
   const promises = []
   if (options.waitForNavigation) {
     promises.push(this.waitForNavigation())
@@ -3160,43 +3271,57 @@ async function proceedIsChecked(assertType, option) {
   return truth(`checkable ${option}`, 'to be checked')[assertType](selected)
 }
 
-async function findVisibleFields(locator) {
-  const els = await findFields.call(this, locator)
+async function findVisibleFields(locator, context = null) {
+  const els = await findFields.call(this, locator, context)
   const visible = await Promise.all(els.map(el => el.boundingBox()))
   return els.filter((el, index) => visible[index])
 }
 
-async function findFields(locator) {
+async function findFields(locator, context = null) {
+  let contextEl
+  if (context) {
+    const contextPage = await this.context
+    const contextEls = await findElements.call(this, contextPage, context)
+    assertElementExists(contextEls, context, 'Context element')
+    contextEl = contextEls[0]
+  }
+
+  const locateFn = contextEl
+    ? loc => findElements.call(this, contextEl, loc)
+    : loc => this._locate(loc)
+
   const matchedLocator = new Locator(locator)
   if (!matchedLocator.isFuzzy()) {
-    return this._locate(matchedLocator)
+    return locateFn(matchedLocator)
   }
   const literal = xpathLocator.literal(matchedLocator.value)
 
-  let els = await this._locate({ xpath: Locator.field.labelEquals(literal) })
+  let els = await locateFn({ xpath: Locator.field.labelEquals(literal) })
   if (els.length) {
     return els
   }
 
-  els = await this._locate({ xpath: Locator.field.labelContains(literal) })
+  els = await locateFn({ xpath: Locator.field.labelContains(literal) })
   if (els.length) {
     return els
   }
-  els = await this._locate({ xpath: Locator.field.byName(literal) })
+  els = await locateFn({ xpath: Locator.field.byName(literal) })
   if (els.length) {
     return els
   }
 
   // Try ARIA selector for accessible name
-  try {
-    const page = await this.context
-    els = await page.$$(`::-p-aria(${matchedLocator.value})`)
-    if (els.length) return els
-  } catch (err) {
-    // ARIA selector not supported or failed
+  if (!contextEl) {
+    try {
+      const page = await this.context
+      els = await page.$$(`::-p-aria(${matchedLocator.value})`)
+      if (els.length) return els
+    } catch (err) {
+      // ARIA selector not supported or failed
+    }
   }
 
-  return this._locate({ css: matchedLocator.value })
+  return locateFn({ css: matchedLocator.value })
 }
 
 async function proceedDragAndDrop(sourceLocator, destinationLocator) {
@@ -3225,8 +3350,8 @@ async function proceedDragAndDrop(sourceLocator, destinationLocator) {
   await this._waitForAction()
 }
 
-async function proceedSeeInField(assertType, field, value) {
-  const els = await findVisibleFields.call(this, field)
+async function proceedSeeInField(assertType, field, value, context) {
+  const els = await findVisibleFields.call(this, field, context)
   assertElementExists(els, field, 'Field')
   const el = els[0]
   const tag = await el.getProperty('tagName').then(el => el.jsonValue())
@@ -3339,6 +3464,13 @@ function assertElementExists(res, locator, prefix, suffix) {
   }
 }
 
+function assertOnlyOneElement(elements, locator, helper) {
+  if (elements.length > 1) {
+    const webElements = elements.map(el => new WebElement(el, helper))
+    throw new MultipleElementsFound(locator, webElements)
+  }
+}
+
 function $XPath(element, selector) {
   const found = document.evaluate(selector, element || document.body, null, 5, null)
   const res = []
@@ -3446,7 +3578,7 @@ function getNormalizedKey(key) {
 }
 
 function highlightActiveElement(element, context) {
-  if (this.options.highlightElement && global.debugMode) {
+  if (this.options.highlightElement && store.debugMode) {
     highlightElement(element, context)
   }
 }