codeceptjs 4.0.0-beta.3 → 4.0.0-beta.5

package/lib/helper/REST.js

@@ -205,10 +205,7 @@ class REST extends Helper {
 
     if (request.data instanceof Secret) {
       _debugRequest.data = '*****'
-      request.data =
-        typeof request.data === 'object' && !(request.data instanceof Secret)
-          ? { ...request.data.toString() }
-          : request.data.toString()
+      request.data = typeof request.data === 'object' && !(request.data instanceof Secret) ? { ...request.data.toString() } : request.data.toString()
     }
 
     if (typeof request.data === 'string') {
@@ -221,9 +218,7 @@ class REST extends Helper {
       await this.config.onRequest(request)
     }
 
-    this.options.prettyPrintJson
-      ? this.debugSection('Request', beautify(JSON.stringify(_debugRequest)))
-      : this.debugSection('Request', JSON.stringify(_debugRequest))
+    this.options.prettyPrintJson ? this.debugSection('Request', beautify(JSON.stringify(_debugRequest))) : this.debugSection('Request', JSON.stringify(_debugRequest))
 
     if (this.options.printCurl) {
       this.debugSection('CURL Request', curlize(request))
@@ -240,9 +235,7 @@ class REST extends Helper {
     if (this.config.onResponse) {
       await this.config.onResponse(response)
     }
-    this.options.prettyPrintJson
-      ? this.debugSection('Response', beautify(JSON.stringify(response.data)))
-      : this.debugSection('Response', JSON.stringify(response.data))
+    this.options.prettyPrintJson ? this.debugSection('Response', beautify(JSON.stringify(response.data))) : this.debugSection('Response', JSON.stringify(response.data))
     return response
   }
 
@@ -408,18 +401,37 @@ class REST extends Helper {
 
     return this._executeRequest(request)
   }
+
+  /**
+   * Sends DELETE request to API with payload.
+   *
+   * ```js
+   * I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' });
+   * ```
+   *
+   * @param {*} url
+   * @param {*} [payload={}] - the payload to be sent. By default it is sent as an empty object
+   * @param {object} [headers={}] - the headers object to be sent. By default, it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
+   */
+  async sendDeleteRequestWithPayload(url, payload = {}, headers = {}) {
+    const request = {
+      baseURL: this._url(url),
+      method: 'DELETE',
+      data: payload,
+      headers,
+    }
+
+    return this._executeRequest(request)
+  }
 }
 
 module.exports = REST
 
 function curlize(request) {
-  if (request.data?.constructor.name.toLowerCase() === 'formdata')
-    return 'cURL is not printed as the request body is not a JSON'
-  let curl =
-    `curl --location --request ${request.method ? request.method.toUpperCase() : 'GET'} ${request.baseURL} `.replace(
-      "'",
-      '',
-    )
+  if (request.data?.constructor.name.toLowerCase() === 'formdata') return 'cURL is not printed as the request body is not a JSON'
+  let curl = `curl --location --request ${request.method ? request.method.toUpperCase() : 'GET'} ${request.baseURL} `.replace("'", '')
 
   if (request.headers) {
     Object.entries(request.headers).forEach(([key, value]) => {

package/lib/helper/TestCafe.js

@@ -21,9 +21,8 @@ const Locator = require('../locator')
 /**
  * Client Functions
  */
-const getPageUrl = (t) => ClientFunction(() => document.location.href).with({ boundTestRun: t })
-const getHtmlSource = (t) =>
-  ClientFunction(() => document.getElementsByTagName('html')[0].innerHTML).with({ boundTestRun: t })
+const getPageUrl = t => ClientFunction(() => document.location.href).with({ boundTestRun: t })
+const getHtmlSource = t => ClientFunction(() => document.getElementsByTagName('html')[0].innerHTML).with({ boundTestRun: t })
 
 /**
  * Uses [TestCafe](https://github.com/DevExpress/testcafe) library to run cross-browser tests.
@@ -187,7 +186,7 @@ class TestCafe extends Helper {
         assertionTimeout: this.options.waitForTimeout,
         takeScreenshotsOnFails: true,
       })
-      .catch((err) => {
+      .catch(err => {
         this.debugSection('_before', `Error ${err.toString()}`)
         this.isRunning = false
         this.testcafe.close()
@@ -208,7 +207,7 @@ class TestCafe extends Helper {
           skipJsErrors: true,
           skipUncaughtErrors: true,
         })
-        .catch((err) => {
+        .catch(err => {
           this.debugSection('_before', `Error ${err.toString()}`)
           this.isRunning = false
           this.testcafe.close()
@@ -260,7 +259,7 @@ class TestCafe extends Helper {
       await this.clearCookie()
 
       // TODO IMHO that should only happen when
-      await this.executeScript(() => localStorage.clear()).catch((err) => {
+      await this.executeScript(() => localStorage.clear()).catch(err => {
         if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err
       })
     }
@@ -383,7 +382,6 @@ class TestCafe extends Helper {
    * {{> refreshPage }}
    */
   async refreshPage() {
-    // eslint-disable-next-line no-restricted-globals
     return this.t.eval(() => location.reload(true), { boundTestRun: this.t }).catch(mapError)
   }
 
@@ -394,9 +392,7 @@ class TestCafe extends Helper {
   async waitForVisible(locator, sec) {
     const timeout = sec ? sec * 1000 : undefined
 
-    return (await findElements.call(this, this.context, locator))
-      .with({ visibilityCheck: true, timeout })()
-      .catch(mapError)
+    return (await findElements.call(this, this.context, locator)).with({ visibilityCheck: true, timeout })().catch(mapError)
   }
 
   /**
@@ -565,7 +561,6 @@ class TestCafe extends Helper {
           await this.t.click(optEl).catch(mapError)
           continue
         }
-        // eslint-disable-next-line no-empty
       } catch (err) {}
 
       try {
@@ -574,7 +569,6 @@ class TestCafe extends Helper {
         if (await optEl.count) {
           await this.t.click(optEl).catch(mapError)
         }
-        // eslint-disable-next-line no-empty
       } catch (err) {}
     }
   }
@@ -634,10 +628,7 @@ class TestCafe extends Helper {
       els = (await findElements.call(this, this.context, 'body')).withText(text)
     }
 
-    return this.t
-      .expect(els.filterVisible().count)
-      .eql(0, `Element with text "${text}" can still be seen`)
-      .catch(mapError)
+    return this.t.expect(els.filterVisible().count).eql(0, `Element with text "${text}" can still be seen`).catch(mapError)
   }
 
   /**
@@ -789,7 +780,7 @@ class TestCafe extends Helper {
    * {{> wait }}
    */
   async wait(sec) {
-    return new Promise((done) => {
+    return new Promise(done => {
       setTimeout(done, sec * 1000)
     })
   }
@@ -938,10 +929,7 @@ class TestCafe extends Helper {
     return ClientFunction(() => {
       const body = document.body
       const html = document.documentElement
-      window.scrollTo(
-        0,
-        Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight),
-      )
+      window.scrollTo(0, Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight))
     })
       .with({ boundTestRun: this.t })()
       .catch(mapError)
@@ -957,7 +945,7 @@ class TestCafe extends Helper {
       locator = null
     }
 
-    const scrollBy = ClientFunction((offset) => {
+    const scrollBy = ClientFunction(offset => {
       if (window && window.scrollBy && offset) {
         window.scrollBy(offset.x, offset.y)
       }
@@ -1042,14 +1030,13 @@ class TestCafe extends Helper {
   async grabCookie(name) {
     if (!name) {
       const getCookie = ClientFunction(() => {
-        return document.cookie.split(';').map((c) => c.split('='))
+        return document.cookie.split(';').map(c => c.split('='))
       }).with({ boundTestRun: this.t })
       const cookies = await getCookie()
-      return cookies.map((cookie) => ({ name: cookie[0].trim(), value: cookie[1] }))
+      return cookies.map(cookie => ({ name: cookie[0].trim(), value: cookie[1] }))
     }
     const getCookie = ClientFunction(
       () => {
-        // eslint-disable-next-line prefer-template
         const v = document.cookie.match('(^|;) ?' + name + '=([^;]*)(;|$)')
         return v ? v[2] : null
       },
@@ -1089,7 +1076,7 @@ class TestCafe extends Helper {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
 
     const clientFn = createClientFunction(
-      (urlPart) => {
+      urlPart => {
         const currUrl = decodeURIComponent(decodeURIComponent(decodeURIComponent(window.location.href)))
         return currUrl.indexOf(urlPart) > -1
       },
@@ -1114,7 +1101,7 @@ class TestCafe extends Helper {
     }
 
     const clientFn = createClientFunction(
-      (urlPart) => {
+      urlPart => {
         const currUrl = decodeURIComponent(decodeURIComponent(decodeURIComponent(window.location.href)))
         return currUrl === urlPart
       },
@@ -1175,9 +1162,7 @@ class TestCafe extends Helper {
   async waitToHide(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
 
-    return this.t
-      .expect(createSelector(locator).filterHidden().with({ boundTestRun: this.t }).exists)
-      .notOk({ timeout: waitTimeout })
+    return this.t.expect(createSelector(locator).filterHidden().with({ boundTestRun: this.t }).exists).notOk({ timeout: waitTimeout })
   }
 
   /**
@@ -1186,9 +1171,7 @@ class TestCafe extends Helper {
   async waitForInvisible(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
 
-    return this.t
-      .expect(createSelector(locator).filterVisible().with({ boundTestRun: this.t }).exists)
-      .ok({ timeout: waitTimeout })
+    return this.t.expect(createSelector(locator).filterVisible().with({ boundTestRun: this.t }).exists).ok({ timeout: waitTimeout })
   }
 
   /**
@@ -1215,17 +1198,16 @@ class TestCafe extends Helper {
 
 async function waitForFunction(browserFn, waitTimeout) {
   const pause = () =>
-    new Promise((done) => {
+    new Promise(done => {
       setTimeout(done, 50)
     })
 
   const start = Date.now()
-  // eslint-disable-next-line no-constant-condition
+
   while (true) {
     let result
     try {
       result = await browserFn()
-      // eslint-disable-next-line no-empty
     } catch (err) {
       throw new Error(`Error running function ${err.toString()}`)
     }
@@ -1240,13 +1222,13 @@ async function waitForFunction(browserFn, waitTimeout) {
   }
 }
 
-const createSelector = (locator) => {
+const createSelector = locator => {
   locator = new Locator(locator, 'css')
   if (locator.isXPath()) return elementByXPath(locator.value)
   return Selector(locator.simplify())
 }
 
-const elementByXPath = (xpath) => {
+const elementByXPath = xpath => {
   assert(xpath, 'xpath is required')
 
   return Selector(
@@ -1279,9 +1261,7 @@ async function findElements(matcher, locator) {
   locator = new Locator(locator, 'css')
 
   if (!locator.isXPath()) {
-    return matcher
-      ? matcher.find(locator.simplify())
-      : Selector(locator.simplify()).with({ timeout: 0, boundTestRun: this.t })
+    return matcher ? matcher.find(locator.simplify()) : Selector(locator.simplify()).with({ timeout: 0, boundTestRun: this.t })
   }
 
   if (!matcher) return elementByXPath(locator.value).with({ timeout: 0, boundTestRun: this.t })
@@ -1310,12 +1290,7 @@ async function proceedClick(locator, context = null) {
 
   const els = await findClickable.call(this, matcher, locator)
   if (context) {
-    await assertElementExists(
-      els,
-      locator,
-      'Clickable element',
-      `was not found inside element ${new Locator(context).toString()}`,
-    )
+    await assertElementExists(els, locator, 'Clickable element', `was not found inside element ${new Locator(context).toString()}`)
   } else {
     await assertElementExists(els, locator, 'Clickable element')
   }