CHANGELOG.md

Changelog

1.31.0 - 2023-08-10

• Fix: Warning shown from OkHttp for leaking response bodies on CLI
  • Closing response bodies for retries done on the XCUITest driver
  • Closing response bodies for permissions
  • Removing different thread execution done on hideKeyboard
• Fix: Scroll for React native apps on screens with large view hierarchies on iOS
• Fix: Showing more descriptive errors on flow file not found during maestro cloud command.
• Fix: Input text characters being skipped or being appended later in the test on iOS
• Fix: Crash in debug output generation when maestro flow contains "/"’
• Fix: Resolved issue where tapping on the device in maestro studio produced inaccurate click locations due to incorrect coordinates. Now fixed for accurate device interaction
• Fix: In Maestro Studio, the issue of window resizing causing devices to overflow off the screen has been resolved.
• Feature: Add headers to HTTP response for API calls done with Maestro. Thanks, Jesse Willoughby! for this contribution.
• Feature: Now it is possible to configure the path with the –debug-output option for debugging information that maestro dumps in the user directory by default.
• Feature: Enhanced Maestro Studio with keyboard accessibility, streamlining navigation and facilitating the copy, run, and edit commands using the keyboard.
• Change: Fail the test if any of the onFlowStart or onFlowComplete hooks fail
• Change: Removed IDB on iOS. This may impact the performance of maestro commands like tapOn and assertVisible on iOS screens with large view hierarchies.
  • Studio and CLI will now provide insights and warnings in case the hierarchy of these screens becomes extensive.
• Change: In Maestro Studio, we've integrated screenshots of selected elements alongside their corresponding commands.
• Change: In Maestro Studio, double-clicking will now execute the command.

1.30.4 - 2023-07-19

• Fix: correctly resolve external parameters for onStart/Complete hooks
• Fix: reuse JSEngine for all executeCommands (hooks, main commands, subflows) actions

1.30.3 - 2023-07-17

• Update: Maestro Studio revamp improvements
  • wrapped element names in sidebar
  • sidebar text always visible
  • add "hintText" and "accesbilityText" in sidebar
  • improve sidebar search
  • fixed highlight issues in search
  • various other small improvements

1.30.2 - 2023-07-14

• Revert connection improvements (from 1.30.1)

1.30.1 - 2023-07-14

• Fix: Allow running maestro studio and maestro test simultaneusly
• Fix: Connection improvements

1.30.0 - 2023-07-13

• Feature: onFlowStart / onFlowComplete hooks
• Feature: Maestro Studio revamp
  • improved design
  • search components panel
  • improved drag-and-drop
• Feature: Introduce --app-binary-id parameter for Maestro Cloud upload action to be able to re-use a previously uploaded app for different flows
• Feature: Implement Experimental GraalJsEngine (ECMAScript 2022 compliant)
• Fix: Save xctest xcodebuild logs output to system temp dir
• Fix: Close existing screen recording if it was left open.
  • Thanks, @carlosmuvi, for the contribution!
• Fix: Execute sequential Flows even if no other Flows are present
• Fix: Various XCTestClient connection improvements
• Deprecate: assertOutgoingRequestsCommand
• Deprecate: Network Mocking feature
• Deprecate: Maestro Mock Server feature

1.29.0 - 2023-06-19

• Feature: Add test duration measurement and display
• Feature: New screen recording commands
  • Thanks, @tokou, for the contribution!
• Feature: Add support for sequential execution
• Feature: Add support for double taps + multiple taps in tapOn
• Feature: Add support for custom Android driver startup timeout
  • Thanks, @arildojr7, for the contribution!
• Fix: Validate workspace prior to upload to Maestro Cloud
• Fix: Resolve Android scrollUntilVisible flakiness
• Fix: Resolve inputText flakiness
• Fix: iOS url arguments
  • Thanks, @tokou, for the contribution!

1.28.0 - 2023-05-18

