How to use getTestFromRunnable method in Cypress

...731    onRunnableRun (runnableRun, runnable, args) {732      // extract out the next(fn) which mocha uses to733      // move to the next runnable - this will be our async seam734      const _next = args[0]735      const test = getTest() || getTestFromRunnable(runnable)736      // if there's no test, this is likely a rouge before/after hook737      // that should not have run, so skip this runnable738      if (!test) {739        return _next()740      }741      // closure for calculating the actual742      // runtime of a runnables fn exection duration743      // and also the run of the runnable:after:run:async event744      let lifecycleStart745      let wallClockStartedAt = null746      let wallClockEnd = null747      let fnDurationStart = null748      let fnDurationEnd = null749      let afterFnDurationStart = null...

...696        if (previousDomainVisited && (remote.originPolicy !== existing.originPolicy)) {697          // if we've already visited a new superDomain698          // then die else we'd be in a terrible endless loop699          // we also need to disable retries to prevent the endless loop700          $utils.getTestFromRunnable(state('runnable'))._retries = 0701          return cannotVisitDifferentOrigin(remote.origin, previousDomainVisited, remote, existing, options._log)702        }703        const current = $Location.create(win.location.href)704        // if all that is changing is the hash then we know705        // the browser won't actually make a new http request706        // for this, and so we need to resolve onLoad immediately707        // and bypass the actual visit resolution stuff708        if (bothUrlsMatchAndRemoteHasHash(current, remote)) {709          // https://github.com/cypress-io/cypress/issues/1311710          if (current.hash === remote.hash) {711            consoleProps['Note'] = 'Because this visit was to the same hash, the page did not reload and the onBeforeLoad and onLoad callbacks did not fire.'712            return onLoad({ runOnLoadCallback: false })713          }714          return changeIframeSrc(remote.href, 'hashchange')...

...140  const getTestAttemptFromRunnable = (runnable) => {141    if (!runnable) {142      return143    }144    const t = $utils.getTestFromRunnable(runnable)145    return t._currentRetry || 0146  }147  return _.defaults(obj, {148    id: (counter += 1),149    state: 'pending',150    instrument: 'command',151    url: state('url'),152    hookId: state('hookId'),153    testId: runnable ? runnable.id : undefined,154    testCurrentRetry: getTestAttemptFromRunnable(state('runnable')),155    viewportWidth: state('viewportWidth'),156    viewportHeight: state('viewportHeight'),157    referencesAlias: undefined,158    alias: undefined,...

...211          numRetries: args[0] ?? 2,212        },213      })214      // so this error doesn't cause a retry215      getTestFromRunnable(this)._retries = -1216      throw err217    }218    return hookRetries.apply(this, args)219  }220}221// matching the current Runner.prototype.fail except222// changing the logic for determing whether this is a valid err223const patchRunnerFail = () => {224  Runner.prototype.fail = function (runnable, err) {225    const errMessage = _.get(err, 'message')226    if (errMessage && errMessage.indexOf('Resolution method is overspecified') > -1) {227      err.message = $errUtils.errByPath('mocha.overspecified', { error: err.stack }).message228    }229    // if this isnt a correct error object then just bail...

...41  const props = _.extend({42    titles,43    testId: runnable.id,44    takenPaths: state('screenshotPaths'),45    testAttemptIndex: $utils.getTestFromRunnable(runnable)._currentRetry,46  }, _.omit(options, 'runnable', 'timeout', 'log', 'subject'))47  const automate = () => {48    return Cypress.automation('take:screenshot', props)49  }50  if (!timeout) {51    return automate()52  }53  // need to remove the current timeout54  // because we're handling timeouts ourselves55  cy.clearTimeout('take:screenshot')56  return automate()57  .timeout(timeout)58  .catch((err) => {59    return $errUtils.throwErr(err, { onFail: options.log })60  })61  .catch(Promise.TimeoutError, () => {62    return $errUtils.throwErrByPath('screenshot.timed_out', {63      onFail: options.log,64      args: { timeout },65    })66  })67}68const scrollOverrides = (win, doc) => {69  const originalOverflow = doc.documentElement.style.overflow70  const originalBodyOverflowY = doc.body.style.overflowY71  const originalX = win.scrollX72  const originalY = win.scrollY73  // overflow-y: scroll can break `window.scrollTo`74  if (doc.body) {75    doc.body.style.overflowY = 'visible'76  }77  // hide scrollbars78  doc.documentElement.style.overflow = 'hidden'79  // in the case that an element might change size on scroll80  // we trigger a scroll event to ensure that all elements are81  // at their final size before we calculate the total height82  // since we scroll down the page in takeScrollingScreenshots83  // and don't want the page size to change once we start84  // https://github.com/cypress-io/cypress/issues/609985  win.dispatchEvent(new win.Event('scroll'))86  return () => {87    doc.documentElement.style.overflow = originalOverflow88    if (doc.body) {89      doc.body.style.overflowY = originalBodyOverflowY90    }91    return win.scrollTo(originalX, originalY)92  }93}94const validateNumScreenshots = (numScreenshots, automationOptions) => {95  if (numScreenshots < 1) {96    $errUtils.throwErrByPath('screenshot.invalid_height', {97      log: automationOptions.log,98    })99  }100}101const takeScrollingScreenshots = (scrolls, win, state, automationOptions) => {102  const scrollAndTake = ({ y, clip, afterScroll }, index) => {103    win.scrollTo(0, y)104    if (afterScroll) {105      clip = afterScroll()106    }107    const options = _.extend({}, automationOptions, {108      current: index + 1,109      total: scrolls.length,110      clip,111    })112    return automateScreenshot(state, options)113  }114  return Promise115  .mapSeries(scrolls, scrollAndTake)116  .then(_.last)117}118const takeFullPageScreenshot = (state, automationOptions) => {119  const win = state('window')120  const doc = state('document')121  const resetScrollOverrides = scrollOverrides(win, doc)122  const docHeight = $(doc).height()123  const viewportHeight = getViewportHeight(state)124  const numScreenshots = Math.ceil(docHeight / viewportHeight)125  validateNumScreenshots(numScreenshots, automationOptions)126  const scrolls = _.map(_.times(numScreenshots), (index) => {127    const y = viewportHeight * index128    let clip129    if ((index + 1) === numScreenshots) {130      const heightLeft = docHeight - (viewportHeight * index)131      clip = {132        x: automationOptions.clip.x,133        y: viewportHeight - heightLeft,134        width: automationOptions.clip.width,135        height: heightLeft,136      }137    } else {138      clip = automationOptions.clip139    }140    return { y, clip }141  })142  return takeScrollingScreenshots(scrolls, win, state, automationOptions)143  .finally(resetScrollOverrides)144}145const applyPaddingToElementPositioning = (elPosition, automationOptions) => {146  if (!automationOptions.padding) {147    return elPosition148  }149  const [paddingTop, paddingRight, paddingBottom, paddingLeft] = automationOptions.padding150  return {151    width: elPosition.width + paddingLeft + paddingRight,152    height: elPosition.height + paddingTop + paddingBottom,153    fromElViewport: {154      top: elPosition.fromElViewport.top - paddingTop,155      left: elPosition.fromElViewport.left - paddingLeft,156      bottom: elPosition.fromElViewport.bottom + paddingBottom,157    },158    fromElWindow: {159      top: elPosition.fromElWindow.top - paddingTop,160    },161  }162}163const takeElementScreenshot = ($el, state, automationOptions) => {164  const win = state('window')165  const doc = state('document')166  const resetScrollOverrides = scrollOverrides(win, doc)167  let elPosition = applyPaddingToElementPositioning(168    $dom.getElementPositioning($el),169    automationOptions,170  )171  const viewportHeight = getViewportHeight(state)172  const viewportWidth = getViewportWidth(state)173  const numScreenshots = Math.ceil(elPosition.height / viewportHeight)174  validateNumScreenshots(numScreenshots, automationOptions)175  const scrolls = _.map(_.times(numScreenshots), (index) => {176    const y = elPosition.fromElWindow.top + (viewportHeight * index)177    const afterScroll = () => {178      elPosition = applyPaddingToElementPositioning(179        $dom.getElementPositioning($el),180        automationOptions,181      )182      const x = Math.min(viewportWidth, elPosition.fromElViewport.left)183      const width = Math.min(viewportWidth - x, elPosition.width)184      if (numScreenshots === 1) {185        return {186          x,187          y: elPosition.fromElViewport.top,188          width,189          height: elPosition.height,190        }191      }192      if ((index + 1) === numScreenshots) {193        const overlap = ((numScreenshots - 1) * viewportHeight) + elPosition.fromElViewport.top194        const heightLeft = elPosition.fromElViewport.bottom - overlap195        return {196          x,197          y: overlap,198          width,199          height: heightLeft,200        }201      }202      return {203        x,204        y: Math.max(0, elPosition.fromElViewport.top),205        width,206        // TODO: try simplifying to just 'viewportHeight'207        height: Math.min(viewportHeight, elPosition.fromElViewport.top + elPosition.height),208      }209    }210    return { y, afterScroll }211  })212  return takeScrollingScreenshots(scrolls, win, state, automationOptions)213  .finally(resetScrollOverrides)214}215// "app only" means we're hiding the runner UI216const isAppOnly = ({ capture }) => {217  return (capture === 'viewport') || (capture === 'fullPage')218}219const getShouldScale = ({ capture, scale }) => {220  return isAppOnly({ capture }) ? scale : true221}222const getBlackout = ({ capture, blackout }) => {223  return isAppOnly({ capture }) ? blackout : []224}225const takeScreenshot = (Cypress, state, screenshotConfig, options = {}) => {226  const {227    capture,228    padding,229    clip,230    disableTimersAndAnimations,231    onBeforeScreenshot,232    onAfterScreenshot,233  } = screenshotConfig234  const { subject, runnable } = options235  const startTime = new Date()236  const send = (event, props, resolve) => {237    Cypress.action(`cy:${event}`, props, resolve)238  }239  const sendAsync = (event, props) => {240    return new Promise((resolve) => {241      return send(event, props, resolve)242    })243  }244  const getOptions = (isOpen) => {245    return {246      id: runnable.id,247      testAttemptIndex: $utils.getTestFromRunnable(runnable)._currentRetry,248      isOpen,249      appOnly: isAppOnly(screenshotConfig),250      scale: getShouldScale(screenshotConfig),251      waitForCommandSynchronization: !isAppOnly(screenshotConfig),252      disableTimersAndAnimations,253      blackout: getBlackout(screenshotConfig),254    }255  }256  const before = () => {257    return Promise.try(() => {258      if (disableTimersAndAnimations) {259        return cy.pauseTimers(true)260      }261    })...

1const _ = require('lodash')2const capitalize = require('underscore.string/capitalize')3const methods = require('methods')4const dayjs = require('dayjs')5const $ = require('jquery')6const $jquery = require('../dom/jquery')7const $Location = require('./location')8const tagOpen = /\[([a-z\s='"-]+)\]/g9const tagClosed = /\[\/([a-z]+)\]/g10const quotesRe = /('|")/g11const defaultOptions = {12  delay: 10,13  force: false,14  timeout: null,15  interval: null,16  multiple: false,17  waitForAnimations: true,18  animationDistanceThreshold: 5,19  scrollBehavior: 'top',20}21const USER_FRIENDLY_TYPE_DETECTORS = _.map([22  [_.isUndefined, 'undefined'],23  [_.isNull, 'null'],24  [_.isBoolean, 'boolean'],25  [_.isNumber, 'number'],26  [_.isString, 'string'],27  [_.isRegExp, 'regexp'],28  [_.isSymbol, 'symbol'],29  [_.isElement, 'element'],30  [_.isError, 'error'],31  [_.isSet, 'set'],32  [_.isWeakSet, 'set'],33  [_.isMap, 'map'],34  [_.isWeakMap, 'map'],35  [_.isFunction, 'function'],36  [_.isArrayLikeObject, 'array'],37  [_.isBuffer, 'buffer'],38  [_.isDate, 'date'],39  [_.isObject, 'object'],40  [_.stubTrue, 'unknown'],41], ([fn, type]) => {42  return [fn, _.constant(type)]43})44module.exports = {45  warning (msg) {46    // eslint-disable-next-line no-console47    return console.warn(`Cypress Warning: ${msg}`)48  },49  log (...msgs) {50    // eslint-disable-next-line no-console51    return console.log(...msgs)52  },53  monkeypatchBefore (origFn, fn) {54    return function () {55      const newArgs = fn.apply(this, arguments)56      if (newArgs !== undefined) {57        return origFn.apply(this, newArgs)58      }59      return origFn.apply(this, arguments)60    }61  },62  unwrapFirst (val) {63    // this method returns the first item in an array64    // and if its still a jquery object, then we return65    // the first() jquery element66    const item = [].concat(val)[0]67    if ($jquery.isJquery(item)) {68      return item.first()69    }70    return item71  },72  switchCase (value, casesObj, defaultKey = 'default') {73    if (_.has(casesObj, value)) {74      return _.result(casesObj, value)75    }76    if (_.has(casesObj, defaultKey)) {77      return _.result(casesObj, defaultKey)78    }79    const keys = _.keys(casesObj)80    throw new Error(`The switch/case value: '${value}' did not match any cases: ${keys.join(', ')}.`)81  },82  reduceProps (obj, props = []) {83    if (!obj) {84      return null85    }86    return _.reduce(props, (memo, prop) => {87      if (_.has(obj, prop) || obj[prop] !== undefined) {88        memo[prop] = _.result(obj, prop)89      }90      return memo91    }, {})92  },93  normalizeObjWithLength (obj) {94    // lodash shits the bed if our object has a 'length'95    // property so we have to normalize that96    if (_.has(obj, 'length')) {97      obj.Length = obj.length98      delete obj.length99    }100    return obj101  },102  // return a new object if the obj103  // contains the properties of filter104  // and the values are different105  filterOutOptions (obj, filter = {}) {106    _.defaults(filter, defaultOptions)107    this.normalizeObjWithLength(filter)108    const whereFilterHasSameKeyButDifferentValue = (value, key) => {109      const upperKey = capitalize(key)110      return (_.has(filter, key) || _.has(filter, upperKey)) &&111        filter[key] !== value112    }113    obj = _.pickBy(obj, whereFilterHasSameKeyButDifferentValue)114    if (_.isEmpty(obj)) {115      return undefined116    }117    return obj118  },119  stringifyActualObj (obj) {120    obj = this.normalizeObjWithLength(obj)121    const str = _.reduce(obj, (memo, value, key) => {122      memo.push(`${`${key}`.toLowerCase()}: ${this.stringifyActual(value)}`)123      return memo124    }, [])125    return `{${str.join(', ')}}`126  },127  stringifyActual (value) {128    const $dom = require('../dom')129    if ($dom.isDom(value)) {130      return $dom.stringify(value, 'short')131    }132    if (_.isFunction(value)) {133      return 'function(){}'134    }135    if (_.isArray(value)) {136      const len = value.length137      if (len > 3) {138        return `Array[${len}]`139      }140      return `[${_.map(value, _.bind(this.stringifyActual, this)).join(', ')}]`141    }142    if (_.isRegExp(value)) {143      return value.toString()144    }145    if (_.isObject(value)) {146      // Cannot use $dom.isJquery here because it causes infinite recursion.147      if (value instanceof $) {148        return `jQuery{${value.length}}`149      }150      const len = _.keys(value).length151      if (len > 2) {152        return `Object{${len}}`153      }154      return this.stringifyActualObj(value)155    }156    if (_.isSymbol(value)) {157      return 'Symbol'158    }159    if (_.isUndefined(value)) {160      return undefined161    }162    return `${value}`163  },164  // give us some user-friendly "types"165  stringifyFriendlyTypeof: _.cond(USER_FRIENDLY_TYPE_DETECTORS),166  stringify (values) {167    // if we already have an array168    // then nest it again so that169    // its formatted properly170    values = [].concat(values)171    return _172    .chain(values)173    .map(_.bind(this.stringifyActual, this))174    .without(undefined)175    .join(', ')176    .value()177  },178  stringifyArg (arg) {179    if (_.isString(arg) || _.isNumber(arg) || _.isBoolean(arg)) {180      return JSON.stringify(arg)181    }182    if (_.isNull(arg)) {183      return 'null'184    }185    if (_.isUndefined(arg)) {186      return 'undefined'187    }188    return this.stringifyActual(arg)189  },190  plural (obj, plural, singular) {191    obj = _.isNumber(obj) ? obj : obj.length192    if (obj > 1) {193      return plural194    }195    return singular196  },197  convertHtmlTags (html) {198    return html199    .replace(tagOpen, '<$1>')200    .replace(tagClosed, '</$1>')201  },202  isInstanceOf (instance, constructor) {203    try {204      return instance instanceof constructor205    } catch (e) {206      return false207    }208  },209  escapeQuotes (text) {210    // convert to str and escape any single211    // or double quotes212    return (`${text}`).replace(quotesRe, '\\$1')213  },214  normalizeNumber (num) {215    const parsed = Number(num)216    // return num if this isNaN else return parsed217    if (_.isNaN(parsed)) {218      return num219    }220    return parsed221  },222  isValidHttpMethod (str) {223    return _.isString(str) && _.includes(methods, str.toLowerCase())224  },225  addTwentyYears () {226    return dayjs().add(20, 'year').unix()227  },228  locReload (forceReload, win) {229    return win.location.reload(forceReload)230  },231  locHref (url, win) {232    win.location.href = url233  },234  locToString (win) {235    return win.location.toString()236  },237  locExisting () {238    return $Location.create(window.location.href)239  },240  iframeSrc ($autIframe, url) {241    return $autIframe.prop('src', url)242  },243  getDistanceBetween (point1, point2) {244    const deltaX = point1.x - point2.x245    const deltaY = point1.y - point2.y246    return Math.sqrt((deltaX * deltaX) + (deltaY * deltaY))247  },248  getTestFromRunnable (r) {249    return r.ctx.currentTest || r250  },251  memoize (func, cacheInstance = new Map()) {252    const memoized = function (...args) {253      const key = args[0]254      const { cache } = memoized255      if (cache.has(key)) {256        return cache.get(key)257      }258      const result = func.apply(this, args)259      memoized.cache = cache.set(key, result) || cache260      return result261    }262    memoized.cache = cacheInstance263    return memoized264  },265  indent (str, indentAmount) {266    const indentStr = _.repeat(' ', indentAmount)267    str = str.replace(/\n/g, `\n${indentStr}`)268    return `${indentStr}${str}`269  },270  // normalize more than {maxNewLines} new lines into271  // exactly {replacementNumLines} new lines272  normalizeNewLines (str, maxNewLines, replacementNumLines) {273    const moreThanMaxNewLinesRe = new RegExp(`\\n{${maxNewLines},}`)274    const replacementWithNumLines = replacementNumLines ?? maxNewLines275    return _.chain(str)276    .split(moreThanMaxNewLinesRe)277    .compact()278    .join(_.repeat('\n', replacementWithNumLines))279    .value()280  },281  /**282   * Correctly decodes Unicode string in encoded in base64283   * @see https://github.com/cypress-io/cypress/issues/5435284   * @see https://github.com/cypress-io/cypress/issues/7507285   * @see https://stackoverflow.com/questions/30106476/using-javascripts-atob-to-decode-base64-doesnt-properly-decode-utf-8-strings286   *287   * @example288    ```289    Buffer.from(JSON.stringify({state: '🙂'})).toString('base64')290    // 'eyJzdGF0ZSI6IvCfmYIifQ=='291    // "window.atob" does NOT work292    // atob('eyJzdGF0ZSI6IvCfmYIifQ==')293    // "{"state":"🙂"}"294    // but this function works295    b64DecodeUnicode('eyJzdGF0ZSI6IvCfmYIifQ==')296    '{"state":"🙂"}'297    ```298  */299  decodeBase64Unicode (str) {300    return decodeURIComponent(atob(str).split('').map((char) => {301      return `%${(`00${char.charCodeAt(0).toString(16)}`).slice(-2)}`302    }).join(''))303  },304  /**305   * Correctly encodes Unicode string to base64306   * @see https://stackoverflow.com/questions/30106476/using-javascripts-atob-to-decode-base64-doesnt-properly-decode-utf-8-strings307  */308  encodeBase64Unicode (str) {309    return btoa(encodeURIComponent(str).replace(/%([0-9A-F]{2})/g, (match, p1) => {310      return String.fromCharCode(`0x${p1}`)311    }))312  },...