VoyagerXHF's picture
Upload folder using huggingface_hub (part 29)
dbe005a verified
Raw History Blame Contribute Delete
183 kB
<!DOCTYPE html>
<html class="docs-wrapper docs-doc-page docs-version-20.x plugin-docs plugin-id-default docs-doc-id-guide/migration show--consent" data-has-hydrated="true" data-rh="lang,dir,class,data-has-hydrated" data-theme="dark" dir="ltr" lang="en"><head>
<meta charset="utf-8"/>
<meta content="Docusaurus v2.4.3" name="generator"/>
<title>Migration Guide | Detox</title><meta content="summary_large_image" data-rh="true" name="twitter:card"/><meta content="en" data-rh="true" name="docusaurus_locale"/><meta content="en" data-rh="true" name="docsearch:language"/><meta content="20.x" data-rh="true" name="docusaurus_version"/><meta content="docs-default-20.x" data-rh="true" name="docusaurus_tag"/><meta content="20.x" data-rh="true" name="docsearch:version"/><meta content="docs-default-20.x" data-rh="true" name="docsearch:docusaurus_tag"/><meta content="Migration Guide | Detox" data-rh="true" property="og:title"/><meta content="We are improving Detox API as we go along, sometimes these changes require us to break the API in order for it to make more sense. These migration guides refer to breaking changes. If a newer version has no entries in this document, it means it does not require special migration steps. Refer to the release notes of the latter builds to learn about their improvements and changes." data-rh="true" name="description"/><meta content="We are improving Detox API as we go along, sometimes these changes require us to break the API in order for it to make more sense. These migration guides refer to breaking changes. If a newer version has no entries in this document, it means it does not require special migration steps. Refer to the release notes of the latter builds to learn about their improvements and changes." data-rh="true" property="og:description"/><link data-rh="true" href="/img/favicon.ico" rel="icon"/><link crossorigin="anonymous" data-rh="true" href="/_404.html" rel="preconnect"/><link href="/blog/rss.xml" rel="alternate" title="Detox RSS Feed" type="application/rss+xml"/>
<link href="/blog/atom.xml" rel="alternate" title="Detox Atom Feed" type="application/atom+xml"/>
<link href="/_404.html" rel="preconnect"/>
<link href="/_404.html" rel="preconnect"/>
<link href="/_404.html" rel="preconnect"/>
<script>window.dataLayer=window.dataLayer||[]</script>
<link href="/opensearch.xml" rel="search" title="Detox" type="application/opensearchdescription+xml"/>
<script async="" src="/_cdn/platform.twitter.com/widgets.js"></script><link href="/assets/css/styles.2561cce4.css" rel="stylesheet"/>
<link as="script" href="/assets/js/runtime~main.12cb17c3.js" rel="preload"/>
<link as="script" href="/assets/js/main.899efd46.js" rel="preload"/>
<link data-rh="true" href="/docs/guide/migration/" rel="canonical"/><link data-rh="true" href="/docs/guide/migration/" hreflang="en" rel="alternate"/><link data-rh="true" href="/docs/guide/migration/" hreflang="x-default" rel="alternate"/><meta content="width=device-width, initial-scale=1.0" data-rh="true" name="viewport"/><meta content="/docs/guide/migration/" data-rh="true" property="og:url"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/7c97e9a2.69c6c05c.js" rel="prefetch"/><link href="/assets/js/c4f5d8e4.1d727c7d.js" rel="prefetch"/><link href="/assets/js/0ef19a76.b6a3804a.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/bab8a798.39e6da23.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/5eff386f.b247addc.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/435645a6.e680c3f3.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/d9894068.9ef62e7b.js" rel="prefetch"/><link href="/assets/js/5fc994c2.0a3b56b5.js" rel="prefetch"/><link href="/assets/js/0ef19a76.b6a3804a.js" rel="prefetch"/><link href="/assets/js/a6aa9e1f.f7d63002.js" rel="prefetch"/><link href="/assets/js/181d712d.f728104a.js" rel="prefetch"/><link href="/assets/js/814f3328.368bc5eb.js" rel="prefetch"/><link href="/assets/js/83eb08f7.4d5ec241.js" rel="prefetch"/><link href="/assets/js/9292650b.f26ac725.js" rel="prefetch"/><link href="/assets/js/933bed1e.d56d75f0.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/e6bddadc.d0b3b5ab.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/935f2afb.d4cfcd14.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/1373a77b.30c5b917.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/45e366b7.00b7e983.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/671ab86b.6febeedb.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/f14c3b1d.750d68cc.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/79ac7843.08fb5e78.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/5b12c1a9.ead7646c.js" rel="prefetch"/><link href="/_cdn/unpkg.com/@68publishers/cookie-consent/dist/cookie-consent.css" rel="stylesheet"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/a4761f6f.ea064397.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/04d1378b.3afbb8df.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/ef7da448.65c104e2.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/373c35af.5d2e051c.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/a622d695.ad67fb36.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/7accbb75.e3d53ef1.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/96997528.38ed49ad.js" rel="prefetch"/><link href="/assets/js/a8a1de49.bab92bdd.js" rel="prefetch"/><link href="/assets/js/3fb5a56d.b5c89c21.js" rel="prefetch"/><link href="/assets/js/d350cff3.43602b60.js" rel="prefetch"/><link href="/assets/js/17896441.b40a6528.js" rel="prefetch"/><link href="/assets/js/4da36d59.d47dd4ab.js" rel="prefetch"/></head>
<body class="navigation-with-keyboard" data-rh="class" style="overflow: visible;">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus"><div class="banner_SLir"><a class="link_SNdm" href="/_404.html" rel="noopener noreferrer" target="_blank"><span class="uaFlag_wtbk"></span> This project is created with substantial contributions from our Ukrainian colleagues.<!-- --> <span class="hashtag_KSDo">#StandWithUkraine</span></a></div><div aria-label="Skip to main content" role="region"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-expanded="false" aria-label="Toggle navigation bar" class="navbar__toggle clean-btn" type="button"><svg aria-hidden="true" fill="currentColor" height="12" viewbox="0 0 19 12" width="19"><rect height="1" rx="0.5" stroke="currentColor" stroke-linecap="round" width="18" x="0.5" y="5.5"></rect><rect height="1" rx="0.5" stroke="currentColor" stroke-linecap="round" width="18" x="0.5" y="10.5"></rect><rect height="1" rx="0.5" stroke="currentColor" stroke-linecap="round" width="18" x="0.5" y="0.5"></rect></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img alt="Detox Logo" class="themedImage_ToTc themedImage--dark_i4oU" src="/img/logo.png"/></div><b class="navbar__title text--truncate">Detox</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/introduction/getting-started">Docs</a><a class="navbar__item navbar__link" href="/docs/config/overview">API</a><a class="navbar__item navbar__link" href="/docs/contributing">Contribute</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link header-showcase-link" href="/showcase">Showcase</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a aria-expanded="false" aria-haspopup="true" class="navbar__link" href="/docs/introduction/getting-started" role="button">20.x</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/next/guide/migration">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/guide/migration">20.x</a></li><li><a class="dropdown__link" href="/docs/19.x/">19.x</a></li></ul></div><a aria-label="GitHub repository" class="navbar__item navbar__link header-github-link" href="/_404.html" rel="noopener noreferrer" target="_blank"></a><div class="toggle_vylO colorModeToggle_DEke"><button aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite" class="clean-btn toggleButton_gllP" title="Switch between dark and light mode (currently dark mode)" type="button"><svg class="lightToggleIcon_pyhR" height="24" viewbox="0 0 24 24" width="24"><path d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z" fill="currentColor"></path></svg><svg class="darkToggleIcon_wfgR" height="24" viewbox="0 0 24 24" width="24"><path d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z" fill="currentColor"></path></svg></button></div><div class="searchWrapper_jYdA searchBox_ZlJk"><button aria-label="Search (Ctrl+K)" class="DocSearch DocSearch-Button" type="button"><span class="DocSearch-Button-Container"><svg aria-hidden="true" class="DocSearch-Search-Icon" height="20" viewbox="0 0 20 20" width="20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" fill="none" fill-rule="evenodd" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"><svg class="DocSearch-Control-Key-Icon" height="15" width="15"><path d="M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953" fill="none" stroke="currentColor" stroke-linecap="square" stroke-width="1.2"></path></svg></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div></div></div><div class="navbar-sidebar__backdrop" role="presentation"></div></nav><div class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX" id="__docusaurus_skipToContent_fallback"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a aria-expanded="false" class="menu__link menu__link--sublist menu__link--sublist-caret" href="#">Introduction</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a aria-expanded="false" class="menu__link menu__link--sublist menu__link--sublist-caret" href="#">Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a aria-expanded="false" class="menu__link menu__link--sublist menu__link--sublist-caret" href="#">Pilot-Powered Detox Testing</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a aria-expanded="false" class="menu__link menu__link--sublist menu__link--sublist-caret" href="#">Troubleshooting</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a aria-current="page" class="menu__link menu__link--active" href="/docs/guide/migration">Migration Guide</a></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav aria-label="Breadcrumbs" class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg class="breadcrumbHomeIcon_YNFT" viewbox="0 0 24 24"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active" itemprop="itemListElement" itemscope="" itemtype="https://schema.org/ListItem"><span class="breadcrumbs__link" itemprop="name">Migration Guide</span><meta content="1" itemprop="position"/></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 20.x</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button class="clean-btn tocCollapsibleButton_TO0P" type="button">On this page</button></div><div class="theme-doc-markdown markdown"><h1>Migration Guide</h1><p>We are improving Detox API as we go along, sometimes these changes require us to break the API in order for it to make more sense. These migration guides refer to breaking changes. If a newer version has no entries in this document, it means it does not require special migration steps. Refer to the release notes of the latter builds to learn about their improvements and changes.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="200">20.0<a aria-label="Direct link to 20.0" class="hash-link" href="#200" title="Direct link to 20.0">​</a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="no-mocha-support">No <a href="/_404.html" rel="noopener noreferrer" target="_blank">Mocha</a> support<a aria-label="Direct link to no-mocha-support" class="hash-link" href="#no-mocha-support" title="Direct link to no-mocha-support">​</a></h3><p>If you were using Mocha, now you have two options:</p><ul><li>switch to <a href="/_404.html" rel="noopener noreferrer" target="_blank">Jest</a> using <a href="/docs/cli/init"><code>detox init</code></a> boilerplate as a reference and <a href="/docs/config/testRunner"><code>testRunner</code> config</a>;</li><li>wait until a third-party integration with Mocha appears.</li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="jest-2725-and-higher">Jest 27.2.5 and higher<a aria-label="Direct link to Jest 27.2.5 and higher" class="hash-link" href="#jest-2725-and-higher" title="Direct link to Jest 27.2.5 and higher">​</a></h3><p>You have to upgrade your Jest version to at least 27.2.5 or higher. The recommended choice is 28.x or 29.x.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="all-in-one-configs">All-in-one configs<a aria-label="Direct link to All-in-one configs" class="hash-link" href="#all-in-one-configs" title="Direct link to All-in-one configs">​</a></h3><p>If you see an error like this:</p><div class="language-plain codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-plain codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">DetoxConfigError: Configuration "legacy" uses a deprecated all-in-one schema,</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">which is not supported by Detox.</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>You have to extract device and app configs from your configuration, as shown in the example below:</p><table><tr><th>Legacy schema</th><th>Modern schema</th></tr><tr><td><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-json codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"configurations"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"ios.sim.debug"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"type"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"ios.simulator"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"device"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"iPhone 12"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"binaryPath"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"/some/path/ios.app"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"build"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"..."</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"android.emu.debug"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"type"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"android.emulator"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"device"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"Pixel_30_API"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"binaryPath"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"/some/path/android.apk"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"build"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"..."</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"launchArgs"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div></td><td><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-json codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"apps"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"ios.debug"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"type"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"ios.app"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"binaryPath"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"/some/path/ios.app"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"build"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"..."</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"android.debug"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"type"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"android.apk"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"binaryPath"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"/some/path/android.apk"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"build"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"..."</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"launchArgs"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"devices"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"ios.simulator"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"type"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"ios.simulator"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"device"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> </span><span class="token property">"type"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"iPhone 12"</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"android.emulator"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"type"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"android.apk"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"device"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> </span><span class="token property">"avdName"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"Pixel_30_API"</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"configurations"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"ios.sim.debug"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"device"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"ios.simulator"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"app"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"ios.debug"</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"android.emu.debug"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"device"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"android.emulator"</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token property">"app"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">"android.debug"</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div></td></tr></table><p>For more details refer to the <a href="/docs/config/devices"><code>Config &gt; Devices</code></a> and <a href="/docs/config/apps"><code>Config &gt; Apps</code></a> sections.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="testrunner-config-section"><code>testRunner</code> config section<a aria-label="Direct link to testrunner-config-section" class="hash-link" href="#testrunner-config-section" title="Direct link to testrunner-config-section">​</a></h3><p>Three top-level string properties (<code>testRunner</code>, <code>runnerConfig</code>, <code>specs</code>) have been unified into a complex
<code>testRunner</code> section which strives to be as agnostic as possible:</p><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">.detoxrc.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> testRunner: 'jest',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> runnerConfig: 'e2e/jest.config.js',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> specs: 'e2e',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> skipLegacyWorkersInjection: true,</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> testRunner: {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> $0: 'jest',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> args: {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> config: 'e2e/jest.config.js',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> _: ['e2e']</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> },</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> },</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>Also, <code>skipLegacyWorkersInjection</code> migration option no longer has meaning, so you can remove it safely.</p><p>If you didn’t have <code>runnerConfig</code> previously, use <code>e2e/config.json</code> (because that was an implicit default
in Detox 19 and earlier):</p><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> testRunner: {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> $0: 'jest',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> args: {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> config: 'e2e/config.json',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> },</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line">},</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="custom-jest-environment">Custom Jest environment<a aria-label="Direct link to Custom Jest environment" class="hash-link" href="#custom-jest-environment" title="Direct link to Custom Jest environment">​</a></h3><p>You no longer need to have an autogenerated environment file if you haven’t been customizing it,
and if it looks like below:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">e2e/environment.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">const</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token maybe-class-name">DetoxCircusEnvironment</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token maybe-class-name">SpecReporter</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token maybe-class-name">WorkerAssignReporter</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">require</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest-circus'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">class</span><span class="token plain"> </span><span class="token class-name">CustomDetoxEnvironment</span><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">extends</span><span class="token plain"> </span><span class="token class-name">DetoxCircusEnvironment</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">constructor</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token parameter">config</span><span class="token parameter punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token parameter"> context</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">super</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token plain">config</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"> context</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">// Can be safely removed, if you are content with the default value (=300000ms)</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">this</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">initTimeout</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token number">300000</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">// This takes care of generating status logs on a per-spec basis. By default, Jest only reports at file-level.</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">// This is strictly optional.</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">this</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token method function property-access" style="color: rgb(80, 250, 123);">registerListeners</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token maybe-class-name">SpecReporter</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token maybe-class-name">WorkerAssignReporter</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token maybe-class-name">CustomDetoxEnvironment</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Toggle word wrap" class="clean-btn" title="Toggle word wrap" type="button"><svg aria-hidden="true" class="wordWrapButtonIcon_Bwma" viewbox="0 0 24 24"><path d="M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z" fill="currentColor"></path></svg></button><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>If you want, for example:</p><ul><li>to reduce the init timeout to 120 seconds,</li><li>remove <code>SpecReporter</code> output,</li><li>remove <code>WorkerAssignReporter</code> output,</li></ul><p>then you can express this intent via config:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">.detoxrc.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token comment" style="color: rgb(98, 114, 164);">/** @type {Detox.DetoxConfig} */</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">testRunner</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">$0</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'jest'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">args</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">config</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'e2e/jest.config.js'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">_</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">[</span><span class="token string" style="color: rgb(255, 121, 198);">'e2e'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">]</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line theme-code-block-highlighted-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">jest</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line theme-code-block-highlighted-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">setupTimeout</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">120000</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line theme-code-block-highlighted-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">reportSpecs</span><span class="token operator">:</span><span class="token plain"> </span><span class="token boolean">false</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line theme-code-block-highlighted-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">reportWorkerAssign</span><span class="token operator">:</span><span class="token plain"> </span><span class="token boolean">false</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line theme-code-block-highlighted-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">// …</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>If you have some customizations beyond that, make sure to remove the boilerplate code:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">e2e/environment.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line theme-code-block-highlighted-line" style="color: rgb(248, 248, 242);"><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">const</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> </span><span class="token maybe-class-name">DetoxCircusEnvironment</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">require</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">class</span><span class="token plain"> </span><span class="token class-name">CustomDetoxEnvironment</span><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">extends</span><span class="token plain"> </span><span class="token class-name">DetoxCircusEnvironment</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">constructor</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token parameter">config</span><span class="token parameter punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token parameter"> context</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">super</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token plain">config</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"> context</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">// leave your custom code</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token maybe-class-name">CustomDetoxEnvironment</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>Pay attention that the import has been changed to <code>detox/runners/jest</code> (previously it was <code>detox/runners/jest-circus</code>),
and the reporters (<code>SpecReporter</code>, <code>WorkerAssignReporter</code>) are no longer exported. You can continue using
<code>this.initTimeout</code> if you rename it there to <code>this.setupTimeout</code>, but you can also delegate that to Detox config like shown earlier.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="new-jest-config">New Jest config<a aria-label="Direct link to New Jest config" class="hash-link" href="#new-jest-config" title="Direct link to New Jest config">​</a></h3><p>Let's examine <strong>the old configs</strong> first to see what needs to be removed or changed:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">e2e/jest.config.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv codeBlockLinesWithNumbering_o6Pm"><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">maxWorkers</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">1</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">testEnvironment</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'./environment'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">testRunner</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'jest-circus/runner'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">testTimeout</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">120000</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">testRegex</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'\\.e2e\\.js$'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">reporters</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">[</span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest/streamlineReporter'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">]</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">verbose</span><span class="token operator">:</span><span class="token plain"> </span><span class="token boolean">true</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span></span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>See comments line by line:</p><p>1<!-- -->.<!-- --> As a recommendation, switch to CommonJS (<code>module.exports = {}</code>) instead of JSON, if you haven’t done that already.</p><p>2<!-- -->.<!-- --> If you don’t have <code>maxWorkers: 1</code> configured, please add it.</p><p>3<!-- -->.<!-- --> If you removed your test environment in the previous step, remove the <code>testEnvironment</code> property.</p><p>4<!-- -->.<!-- --> Remove <code>testRunner</code> since it is already <code>jest-circus</code> by default in Jest 27.x and higher.</p><p>5<!-- -->.<!-- --> You need a long <code>testTimeout</code> value, because usually end-to-end tests cannot complete in 5 seconds, which is
Jest's default timeout value. We suggest 120 seconds by default, but you can fine-tine it.</p><p>6<!-- -->.<!-- --> We recommend to use <code>rootDir</code> and <code>testMatch</code> instead of <code>testRegex</code>, like this (assuming your Jest config is
in <code>e2e</code> folder of your project, together with the Detox test files):</p><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> testRegex: '',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> rootDir: '..',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> testMatch: ['&lt;rootDir&gt;/e2e/**/*.test.js'],</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>7<!-- -->.<!-- --> Remove that <code>streamlineReporter</code>. You’ll be adding a new reporter in a second.</p><p>8<!-- -->.<!-- --> You need to set <code>verbose: true</code> to disable log batching. In other words, Jest will be printing
logs with a significant delay, which is just inconvenient and annoying when you need
to know what exactly is happening right now.</p><p>Now, let's take a look at <strong>the new config</strong> and the required additions:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">e2e/jest.config.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv codeBlockLinesWithNumbering_o6Pm"><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">maxWorkers</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">1</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">testTimeout</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">120000</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">verbose</span><span class="token operator">:</span><span class="token plain"> </span><span class="token boolean">true</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line theme-code-block-highlighted-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">reporters</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">[</span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest/reporter'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">]</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line theme-code-block-highlighted-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">globalSetup</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest/globalSetup'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line theme-code-block-highlighted-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">globalTeardown</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest/globalTeardown'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line theme-code-block-highlighted-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> </span><span class="token literal-property property">testEnvironment</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest/testEnvironment'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span></span><br/></span><span class="token-line codeLine_lJS_" style="color: rgb(248, 248, 242);"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span></span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>Let's focus on lines 5-8:</p><ol start="5"><li><p>Add the new Detox reporter as the first one to your existing <code>reporters: [...]</code> array or create that property
like we show. It is a reserved reporter for Detox core logic, so it does not affect your logs or any other output –
just make sure you have it.</p></li><li><p>Register <code>globalSetup</code> shipped with Detox. If you have your own <code>globalSetup</code>, then call both in a wrapper function:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token method-variable function-variable method function property-access" style="color: rgb(80, 250, 123);">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">async</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token plain"> </span><span class="token arrow operator">=&gt;</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword control-flow" style="color: rgb(189, 147, 249); font-style: italic;">await</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">require</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest/index'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token method function property-access" style="color: rgb(80, 250, 123);">globalSetup</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword control-flow" style="color: rgb(189, 147, 249); font-style: italic;">await</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">yourGlobalSetupFunction</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div></li><li><p>Register <code>globalTeardown</code> shipped with Detox. If you have your own <code>globalTeardown</code>, then you should wrap it
with <code>try-finally</code> and call the teardown of Detox too:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token method-variable function-variable method function property-access" style="color: rgb(80, 250, 123);">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">async</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token plain"> </span><span class="token arrow operator">=&gt;</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword control-flow" style="color: rgb(189, 147, 249); font-style: italic;">try</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword control-flow" style="color: rgb(189, 147, 249); font-style: italic;">await</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">yourGlobalTeardownFunction</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"> </span><span class="token keyword control-flow" style="color: rgb(189, 147, 249); font-style: italic;">finally</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword control-flow" style="color: rgb(189, 147, 249); font-style: italic;">await</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">require</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token string" style="color: rgb(255, 121, 198);">'detox/runners/jest/index'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token method function property-access" style="color: rgb(80, 250, 123);">globalTeardown</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div></li><li><p>If you already have removed your custom test environment, please switch to the default test environment shipped
with Detox like shown in the example. Otherwise, stay with your custom test environment but make sure to migrate it
as was described earlier.</p></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="stop-using-timeline-artifacts">Stop using timeline artifacts<a aria-label="Direct link to Stop using timeline artifacts" class="hash-link" href="#stop-using-timeline-artifacts" title="Direct link to Stop using timeline artifacts">​</a></h3><p>If you have been using <code>--record-timeline all</code> CLI option or had timeline artifact configured in your config,</p><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line">{</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> artifacts: {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> plugins: {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> logs: 'all',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> screenshot: 'failing',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> timeline: 'all',</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> }</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> }</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line">}</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>please remove it from your configs and scripts. Timeline artifacts have been merged with log artifacts, so if
you need to have <code>detox.trace.json</code> – just don’t turn off your logs, and you’ll get it.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="updating-command-line-scripts">Updating command-line scripts<a aria-label="Direct link to Updating command-line scripts" class="hash-link" href="#updating-command-line-scripts" title="Direct link to Updating command-line scripts">​</a></h3><p>Check your Detox scripts whether they had command-line arguments such as:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-bash codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">detox </span><span class="token builtin class-name" style="color: rgb(189, 147, 249);">test</span><span class="token plain"> … -o path/to/jest.config …</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">detox </span><span class="token builtin class-name" style="color: rgb(189, 147, 249);">test</span><span class="token plain"> … --runner-config path/to/jest.config …</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">detox </span><span class="token builtin class-name" style="color: rgb(189, 147, 249);">test</span><span class="token plain"> … --workers </span><span class="token number">3</span><span class="token plain"> …</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>Detox became agnostic about third-party test runner arguments, and now you need to forward those arguments directly
to your test runner (i.e. Jest):</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-bash codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">detox </span><span class="token builtin class-name" style="color: rgb(189, 147, 249);">test</span><span class="token plain"> … --config path/to/jest.config …</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">detox </span><span class="token builtin class-name" style="color: rgb(189, 147, 249);">test</span><span class="token plain"> … --maxWorkers </span><span class="token number">3</span><span class="token plain"> …</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>You’ll be able to tell that you’ve run into a situation like this if you see error messages like:</p><div class="language-plain codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-plain codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">● Unrecognized CLI Parameter:</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> Unrecognized option "workers".</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> CLI Options Documentation:</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> https://jestjs.io/docs/cli</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>Besides, verify you don’t have a deprecated <code>--device-launch-args</code> parameter in your scripts.
It has been superseded by <code>--device-boot-args</code>:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-bash codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">detox </span><span class="token builtin class-name" style="color: rgb(189, 147, 249);">test</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">..</span><span class="token plain">. --device-boot-args</span><span class="token operator">=</span><span class="token string" style="color: rgb(255, 121, 198);">"arg1 arg2"</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="revisit-environment-variables">Revisit environment variables<a aria-label="Direct link to Revisit environment variables" class="hash-link" href="#revisit-environment-variables" title="Direct link to Revisit environment variables">​</a></h3><p>If you’re relying somewhere in your code on things like <code>process.env.DETOX_CONFIGURATION</code> or any other that starts from <code>DETOX_</code>, as a matter of a workaround, you can turn on <code>testRunner.forwardEnv</code> in your Detox config:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">.detoxrc.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token comment" style="color: rgb(98, 114, 164);">/** @type {Detox.DetoxConfig} */</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">testRunner</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">args</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">$0</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'jest'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line theme-code-block-highlighted-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">forwardEnv</span><span class="token operator">:</span><span class="token plain"> </span><span class="token boolean">true</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">devices</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">/* ... */</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">apps</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">/* ... */</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">configurations</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">/* ... */</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>That should solve temporarily the issue with missing environment variables, but this is
not the best solution overall. The better fix for that would be switch to using Detox
Internals API.</p><p>For example, you were determining the number of workers depending on your configuration:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">e2e/jest.config.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">maxWorkers</span><span class="token operator">:</span><span class="token plain"> process</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">env</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token constant" style="color: rgb(189, 147, 249);">CI</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token operator">?</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token template-string template-punctuation string" style="color: rgb(255, 121, 198);">`</span><span class="token template-string interpolation interpolation-punctuation punctuation" style="color: rgb(248, 248, 242);">${</span><span class="token template-string interpolation">process</span><span class="token template-string interpolation punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token template-string interpolation property-access">env</span><span class="token template-string interpolation punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token template-string interpolation constant" style="color: rgb(189, 147, 249);">DETOX_CONFIGURATION</span><span class="token template-string interpolation interpolation-punctuation punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token template-string template-punctuation string" style="color: rgb(255, 121, 198);">`</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token method function property-access" style="color: rgb(80, 250, 123);">startsWith</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token string" style="color: rgb(255, 121, 198);">'ios.'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token plain"> </span><span class="token operator">?</span><span class="token plain"> </span><span class="token number">3</span><span class="token plain"> </span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">2</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">1</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">globalSetup</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'...'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">globalTeardown</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'...'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">// ... and so on ...</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>That would translate to a cleaner code in Detox 20:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockTitle_Ktv7">e2e/jest.config.js</div><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">const</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> resolveConfig </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">require</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token string" style="color: rgb(255, 121, 198);">'detox/internals'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">module</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token method-variable function-variable method function property-access" style="color: rgb(80, 250, 123);">exports</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">async</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token plain"> </span><span class="token arrow operator">=&gt;</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword" style="color: rgb(189, 147, 249); font-style: italic;">const</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> device </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token plain"> </span><span class="token operator">=</span><span class="token plain"> </span><span class="token keyword control-flow" style="color: rgb(189, 147, 249); font-style: italic;">await</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">resolveConfig</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token keyword control-flow" style="color: rgb(189, 147, 249); font-style: italic;">return</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">maxWorkers</span><span class="token operator">:</span><span class="token plain"> process</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">env</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token constant" style="color: rgb(189, 147, 249);">CI</span><span class="token plain"> </span><span class="token operator">?</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token plain">device</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">type</span><span class="token plain"> </span><span class="token operator">===</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'ios.simulator'</span><span class="token plain"> </span><span class="token operator">?</span><span class="token plain"> </span><span class="token number">3</span><span class="token plain"> </span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">2</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token plain"> </span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">1</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">globalSetup</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'...'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token literal-property property">globalTeardown</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color: rgb(255, 121, 198);">'...'</span><span class="token punctuation" style="color: rgb(248, 248, 242);">,</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">// ... and so on ...</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="miscellaneous">Miscellaneous<a aria-label="Direct link to Miscellaneous" class="hash-link" href="#miscellaneous" title="Direct link to Miscellaneous">​</a></h3><p>Detox 20 drops <code>ios.none</code> driver due to the low demand and legacy code issues.
If you have been using it, please follow the new <a href="/docs/introduction/debugging#native-application-code">Debugging &gt; Native application code</a> tutorial which explains how to use <code>launchApp: 'manual'</code> as a replacement for <code>ios.none</code>.</p><p>If you have been using <code>{ permanent: true }</code> option for <code>device.appLaunch.args.modify</code> API, please note that it has been removed in PR <a href="/_404.html" rel="noopener noreferrer" target="_blank">#3360</a>, in favor of <code>appLaunchArgs.shared</code>:</p><div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-js codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token comment" style="color: rgb(98, 114, 164);">// device.appLaunchArgs.modify({ /* ... */ }, { permanent: true });</span><span class="token plain"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">device</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">appLaunchArgs</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token property-access">shared</span><span class="token punctuation" style="color: rgb(248, 248, 242);">.</span><span class="token method function property-access" style="color: rgb(80, 250, 123);">modify</span><span class="token punctuation" style="color: rgb(248, 248, 242);">(</span><span class="token punctuation" style="color: rgb(248, 248, 242);">{</span><span class="token plain"> </span><span class="token comment" style="color: rgb(98, 114, 164);">/* ... */</span><span class="token plain"> </span><span class="token punctuation" style="color: rgb(248, 248, 242);">}</span><span class="token punctuation" style="color: rgb(248, 248, 242);">)</span><span class="token punctuation" style="color: rgb(248, 248, 242);">;</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><hr/><p>The hard part is over now, congratulations on finishing the migration!
Stay tuned for the upcoming minor releases leveraging the recent architectural changes in Detox.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="192">19.2<a aria-label="Direct link to 19.2" class="hash-link" href="#192" title="Direct link to 19.2">​</a></h2><p>The release has a <strong>developer experience</strong> improvement – <em>Detect pending in-flight requests</em> (<a href="/_404.html" rel="noopener noreferrer" target="_blank">#3003</a>, <a href="/_404.html" rel="noopener noreferrer" target="_blank"><strong>@jonathanmos</strong></a>).
The feature adds extra logic that prevents forgotten <code>await</code> statements on asynchronous Detox APIs. That’s why you might see a new error like this:</p><div class="language-plain codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-plain codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">FAILED</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">DetoxRuntimeError: The pending request \#246 ("invoke") has been rejected due to the following error:</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">Detox has detected multiple interactions taking place simultaneously. Have you forgotten to apply an await over one of the Detox actions in your test code?</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Toggle word wrap" class="clean-btn" title="Toggle word wrap" type="button"><svg aria-hidden="true" class="wordWrapButtonIcon_Bwma" viewbox="0 0 24 24"><path d="M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z" fill="currentColor"></path></svg></button><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>That should help you find forgotten <code>await</code>s in your code that are a potential reason for flakiness in E2E tests.
You’ll need to find those places and apply trivial fixes like shown below:</p><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> await screenDriver.performSomeAction();</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> expect(screenDriver.get.myElement()).toBeNotVisible();</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> await expect(screenDriver.get.myElement()).toBeNotVisible();</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="190">19.0<a aria-label="Direct link to 19.0" class="hash-link" href="#190" title="Direct link to 19.0">​</a></h2><p><strong>Version 19 is not really a breaking change!</strong></p><p>We decided to bump Detox into a major version release, nonetheless, because it is breaking for projects that sport <a href="/docs/articles/third-party-drivers">custom Detox drivers</a>, such as <a href="/_404.html" rel="noopener noreferrer" target="_blank"><code>detox-puppeteer</code></a>.</p><p>If you are a maintainer of such a project, and you wish to upgrade your Detox dependency to 19 (kudos! 👏), follow this step-by-step migration guide; You can refer to <a href="/_404.html" rel="noopener noreferrer" target="_blank">this pull-request</a>, which does that for the <code>detox-puppeteer</code> project.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="migrating-custom-drivers">Migrating Custom Drivers<a aria-label="Direct link to Migrating Custom Drivers" class="hash-link" href="#migrating-custom-drivers" title="Direct link to Migrating Custom Drivers">​</a></h3><p>The core of the change is that Detox' drivers framework is <strong>no longer a single monolith</strong>, responsible for everything platform-specific. Rather, it’s been broken down to these subresponsibilies:</p><ul><li>Allocation: The process of launching / selecting a device over which the tests would run in the current execution.</li><li>Validation: Execution environment checkups.</li><li>Artifacts: Platform-based selection of build-artifacts implementation (e.g. screenshots).</li><li>Runtime</li></ul><blockquote><p>You can find a visual explanation, <a href="https://github.com/wix/Detox/files/7338121/pre-multiapps-rfc.pdf" rel="noopener noreferrer" target="_blank">here</a>.</p></blockquote><p>In addition, the runtime driver is no longer state-less – basically, allowing implementation to hold any state that is required in identifying and managing the associated device.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="how-to-migrate">How to migrate<a aria-label="Direct link to How to migrate" class="hash-link" href="#how-to-migrate" title="Direct link to How to migrate">​</a></h4><p>Everything here will be based on the changes made in the <a href="/_404.html" rel="noopener noreferrer" target="_blank"><code>detox-puppeteer</code> example</a> - names included (please don’t use them as-is in your own implementation!).</p><p><strong>Allocation:</strong></p><ul><li>Create a new class, called <code>PuppeteerDeviceAllocation</code> (change name to something that would make sense in your project).</li><li>Move everything currently in <code>PuppeteerDriver.acquireFreeDevice()</code> and <code>.shutdown()</code> onto <code>PuppeteerDeviceAllocation.allocate()</code> and <code>.free()</code>, respectively.</li><li>Create a POJO class called <code>PuppeteerAllocCookie</code>. This class should hold anything that would later be required in order to specify the specifically associated device (example: <code>UDID</code> for iOS simulators, <code>adb</code> names for Android devices).</li><li>Make <code>.allocate()</code> return an instance of your cookie class. Puppeteer example: <a href="/_404.html" rel="noopener noreferrer" target="_blank">here</a>.</li><li><strong>Delete <code>PuppeteerDriver.acquireFreeDevice()</code> and <code>PuppeteerDriver.shutdown()</code>.</strong></li></ul><blockquote><p>For a precise class c'tor and method signatures, see <a href="/_404.html" rel="noopener noreferrer" target="_blank">here</a>.</p></blockquote><p>Add the new allocation class to the <code>module.exports</code> list, under the name: <code>DeviceAllocationDriverClass</code>.</p><p><strong>Validation:</strong></p><ul><li>If you have any validations implemented in <code>PuppeteerDriver.prepare()</code>, create a class called <code>PuppeteerEnvironmentValidator</code>.</li><li>Move anything inside <code>PuppeteerDriver.prepare()</code> to <code>PuppeteerEnvironmentValidator.validate()</code>.</li><li><strong>Delete <code>PupeteerDriver.prepare()</code>.</strong></li></ul><blockquote><p>For a precise class c'tor and method signatures, see <a href="/_404.html" rel="noopener noreferrer" target="_blank">here</a>.</p></blockquote><p>Add the new (optional) class to the <code>module.exports</code> list, under the name: <code>EnvironmentValidatorClass</code>.</p><p><strong>Artifacts:</strong></p><ul><li>Move your implementation of <code>PuppeteerDriver.declareArtifactPlugins()</code> to the same method in a new class, called <code>PuppeteerArtifactPluginsProvider.declareArtifactPlugins()</code> (change name to something that would make sense in your project).</li></ul><blockquote><p>There are no changes in method signature in this case.</p></blockquote><p>Add the new class to the <code>module.exports</code> list, under the name: <code>ArtifactPluginsProviderClass</code>.</p><p><strong>Runtime:</strong></p><ul><li>Optionally rename your class from <code>PuppeteerDriver</code> to <code>PuppeteerRuntimeDriver</code>.</li><li>In the methods remaining in the class accepting the <code>deviceId</code> arg: <strong>remove the <code>deviceId</code> arg entirely</strong>. This might break your implementation - don’t worry, continue reading.</li><li>If applicable, change the signature of the class' c'tor to accept the cookie as its 2nd argument (instance previously allocated in <code>PuppeteerAllocationDriver.allocate()</code>). Save data from the cookie as part of the driver’s state, in order to unbreak your implementation, following the previous step.</li><li>Add two methods: <code>getExternalId()</code> and <code>getDeviceName()</code>. Implement them such that they would comply with the <code>device.id</code> and <code>device.name</code> <a href="/docs/api/device">API contracts</a>, respectively.</li></ul><p>Export the runtime driver class in the <code>module.exports</code> list as <code>RuntimeDriverClass</code>, <strong>instead of <code>DriverClass</code>.</strong></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="troubleshooting">Troubleshooting<a aria-label="Direct link to Troubleshooting" class="hash-link" href="#troubleshooting" title="Direct link to Troubleshooting">​</a></h4><p>For issue related to these migrations, approach us by <a href="/_404.html" rel="noopener noreferrer" target="_blank">submitting an issue on GitHub</a>. Please apply the <code>Detox19</code> label.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1860">18.6.0<a aria-label="Direct link to 18.6.0" class="hash-link" href="#1860" title="Direct link to 18.6.0">​</a></h2><p>Detox has normalized the configuration format, so that along with the combined <code>configurations</code> object you now can define your <code>devices</code> and <code>apps</code> separately.
Please refer to the <a href="/docs/config/overview">configuration doc</a> to obtain more details.
This change is backward-compatible, although the new format is now the recommended option.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="180">18.0<a aria-label="Direct link to 18.0" class="hash-link" href="#180" title="Direct link to 18.0">​</a></h2><p>Detox now uses a custom synchronization system on iOS, <a href="/_404.html" rel="noopener noreferrer" target="_blank">developed in-house</a>; this is the second step in phasing out our Earl Grey usage. We have tested this system extensively internally, and are confident that it should work as expected. There are no known limitations with the new system.</p><p>If you are seeing issues with the new sync system, please open an issue.</p><p><strong>Breaking:</strong></p><ul><li><strong>iOS.</strong> Detox now requires iOS 13.0 and above iOS simulator runtimes, and iOS 12.x and below are no longer supported. This does not require that you drop support for iOS 12.x in your apps, just that tests will no longer work on iOS 12 and below. Please make sure your tests are running on iOS 13 or above</li><li><strong>JS.</strong> ⚠️ Detox no longer launches the app automatically (even if asked to do so in configuration) — you have to launch your app explicitly:</li></ul><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> beforeAll(async () =&gt; {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> await device.launchApp();</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> });</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><ul><li><strong>JS (jest-circus).</strong> The <code>DetoxCircusEnvironment</code> provided from <code>detox/runners/jest-circus</code> package now requires two arguments in its constructor, so you have to update your descendant class signature:</li></ul><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">class CustomDetoxEnvironment extends DetoxCircusEnvironment {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> constructor(config) {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> super(config);</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> constructor(config, context) {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> super(config, context);</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><ul><li><strong>JS (iOS).</strong> <code>device.launchApp({ launchArgs: { ... })</code> argument escaping has been improved. If you use complex launch args such as regular expressions, make sure you remove manual escaping from now on to avoid erroneous double escaping, e.g.:</li></ul><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line">await device.launchApp({</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> launchArgs: {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> detoxURLBlacklistRegex: '(\\".*example.com/some-url/.*\\")' }`,</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> detoxURLBlacklistRegex: '(".*example.com/some-url/.*")' }`,</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> },</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line">});</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><ul><li><strong>JS (internal).</strong> There is a breaking change for people writing custom Detox integrations. Environment variable naming schema has changed – now Detox uses prefix to distinguish its own environment variables (usually passed from <code>detox test</code> CLI), e.g.: <code>recordLogs=all</code> becomes <code>DETOX_RECORD_LOGS=all</code>, <code>loglevel=trace</code> becomes <code>DETOX_LOGLEVEL=trace</code>, and so on.</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1752">17.5.2<a aria-label="Direct link to 17.5.2" class="hash-link" href="#1752" title="Direct link to 17.5.2">​</a></h2><p>Fixes the issue from <strong>17.4.7</strong> (see below) - now the migration guide for <strong>17.4.7</strong> can be safely ignored.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1747">17.4.7<a aria-label="Direct link to 17.4.7" class="hash-link" href="#1747" title="Direct link to 17.4.7">​</a></h2><p>This release was not meant to be breaking in any sense, but unfortunately there are two minor caveats that leaked in.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="jest-cli"><code>jest-cli</code><a aria-label="Direct link to jest-cli" class="hash-link" href="#jest-cli" title="Direct link to jest-cli">​</a></h3><p>From now on, Detox explicitly depends on <code>jest-cli</code> package (marked as a peer dependency), that’s why if you see an error like the one below:</p><div class="language-plain codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-plain codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">Cannot find module 'jest-cli/build/cli/args'</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p><del>You should add <code>jest-cli</code> to your <code>package.json</code>’s <code>devDependencies</code> and rerun <code>npm install</code>, e.g.:</del></p><p><strong>UPD</strong>: since <code>detox@17.5.2</code> you can ignore this advice. The problem should go away <strong>without</strong> these edits:</p><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line">"devDependencies": {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> "jest": "26.x.x",</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> "jest-cli": "26.x.x",</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="detox-cli"><code>detox-cli</code><a aria-label="Direct link to detox-cli" class="hash-link" href="#detox-cli" title="Direct link to detox-cli">​</a></h3><p>If you were using <code>detox-cli</code> global package, make sure to upgrade it before proceeding to <code>detox@17.4.7</code>.</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-bash codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token function" style="color: rgb(80, 250, 123);">npm</span><span class="token plain"> </span><span class="token function" style="color: rgb(80, 250, 123);">install</span><span class="token plain"> detox-cli --global</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><p>If you have an older version of <code>detox-cli</code>, then you might see the following error on an attempt to run <code>detox test &lt;...args&gt;</code>:</p><div class="language-plain codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-plain codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">'jest' is not recognized as an internal or external command,</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">operable program or batch file.</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">detox[43764] ERROR: [cli.js] Error: Command failed: jest --config e2e/config.json --testNamePattern "^((?!:android:).)*$" --maxWorkers 1 e2e</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Toggle word wrap" class="clean-btn" title="Toggle word wrap" type="button"><svg aria-hidden="true" class="wordWrapButtonIcon_Bwma" viewbox="0 0 24 24"><path d="M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z" fill="currentColor"></path></svg></button><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1730">17.3.0<a aria-label="Direct link to 17.3.0" class="hash-link" href="#1730" title="Direct link to 17.3.0">​</a></h2><p>In the context of introducing the element screenshots feature (<a href="/_404.html" rel="noopener noreferrer" target="_blank">#2012</a>), we decided to slightly change the contract between Detox and externally-implemented <em>drivers</em>. These should be modified according to the follow diff-snippet:</p><div class="language-diff codeBlockContainer_Ckt0 theme-code-block" style="--prism-color: #F8F8F2; --prism-background-color: #282A36;"><div class="codeBlockContent_biex"><pre class="prism-code language-diff codeBlock_bY9V thin-scrollbar" tabindex="0"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">class Expect {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> constructor(invocationManager) {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> constructor({ invocationManager }) {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> this._invocationManager = invocationManager;</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> }</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token plain">}</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain">class PluginDriver {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> constructor() {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"> this.matchers = new Expect(new invocationManager());</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token unchanged prefix unchanged"> </span><span class="token unchanged line"> }</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token unchanged line"></span><span class="token plain">}</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain" style="display: inline-block;"></span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token plain"></span><span class="token deleted-sign deleted prefix deleted" style="color: rgb(255, 85, 85);">-</span><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);">module.exports = PluginDriver;</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token deleted-sign deleted line" style="color: rgb(255, 85, 85);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);">module.exports = {</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> DriverClass: PluginDriver,</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"> ExpectClass: Expect,</span><br/></span><span class="token-line" style="color: rgb(248, 248, 242);"><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);"></span><span class="token inserted-sign inserted prefix inserted" style="color: rgb(80, 250, 123);">+</span><span class="token inserted-sign inserted line" style="color: rgb(80, 250, 123);">}</span><br/></span></code></pre><div class="buttonGroup__atx"><button aria-label="Copy code to clipboard" class="clean-btn" title="Copy" type="button"><span aria-hidden="true" class="copyButtonIcons_eSgA"><svg class="copyButtonIcon_y97N" viewbox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z" fill="currentColor"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewbox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" fill="currentColor"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1700">17.0.0<a aria-label="Direct link to 17.0.0" class="hash-link" href="#1700" title="Direct link to 17.0.0">​</a></h2><p>Detox for iOS now uses an entirely new, custom-built matcher, action and expectation infrastructure. This is the first step in our roadmap of removing Earl Grey as a dependency.</p><p>While the new system has been designed to be as compatible as possible with the existing system, some changes we made to existing APIs that may or may not require your attention.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="new-api">New API<a aria-label="Direct link to New API" class="hash-link" href="#new-api" title="Direct link to New API">​</a></h3><ul><li><code>pinch()</code>—new API for pinching elements, replacing the deprecated <code>pinchWithAngle()</code> (iOS)</li><li><code>getAttributes()</code>—new API for obtaining element properties (iOS)</li><li><code>not</code>—new API for inverting expectation logic (iOS, Android)</li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="modified-api-potentially-breaking-changes">Modified API (<strong>Potentially Breaking Changes</strong>)<a aria-label="Direct link to modified-api-potentially-breaking-changes" class="hash-link" href="#modified-api-potentially-breaking-changes" title="Direct link to modified-api-potentially-breaking-changes">​</a></h3><p>The following APIs have changed and require attention</p><ul><li><code>by.text()</code>—matching elements by text actually uses the element’s text value instead of using the accessibility label (iOS)</li><li><code>by.traits()</code>—the supported trait values have changed (iOS)</li><li><code>atIndex()</code>—matched elements are now sorted by x and y axes to allow for stability between tests; indices will most likely change after upgrading to this version of Detox (iOS)</li><li><code>tap()</code>—this method now accepts an optional point to tap (iOS, Android)</li><li><code>setColumnToValue()</code>—this method no longer supports date pickers; use <code>setDatePickerDate()</code> to change picker dates (iOS)</li><li><code>setDatePickerDate()</code>—in addition to normal date formats, a new special case is introduced for ISO 8601 formatted date strings: <code>"ISO8601"</code> (iOS)</li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="deprecated-api">Deprecated API<a aria-label="Direct link to Deprecated API" class="hash-link" href="#deprecated-api" title="Direct link to Deprecated API">​</a></h3><p>The following APIs have been deprecated, but is still available</p><ul><li><code>tapAtPoint()</code>—the API has been consolidated with <code>tap(point)</code> (iOS, Android)</li><li><code>pinchWithAngle()</code>—this API has been replaced with <code>pinch()</code> (iOS)</li><li><code>toBeNotVisible()</code>—deprecated in favor of <code>not.toBeVisible()</code> (iOS, Android)</li><li><code>toNotExist()</code>—deprecated in favor of <code>not.toExist()</code> (iOS, Android)</li></ul><p>Make sure to read the API reference for <a href="/docs/api/matchers">matchers</a>, <a href="/docs/api/actions">actions</a> and <a href="/docs/api/expect">expectations</a>.</p><p>If you see unexpected results, make sure to open an issue.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1600">16.0.0<a aria-label="Direct link to 16.0.0" class="hash-link" href="#1600" title="Direct link to 16.0.0">​</a></h2><p>Detox now comes as a prebuilt framework on iOS, thus lowering npm install times and saving some build issues that happen due to unexpected Xcode setups.</p><p>To support this, Detox needs Swift 5 support, so the iOS requirements have changed slightly:</p><ul><li><strong>Xcode</strong>: 10.2 or higher<ul><li><strong>iOS Simulator Runtime</strong>: iOS 12.2 or higher</li></ul></li></ul><p>This does not require that your app require iOS 12.2, only that you build and run your app on Xcode 10.2 or above, and use an iOS 12.2 or above simulator.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a class="theme-edit-this-page" href="/_404.html" rel="noreferrer noopener" target="_blank"><svg aria-hidden="true" class="iconEdit_Z9Sw" fill="currentColor" height="20" viewbox="0 0 40 40" width="20"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav aria-label="Docs pages" class="pagination-nav docusaurus-mt-lg"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/troubleshooting/element-matching"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Dealing with Element Matching Issues</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a class="table-of-contents__link toc-highlight" href="#200">20.0</a><ul><li><a class="table-of-contents__link toc-highlight" href="#no-mocha-support">No Mocha support</a></li><li><a class="table-of-contents__link toc-highlight" href="#jest-2725-and-higher">Jest 27.2.5 and higher</a></li><li><a class="table-of-contents__link toc-highlight" href="#all-in-one-configs">All-in-one configs</a></li><li><a class="table-of-contents__link toc-highlight" href="#testrunner-config-section"><code>testRunner</code> config section</a></li><li><a class="table-of-contents__link toc-highlight" href="#custom-jest-environment">Custom Jest environment</a></li><li><a class="table-of-contents__link toc-highlight" href="#new-jest-config">New Jest config</a></li><li><a class="table-of-contents__link toc-highlight" href="#stop-using-timeline-artifacts">Stop using timeline artifacts</a></li><li><a class="table-of-contents__link toc-highlight" href="#updating-command-line-scripts">Updating command-line scripts</a></li><li><a class="table-of-contents__link toc-highlight" href="#revisit-environment-variables">Revisit environment variables</a></li><li><a class="table-of-contents__link toc-highlight" href="#miscellaneous">Miscellaneous</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="#192">19.2</a></li><li><a class="table-of-contents__link toc-highlight" href="#190">19.0</a><ul><li><a class="table-of-contents__link toc-highlight" href="#migrating-custom-drivers">Migrating Custom Drivers</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="#1860">18.6.0</a></li><li><a class="table-of-contents__link toc-highlight" href="#180">18.0</a></li><li><a class="table-of-contents__link toc-highlight" href="#1752">17.5.2</a></li><li><a class="table-of-contents__link toc-highlight" href="#1747">17.4.7</a><ul><li><a class="table-of-contents__link toc-highlight" href="#jest-cli"><code>jest-cli</code></a></li><li><a class="table-of-contents__link toc-highlight" href="#detox-cli"><code>detox-cli</code></a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="#1730">17.3.0</a></li><li><a class="table-of-contents__link toc-highlight" href="#1700">17.0.0</a><ul><li><a class="table-of-contents__link toc-highlight" href="#new-api">New API</a></li><li><a class="table-of-contents__link toc-highlight" href="#modified-api-potentially-breaking-changes">Modified API (<strong>Potentially Breaking Changes</strong>)</a></li><li><a class="table-of-contents__link toc-highlight" href="#deprecated-api">Deprecated API</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="#1600">16.0.0</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col footer__col_docs"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/introduction/getting-started">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing to Detox</a></li></ul></div><div class="col footer__col footer__col_support"><div class="footer__title">Support</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item footer__link-item_ask-a-question-on-stack-overflow" href="/_404.html" rel="noopener noreferrer" target="_blank">Ask a question on Stack Overflow</a></li><li class="footer__item"><a class="footer__link-item footer__link-item_create-new-issue-on-github" href="/_404.html" rel="noopener noreferrer" target="_blank">Create new issue on Github</a></li></ul></div><div class="col footer__col footer__col_more"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item footer__link-item_git-hub" href="/_404.html" rel="noopener noreferrer" target="_blank">GitHub</a></li><li class="footer__item"><a class="footer__link-item footer__link-item_twitter" href="/_404.html" rel="noopener noreferrer" target="_blank">Twitter</a></li><li class="footer__item"><a class="footer__link-item footer__link-item_discord" href="/_404.html" rel="noopener noreferrer" target="_blank">Discord</a></li></ul></div></div></div></footer></div>
<script src="/assets/js/runtime~main.12cb17c3.js"></script>
<script src="/assets/js/main.899efd46.js"></script>
<iframe allowtransparency="true" frameborder="0" scrolling="no" src="/_cdn/platform.twitter.com/widgets/widget_iframe.1227a5674072e080ffb1ba14ac0c1079.html?origin=https%3A%2F%2Fwix.github.io" style="display: none;" title="Twitter settings iframe"></iframe><div class="c--anim" id="cc--main" style="position: fixed;"><div class="cc_div" id="cc_div"><div aria-describedby="c-txt" aria-labelledby="c-ttl" aria-modal="true" class="box bottom center zoom" id="cm" role="dialog" style="visibility: hidden;" tabindex="-1"><div id="c-inr"><div id="c-inr-i"><h2 id="c-ttl">We use cookies!</h2><div id="c-txt">This website uses essential cookies to ensure its proper operation and tracking cookies to understand how you interact with it. The latter will be set only after consent.</div></div><div id="c-bns"><button class="c-bn" id="c-p-bn" type="button"><span tabindex="-1">I agree</span></button><button class="c-bn c_link" id="c-s-bn" type="button"><span tabindex="-1">Customize</span></button></div></div></div><div id="cm-ov" style="visibility: hidden; opacity: 0;"></div><div aria-hidden="true" aria-labelledby="s-ttl" aria-modal="true" class="zoom" id="s-cnt" role="dialog" style="visibility: hidden;" tabindex="-1"><div id="c-vln"><div id="cs"><div id="c-s-in"><div class="bns-t" id="s-inr"><div id="s-hdr"><h2 id="s-ttl">Cookie settings</h2><div id="s-c-bnc"><button aria-label="Close" class="c-bn" id="s-c-bn" type="button"><span tabindex="-1"></span></button></div></div><div id="s-bl"><div class="c-bl"><div class="title"><div aria-level="3" class="b-tl" role="heading">Cookie usage</div></div><div class="desc"><div class="p">We use cookies to ensure the basic functionalities of the website and to enhance your online experience. You can choose for each category to opt-in/out whenever you want.</div></div></div><div class="c-bl b-ex"><div class="title b-bn"><button aria-controls="c-ac-1" aria-expanded="false" class="b-tl exp" type="button">Functionality cookies</button><label class="b-tg"><input class="c-tgl" disabled="" type="checkbox" value="functionality_storage"/><span aria-hidden="true" class="c-tg c-ro"><span class="on-i"></span><span class="off-i"></span></span><span class="t-lb">Functionality cookies</span></label></div><div aria-hidden="true" class="desc b-acc" id="c-ac-1"><div class="p">These cookies are necessary for the proper functioning of our website. Without these cookies, the website might not be working properly.</div></div></div><div class="c-bl b-ex"><div class="title b-bn"><button aria-controls="c-ac-2" aria-expanded="false" class="b-tl exp" type="button">Security cookies</button><label class="b-tg"><input class="c-tgl" type="checkbox" value="security_storage"/><span aria-hidden="true" class="c-tg"><span class="on-i"></span><span class="off-i"></span></span><span class="t-lb">Security cookies</span></label></div><div aria-hidden="true" class="desc b-acc" id="c-ac-2"><div class="p">Security cookies allows storage of security-related information, such as authentication, fraud protection, and other means to protect the user.</div></div></div><div class="c-bl b-ex"><div class="title b-bn"><button aria-controls="c-ac-3" aria-expanded="false" class="b-tl exp" type="button">Personalization cookies</button><label class="b-tg"><input class="c-tgl" type="checkbox" value="personalization_storage"/><span aria-hidden="true" class="c-tg"><span class="on-i"></span><span class="off-i"></span></span><span class="t-lb">Personalization cookies</span></label></div><div aria-hidden="true" class="desc b-acc" id="c-ac-3"><div class="p">Personalisation cookies may use third party cookies to help them personalise content and track users across different websites and devices.</div></div></div><div class="c-bl b-ex"><div class="title b-bn"><button aria-controls="c-ac-4" aria-expanded="false" class="b-tl exp" type="button">Ad cookies</button><label class="b-tg"><input class="c-tgl" type="checkbox" value="ad_storage"/><span aria-hidden="true" class="c-tg"><span class="on-i"></span><span class="off-i"></span></span><span class="t-lb">Ad cookies</span></label></div><div aria-hidden="true" class="desc b-acc" id="c-ac-4"><div class="p">Advertising cookies are used by us or our partners to show you relevant content or advertisements both on our site and on third party sites. This enables us to create profiles based on your interests, so-called pseudonymised profiles. Based on this information, it is generally not possible to directly identify you as a person, as only pseudonymised data is used. Unless you express your consent, you will not receive content and advertisements tailored to your interests.</div></div></div><div class="c-bl b-ex"><div class="title b-bn"><div class="b-tl">Ad user data</div><label class="b-tg"><input class="c-tgl" type="checkbox" value="ad_user_data"/><span aria-hidden="true" class="c-tg"><span class="on-i"></span><span class="off-i"></span></span><span class="t-lb">Ad user data</span></label></div><div aria-hidden="true" class="desc b-acc" id="c-ac-5"></div></div><div class="c-bl b-ex"><div class="title b-bn"><div class="b-tl">Ad personalization</div><label class="b-tg"><input class="c-tgl" type="checkbox" value="ad_personalization"/><span aria-hidden="true" class="c-tg"><span class="on-i"></span><span class="off-i"></span></span><span class="t-lb">Ad personalization</span></label></div><div aria-hidden="true" class="desc b-acc" id="c-ac-6"></div></div><div class="c-bl b-ex"><div class="title b-bn"><button aria-controls="c-ac-7" aria-expanded="false" class="b-tl exp" type="button">Analytics cookies</button><label class="b-tg"><input class="c-tgl" type="checkbox" value="analytics_storage"/><span aria-hidden="true" class="c-tg"><span class="on-i"></span><span class="off-i"></span></span><span class="t-lb">Analytics cookies</span></label></div><div aria-hidden="true" class="desc b-acc" id="c-ac-7"><div class="p">Analytics cookies allow us to measure the performance of our website and our advertising campaigns. We use them to determine the number of visits and sources of visits to our website. We process the data obtained through these cookies in aggregate, without using identifiers that point to specific users of our website. If you disable the use of analytics cookies in relation to your visit, we lose the ability to analyse performance and optimise our measures.</div></div></div><div class="c-bl"><div class="title"><div aria-level="3" class="b-tl" role="heading">More information</div></div><div class="desc"><div class="p">For any queries in relation to our policy on cookies and your choices, please contact us.</div></div></div></div><div id="s-bns"><button class="c-bn" id="s-all-bn" type="button">Accept all</button><button class="c-bn" id="s-rall-bn" type="button">Accept necessary</button><button class="c-bn" id="s-sv-bn" type="button">Save settings</button></div></div></div></div></div></div><div id="cs-ov" style="visibility: hidden; opacity: 0;"></div></div></div><iframe allowfullscreen="true" allowtransparency="true" frameborder="0" id="rufous-sandbox" scrolling="no" style="position: absolute; visibility: hidden; display: none; width: 0px; height: 0px; padding: 0px; border-width: medium; border-style: none; border-color: currentcolor; border-image: initial;" title="Twitter analytics iframe"></iframe></body></html>