• Feature: runScript command now support conditional execution
• Feature: Improved debug output:
  • Shows failure reason when command fails
  • Generates screenshot when command fails
  • Unified most logs under ~/.maestro/tests//maestro.log
• Change: Launch arguments support for long values
• Tweak: JUnit report naming changes. Local and Cloud should now have the same naming convention.
• Tweak: Added deprecation notice for experimental features
• Fix: maestro record command was not working on iOS
• Fix: WebDriver, only scroll to elements outside of the window before tapping
• Fix: close request leaking body
• Fix: maestro cloud now will fail on timeout if configured as such

1.27.0 - 2023-05-02

• Feature: Adds assertOutgoingRequests to assert the network requests from the app
• Feature: Add platform condition in runFlow command to do platform-specific orchestration. Thanks, Larry Ng for your contribution!
• Feature: Adds a new selector containsDescendants. Thanks, Larry Ng for your contribution!
• Feature: iOS and Android launch arguments
• Change: Include the update command instead of update instructions in the update message. Thanks @bobpozun for your contribution!
• Fix: Fixes swipe flakiness caused due to waiting for animations to complete on XCTest
• Fix: Correctly resolving maestro.copiedText
• Fix: Using deviceId instead of booted, potentially resolving XCTestUnreachable exceptions.
• Fix: Improving waitForAppToSettle for Android by accounting window updates. Resolves maestro command interaction in Android 13.
• Fix: Notification permissions not getting granted
• Fix: Use correct documentation URLs in Studio

1.26.1 - 2023-04-13

• Fix: hideKeyboard crashing on react native apps because swipe fails on some screens

1.26.0 - 2023-04-13

• Feature: Adds Travel command to mock motion for app
• Feature: Adds a capability to match the toast messages
• Feature: Add support for console.log in javascript
• Feature: Allow writing inline flows with runFlow command
• Change: Adds sms permission to permission names which can be used to allow/deny: android.permission.READ_SMS, android.permission.RECIEVE_SMS, android.permission.SEND_SMS. Thanks, @depapp for the contribution.
• Change: Maestro can now also match hint text and values of text field.
• Change: Maestro can now also match elements with their accessibility text.
• Commands moved away from IDB:
  • Long press is now done with XCTest instead of idb
  • Installation of app is now done with simctl commands
  • Hide keyboard with help of XCTest. We now scroll up and down from the middle of the screen to close the keyboard.
  • Press key now is done with XCTest.
  • Note that with this change pressKey: Enter now only wraps on new line - earlier it also closed the keyboard
  • Erase text is now done with XCTest.
  • Use simctl to record screen
• Fix: Web driver no longer crashes when using latest Chrome
• Fix: Fixes hideKeyboard on android by appropriately dispatching proper event. Thanks, @nhaarman for contribution
• Fix: Properly shutting down studio by listening to SIGTSP signal
• Fix: Update granting of notifications and health permissions causing simulator restarts and XCTestUnreachableExceptions.

1.25.0 - 2023-03-13

• Fix: Shell environment variables can no longer crash the javascript runtime
• Fix: XCTestRunner and IDB are restarted on connection error
• Feature: Add support for setLocation

1.24.0 - 2023-03-07

• Change: LaunchApp command sets all app permissions to allow (documentation)
• Feature: LaunchApp supports specifying app permission state
• Feature: On Android it is now possible to force links to be opened in the browser
• Fix: Autocorrect is no longer applied to inputText on iOS
• Fix: iOS apps with big view hierarchies (common with ReactNative and Flutter) caused an error in XCTest.framework
• Fix: Studio UI fixes for Firefox and Safari
• Fix: Element selection behavior in Maestro Studio

1.23.0 - 2023-02-15

