Detox

Breaking changes

In this release, technically there are two breaking changes, although it is unlikely that they affect you. However, if you have been:

1. using semi-documented detox.artifacts.pathBuilder property in package.json of your project:

See #1827 — fix(configuration): pathBuilder resolution should be Node.js-ish [by @noomorph]

2. using the deprecated -f, --file, -s, --specs for Detox CLI, or detox.file property in package.json:

See #1828 — deprecation: CLI (-f, --file, -s, --specs), package.json (detox.file) [by @noomorph]

Features

• #1822 — Apply Jest timeout setup optimization into init (cli) template [by @d4vidi]

Fixes

Android emulator

• #1778 — Respect ANDROID_AVD_HOME environment variable [by @lvanengelen]
• #1816 — Extra step to find config file in case emulator has been renamed [by @gustavos60]

Instruments recording (--record-performance)

• #1823 — should not crash if the app was terminated inside a test [by @noomorph]

• Fix issue: Update getDirectories to include symbolic links to directories (#1799)

Android:

• Allow for proprietary instrumentation args to run seamlessly via launch-args (but not to the app) (#1815)
• Various Detox CI fixes and enhancements

Attempt to fix a crash in Detox pretty print function.

No significant changes compared to 14.8.4

Android:

• Fix crash related to url-based app launching in recent Android SDK's (>=28 or so) (#1728):

Calling startActivity() from outside of an Activity context requires the FLAG_ACTIVITY_NEW_TASK flag. Is this really what you want?

• Improve overall robustness (of tap-actions, among others)

Hide iOS' keyboard tutorial when running tests.

• Make device ID publicly available at top-level API

Android:

• Improve stability of emulator boot-ups in parallel-exec mode

Android:

• Introduce reverseTcpPort() and unreverseTcpPort() as top-level API's, equivalent to the adb reverse command
• Fix occasional crash originally cause due to refactoring of what used to be the ReactNativeSupport class

Android:

• Introduce partial (initial) refactoring of some of detox' react native code
• Improve resolution of AAPT path (see ##1737)

Android:

• Introduced a long overdue (internal) refactoring of some of detox' react-native related code on Android

iOS:

• Allow to override status bar on iOS simulator (#1748)

Fixes

• fix(android): ability to execute SDK binaries from "Program Files (x86)" or other folders containing whitespaces (#1738, #1739 by @forki)

Features

• feat(config): add artifacts subsystem configuration via JSON (#1729, by @noomorph) — see Artifacts Configuration

Documentation

• typo fix (#1744 by @samin)
• update support table (https://github.com/wix/Detox/commit/50c7d7e91c2b7b6e9437c52e5ce4da9167e96963 by @d4vidi )

• fix(android): compliance with RN 61 for Android (#1731, @d4vidi) - stay tuned for iOS support.

Fixes

• fix(android): compliance with RN 60 for Android (#1721, @d4vidi)

Features

• feat(device): takeScreenshot() returns temp path (#1715, @noomorph)

Performance improvements

• perf(ios): faster time to boot in multi-worker mode (#1727, @rotemmiz)

• Add support for modern RN timer implementation (thanks @rodrigos-facebook)

Migration

It is recommended to change "name" string to "device" object in your configurations like shown in Guide.Migration.md#14.5.0.

Issues resolved

#853 - [SimulatorDriver] semantics of device.name has been unexpectedly changed since 7.4.0
#1103 - Incorrect OS version of specified iPhone simulator name
#1565 - TypeError: Cannot read property 'identifier' of undefined
#1692 - "detox init" removes package.json if there is invalid JSON

Pull requests merged

#1693 - fix(init) exits on error before erasing package.json
#1694 - feat(ios): remove dependency on xcrun simctl list -j
#1698 - feat(configuration): name string -> device object
#1697 - feat(ios): add method device.clearKeychain()

Fixed an edge-case issue with app launched on Android, taking place in calls to device.launchApp() while the app is already running (#1599).

• Added --device-launch-args (#1676), a list of passthrough-arguments to use if/when devices (Android emulator or iOS simulator) are launched by Detox. Usage for Android:

detox test  ...  --device-launch-args="-http-proxy http://1.1.1.1:8000 -no-snapshot-load"

• Allow passing --workers as a percent value to Jest runner (#1680). Example:

detox test  ...  --workers "50%"

Original description by @noomorph

• iOS 13 support
• Added support for scrolling start-position control on Android (parity with iOS)

Android:

• Further improve scrolling accuracy, to better match JS-provided amount parameter (#1662)

iOS:

• Improve idle-wait time when disableTouchIndicator is set (#1660)