• Feature: Maestro Studio - Action Modal
• Feature: Maestro Studio - Dark Mode
• Feature: assertion on enabled, selected, checked, focused properties (documentation)
• Feature: running tests in a deterministic order (documentation)
• Feature: default global tags can now be set in config.yaml (documentation)
• Feature: allow to configure what flows should be included into a run at config.yaml level (documentation)
• Tweak: considerable speed-up of iOS tests due to removal of unnecessary hierarchy polling
• Tweak: wait for app to settle before proceeding with iOS test
• Tweak: UX improvements in "delete command" confirmation dialog
• Tweak: using xcrun for uninstall command on iOS
• Tweak: using xcrun for clearKeychain command on iOS
• Tweak: using .maestro directory by default for mockserver deploy command
• Fix: errors were clipped in Maestro Studio
• Fix: use element title as id in Web driver
• Fix: Repeat-while-true did not work properly with JavaScript conditions
• Fix: Repeat-times did not work properly with JavaScript input
• Fix: added artificial delay after key presses (i.e. "back" key) on Android

1.22.1 - 2023-02-09

• Early Access Feature: Maestro Mock Server and Maestro SDK (Android preview)
• Tweak: added visibility threshold and scroll speed to scrollUntilVisible command
• Tweak: speed up tapOn command on iOS
• Fix: removing view hierarchy elements that are out of screen bounds
• Fix: inputText command skipping characters on iOS
• Fix: Reworked clearAppState behaviour on iOS, solving issue that caused crashes after clearing the state
• Fix: crash when running multiple Maestro sessions in parallel while using iOS device
• Fix: a rare crash in React Native apps when trying to input a long string on iOS
• Fix: properly handling linebreaks in Maestro Studio

1.21.3 - 2023-01-30

• Fix: scrollUntilVisible was not always working on iOS
• Tweak: speed up tests by skipping an unnecessary hierarchy poll
• Tweak: iOS screenshot no longer depends on IDB and is faster

1.21.2 - 2023-01-26

• Hotfix: Move iOS tap() implementation back to IDB to resolve problems with React Native apps
• Fix: running multiple Maestro instances would sometimes result in Connection exception
• Fix: support JS injection in scrollUntilVisible command

1.21.1 - 2023-01-25

• Fix: Increase typing speed for iOS text input

1.21.0 - 2023-01-25

• Feature: Next evolution of Maestro Studio
• Fix: More robust implementation of inputText on iOS
• Fix: More robust implementation of tap on iOS
• Experimental: Added web driver

1.20.0 - 2023-01-24

• Feature: Maestro Studio - use percentage-based swiping
• Feature: Scroll until view element is visible
• Feature: Relatively swipe with percentage based start and end coordinates
• Fix: Android tap was not always working
• Fix: Bottom of Android hierarchy was cut off
• Fix: idb_companion fails to start due to gRPC timeout exception
• Tweak: Improve Android Screenshot Internal Logic
• Tweak: Change the end coordinates for swipe element
• Tweak: Update sample flows

1.19.5 - 2023-01-19

• Fix: inputText was not working on iOS React Native apps
• Fix: Maestro fails to launch on iOS if --device parameter is present
• Fix: Evaluate JS scripts with element selector in swipe command
• Tweak: added tags to sample flows
• Tweak: indicating whether build is running on CI in analytics

1.19.2 - 2023-01-17

• Hotfix: Maestro Studio was not working

1.19.1 - 2023-01-17

• Feature: generating test report from maestro cloud output
• Fix: in rare cases, maestro cloud was computing progress bar as negative value
• Fix: local test suite included non-flow files
• Fix: some special characters were not allowed in env variables (i.e. &)
• Fix: vertical scrolling was sometimes not working on iOS
• Fix: if a text string is an invalid regex, treat it as a regular string instead
• Fix: scroll and swipe commands on iOS were throwing an error when running in parallel with Maestro Studio
• Tweak: print out valid inputs for --format parameter in maestro test and maestro upload
• Tweak: removed Maestro Studio warning related to parallel execution
• Refactor: making XCTestDriver configurable

1.19.0 - 2023-01-13

• Feature: iOS unicode input support + non-English keyboards
• Feature: swipe command now supports from argument to swipe from a given view
• Feature: repeat command now supports while condition
• Feature: Allowing extendedWaitUntil command to use env values in timeout property
• Tweak: assert commands now respect optional flag
• Tweak: error analytics
• Fix: scroll not working reliably on iOS
• Fix: openLink was opening Google Maps on Android
• Fix: sub-flows are now included regardless of their tags
• Fix: Maestro Studio was not always computing index field correctly
• Fix: maestro upload was ignoring JS files
• Fix: openLink command now supports query parameters

1.18.5 - 2023-01-10

• Feature: tags
• Tweak: allow running other maestro commands alongside Maestro Studio
• Tweak: improved matching for strings with linebreaks
• Fix: creating maestro logs directory was not always working properly
• Fix: maestro studio was not working properly on Kubuntu

1.18.3 - 2022-12-27

• XCUITest driver improvements and fixes:
  • Close the response when validating server up
  • Add logs to uninstall of runner
  • Remove redundant import and library from maestro-ios
  • Kills the process before we uninstall it
  • Redirect runner logs in xctest_runner_logs directory

1.18.2 - 2022-12-27

• Fix: Wait for XCUITest server to start before proceeding

1.18.1 - 2022-12-27

• Fix: Create XCUITest driver HTTP server on loopback address
• Fix: Create parity with idb for text attribute with following priority:
  • Title
  • Label
  • Value

1.18.0 - 2022-12-26

• Feature: Adds new XcUITest driver to capture view hierarchy on iOS.
  • Fixes stability issues on iOS 16
  • Fixes not identified bottom navigation tabs
  • Gets view hierarchy natively from XCUITest
• Fix: Missing letter j and y in inputRandomText command
• Tweak: Un-deprecate the hierarchy command, inform about Studio
• Tweak: Match negative bounds as well in maestro studio
• Feature: Adds replay functionality in maestro studio
• Feature: Adding device interaction to interact page in Maestro Studio

1.17.4 - 2022-12-15

• Fix: Maestro commands were failing if Android SDK wasn't installed

1.17.3 - 2022-12-15

• Feature: no-ansi version for terminals that do not ANSI
• Feature: Android Maven artifact for setting up network mocking
• Fix: Android emulator was not discovered properly if it wasn't on PATH
• Fix: missing favicon

1.17.2 - 2022-12-13

• Tweak: Deprecate hierachy and query CLI commands

1.17.1 - 2022-12-12

• Tweak: Remove Maestro Studio icon from Mac dock
• Tweak: Prefer port 9999 for Maestro Studio app
• Fix: Fix Maestro Studio conditional code snippet

1.17.0 - 2022-12-12

• Feature: Maestro Studio
• Feature: Print a message when an update is available
• Feature: Support percentages for tapOn
• Fix: Maestro commands execute faster now
• Fix: Fix environment variable substitution in certain cases
• Fix: Use actual android device screen size (including nav bar)

1.16.4 - 2022-12-02

• Fix: Add error message for when an Android screen recording fails

1.16.3 - 2022-12-02

• Fix: Fix iOS clearState not working in certain cases
• Fix: Fix maestro record not capturing full launch screen recording

1.16.2 - 2022-12-02

• Fix: older version of Maestro Driver on Android was not always updated

1.16.1 - 2022-11-30

• Feature: maestro record command
• Fix: z character was not inputted correctly on Android

1.16.0 - 2022-11-29

• Feature: Javascript injection support
  • runScript and evalScript commands to run scripts
  • assertTrue command to assert based on Javascript
  • runFlow can be launched based on Javascript condition
  • copyTextFrom now also stores result in maestro.copiedText variable
  • Env parameters are now treated as Javascript variables
• Feature: HTTP(s) requests
  • http.request() Javascript API that allows to make HTTP requests as part of Maestro flows
• Feature: Maestro Cloud --android-api-level parameter to select API version to be used
• Feature: waitForAnimationToEnd command to wait until animations/videos are finished
• Tweak: test reports can now be generated for single test runs (and not just folders)
• Tweak: inputText on Android was reworked to increase speed and input stability
• Tweak: eraseText is now much faster
• Tweak: maestro cloud will automatically retry upload up to 3 times
• Fix: running on Samsung devices was sometimes failing because of wrong user being used

1.15.0 - 2022-11-17

• Feature: run all tests in a folder as a suite
• Feature: XML test report in JUnit-compatible format
• Feature: copyTextFrom command for copying text from a view
• Feature: maestro bugreport command for capturing Maestro logs
• Breaking change: Removed clipboardPaste command in favour of new pasteText command
• Fix: Java 8 compatibility issue for M1 users
• Fix: _ character was mapped incorrectly on iOS
• Fix: first tapOn command was failing unless it was preceeded by launchApp or openLink
• Tweak: Maestro no longer kills running idb_companion processes
• Tweak: updated gRPC version to 1.52.0

1.14.0 - 2022-11-14

• Fix: passing env parameters to subflows and other env params
• Speeding up maestro flows
• Checking in maestro sample flows and adds sample updating guide
• Maestro is now compatible with java 8!
• Launching app without stopping the app
• Fixing launching app when resolving launcher activity throws NullPointerException

1.13.2 - 2022-11-10

• Fix: Fallback properly on monkey when start-activity command fails, when launching app.

1.13.1 - 2022-11-09

• Fix: Fix maestro hanging with message "Waiting for idb service to start.."
• Fix: Fix clearState operation not working on iOS

1.13.0 - 2022-11-08

• Feature: Option to set direction and speed for swipe command
• Fix: Fix duplicate and unavailable iOS simulators in list
• Fix: Longer timeout for iOS simulator boot

1.12.0 - 2022-11-06

• Feature: maestro cloud command added

1.11.4 - 2022-11-02

• Fix: Use absolute path to prevent NullPointerException when .app folder is in the cwd
• Fix: Create parent directory if not exists when generating adb key pair, updates dadb to 1.2.6
• Fix: Opening of leak canary app
• Tweak: send agent: ci when known CI environment variables are set

1.11.3 - 2022-10-29

• Fix: updating to dadb 1.2.4

1.11.2 - 2022-10-29

• Fix: updating to dadb 1.2.3 to fix an occassional device connection issue
• Fix: injecting env parameters into conditions (i.e. in runFlow)

1.11.1 - 2022-10-27

• Fix: closing idb_companion after maestro completes

1.11.0 - 2022-10-26

• Feature: maestro will offer user to select a device if one is not running already
• Feature: env variables can be inlined in flow file or in runFlow command
• Breaking change: --platform option is deprecated. CLI now prompts user to pick a device.
• Tweak: auto-starting idb_companion. No need to start it manually anymore.
• Tweak: tripled Android Driver launch timeout
• Tweak: customisable error resolution in Orchestra
• Fix: maestro upload was not ignoring -e parameters

1.10.1 - 2022-10-12

• Fix: login command fails with java.lang.IllegalStateException: closed

1.10.0 - 2022-10-12

• Feature: repeat command that allows to create loops
• Feature: conditional runFlow execution that allows to create if-conditions
• Feature: inputRandomText, inputRandomNumber, inputRandomEmail and inputRandomPersonName commands (thanks @ttpho !)
• Feature: clipboardPaste command (thanks @depapp !)
• Feature: Added enabled property to element selector
• Feature: Added download-samples command to allow quickstart without having to build your own app
• Feature: Added login and logout commands for interacting with mobile.dev
• Breaking change: upload now takes 1 less argument. uploadName parameter was replaced with --name optional argument
• Tweak: upload command automatically zips iOS apps
• Tweak: sending agent: cli value alongside upload and login commands
• Fix: properly compare fields that contain regex special symbols
• Fix: input text on Android was sometimes missing characters

1.9.0 - 2022-09-30

• Feature: USB support for Android devices

1.8.3 - 2022-09-28

• Fix: occasional crash when an iOS layout has a view group with a 0 width
• Fix: properly mapping top-level syntax errors

1.8.2 - 2022-09-27

• Tweak: prioritise clickable elements over non-clickable ones
• Fix: close TCP forwarder if it is already in use
• Fix: hideKeyboard on Android did not always work

1.8.1 - 2022-09-27

• Fix: Timeout exception while opening port for tcp forwarding

1.8.0 - 2022-09-22

• Feature: runFlow command
• Tweak: support of Tab Bar on iOS
• Tweak: added --mapping option to upload CLI command
• Fix: open the main launcher screen on Android instead of Leak Canary
• Fix: input character-by-character on Android to counter adb issue where not the whole text gets transferred to the device

1.7.2 - 2022-09-20

• Fix: tapOn command was failing due to a failure during screenshot capture

1.7.1 - 2022-09-19

• Feature: clearState command
• Feature: clearKeychain command
• Feature: stopApp command
• Tweak: Maestro now compares screenshots to decide whether screen has been updated
• Tweak: launchApp command now supports env parameters

1.7.0 - 2022-09-16

• Feature: maestro upload command for uploading your builds to mobile.dev
• Feature: takeScreenshot command
• Feature: extendedWaitUntil command
• Fix: waiting for Android gRPC server to properly start before interacting with it
• Fix: brought back multi-window support on Android
• Fix: hideKeyboard command did not always work
• Fix: make project buildable on Java 14
• Refactoring: make MaestroCommand serializable without custom adapters
• Refactoring: migrated to JUnit 5

1.6.0 - 2022-09-13

• Feature: hideKeyboard command
• Feature: add Android TV Remote navigation
• Tweak: allowing to skip package name when searching by id
• Fix: Android WebView contents were sometimes not reported as part of the view hierarchy
• Fix: iOS inputText race condition
• Fix: populate iOS accessibility value
• Refactoring: simplified MaestroCommand serialization

1.5.0 - 2022-09-08

• Temporary fix: showing an error when unicode characters are passed to inputText
• Feature: eraseText command

1.4.2 - 2022-09-06

• Fix: Android devices were not discoverable in some cases

1.4.1 - 2022-09-05

• Fix: relative position selectors (i.e. below) were sometimes picking a wrong view
• Fix: await channel termination when closing a gRPC ManagedChannel
• Fix: Android inputText did not work properly when a string had whitespaces in it
• Fix: race condition in iOS inputText

1.4.0 - 2022-08-29

• Added traits selector.
• Relative selectors (such as above, below, etc.) are now picking the closest element.
• Fix: continuous mode did not work for paths without a parent directory
• Fix: workaround for UiAutomator content descriptor crash
• Fix: tapOn: {int} did not work

1.3.6 - 2022-08-25

• Added longPressOn command
• Decreased wait time in apps that have a screen overlay
• Fixed CLI issue where status updates would not propagate correctly

1.3.3 - 2022-08-23

• Fix: iOS accessibility was not propagated to Maestro

1.3.2 - 2022-08-22

• Fix: env parameters did not work with init flows when using Maestro programmatically

1.3.1 - 2022-08-19

• Added support for externally supplied parameters
• Added openLink command

1.2.6 - 2022-08-18

• Fail launching an iOS app if the app is already running

1.2.4 - 2022-08-17

• Add support for cli to specify what platform, host and port to connect to

1.2.3 - 2022-08-15

• Added support of iOS state restoration
• Exposing appId field as part of MaestroConfig

1.2.2 - 2022-08-08

• Update Orchestra to support state restoration

1.2.1 - 2022-08-04

• Update YamlCommandReader to accept Paths instead of Files to support zip Filesystems

1.2.0 - 2022-08-04

• Config is now defined via a document separator
• launchApp no longer requires and appId
• initFlow config implemented

1.1.0 - 2022-07-28

• launchApp command now can optionally clear app state
• config command to allow Orchestra consumers a higher degree of customization
• Fixed a bug where ElementNotFound hierarchy field was not declared as public

1.0.0 - 2022-07-20

• Initial Maestro release (formerly known as Conductor)